From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 13 Jan 2012 07:34:26 +0000 (-0800)
Subject: Merge branch 'tr/maint-mailinfo'
X-Git-Tag: v1.7.9-rc1~2
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/b51ffa80f6e65fde91a667c4825eeeb4deb997f6?hp=-c

Merge branch 'tr/maint-mailinfo'

* tr/maint-mailinfo:
mailinfo documentation: accurately describe non -k case
---

b51ffa80f6e65fde91a667c4825eeeb4deb997f6
diff --combined Documentation/git-mailinfo.txt
index 51dc325748,36d0400207..97e7a8e9e7
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@@ -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 '['