Skip to content

Commit db97296

Browse files
Linus Arvergitster
authored andcommitted
trailer doc: emphasize the effect of configuration variables
The sentence does not mention the effect of configuration variables at all, when they are actively used by default (unless --parse is specified) to potentially add new trailers, without the user having to always supply --trailer manually. Signed-off-by: Linus Arver <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 289a0b2 commit db97296

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Documentation/git-interpret-trailers.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,12 @@ This command reads commit messages from either the
3434
If `--parse` is specified, the output consists of the parsed trailers
3535
coming from the input, without influencing them with any command line
3636
options or configuration variables.
37-
Otherwise, this command applies the arguments passed using the
38-
`--trailer` option, if any, to each input file. The result is emitted on the
39-
standard output.
37+
38+
Otherwise, this command applies `trailer.*` configuration variables
39+
(which could potentially add new trailers, as well as reposition them),
40+
as well as any command line arguments that can override configuration
41+
variables (such as `--trailer=...` which could also add new trailers),
42+
to each input file. The result is emitted on the standard output.
4043

4144
This command can also operate on the output of linkgit:git-format-patch[1],
4245
which is more elaborate than a plain commit message. Namely, such output

0 commit comments

Comments
 (0)