development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-10-05 16:19:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'tr/maint-mailinfo'

Browse source 
* tr/maint-mailinfo:
  mailinfo documentation: accurately describe non -k case
This commit is contained in:
Junio C Hamano 2012-01-12 23:34:26 -08:00
parent 96e3360997 82553cbb08
commit b51ffa80f6
1 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
Documentation/git-mailinfo.txt
View file

@ -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 '['