Skip to content

Commit cb088cb

Browse files
Linus Arvergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a6c72e7 commit cb088cb

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Documentation/git-interpret-trailers.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ the last two lines starting with "Signed-off-by" are trailers.
3131

3232
This command reads commit messages from either the
3333
<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.
3537
Otherwise, this command applies the arguments passed using the
3638
`--trailer` option, if any, to each input file. The result is emitted on the
3739
standard output.
@@ -158,7 +160,10 @@ OPTIONS
158160

159161
--parse::
160162
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.
162167

163168
--no-divider::
164169
Do not treat `---` as the end of the commit message. Use this

0 commit comments

Comments
 (0)