diff mbox series

[03/21] doc: mention canonicalization in git i-t manual

Message ID 20201025212652.3003036-4-anders@0x63.nu (mailing list archive)
State New, archived
Headers show
Series trailer fixes | expand

Commit Message

Anders Waldenborg Oct. 25, 2020, 9:26 p.m. UTC
); SAEximRunCond expanded to false

Signed-off-by: Anders Waldenborg <anders@0x63.nu>
---
 Documentation/git-interpret-trailers.txt | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Christian Couder Oct. 26, 2020, 12:14 p.m. UTC | #1
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."
diff mbox series

Patch

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"
+form if the trailer has a corresponding 'trailer.<token>.key'
+configuration value. This means that it will use the exact spelling
+(upper case vs lower case and separator) defined in configuration.
+
 Some configuration variables control the way the `--trailer` arguments
 are applied to each commit message and the way any existing trailer in
 the commit message is changed. They also make it possible to