summaryrefslogtreecommitdiff
path: root/Documentation/git-mailinfo.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-01-12 23:34:26 -0800
committerJunio C Hamano <gitster@pobox.com>2012-01-12 23:34:26 -0800
commitb51ffa80f6e65fde91a667c4825eeeb4deb997f6 (patch)
treef2571e62f2c381df85daea02eeed3f1fc298183f /Documentation/git-mailinfo.txt
parent96e33609974a79e6826dc62d008a8bc9c0923612 (diff)
parent82553cbb08b791aa0bed920ee58494268c0f579f (diff)
downloadgit-b51ffa80f6e65fde91a667c4825eeeb4deb997f6.tar.gz
Merge branch 'tr/maint-mailinfo'
* tr/maint-mailinfo: mailinfo documentation: accurately describe non -k case
Diffstat (limited to 'Documentation/git-mailinfo.txt')
-rw-r--r--Documentation/git-mailinfo.txt25
1 files changed, 18 insertions, 7 deletions
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index 51dc325748..97e7a8e9e7 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -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 '['