Skip to content

Commit

Permalink
Merge branch 'tr/maint-mailinfo'
Browse files Browse the repository at this point in the history
* tr/maint-mailinfo:
  mailinfo documentation: accurately describe non -k case
  • Loading branch information
gitster committed Jan 13, 2012
2 parents 96e3360 + 82553cb commit b51ffa8
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions Documentation/git-mailinfo.txt
Expand Up @@ -25,13 +25,24 @@ command directly. See linkgit:git-am[1] instead.
OPTIONS
-------
-k::
Usually the program 'cleans up' the Subject: header line
to extract the title line for the commit log message,
among which (1) remove 'Re:' or 're:', (2) leading
whitespaces, (3) '[' up to ']', typically '[PATCH]', and
then prepends "[PATCH] ". This flag forbids this
munging, and is most useful when used to read back
'git format-patch -k' output.
Usually the program removes email cruft from the Subject:
header line to extract the title line for the commit log
message. This option prevents this munging, and is most
useful when used to read back 'git format-patch -k' output.
+
Specifically, the following are removed until none of them remain:
+
--
* Leading and trailing whitespace.

* Leading `Re:`, `re:`, and `:`.

* Leading bracketed strings (between `[` and `]`, usually
`[PATCH]`).
--
+
Finally, runs of whitespace are normalized to a single ASCII space
character.

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

0 comments on commit b51ffa8

Please sign in to comment.