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 <linusa@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Linus Arver committed
Sep 7, 2023 at 22:20 UTC
db97296122b8cfb14cd166124d3e933df64c9a78
1 file changed
+6
-3
Documentation/git-interpret-trailers.txt
+6
-3
@@ -34,9 +34,12 @@ This command reads commit messages from either the
34
If `--parse` is specified, the output consists of the parsed trailers
35
coming from the input, without influencing them with any command line
36
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.
43
44
This command can also operate on the output of linkgit:git-format-patch[1],
45
which is more elaborate than a plain commit message. Namely, such output