]>
Commit | Line | Data |
---|---|---|
7fc9d69f JH |
1 | git-mailinfo(1) |
2 | =============== | |
3 | ||
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-mailinfo - Extracts patch and authorship from a single e-mail message |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
d268cb94 | 11 | 'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch> |
f85a4191 | 12 | |
7fc9d69f JH |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
04c8ce9c | 16 | Reads a single e-mail message from the standard input, and |
f85a4191 JH |
17 | writes the commit log message in <msg> file, and the patches in |
18 | <patch> file. The author name, e-mail and e-mail subject are | |
0b444cdb | 19 | written out to the standard output to be used by 'git am' |
f85a4191 | 20 | to create a commit. It is usually not necessary to use this |
5162e697 | 21 | command directly. See linkgit:git-am[1] instead. |
7fc9d69f JH |
22 | |
23 | ||
24 | OPTIONS | |
25 | ------- | |
f85a4191 JH |
26 | -k:: |
27 | Usually the program 'cleans up' the Subject: header line | |
28 | to extract the title line for the commit log message, | |
29 | among which (1) remove 'Re:' or 're:', (2) leading | |
30 | whitespaces, (3) '[' up to ']', typically '[PATCH]', and | |
31 | then prepends "[PATCH] ". This flag forbids this | |
46e56e81 | 32 | munging, and is most useful when used to read back |
0b444cdb | 33 | 'git format-patch -k' output. |
f85a4191 | 34 | |
17635fc9 JH |
35 | -b:: |
36 | When -k is not in effect, all leading strings bracketed with '[' | |
37 | and ']' pairs are stripped. This option limits the stripping to | |
38 | only the pairs whose bracketed string contains the word "PATCH". | |
39 | ||
f85a4191 | 40 | -u:: |
bb1091a4 JH |
41 | The commit log message, author name and author email are |
42 | taken from the e-mail, and after minimally decoding MIME | |
e0a91101 ZL |
43 | transfer encoding, re-coded in the charset specified by |
44 | i18n.commitencoding (defaulting to UTF-8) by transliterating | |
bb1091a4 JH |
45 | them. This used to be optional but now it is the default. |
46 | + | |
47 | Note that the patch is always used as-is without charset | |
48 | conversion, even with this flag. | |
7fc9d69f | 49 | |
9f63892b | 50 | --encoding=<encoding>:: |
e0a91101 ZL |
51 | Similar to -u. But when re-coding, the charset specified here is |
52 | used instead of the one specified by i18n.commitencoding or UTF-8. | |
9f63892b | 53 | |
b4958181 LS |
54 | -n:: |
55 | Disable all charset re-coding of the metadata. | |
56 | ||
017678b4 JH |
57 | --scissors:: |
58 | Remove everything in body before a scissors line. A line that | |
59 | mainly consists of scissors (either ">8" or "8<") and perforation | |
60 | (dash "-") marks is called a scissors line, and is used to request | |
61 | the reader to cut the message at that line. If such a line | |
62 | appears in the body of the message before the patch, everything | |
63 | before it (including the scissors line itself) is ignored when | |
64 | this option is used. | |
65 | + | |
66 | This is useful if you want to begin your message in a discussion thread | |
67 | with comments and suggestions on the message you are responding to, and to | |
68 | conclude it with a patch submission, separating the discussion and the | |
69 | beginning of the proposed commit log message with a scissors line. | |
434a6db7 NS |
70 | + |
71 | This can enabled by default with the configuration option mailinfo.scissors. | |
72 | ||
73 | --no-scissors:: | |
74 | Ignore scissors lines. Useful for overriding mailinfo.scissors settings. | |
017678b4 | 75 | |
f85a4191 JH |
76 | <msg>:: |
77 | The commit log message extracted from e-mail, usually | |
78 | except the title line which comes from e-mail Subject. | |
79 | ||
80 | <patch>:: | |
81 | The patch extracted from e-mail. | |
7fc9d69f | 82 | |
7fc9d69f JH |
83 | GIT |
84 | --- | |
9e1f0a85 | 85 | Part of the linkgit:git[1] suite |