]> git.ipfire.org Git - thirdparty/git.git/commitdiff
trailer doc: emphasize the effect of configuration variables
authorLinus Arver <linusa@google.com>
Thu, 7 Sep 2023 22:20:07 +0000 (22:20 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 8 Sep 2023 06:04:44 +0000 (23:04 -0700)
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 <linusa@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-interpret-trailers.txt

index 62ba2b1232e97e062cce970f47190ded661469bc..a288ff111cb4c1c4653a91cc0661effabc3f1343 100644 (file)
@@ -34,9 +34,12 @@ This command reads commit messages from either the
 If `--parse` is specified, the output consists of the parsed trailers
 coming from the input, without influencing them with any command line
 options or configuration variables.
-Otherwise, this command applies the arguments passed using the
-`--trailer` option, if any, to each input file. The result is emitted on the
-standard output.
+
+Otherwise, this command applies `trailer.*` configuration variables
+(which could potentially add new trailers, as well as reposition them),
+as well as any command line arguments that can override configuration
+variables (such as `--trailer=...` which could also add new trailers),
+to each input file. The result is emitted on the standard output.
 
 This command can also operate on the output of linkgit:git-format-patch[1],
 which is more elaborate than a plain commit message. Namely, such output