Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 1 | git-mailinfo(1) |
| 2 | =============== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
Junio C Hamano | c3f0baa | 2007-01-18 15:53:37 -0800 | [diff] [blame] | 6 | git-mailinfo - Extracts patch and authorship from a single e-mail message |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
Martin von Zweigbergk | 7791a1d | 2011-07-01 22:38:26 -0400 | [diff] [blame] | 11 | [verse] |
Felipe Contreras | 0460ed2 | 2013-05-08 20:16:55 -0500 | [diff] [blame] | 12 | 'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch> |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 13 | |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 14 | |
| 15 | DESCRIPTION |
| 16 | ----------- |
Markus Heidelberg | 04c8ce9 | 2008-12-19 13:14:18 +0100 | [diff] [blame] | 17 | Reads a single e-mail message from the standard input, and |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [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 |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 20 | written out to the standard output to be used by 'git am' |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 21 | to create a commit. It is usually not necessary to use this |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 22 | command directly. See linkgit:git-am[1] instead. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 23 | |
| 24 | |
| 25 | OPTIONS |
| 26 | ------- |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 27 | -k:: |
Thomas Rast | 82553cb | 2012-01-11 21:13:42 +0100 | [diff] [blame] | 28 | 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 | + |
| 33 | Specifically, 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 | + |
| 44 | Finally, runs of whitespace are normalized to a single ASCII space |
| 45 | character. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 46 | |
Junio C Hamano | 17635fc | 2009-07-15 15:31:12 -0700 | [diff] [blame] | 47 | -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 Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 52 | -u:: |
Junio C Hamano | bb1091a | 2007-01-09 21:31:36 -0800 | [diff] [blame] | 53 | The commit log message, author name and author email are |
| 54 | taken from the e-mail, and after minimally decoding MIME |
Zhang Le | e0a9110 | 2010-06-14 02:49:47 +0800 | [diff] [blame] | 55 | transfer encoding, re-coded in the charset specified by |
| 56 | i18n.commitencoding (defaulting to UTF-8) by transliterating |
Junio C Hamano | bb1091a | 2007-01-09 21:31:36 -0800 | [diff] [blame] | 57 | them. This used to be optional but now it is the default. |
| 58 | + |
| 59 | Note that the patch is always used as-is without charset |
| 60 | conversion, even with this flag. |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 61 | |
Junio C Hamano | 9f63892 | 2005-11-28 01:29:52 -0800 | [diff] [blame] | 62 | --encoding=<encoding>:: |
Zhang Le | e0a9110 | 2010-06-14 02:49:47 +0800 | [diff] [blame] | 63 | 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 Hamano | 9f63892 | 2005-11-28 01:29:52 -0800 | [diff] [blame] | 65 | |
Lukas Sandström | b495818 | 2008-07-10 23:36:28 +0200 | [diff] [blame] | 66 | -n:: |
| 67 | Disable all charset re-coding of the metadata. |
| 68 | |
Paolo Bonzini | 452dfbe | 2014-11-25 15:00:55 +0100 | [diff] [blame] | 69 | -m:: |
| 70 | --message-id:: |
| 71 | Copy the Message-ID header at the end of the commit message. This |
| 72 | is useful in order to associate commits with mailing list discussions. |
| 73 | |
Junio C Hamano | 017678b | 2009-08-26 21:36:05 -0700 | [diff] [blame] | 74 | --scissors:: |
| 75 | Remove everything in body before a scissors line. A line that |
| 76 | mainly consists of scissors (either ">8" or "8<") and perforation |
| 77 | (dash "-") marks is called a scissors line, and is used to request |
| 78 | the reader to cut the message at that line. If such a line |
| 79 | appears in the body of the message before the patch, everything |
| 80 | before it (including the scissors line itself) is ignored when |
| 81 | this option is used. |
| 82 | + |
| 83 | This is useful if you want to begin your message in a discussion thread |
| 84 | with comments and suggestions on the message you are responding to, and to |
| 85 | conclude it with a patch submission, separating the discussion and the |
| 86 | beginning of the proposed commit log message with a scissors line. |
Nicolas Sebrecht | 434a6db | 2009-09-11 02:29:58 +0200 | [diff] [blame] | 87 | + |
Vasco Almeida | dee2303 | 2016-05-11 20:42:54 +0000 | [diff] [blame] | 88 | This can be enabled by default with the configuration option mailinfo.scissors. |
Nicolas Sebrecht | 434a6db | 2009-09-11 02:29:58 +0200 | [diff] [blame] | 89 | |
| 90 | --no-scissors:: |
| 91 | Ignore scissors lines. Useful for overriding mailinfo.scissors settings. |
Junio C Hamano | 017678b | 2009-08-26 21:36:05 -0700 | [diff] [blame] | 92 | |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 93 | <msg>:: |
| 94 | The commit log message extracted from e-mail, usually |
| 95 | except the title line which comes from e-mail Subject. |
| 96 | |
| 97 | <patch>:: |
| 98 | The patch extracted from e-mail. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 99 | |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 100 | GIT |
| 101 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 102 | Part of the linkgit:git[1] suite |