trailer --parse docs: add explanation for its usefulness
For users who are skimming the docs to go straight to the individual breakdown of each flag, it may not be clear why --parse is a convenience alias (without them also looking at the other options that --parse turns on). To save them the trouble of looking at the other options (and computing what that would mean), describe a summary of the overall effect. Similarly update the area when we first mention --parse near the top of the doc. 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
cb088cbe0f8589938d345b7e2524c2345fbb0166
1 file changed
+7
-2
Documentation/git-interpret-trailers.txt
+7
-2
@@ -31,7 +31,9 @@ the last two lines starting with "Signed-off-by" are trailers.
31
32
This command reads commit messages from either the
33
<file> arguments or the standard input if no <file> is specified.
34
-If `--parse` is specified, the output consists of the parsed trailers.
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.
@@ -158,7 +160,10 @@ OPTIONS
160
161
--parse::
162
A convenience alias for `--only-trailers --only-input
161
- --unfold`.
163
+ --unfold`. This makes it easier to only see the trailers coming from the
164
+ input without influencing them with any command line options or
165
+ configuration variables, while also making the output machine-friendly with
166
+ --unfold.
167
168
--no-divider::
169
Do not treat `---` as the end of the commit message. Use this