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