blob: 97e7a8e9e7cc01bc350d57ca66e08f5ed96221de [file] [log] [blame]
Junio C Hamano7fc9d692005-08-23 01:49:47 -07001git-mailinfo(1)
2===============
3
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -08006git-mailinfo - Extracts patch and authorship from a single e-mail message
Junio C Hamano7fc9d692005-08-23 01:49:47 -07007
8
9SYNOPSIS
10--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -040011[verse]
Junio C Hamanod268cb92009-11-30 14:43:24 -080012'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
Junio C Hamanof85a4192005-08-29 17:21:06 -070013
Junio C Hamano7fc9d692005-08-23 01:49:47 -070014
15DESCRIPTION
16-----------
Markus Heidelberg04c8ce92008-12-19 13:14:18 +010017Reads a single e-mail message from the standard input, and
Junio C Hamanof85a4192005-08-29 17:21:06 -070018writes the commit log message in <msg> file, and the patches in
19<patch> file. The author name, e-mail and e-mail subject are
Thomas Rast0b444cd2010-01-10 00:33:00 +010020written out to the standard output to be used by 'git am'
Junio C Hamanof85a4192005-08-29 17:21:06 -070021to create a commit. It is usually not necessary to use this
Dan McGee5162e692007-12-29 00:20:38 -060022command directly. See linkgit:git-am[1] instead.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070023
24
25OPTIONS
26-------
Junio C Hamanof85a4192005-08-29 17:21:06 -070027-k::
Thomas Rast82553cb2012-01-11 21:13:42 +010028 Usually the program removes email cruft from the Subject:
29 header line to extract the title line for the commit log
30 message. This option prevents this munging, and is most
31 useful when used to read back 'git format-patch -k' output.
32+
33Specifically, the following are removed until none of them remain:
34+
35--
36* Leading and trailing whitespace.
37
38* Leading `Re:`, `re:`, and `:`.
39
40* Leading bracketed strings (between `[` and `]`, usually
41 `[PATCH]`).
42--
43+
44Finally, runs of whitespace are normalized to a single ASCII space
45character.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070046
Junio C Hamano17635fc2009-07-15 15:31:12 -070047-b::
48 When -k is not in effect, all leading strings bracketed with '['
49 and ']' pairs are stripped. This option limits the stripping to
50 only the pairs whose bracketed string contains the word "PATCH".
51
Junio C Hamanof85a4192005-08-29 17:21:06 -070052-u::
Junio C Hamanobb1091a2007-01-09 21:31:36 -080053 The commit log message, author name and author email are
54 taken from the e-mail, and after minimally decoding MIME
Zhang Lee0a91102010-06-14 02:49:47 +080055 transfer encoding, re-coded in the charset specified by
56 i18n.commitencoding (defaulting to UTF-8) by transliterating
Junio C Hamanobb1091a2007-01-09 21:31:36 -080057 them. This used to be optional but now it is the default.
58+
59Note that the patch is always used as-is without charset
60conversion, even with this flag.
Junio C Hamanof85a4192005-08-29 17:21:06 -070061
Junio C Hamano9f638922005-11-28 01:29:52 -080062--encoding=<encoding>::
Zhang Lee0a91102010-06-14 02:49:47 +080063 Similar to -u. But when re-coding, the charset specified here is
64 used instead of the one specified by i18n.commitencoding or UTF-8.
Junio C Hamano9f638922005-11-28 01:29:52 -080065
Lukas Sandströmb4958182008-07-10 23:36:28 +020066-n::
67 Disable all charset re-coding of the metadata.
68
Junio C Hamano017678b2009-08-26 21:36:05 -070069--scissors::
70 Remove everything in body before a scissors line. A line that
71 mainly consists of scissors (either ">8" or "8<") and perforation
72 (dash "-") marks is called a scissors line, and is used to request
73 the reader to cut the message at that line. If such a line
74 appears in the body of the message before the patch, everything
75 before it (including the scissors line itself) is ignored when
76 this option is used.
77+
78This is useful if you want to begin your message in a discussion thread
79with comments and suggestions on the message you are responding to, and to
80conclude it with a patch submission, separating the discussion and the
81beginning of the proposed commit log message with a scissors line.
Nicolas Sebrecht434a6db2009-09-11 02:29:58 +020082+
83This can enabled by default with the configuration option mailinfo.scissors.
84
85--no-scissors::
86 Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
Junio C Hamano017678b2009-08-26 21:36:05 -070087
Junio C Hamanof85a4192005-08-29 17:21:06 -070088<msg>::
89 The commit log message extracted from e-mail, usually
90 except the title line which comes from e-mail Subject.
91
92<patch>::
93 The patch extracted from e-mail.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070094
Junio C Hamano7fc9d692005-08-23 01:49:47 -070095GIT
96---
Christian Couder9e1f0a82008-06-06 09:07:32 +020097Part of the linkgit:git[1] suite