Skip to content

Commit cb65736

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: interpret-trailers: rewrite new-trailers paragraphs
Two commits ago we moved new-trailers paragraph next to each other. But there is something curious about two of them: By default the new trailer will appear at the end of the trailer block. [...] Then a source block and a paragraph later: By default, a `<key>=<value>` or `<key>:<value>` argument given using `--trailer` will be appended after the existing trailers only if [...] Why are there two paragraphs that talk about how “By default” a trailer will be appended? We can make these paragraphs flow better, and with a more distinct character each, by dividing the flow like this: 1. Declare that we are about to talk about `--trailer` appending 2. Explain the default behavior 3. Explain how this affects the trailer block 4. Then discuss what each trailer line will look like Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 4d45e57 commit cb65736

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎Documentation/git-interpret-trailers.adoc‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,18 @@ are applied to each input and the way any existing trailer in
6060
the input is changed. They also make it possible to
6161
automatically add some trailers.
6262

63-
By default, a `<key>=<value>` or `<key>:<value>` argument given
64-
using `--trailer` will be appended after the existing trailers only if
65-
the last trailer has a different (_<key>_, _<value>_) pair (or if there
66-
is no existing trailer). The _<key>_ and _<value>_ parts will be trimmed
63+
Let's consider new trailers added with `--trailer`.
64+
By default, the new trailer will appear at the end of the trailer block.
65+
Also by default, this new trailer will only be added
66+
if the last trailer is different to it.
67+
A trailer block will be created with only that trailer if a trailer
68+
block does not already exist. Recall that a trailer block needs to be
69+
preceded by a blank line, so a blank line will be inserted before the
70+
new trailer block in that case.
71+
72+
This is how the new trailer is added: a `<key>=<value>` or
73+
`<key>:<value>` argument given using `--trailer` will be appended after
74+
the existing trailers. The _<key>_ and _<value>_ parts will be trimmed
6775
to remove starting and trailing whitespace, and the resulting trimmed
6876
_<key>_ and _<value>_ will appear in the output like this:
6977

@@ -74,12 +82,6 @@ key: value
7482
This means that the trimmed _<key>_ and _<value>_ will be separated by
7583
"`:`{nbsp}" (one colon followed by one space).
7684

77-
By default the new trailer will appear at the end of the trailer block.
78-
A trailer block will be created with only that trailer if a trailer
79-
block does not already exist. Recall that a trailer block needs to be
80-
preceded by a blank line, so a blank line will be inserted before the
81-
new trailer block in that case.
82-
8385
Existing trailers are extracted from the input by looking for the
8486
trailer block. A trailer block is a group of one or more lines that (i)
8587
is all trailers, or (ii) contains at least one Git-generated or

0 commit comments

Comments
 (0)