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 | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 11 | 'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 12 | |
| 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
Junio C Hamano | 54bf1e2 | 2008-12-20 06:30:11 | [diff] [blame] | 16 | Reads a single e-mail message from the standard input, and |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 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 |
Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame^] | 19 | written out to the standard output to be used by 'git am' |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 20 | to create a commit. It is usually not necessary to use this |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 21 | command directly. See linkgit:git-am[1] instead. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 22 | |
| 23 | |
| 24 | OPTIONS |
| 25 | ------- |
| 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 |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 32 | munging, and is most useful when used to read back |
Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame^] | 33 | 'git format-patch -k' output. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 34 | |
Junio C Hamano | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 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 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 40 | -u:: |
Junio C Hamano | 27eacdb | 2007-01-10 05:37:47 | [diff] [blame] | 41 | The commit log message, author name and author email are |
| 42 | taken from the e-mail, and after minimally decoding MIME |
| 43 | transfer encoding, re-coded in UTF-8 by transliterating |
| 44 | them. This used to be optional but now it is the default. |
| 45 | + |
| 46 | Note that the patch is always used as-is without charset |
| 47 | conversion, even with this flag. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 48 | |
| 49 | --encoding=<encoding>:: |
| 50 | Similar to -u but if the local convention is different |
| 51 | from what is specified by i18n.commitencoding, this flag |
| 52 | can be used to override it. |
| 53 | |
Junio C Hamano | 46a38aa | 2008-07-14 03:13:27 | [diff] [blame] | 54 | -n:: |
| 55 | Disable all charset re-coding of the metadata. |
| 56 | |
Junio C Hamano | c28068f | 2009-09-08 00:55:23 | [diff] [blame] | 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. |
Junio C Hamano | cf5b773 | 2009-09-11 23:28:32 | [diff] [blame] | 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. |
Junio C Hamano | c28068f | 2009-09-08 00:55:23 | [diff] [blame] | 75 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 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. |
| 82 | |
| 83 | |
| 84 | Author |
| 85 | ------ |
| 86 | Written by Linus Torvalds <torvalds@osdl.org> and |
Junio C Hamano | 0868a30 | 2008-07-22 09:20:44 | [diff] [blame] | 87 | Junio C Hamano <gitster@pobox.com> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 88 | |
| 89 | |
| 90 | Documentation |
| 91 | -------------- |
| 92 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. |
| 93 | |
| 94 | GIT |
| 95 | --- |
Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 96 | Part of the linkgit:git[1] suite |