Skip to content

Commit b51ffa8

Browse files
committed
Merge branch 'tr/maint-mailinfo'
* tr/maint-mailinfo: mailinfo documentation: accurately describe non -k case
2 parents 96e3360 + 82553cb commit b51ffa8

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

Documentation/git-mailinfo.txt

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,24 @@ command directly. See linkgit:git-am[1] instead.
2525
OPTIONS
2626
-------
2727
-k::
28-
Usually the program 'cleans up' the Subject: header line
29-
to extract the title line for the commit log message,
30-
among which (1) remove 'Re:' or 're:', (2) leading
31-
whitespaces, (3) '[' up to ']', typically '[PATCH]', and
32-
then prepends "[PATCH] ". This flag forbids this
33-
munging, and is most useful when used to read back
34-
'git format-patch -k' output.
28+
Usually the program removes email cruft from the Subject:
29+
header line to extract the title line for the commit log
30+
message. This option prevents this munging, and is most
31+
useful when used to read back 'git format-patch -k' output.
32+
+
33+
Specifically, the following are removed until none of them remain:
34+
+
35+
--
36+
* Leading and trailing whitespace.
37+
38+
* Leading `Re:`, `re:`, and `:`.
39+
40+
* Leading bracketed strings (between `[` and `]`, usually
41+
`[PATCH]`).
42+
--
43+
+
44+
Finally, runs of whitespace are normalized to a single ASCII space
45+
character.
3546

3647
-b::
3748
When -k is not in effect, all leading strings bracketed with '['

0 commit comments

Comments
 (0)