Merge branch 'tr/maint-mailinfo'
authorJunio C Hamano <gitster@pobox.com>
Fri, 13 Jan 2012 07:34:26 +0000 (23:34 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 13 Jan 2012 07:34:26 +0000 (23:34 -0800)
* tr/maint-mailinfo:
mailinfo documentation: accurately describe non -k case

1  2 
Documentation/git-mailinfo.txt
index 51dc3257486b07edaec71fe98fed6533e17e1a77,36d04002078950df2bac0cc88d16f33e6a2d4c09..97e7a8e9e7cc01bc350d57ca66e08f5ed96221de
@@@ -8,7 -8,6 +8,7 @@@ git-mailinfo - Extracts patch and autho
  
  SYNOPSIS
  --------
 +[verse]
  'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
  
  
@@@ -25,13 -24,24 +25,24 @@@ command directly.  See linkgit:git-am[1
  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 '['