From: Christian Couder <christian.couder@gmail.com>
Date: Mon, 26 Oct 2020 12:14:01 GMT
Subject: Re: [PATCH 03/21] doc: mention canonicalization in git i-t manual
Message-ID: <CAP8UFD3=HLzG=b61DQYQfAErOg+KXAg-8x06MpDLi+1=NcgejQ@mail.gmail.com>
In-Reply-To: <20201025212652.3003036-4-anders@0x63.nu>

On Sun, Oct 25, 2020 at 10:27 PM Anders Waldenborg <anders@0x63.nu> wrote:

> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
> index 96ec6499f0..a4be8aed66 100644
> --- a/Documentation/git-interpret-trailers.txt
> +++ b/Documentation/git-interpret-trailers.txt
> @@ -25,6 +25,11 @@ 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.
>
> +When trailers read from input they will be changed into "canonical"

Do you mean "When trailers are read from standard input"?

> +form if the trailer has a corresponding 'trailer.<token>.key'
> +configuration value.

This doesn't explain what the canonical form is. So maybe something like:

"When there is a 'trailer.<token>.key' configuration value defined,
this value becomes the canonical form of the <token> trailer, so when
a trailer matching <token> is read from standard input, it is changed
to this canonical value."

> This means that it will use the exact spelling
> +(upper case vs lower case and separator) defined in configuration.

Maybe:

"This means that the key part of the trailer will use the exact
spelling (upper case vs lower case and separator) defined in the
configuration."