freshlybakedca.ke
Git fork
1git-mailinfo(1)
2===============
3
4NAME
5----
6git-mailinfo - Extracts patch and authorship from a single e-mail message
7
8
9SYNOPSIS
10--------
11[verse]
12'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n]
13 [--[no-]scissors] [--quoted-cr=<action>]
14 <msg> <patch>
15
16
17DESCRIPTION
18-----------
19Reads a single e-mail message from the standard input, and
20writes the commit log message in <msg> file, and the patches in
21<patch> file. The author name, e-mail and e-mail subject are
22written out to the standard output to be used by 'git am'
23to create a commit. It is usually not necessary to use this
24command directly. See linkgit:git-am[1] instead.
25
26
27OPTIONS
28-------
29-k::
30 Usually the program removes email cruft from the Subject:
31 header line to extract the title line for the commit log
32 message. This option prevents this munging, and is most
33 useful when used to read back 'git format-patch -k' output.
34+
35Specifically, the following are removed until none of them remain:
36+
37--
38* Leading and trailing whitespace.
39
40* Leading `Re:`, `re:`, and `:`.
41
42* Leading bracketed strings (between `[` and `]`, usually
43 `[PATCH]`).
44--
45+
46Finally, runs of whitespace are normalized to a single ASCII space
47character.
48
49-b::
50 When -k is not in effect, all leading strings bracketed with '['
51 and ']' pairs are stripped. This option limits the stripping to
52 only the pairs whose bracketed string contains the word "PATCH".
53
54-u::
55 The commit log message, author name and author email are
56 taken from the e-mail, and after minimally decoding MIME
57 transfer encoding, re-coded in the charset specified by
58 `i18n.commitEncoding` (defaulting to UTF-8) by transliterating
59 them. This used to be optional but now it is the default.
60+
61Note that the patch is always used as-is without charset
62conversion, even with this flag.
63
64--encoding=<encoding>::
65 Similar to -u. But when re-coding, the charset specified here is
66 used instead of the one specified by `i18n.commitEncoding` or UTF-8.
67
68-n::
69 Disable all charset re-coding of the metadata.
70
71-m::
72--message-id::
73 Copy the Message-ID header at the end of the commit message. This
74 is useful in order to associate commits with mailing list discussions.
75
76--scissors::
77 Remove everything in body before a scissors line (e.g. "-- >8 --").
78 The line represents scissors and perforation marks, and is used to
79 request the reader to cut the message at that line. If that line
80 appears in the body of the message before the patch, everything
81 before it (including the scissors line itself) is ignored when
82 this option is used.
83+
84This is useful if you want to begin your message in a discussion thread
85with comments and suggestions on the message you are responding to, and to
86conclude it with a patch submission, separating the discussion and the
87beginning of the proposed commit log message with a scissors line.
88+
89This can be enabled by default with the configuration option mailinfo.scissors.
90
91--no-scissors::
92 Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
93
94--quoted-cr=<action>::
95 Action when processes email messages sent with base64 or
96 quoted-printable encoding, and the decoded lines end with a CRLF
97 instead of a simple LF.
98+
99The valid actions are:
100+
101--
102* `nowarn`: Git will do nothing when such a CRLF is found.
103* `warn`: Git will issue a warning for each message if such a CRLF is
104 found.
105* `strip`: Git will convert those CRLF to LF.
106--
107+
108The default action could be set by configuration option `mailinfo.quotedCR`.
109If no such configuration option has been set, `warn` will be used.
110
111<msg>::
112 The commit log message extracted from e-mail, usually
113 except the title line which comes from e-mail Subject.
114
115<patch>::
116 The patch extracted from e-mail.
117
118CONFIGURATION
119-------------
120
121include::includes/cmd-config-section-all.adoc[]
122
123include::config/mailinfo.adoc[]
124
125GIT
126---
127Part of the linkgit:git[1] suite