aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-mailinfo.txt
diff options
context:
space:
mode:
authorThomas Rast <trast@student.ethz.ch>2012-01-11 21:13:42 +0100
committerJunio C Hamano <gitster@pobox.com>2012-01-11 17:30:16 -0800
commit82553cbb08b791aa0bed920ee58494268c0f579f (patch)
treefb069f05fdfa69ab0339ce4026a9ce487d68ce1b /Documentation/git-mailinfo.txt
parentf67d2e82d6d2fd385d3d20e8d348eaf69dc95041 (diff)
downloadgit-82553cbb08b791aa0bed920ee58494268c0f579f.tar.gz
git-82553cbb08b791aa0bed920ee58494268c0f579f.tar.xz
mailinfo documentation: accurately describe non -k case
Since its very first description of -k, the documentation for git-mailinfo claimed that (in the case without -k) after cleaning up bracketed strings [blah], it would insert [PATCH]. It doesn't; on the contrary, one of the important jobs of mailinfo is to remove those strings. Since we're already there, rewrite the paragraph to give a complete enumeration of all the transformations. Specifically, it was missing the whitespace normalization (run of isspace(c) -> ' ') and the removal of leading ':'. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
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 ed45662cc..36d040020 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -24,13 +24,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 '['