Re: [PATCH] doc: point to diff attribute in patch format docs

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 27, 2021, 07:40 UTC
Message-ID: <xmqqh7jsdvlb.fsf@gitster.g>
In-Reply-To: <pull.940.git.1619463549689.gitgitgadget@gmail.com>

"Peter Oliver via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 16 quoted lines

> @@ -11,7 +11,7 @@ linkgit:git-diff-files[1]
>  with the `-p` option produces patch text.
>  You can customize the creation of patch text via the
>  `GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
> -(see linkgit:git[1]).
> +(see linkgit:git[1]), and the `diff` attribute (see linkgit:gitattributes[5]).
>  
>  What the -p option produces is slightly different from the traditional
>  diff format:
> @@ -74,6 +74,10 @@ separate lines indicate the old and the new mode.
>        rename from b
>        rename to a
>  
> +5.  Hunk headers mention the name of the function to which the hunk
> +    applies.  See linkgit:gitattributes[5] for details of how to tailor
> +    to this to specific languages.

Shouldn't this part be as helpful as the change you made to the earlier part by mentioning that the user wants to look at a specific part of the document, instead of reading the entire gitattributes(5) manpage? Perhaps "Defining a custom hunk header" section is what they want to refer to.

>  Combined diff format
>  --------------------
>
> base-commit: 48bf2fa8bad054d66bd79c6ba903c89c704201f7