Re: [PATCH] doc: update diff-format.txt for removed ellipses

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 24, 2018, 02:50 UTC
Message-ID: <xmqqwop32npr.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20181123090908.43445-2-greg@hurrell.net>

Thanks for a patch.

Greg Hurrell <greg@hurrell.net> writes:

> Commit 7cb6ac1e4b made the diff format omit ellipses by default, but
> there is still this place in the documentation where we show examples of
> output with ellipses.

We prefer to cite an existing commit with its title and date these days, not just with its object name.

    Since 7cb6ac1e ("diff: diff_aligned_abbrev: remove ellipsis after
    abbreviated SHA-1 value", 2017-12-03), the "--raw" format of diff
    does not add ellipsis in an attempt to align the output, but...

or something like that. Note that saying this is about the raw format is quite essential thing to tell the readers to explain this hange.

> The GIT_PRINT_SHA1_ELLIPSIS environment variable can be used, for now,
> to bring back the old output format, but that is already documented in
> git.txt, so I am not mentioning it here.

Yeah, I do not think it makes sense to use the workaround that is planned for removal, which will later make us revise the example in the documentation again, to end up with the text that you have right now. I do not think this three-line paragraph needs to be in the log message, either, though. Perhaps below the three-dash line.

Also please sign-off your patch here (see Documentation/SubmittingPatches).

> ---

Thanks.

Show 44 quoted lines

>  Documentation/diff-format.txt | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
> index 706916c94c..cdcc17f0ad 100644
> --- a/Documentation/diff-format.txt
> +++ b/Documentation/diff-format.txt
> @@ -26,12 +26,12 @@ line per changed file.
>  An output line is formatted this way:
>  
>  ------------------------------------------------
> -in-place edit  :100644 100644 bcd1234... 0123456... M file0
> -copy-edit      :100644 100644 abcd123... 1234567... C68 file1 file2
> -rename-edit    :100644 100644 abcd123... 1234567... R86 file1 file3
> -create         :000000 100644 0000000... 1234567... A file4
> -delete         :100644 000000 1234567... 0000000... D file5
> -unmerged       :000000 000000 0000000... 0000000... U file6
> +in-place edit  :100644 100644 bcd1234 0123456 M file0
> +copy-edit      :100644 100644 abcd123 1234567 C68 file1 file2
> +rename-edit    :100644 100644 abcd123 1234567 R86 file1 file3
> +create         :000000 100644 0000000 1234567 A file4
> +delete         :100644 000000 1234567 0000000 D file5
> +unmerged       :000000 000000 0000000 0000000 U file6
>  ------------------------------------------------
>  
>  That is, from the left to the right:
> @@ -75,7 +75,7 @@ and it is out of sync with the index.
>  Example:
>  
>  ------------------------------------------------
> -:100644 100644 5be4a4...... 000000...... M file.c
> +:100644 100644 5be4a4a 0000000 M file.c
>  ------------------------------------------------
>  
>  Without the `-z` option, pathnames with "unusual" characters are
> @@ -100,7 +100,7 @@ from the format described above in the following way:
>  Example:
>  
>  ------------------------------------------------
> -::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM	describe.c
> +::100644 100644 100644 fabadb8 cc95eb0 4866510 MM	describe.c
>  ------------------------------------------------
>  
>  Note that 'combined diff' lists only files which were modified from