Re: [PATCH 04/11] doc: trailer: explain "commit mesage part" on first usage

From: Junio C Hamano <gitster@pobox.com>
Date: May 8, 2023, 19:37 UTC
Message-ID: <xmqqa5yeobrj.fsf@gitster.g>
In-Reply-To: <0c10e40794d208ba408a2b1c394fdbd6caa7a92a.1683566870.git.gitgitgadget@gmail.com>

"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Linus Arver <linusa@google.com>
>
> This phrase is used for the first time here, but it's not explained what
> it means. So explain it just in case it's not obvious.

03+04 should be a single patch (as I read more, I may find other steps should also be in a single step, I dunno); otherwise it would waste reviewer's time (just like I did thinking and writing about 03/11).

Or just drop "part". "git cat-file commit HEAD | sed -e '1,/^$/d'" is a good material to use with "--no-divider" because it only has the "commit message". The "part" implies you first had something that has both "commit message" and something else and you split that combination into two (or more) parts. But that does not have to be the case. I think that made 03/11 confusing, at least to me.

Show 22 quoted lines

> Signed-off-by: Linus Arver <linusa@google.com>
> ---
>  Documentation/git-interpret-trailers.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
> index 3e60a6eaabc..7d6e250f37e 100644
> --- a/Documentation/git-interpret-trailers.txt
> +++ b/Documentation/git-interpret-trailers.txt
> @@ -22,9 +22,9 @@ This command reads some patches or commit messages from either the
>  <file> arguments or the standard input if no <file> is specified. If
>  `--parse` is specified, the output consists of the parsed trailers.
>  
> -Otherwise, this command applies the arguments passed using the
> -`--trailer` option, if any, to the commit message part of each input
> -file. The result is emitted on the standard output.
> +Otherwise, this command applies the arguments passed using the `--trailer`
> +option, if any, to the commit message part of each input file (as opposed to the
> +patch part following a '---' divider). The result is emitted to standard output.
>  
>  Some configuration variables control the way the `--trailer` arguments
>  are applied to each commit message and the way any existing trailer in