Re: [PATCH v2 1/1] Introduce git add --renormalize .

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 10, 2017, 00:22 UTC
Message-ID: <xmqq1sl7j83x.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20171109184700.GA27635@tor.lan>

Torsten Bögershausen <tboegi@web.de> writes:

Show 6 quoted lines

> Here is a somwhat shorter description:
>
> Apply the "clean" process freshly to all tracked files.
> This is useful after changing `core.autocrlf` or the `text`
> attributes in the `.gitattributes` file because
> Git may not consider these files as changed.

I think it is OK to omit .git/config for brevity (I am assuming that your justification is because you thought it was obvious it is a configuration variable); but then it is equally obvious (if not more) that `text` attribute comes from .gitattributes (notice we do not mention core.autocrlf is a configuration variable in the above, but we do say `text` is an attribute) so it can also be omitted for brevity.

> Correct the files that had been commited with CRLF,
> they will from now on have LF instead.

Reading this as a single sentence immediately after the above paragraph leaves me feel confused. First of all, this would not happen unless the user corrects core.autocrlf/text like described above. In fact, updating these settings is done as in order to do that correction. So I'd say it should not be split.

> Re-run what the `clean` filter does.

This again looks out of place just like the previous sentence. In fact, provided if "the clean process" is understood by the end user, this is redundant.

> This option implies `-u`.

Taking these altogether, perhaps

    Apply the "clean" process freshly to all tracked files to
    forcibly add them again to the index.  This is useful after
    changing `core.autocrlf` configuration or the `text` attribute
    in order to correct files added with wrong CRLF/LF line endings.
    This option implies `-u`.

Thanks.