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>
Thomas Rast committed
Jan 11, 2012 at 21:13 UTC
82553cbb08b791aa0bed920ee58494268c0f579f
1 file changed
+18
-7
Documentation/git-mailinfo.txt
+18
-7
@@ -24,13 +24,24 @@ command directly. See linkgit:git-am[1] instead.
24
OPTIONS
25
-------
26
-k::
27
- Usually the program 'cleans up' the Subject: header line
28
- to extract the title line for the commit log message,
29
- among which (1) remove 'Re:' or 're:', (2) leading
30
- whitespaces, (3) '[' up to ']', typically '[PATCH]', and
31
- then prepends "[PATCH] ". This flag forbids this
32
- munging, and is most useful when used to read back
33
- 'git format-patch -k' output.
27
+ Usually the program removes email cruft from the Subject:
28
+ header line to extract the title line for the commit log
29
+ message. This option prevents this munging, and is most
30
+ useful when used to read back 'git format-patch -k' output.
31
++
32
+Specifically, the following are removed until none of them remain:
33
++
34
+--
35
+* Leading and trailing whitespace.
36
+
37
+* Leading `Re:`, `re:`, and `:`.
38
+
39
+* Leading bracketed strings (between `[` and `]`, usually
40
+ `[PATCH]`).
41
+--
42
++
43
+Finally, runs of whitespace are normalized to a single ASCII space
44
+character.
45
46
-b::
47
When -k is not in effect, all leading strings bracketed with '['