Junio C Hamano | 215a7ad | 2005-09-07 17:26:23 -0700 | [diff] [blame] | 1 | git-format-patch(1) |
| 2 | =================== |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Fredrik Kuivinen | 7bd7f28 | 2006-03-09 17:24:50 +0100 | [diff] [blame] | 6 | git-format-patch - Prepare patches for e-mail submission |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
Jonas Fonseca | 353ce81 | 2005-12-31 18:37:15 +0100 | [diff] [blame] | 11 | [verse] |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 12 | 'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout] |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 13 | [--no-thread | --thread[=<style>]] |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 14 | [(--attach|--inline)[=<boundary>] | --no-attach] |
| 15 | [-s | --signoff] |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 16 | [--signature=<signature> | --no-signature] |
Jeremiah Mahler | 7022650 | 2014-05-23 21:08:14 -0700 | [diff] [blame] | 17 | [--signature-file=<file>] |
Daniel Barkalow | a5a27c7 | 2008-02-18 22:56:13 -0500 | [diff] [blame] | 18 | [-n | --numbered | -N | --no-numbered] |
| 19 | [--start-number <n>] [--numbered-files] |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 20 | [--in-reply-to=<message id>] [--suffix=.<sfx>] |
Daniel Barkalow | a5a27c7 | 2008-02-18 22:56:13 -0500 | [diff] [blame] | 21 | [--ignore-if-in-upstream] |
Denton Liu | bf8e65b | 2019-10-15 02:06:40 -0700 | [diff] [blame] | 22 | [--cover-from-description=<mode>] |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 23 | [--rfc] [--subject-prefix=<subject prefix>] |
Josh Triplett | 68e83a5 | 2016-09-19 21:23:25 -0700 | [diff] [blame] | 24 | [(--reroll-count|-v) <n>] |
Steven Drake | ae6c098 | 2010-02-17 12:39:34 +1300 | [diff] [blame] | 25 | [--to=<email>] [--cc=<email>] |
Denton Liu | 83d9db7 | 2019-05-10 14:37:03 -0400 | [diff] [blame] | 26 | [--[no-]cover-letter] [--quiet] |
Emma Brooks | 19d097e | 2020-04-08 04:31:38 +0000 | [diff] [blame] | 27 | [--[no-]encode-email-headers] |
Denton Liu | 83d9db7 | 2019-05-10 14:37:03 -0400 | [diff] [blame] | 28 | [--no-notes | --notes[=<ref>]] |
Eric Sunshine | 126facf | 2018-07-22 05:57:05 -0400 | [diff] [blame] | 29 | [--interdiff=<previous>] |
Eric Sunshine | 8631bf1 | 2018-07-22 05:57:16 -0400 | [diff] [blame] | 30 | [--range-diff=<previous> [--creation-factor=<percent>]] |
Junio C Hamano | 3baf58b | 2020-11-06 13:56:24 -0800 | [diff] [blame] | 31 | [--filename-max-length=<n>] |
Kevin Willford | 738e88a | 2017-08-10 14:32:55 -0400 | [diff] [blame] | 32 | [--progress] |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 33 | [<common diff options>] |
Junio C Hamano | 8a1d076 | 2007-08-28 00:38:48 -0700 | [diff] [blame] | 34 | [ <since> | <revision range> ] |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 35 | |
| 36 | DESCRIPTION |
| 37 | ----------- |
Dennis Stosberg | 2052d14 | 2006-05-31 16:14:08 +0200 | [diff] [blame] | 38 | |
Jeff King | 8e0601f | 2021-05-01 10:13:24 -0400 | [diff] [blame] | 39 | Prepare each non-merge commit with its "patch" in |
Junio C Hamano | 28e29ee | 2021-03-24 10:35:40 -0700 | [diff] [blame] | 40 | one "message" per commit, formatted to resemble a UNIX mailbox. |
Dennis Stosberg | 2052d14 | 2006-05-31 16:14:08 +0200 | [diff] [blame] | 41 | The output of this command is convenient for e-mail submission or |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 42 | for use with 'git am'. |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 43 | |
Junio C Hamano | 28e29ee | 2021-03-24 10:35:40 -0700 | [diff] [blame] | 44 | A "message" generated by the command consists of three parts: |
| 45 | |
| 46 | * A brief metadata header that begins with `From <commit>` |
| 47 | with a fixed `Mon Sep 17 00:00:00 2001` datestamp to help programs |
| 48 | like "file(1)" to recognize that the file is an output from this |
| 49 | command, fields that record the author identity, the author date, |
| 50 | and the title of the change (taken from the first paragraph of the |
| 51 | commit log message). |
| 52 | |
| 53 | * The second and subsequent paragraphs of the commit log message. |
| 54 | |
| 55 | * The "patch", which is the "diff -p --stat" output (see |
| 56 | linkgit:git-diff[1]) between the commit and its parent. |
| 57 | |
| 58 | The log message and the patch is separated by a line with a |
| 59 | three-dash line. |
| 60 | |
Junio C Hamano | 8a1d076 | 2007-08-28 00:38:48 -0700 | [diff] [blame] | 61 | There are two ways to specify which commits to operate on. |
| 62 | |
| 63 | 1. A single commit, <since>, specifies that the commits leading |
| 64 | to the tip of the current branch that are not in the history |
| 65 | that leads to the <since> to be output. |
| 66 | |
| 67 | 2. Generic <revision range> expression (see "SPECIFYING |
Jonathan Nieder | 9d83e38 | 2010-10-11 11:03:32 -0500 | [diff] [blame] | 68 | REVISIONS" section in linkgit:gitrevisions[7]) means the |
Junio C Hamano | 2f6a382 | 2007-08-28 21:58:53 -0700 | [diff] [blame] | 69 | commits in the specified range. |
| 70 | |
Thomas Rast | 2d266f9 | 2009-03-26 18:29:25 +0100 | [diff] [blame] | 71 | The first rule takes precedence in the case of a single <commit>. To |
| 72 | apply the second rule, i.e., format everything since the beginning of |
Martin Ågren | 9e9f132 | 2018-04-17 21:15:26 +0200 | [diff] [blame] | 73 | history up until <commit>, use the `--root` option: `git format-patch |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 74 | --root <commit>`. If you want to format only <commit> itself, you |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 75 | can do this with `git format-patch -1 <commit>`. |
Junio C Hamano | 8a1d076 | 2007-08-28 00:38:48 -0700 | [diff] [blame] | 76 | |
Jon Loeliger | e6ff0f4 | 2007-06-05 15:06:53 -0500 | [diff] [blame] | 77 | By default, each output file is numbered sequentially from 1, and uses the |
Dennis Stosberg | 2052d14 | 2006-05-31 16:14:08 +0200 | [diff] [blame] | 78 | first line of the commit message (massaged for pathname safety) as |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 79 | the filename. With the `--numbered-files` option, the output file names |
Jon Loeliger | e6ff0f4 | 2007-06-05 15:06:53 -0500 | [diff] [blame] | 80 | will only be numbers, without the first line of the commit appended. |
| 81 | The names of the output files are printed to standard |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 82 | output, unless the `--stdout` option is specified. |
Andreas Ericsson | 66f04f3 | 2006-02-07 09:37:54 +0000 | [diff] [blame] | 83 | |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 84 | If `-o` is specified, output files are created in <dir>. Otherwise |
Alexander Kuleshov | bc6bf2d | 2016-01-13 06:20:11 -0700 | [diff] [blame] | 85 | they are created in the current working directory. The default path |
Tom Russello | ae9f631 | 2016-06-08 19:23:16 +0200 | [diff] [blame] | 86 | can be set with the `format.outputDirectory` configuration option. |
Alexander Kuleshov | bc6bf2d | 2016-01-13 06:20:11 -0700 | [diff] [blame] | 87 | The `-o` option takes precedence over `format.outputDirectory`. |
| 88 | To store patches in the current working directory even when |
Bert Wesarg | edefc31 | 2019-10-11 10:36:41 +0200 | [diff] [blame] | 89 | `format.outputDirectory` points elsewhere, use `-o .`. All directory |
| 90 | components will be created. |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 91 | |
Jeremy White | 52ffe99 | 2012-09-13 17:27:09 -0500 | [diff] [blame] | 92 | By default, the subject of a single patch is "[PATCH] " followed by |
| 93 | the concatenation of lines from the commit message up to the first blank |
| 94 | line (see the DISCUSSION section of linkgit:git-commit[1]). |
| 95 | |
| 96 | When multiple patches are output, the subject prefix will instead be |
| 97 | "[PATCH n/m] ". To force 1/1 to be added for a single patch, use `-n`. |
| 98 | To omit patch numbers from the subject, use `-N`. |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 99 | |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 100 | If given `--thread`, `git-format-patch` will generate `In-Reply-To` and |
| 101 | `References` headers to make the second and subsequent patch mails appear |
| 102 | as replies to the first mail; this also generates a `Message-Id` header to |
Josh Triplett | cc35de8 | 2006-07-14 17:49:04 -0700 | [diff] [blame] | 103 | reference. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 104 | |
| 105 | OPTIONS |
| 106 | ------- |
Sergei Organov | c1a95fa | 2007-11-15 16:19:29 +0300 | [diff] [blame] | 107 | :git-format-patch: 1 |
Brian Gernhardt | b810537 | 2007-03-05 22:27:44 -0500 | [diff] [blame] | 108 | include::diff-options.txt[] |
| 109 | |
Miklos Vajna | ed5f07a | 2007-07-04 01:38:29 +0200 | [diff] [blame] | 110 | -<n>:: |
Ramkumar Ramachandra | 2c642ed | 2010-08-28 01:58:16 +0530 | [diff] [blame] | 111 | Prepare patches from the topmost <n> commits. |
Miklos Vajna | ed5f07a | 2007-07-04 01:38:29 +0200 | [diff] [blame] | 112 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 113 | -o <dir>:: |
| 114 | --output-directory <dir>:: |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 115 | Use <dir> to store the resulting files, instead of the |
Junio C Hamano | efd0201 | 2006-06-06 08:46:23 -0700 | [diff] [blame] | 116 | current working directory. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 117 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 118 | -n:: |
| 119 | --numbered:: |
Brian Gernhardt | a567fdc | 2008-10-02 16:55:39 -0400 | [diff] [blame] | 120 | Name output in '[PATCH n/m]' format, even with a single patch. |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 121 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 122 | -N:: |
| 123 | --no-numbered:: |
Brian Gernhardt | 49604a4 | 2007-11-03 23:38:24 -0400 | [diff] [blame] | 124 | Name output in '[PATCH]' format. |
| 125 | |
Dennis Stosberg | 2052d14 | 2006-05-31 16:14:08 +0200 | [diff] [blame] | 126 | --start-number <n>:: |
| 127 | Start numbering the patches at <n> instead of 1. |
| 128 | |
Jon Loeliger | e6ff0f4 | 2007-06-05 15:06:53 -0500 | [diff] [blame] | 129 | --numbered-files:: |
| 130 | Output file names will be a simple number sequence |
| 131 | without the default first line of the commit appended. |
Jon Loeliger | e6ff0f4 | 2007-06-05 15:06:53 -0500 | [diff] [blame] | 132 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 133 | -k:: |
| 134 | --keep-subject:: |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 135 | Do not strip/add '[PATCH]' from the first line of the |
| 136 | commit log message. |
| 137 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 138 | -s:: |
| 139 | --signoff:: |
Bradley M. Kuhn | 3abd4a6 | 2020-10-19 18:03:55 -0700 | [diff] [blame] | 140 | Add a `Signed-off-by` trailer to the commit message, using |
Nikolai Weibull | 6f85537 | 2005-12-09 00:28:05 +0100 | [diff] [blame] | 141 | the committer identity of yourself. |
David A. Wheeler | b2c150d | 2016-01-05 14:20:26 -0500 | [diff] [blame] | 142 | See the signoff option in linkgit:git-commit[1] for more information. |
Nikolai Weibull | 6f85537 | 2005-12-09 00:28:05 +0100 | [diff] [blame] | 143 | |
Junio C Hamano | 54ba601 | 2005-10-06 14:25:52 -0700 | [diff] [blame] | 144 | --stdout:: |
Dennis Stosberg | 2052d14 | 2006-05-31 16:14:08 +0200 | [diff] [blame] | 145 | Print all commits to the standard output in mbox format, |
| 146 | instead of creating a file for each one. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 147 | |
Johannes Schindelin | c112f68 | 2007-03-04 00:12:06 +0100 | [diff] [blame] | 148 | --attach[=<boundary>]:: |
| 149 | Create multipart/mixed attachment, the first part of |
| 150 | which is the commit message and the patch itself in the |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 151 | second part, with `Content-Disposition: attachment`. |
Johannes Schindelin | c112f68 | 2007-03-04 00:12:06 +0100 | [diff] [blame] | 152 | |
Jeremy White | 0db5260 | 2009-02-12 09:51:55 -0600 | [diff] [blame] | 153 | --no-attach:: |
| 154 | Disable the creation of an attachment, overriding the |
| 155 | configuration setting. |
| 156 | |
Johannes Schindelin | c112f68 | 2007-03-04 00:12:06 +0100 | [diff] [blame] | 157 | --inline[=<boundary>]:: |
| 158 | Create multipart/mixed attachment, the first part of |
| 159 | which is the commit message and the patch itself in the |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 160 | second part, with `Content-Disposition: inline`. |
Mike McCormack | a15a44e | 2006-03-10 13:47:24 +0900 | [diff] [blame] | 161 | |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 162 | --thread[=<style>]:: |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 163 | --no-thread:: |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 164 | Controls addition of `In-Reply-To` and `References` headers to |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 165 | make the second and subsequent mails appear as replies to the |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 166 | first. Also controls generation of the `Message-Id` header to |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 167 | reference. |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 168 | + |
| 169 | The optional <style> argument can be either `shallow` or `deep`. |
Stephen Boyd | fd1ff30 | 2009-04-23 02:37:57 -0700 | [diff] [blame] | 170 | 'shallow' threading makes every mail a reply to the head of the |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 171 | series, where the head is chosen from the cover letter, the |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 172 | `--in-reply-to`, and the first patch mail, in this order. 'deep' |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 173 | threading makes every mail a reply to the previous one. |
| 174 | + |
Tom Russello | ae9f631 | 2016-06-08 19:23:16 +0200 | [diff] [blame] | 175 | The default is `--no-thread`, unless the `format.thread` configuration |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 176 | is set. If `--thread` is specified without a style, it defaults to the |
Tom Russello | ae9f631 | 2016-06-08 19:23:16 +0200 | [diff] [blame] | 177 | style specified by `format.thread` if any, or else `shallow`. |
Yann Dirson | f693b7e | 2009-07-22 23:39:31 +0200 | [diff] [blame] | 178 | + |
| 179 | Beware that the default for 'git send-email' is to thread emails |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 180 | itself. If you want `git format-patch` to take care of threading, you |
| 181 | will want to ensure that threading is disabled for `git send-email`. |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 182 | |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 183 | --in-reply-to=<message id>:: |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 184 | Make the first mail (or all the mails with `--no-thread`) appear as a |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 185 | reply to the given <message id>, which avoids breaking threads to |
Josh Triplett | da56645 | 2006-07-14 17:49:08 -0700 | [diff] [blame] | 186 | provide a new patch series. |
| 187 | |
David Kågedal | cc75ad6 | 2007-01-18 12:27:35 +0100 | [diff] [blame] | 188 | --ignore-if-in-upstream:: |
| 189 | Do not include a patch that matches a commit in |
| 190 | <until>..<since>. This will examine all patches reachable |
| 191 | from <since> but not from <until> and compare them with the |
| 192 | patches being generated, and any patch that matches is |
| 193 | ignored. |
| 194 | |
Denton Liu | bf8e65b | 2019-10-15 02:06:40 -0700 | [diff] [blame] | 195 | --cover-from-description=<mode>:: |
| 196 | Controls which parts of the cover letter will be automatically |
| 197 | populated using the branch's description. |
| 198 | + |
| 199 | If `<mode>` is `message` or `default`, the cover letter subject will be |
| 200 | populated with placeholder text. The body of the cover letter will be |
| 201 | populated with the branch's description. This is the default mode when |
| 202 | no configuration nor command line option is specified. |
| 203 | + |
| 204 | If `<mode>` is `subject`, the first paragraph of the branch description will |
| 205 | populate the cover letter subject. The remainder of the description will |
| 206 | populate the body of the cover letter. |
| 207 | + |
| 208 | If `<mode>` is `auto`, if the first paragraph of the branch description |
| 209 | is greater than 100 bytes, then the mode will be `message`, otherwise |
| 210 | `subject` will be used. |
| 211 | + |
| 212 | If `<mode>` is `none`, both the cover letter subject and body will be |
| 213 | populated with placeholder text. |
| 214 | |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 215 | --subject-prefix=<subject prefix>:: |
Robin H. Johnson | 2d9e4a4 | 2007-04-11 16:58:07 -0700 | [diff] [blame] | 216 | Instead of the standard '[PATCH]' prefix in the subject |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 217 | line, instead use '[<subject prefix>]'. This |
Robin H. Johnson | 2d9e4a4 | 2007-04-11 16:58:07 -0700 | [diff] [blame] | 218 | allows for useful naming of a patch series, and can be |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 219 | combined with the `--numbered` option. |
Robin H. Johnson | 2d9e4a4 | 2007-04-11 16:58:07 -0700 | [diff] [blame] | 220 | |
Junio C Hamano | 3baf58b | 2020-11-06 13:56:24 -0800 | [diff] [blame] | 221 | --filename-max-length=<n>:: |
| 222 | Instead of the standard 64 bytes, chomp the generated output |
| 223 | filenames at around '<n>' bytes (too short a value will be |
| 224 | silently raised to a reasonable length). Defaults to the |
| 225 | value of the `format.filenameMaxLength` configuration |
| 226 | variable, or 64 if unconfigured. |
| 227 | |
Josh Triplett | 68e83a5 | 2016-09-19 21:23:25 -0700 | [diff] [blame] | 228 | --rfc:: |
| 229 | Alias for `--subject-prefix="RFC PATCH"`. RFC means "Request For |
| 230 | Comments"; use this when sending an experimental patch for |
| 231 | discussion rather than application. |
| 232 | |
Junio C Hamano | 7952ea6 | 2013-01-02 14:19:05 -0800 | [diff] [blame] | 233 | -v <n>:: |
Junio C Hamano | 4aad08e | 2013-01-02 14:16:07 -0800 | [diff] [blame] | 234 | --reroll-count=<n>:: |
| 235 | Mark the series as the <n>-th iteration of the topic. The |
Frans Klaver | d614f07 | 2015-06-10 23:01:14 +0200 | [diff] [blame] | 236 | output filenames have `v<n>` prepended to them, and the |
Junio C Hamano | 4aad08e | 2013-01-02 14:16:07 -0800 | [diff] [blame] | 237 | subject prefix ("PATCH" by default, but configurable via the |
| 238 | `--subject-prefix` option) has ` v<n>` appended to it. E.g. |
| 239 | `--reroll-count=4` may produce `v4-0001-add-makefile.patch` |
| 240 | file that has "Subject: [PATCH v4 1/20] Add makefile" in it. |
ZheNing Hu | db91988 | 2021-03-23 11:12:25 +0000 | [diff] [blame] | 241 | `<n>` does not have to be an integer (e.g. "--reroll-count=4.4", |
| 242 | or "--reroll-count=4rev2" are allowed), but the downside of |
| 243 | using such a reroll-count is that the range-diff/interdiff |
| 244 | with the previous version does not state exactly which |
| 245 | version the new interation is compared against. |
Junio C Hamano | 4aad08e | 2013-01-02 14:16:07 -0800 | [diff] [blame] | 246 | |
Steven Drake | ae6c098 | 2010-02-17 12:39:34 +1300 | [diff] [blame] | 247 | --to=<email>:: |
| 248 | Add a `To:` header to the email headers. This is in addition |
| 249 | to any configured headers, and may be used multiple times. |
Thomas Rast | b2cd17b | 2011-08-29 22:10:49 +0200 | [diff] [blame] | 250 | The negated form `--no-to` discards all `To:` headers added so |
| 251 | far (from config or command line). |
Steven Drake | ae6c098 | 2010-02-17 12:39:34 +1300 | [diff] [blame] | 252 | |
Daniel Barkalow | 736cc67 | 2008-02-19 02:40:35 -0500 | [diff] [blame] | 253 | --cc=<email>:: |
Björn Gustavsson | dce5ef1 | 2009-11-07 10:53:07 +0100 | [diff] [blame] | 254 | Add a `Cc:` header to the email headers. This is in addition |
Daniel Barkalow | 736cc67 | 2008-02-19 02:40:35 -0500 | [diff] [blame] | 255 | to any configured headers, and may be used multiple times. |
Thomas Rast | b2cd17b | 2011-08-29 22:10:49 +0200 | [diff] [blame] | 256 | The negated form `--no-cc` discards all `Cc:` headers added so |
| 257 | far (from config or command line). |
Daniel Barkalow | 736cc67 | 2008-02-19 02:40:35 -0500 | [diff] [blame] | 258 | |
Jeff King | a908047 | 2013-07-03 03:08:22 -0400 | [diff] [blame] | 259 | --from:: |
| 260 | --from=<ident>:: |
| 261 | Use `ident` in the `From:` header of each commit email. If the |
| 262 | author ident of the commit is not textually identical to the |
| 263 | provided `ident`, place a `From:` header in the body of the |
| 264 | message with the original author. If no `ident` is given, use |
| 265 | the committer ident. |
| 266 | + |
| 267 | Note that this option is only useful if you are actually sending the |
| 268 | emails and want to identify yourself as the sender, but retain the |
| 269 | original author (and `git am` will correctly pick up the in-body |
| 270 | header). Note also that `git send-email` already handles this |
| 271 | transformation for you, and this option should not be used if you are |
| 272 | feeding the result to `git send-email`. |
| 273 | |
Michael Hendricks | d7d9c2d | 2009-03-26 10:51:05 -0600 | [diff] [blame] | 274 | --add-header=<header>:: |
| 275 | Add an arbitrary header to the email headers. This is in addition |
| 276 | to any configured headers, and may be used multiple times. |
Thomas Rast | b2cd17b | 2011-08-29 22:10:49 +0200 | [diff] [blame] | 277 | For example, `--add-header="Organization: git-foo"`. |
| 278 | The negated form `--no-add-header` discards *all* (`To:`, |
| 279 | `Cc:`, and custom) headers added so far from config or command |
| 280 | line. |
Michael Hendricks | d7d9c2d | 2009-03-26 10:51:05 -0600 | [diff] [blame] | 281 | |
Felipe Contreras | 2a4c260 | 2013-04-07 12:46:23 -0500 | [diff] [blame] | 282 | --[no-]cover-letter:: |
Matt McCutchen | f491239 | 2008-08-14 13:37:41 -0400 | [diff] [blame] | 283 | In addition to the patches, generate a cover letter file |
Philip Oakley | 561d2b7 | 2015-09-14 15:10:53 +0100 | [diff] [blame] | 284 | containing the branch description, shortlog and the overall diffstat. You can |
Matt McCutchen | f491239 | 2008-08-14 13:37:41 -0400 | [diff] [blame] | 285 | fill in a description in the file before sending it out. |
Daniel Barkalow | a5a27c7 | 2008-02-18 22:56:13 -0500 | [diff] [blame] | 286 | |
Emma Brooks | 19d097e | 2020-04-08 04:31:38 +0000 | [diff] [blame] | 287 | --encode-email-headers:: |
| 288 | --no-encode-email-headers:: |
| 289 | Encode email headers that have non-ASCII characters with |
| 290 | "Q-encoding" (described in RFC 2047), instead of outputting the |
| 291 | headers verbatim. Defaults to the value of the |
| 292 | `format.encodeEmailHeaders` configuration variable. |
| 293 | |
Eric Sunshine | 126facf | 2018-07-22 05:57:05 -0400 | [diff] [blame] | 294 | --interdiff=<previous>:: |
Eric Sunshine | ee6cbf7 | 2018-07-22 05:57:09 -0400 | [diff] [blame] | 295 | As a reviewer aid, insert an interdiff into the cover letter, |
| 296 | or as commentary of the lone patch of a 1-patch series, showing |
Eric Sunshine | 126facf | 2018-07-22 05:57:05 -0400 | [diff] [blame] | 297 | the differences between the previous version of the patch series and |
| 298 | the series currently being formatted. `previous` is a single revision |
| 299 | naming the tip of the previous series which shares a common base with |
| 300 | the series being formatted (for example `git format-patch |
| 301 | --cover-letter --interdiff=feature/v1 -3 feature/v2`). |
| 302 | |
Eric Sunshine | 31e2617 | 2018-07-22 05:57:13 -0400 | [diff] [blame] | 303 | --range-diff=<previous>:: |
| 304 | As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1]) |
Eric Sunshine | 40ce416 | 2018-07-22 05:57:17 -0400 | [diff] [blame] | 305 | into the cover letter, or as commentary of the lone patch of a |
| 306 | 1-patch series, showing the differences between the previous |
Eric Sunshine | 31e2617 | 2018-07-22 05:57:13 -0400 | [diff] [blame] | 307 | version of the patch series and the series currently being formatted. |
Eric Sunshine | 2e6fd71 | 2018-07-22 05:57:14 -0400 | [diff] [blame] | 308 | `previous` can be a single revision naming the tip of the previous |
| 309 | series if it shares a common base with the series being formatted (for |
Eric Sunshine | 31e2617 | 2018-07-22 05:57:13 -0400 | [diff] [blame] | 310 | example `git format-patch --cover-letter --range-diff=feature/v1 -3 |
Eric Sunshine | 2e6fd71 | 2018-07-22 05:57:14 -0400 | [diff] [blame] | 311 | feature/v2`), or a revision range if the two versions of the series are |
| 312 | disjoint (for example `git format-patch --cover-letter |
| 313 | --range-diff=feature/v1~3..feature/v1 -3 feature/v2`). |
Junio C Hamano | d8981c3 | 2018-11-30 13:27:11 +0900 | [diff] [blame] | 314 | + |
| 315 | Note that diff options passed to the command affect how the primary |
| 316 | product of `format-patch` is generated, and they are not passed to |
| 317 | the underlying `range-diff` machinery used to generate the cover-letter |
| 318 | material (this may change in the future). |
Eric Sunshine | 31e2617 | 2018-07-22 05:57:13 -0400 | [diff] [blame] | 319 | |
Eric Sunshine | 8631bf1 | 2018-07-22 05:57:16 -0400 | [diff] [blame] | 320 | --creation-factor=<percent>:: |
| 321 | Used with `--range-diff`, tweak the heuristic which matches up commits |
| 322 | between the previous and current series of patches by adjusting the |
| 323 | creation/deletion cost fudge factor. See linkgit:git-range-diff[1]) |
| 324 | for details. |
| 325 | |
Junio C Hamano | e422c0c | 2012-10-19 13:01:05 -0700 | [diff] [blame] | 326 | --notes[=<ref>]:: |
Denton Liu | 83d9db7 | 2019-05-10 14:37:03 -0400 | [diff] [blame] | 327 | --no-notes:: |
Junio C Hamano | e422c0c | 2012-10-19 13:01:05 -0700 | [diff] [blame] | 328 | Append the notes (see linkgit:git-notes[1]) for the commit |
| 329 | after the three-dash line. |
| 330 | + |
| 331 | The expected use case of this is to write supporting explanation for |
Philip Oakley | 6454d9f | 2012-10-21 22:34:10 +0100 | [diff] [blame] | 332 | the commit that does not belong to the commit log message proper, |
| 333 | and include it with the patch submission. While one can simply write |
| 334 | these explanations after `format-patch` has run but before sending, |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 335 | keeping them as Git notes allows them to be maintained between versions |
Philip Oakley | 6454d9f | 2012-10-21 22:34:10 +0100 | [diff] [blame] | 336 | of the patch series (but see the discussion of the `notes.rewrite` |
| 337 | configuration options in linkgit:git-notes[1] to use this workflow). |
Denton Liu | 13cdf78 | 2019-05-16 19:14:14 -0400 | [diff] [blame] | 338 | + |
| 339 | The default is `--no-notes`, unless the `format.notes` configuration is |
| 340 | set. |
Junio C Hamano | e422c0c | 2012-10-19 13:01:05 -0700 | [diff] [blame] | 341 | |
Ævar Arnfjörð Bjarmason | 2c7ee98 | 2017-03-20 13:20:29 +0000 | [diff] [blame] | 342 | --[no-]signature=<signature>:: |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 343 | Add a signature to each message produced. Per RFC 3676 the signature |
| 344 | is separated from the body by a line with '-- ' on it. If the |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 345 | signature option is omitted the signature defaults to the Git version |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 346 | number. |
| 347 | |
Jeremiah Mahler | 7022650 | 2014-05-23 21:08:14 -0700 | [diff] [blame] | 348 | --signature-file=<file>:: |
| 349 | Works just like --signature except the signature is read from a file. |
| 350 | |
Junio C Hamano | 03eeaea | 2007-01-17 11:12:03 -0800 | [diff] [blame] | 351 | --suffix=.<sfx>:: |
Junio C Hamano | 917a8f8 | 2007-01-17 15:03:39 -0800 | [diff] [blame] | 352 | Instead of using `.patch` as the suffix for generated |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 353 | filenames, use specified suffix. A common alternative is |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 354 | `--suffix=.txt`. Leaving this empty will remove the `.patch` |
| 355 | suffix. |
Junio C Hamano | 03eeaea | 2007-01-17 11:12:03 -0800 | [diff] [blame] | 356 | + |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 357 | Note that the leading character does not have to be a dot; for example, |
| 358 | you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`. |
Junio C Hamano | 03eeaea | 2007-01-17 11:12:03 -0800 | [diff] [blame] | 359 | |
Stefan Beller | b7df098 | 2013-08-03 13:51:20 +0200 | [diff] [blame] | 360 | -q:: |
Carlos Martín Nieto | b781cfa | 2011-04-12 17:51:37 +0200 | [diff] [blame] | 361 | --quiet:: |
| 362 | Do not print the names of the generated files to standard output. |
| 363 | |
Caio Marcelo de Oliveira Filho | 37c22a4 | 2008-05-09 19:55:43 -0300 | [diff] [blame] | 364 | --no-binary:: |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 365 | Do not output contents of changes in binary files, instead |
| 366 | display a notice that those files changed. Patches generated |
| 367 | using this option cannot be applied properly, but they are |
| 368 | still useful for code review. |
Caio Marcelo de Oliveira Filho | 37c22a4 | 2008-05-09 19:55:43 -0300 | [diff] [blame] | 369 | |
brian m. carlson | 3a30aa1 | 2015-12-15 01:52:04 +0000 | [diff] [blame] | 370 | --zero-commit:: |
| 371 | Output an all-zero hash in each patch's From header instead |
| 372 | of the hash of the commit. |
| 373 | |
Denton Liu | 945dc55 | 2019-12-04 13:25:06 -0800 | [diff] [blame] | 374 | --[no-]base[=<commit>]:: |
Xiaolong Ye | fa2ab86 | 2016-04-26 15:51:22 +0800 | [diff] [blame] | 375 | Record the base tree information to identify the state the |
| 376 | patch series applies to. See the BASE TREE INFORMATION section |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 377 | below for details. If <commit> is "auto", a base commit is |
Denton Liu | 945dc55 | 2019-12-04 13:25:06 -0800 | [diff] [blame] | 378 | automatically chosen. The `--no-base` option overrides a |
| 379 | `format.useAutoBase` configuration. |
Xiaolong Ye | fa2ab86 | 2016-04-26 15:51:22 +0800 | [diff] [blame] | 380 | |
Thomas Rast | 2d266f9 | 2009-03-26 18:29:25 +0100 | [diff] [blame] | 381 | --root:: |
| 382 | Treat the revision argument as a <revision range>, even if it |
| 383 | is just a single commit (that would normally be treated as a |
| 384 | <since>). Note that root commits included in the specified |
| 385 | range are always formatted as creation patches, independently |
| 386 | of this flag. |
| 387 | |
Kevin Willford | 738e88a | 2017-08-10 14:32:55 -0400 | [diff] [blame] | 388 | --progress:: |
| 389 | Show progress reports on stderr as patches are generated. |
| 390 | |
Mike McCormack | 96ce6d2 | 2006-03-10 13:47:59 +0900 | [diff] [blame] | 391 | CONFIGURATION |
| 392 | ------------- |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 393 | You can specify extra mail header lines to be added to each message, |
| 394 | defaults for the subject prefix and file suffix, number patches when |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 395 | outputting more than one patch, add "To:" or "Cc:" headers, configure |
| 396 | attachments, change the patch output directory, and sign off patches |
| 397 | with configuration variables. |
Mike McCormack | 96ce6d2 | 2006-03-10 13:47:59 +0900 | [diff] [blame] | 398 | |
Junio C Hamano | 917a8f8 | 2007-01-17 15:03:39 -0800 | [diff] [blame] | 399 | ------------ |
Mike McCormack | 96ce6d2 | 2006-03-10 13:47:59 +0900 | [diff] [blame] | 400 | [format] |
Jonathan Nieder | 7f9d77f | 2008-07-03 00:03:54 -0500 | [diff] [blame] | 401 | headers = "Organization: git-foo\n" |
Nguyễn Thái Ngọc Duy | da0005b | 2015-03-11 16:32:45 -0400 | [diff] [blame] | 402 | subjectPrefix = CHANGE |
Jonathan Nieder | 7f9d77f | 2008-07-03 00:03:54 -0500 | [diff] [blame] | 403 | suffix = .txt |
| 404 | numbered = auto |
Steven Drake | ae6c098 | 2010-02-17 12:39:34 +1300 | [diff] [blame] | 405 | to = <email> |
Miklos Vajna | fe8928e | 2008-04-26 23:19:06 +0200 | [diff] [blame] | 406 | cc = <email> |
Jeremy White | 0db5260 | 2009-02-12 09:51:55 -0600 | [diff] [blame] | 407 | attach [ = mime-boundary-string ] |
Nguyễn Thái Ngọc Duy | da0005b | 2015-03-11 16:32:45 -0400 | [diff] [blame] | 408 | signOff = true |
Denton Liu | c1a6f21 | 2019-08-27 00:05:17 -0400 | [diff] [blame] | 409 | outputDirectory = <directory> |
| 410 | coverLetter = auto |
Denton Liu | bf8e65b | 2019-10-15 02:06:40 -0700 | [diff] [blame] | 411 | coverFromDescription = auto |
Junio C Hamano | 917a8f8 | 2007-01-17 15:03:39 -0800 | [diff] [blame] | 412 | ------------ |
Junio C Hamano | 03eeaea | 2007-01-17 11:12:03 -0800 | [diff] [blame] | 413 | |
Mike McCormack | 96ce6d2 | 2006-03-10 13:47:59 +0900 | [diff] [blame] | 414 | |
Jonathan Nieder | e0d4827 | 2011-04-14 21:22:02 -0500 | [diff] [blame] | 415 | DISCUSSION |
| 416 | ---------- |
| 417 | |
| 418 | The patch produced by 'git format-patch' is in UNIX mailbox format, |
| 419 | with a fixed "magic" time stamp to indicate that the file is output |
| 420 | from format-patch rather than a real mailbox, like so: |
| 421 | |
| 422 | ------------ |
| 423 | From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 |
| 424 | From: Tony Luck <tony.luck@intel.com> |
| 425 | Date: Tue, 13 Jul 2010 11:42:54 -0700 |
| 426 | Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?= |
| 427 | =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig=20diet?= |
| 428 | MIME-Version: 1.0 |
| 429 | Content-Type: text/plain; charset=UTF-8 |
| 430 | Content-Transfer-Encoding: 8bit |
| 431 | |
| 432 | arch/arm config files were slimmed down using a python script |
| 433 | (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment) |
| 434 | |
| 435 | Do the same for ia64 so we can have sleek & trim looking |
| 436 | ... |
| 437 | ------------ |
| 438 | |
| 439 | Typically it will be placed in a MUA's drafts folder, edited to add |
| 440 | timely commentary that should not go in the changelog after the three |
| 441 | dashes, and then sent as a message whose body, in our example, starts |
| 442 | with "arch/arm config files were...". On the receiving end, readers |
| 443 | can save interesting patches in a UNIX mailbox and apply them with |
| 444 | linkgit:git-am[1]. |
| 445 | |
| 446 | When a patch is part of an ongoing discussion, the patch generated by |
| 447 | 'git format-patch' can be tweaked to take advantage of the 'git am |
| 448 | --scissors' feature. After your response to the discussion comes a |
| 449 | line that consists solely of "`-- >8 --`" (scissors and perforation), |
| 450 | followed by the patch with unnecessary header fields removed: |
| 451 | |
| 452 | ------------ |
| 453 | ... |
| 454 | > So we should do such-and-such. |
| 455 | |
| 456 | Makes sense to me. How about this patch? |
| 457 | |
| 458 | -- >8 -- |
| 459 | Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet |
| 460 | |
| 461 | arch/arm config files were slimmed down using a python script |
| 462 | ... |
| 463 | ------------ |
| 464 | |
| 465 | When sending a patch this way, most often you are sending your own |
| 466 | patch, so in addition to the "`From $SHA1 $magic_timestamp`" marker you |
| 467 | should omit `From:` and `Date:` lines from the patch file. The patch |
| 468 | title is likely to be different from the subject of the discussion the |
| 469 | patch is in response to, so it is likely that you would want to keep |
| 470 | the Subject: line, like the example above. |
| 471 | |
Jonathan Nieder | 5775616 | 2011-04-14 21:24:01 -0500 | [diff] [blame] | 472 | Checking for patch corruption |
| 473 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 474 | Many mailers if not set up properly will corrupt whitespace. Here are |
| 475 | two common types of corruption: |
| 476 | |
| 477 | * Empty context lines that do not have _any_ whitespace. |
| 478 | |
| 479 | * Non-empty context lines that have one extra whitespace at the |
| 480 | beginning. |
| 481 | |
| 482 | One way to test if your MUA is set up correctly is: |
| 483 | |
| 484 | * Send the patch to yourself, exactly the way you would, except |
| 485 | with To: and Cc: lines that do not contain the list and |
| 486 | maintainer address. |
| 487 | |
| 488 | * Save that patch to a file in UNIX mailbox format. Call it a.patch, |
| 489 | say. |
| 490 | |
| 491 | * Apply it: |
| 492 | |
| 493 | $ git fetch <project> master:test-apply |
Nguyễn Thái Ngọc Duy | 328c6cb | 2019-03-29 17:39:19 +0700 | [diff] [blame] | 494 | $ git switch test-apply |
Nguyễn Thái Ngọc Duy | 80f537f | 2019-04-25 16:45:58 +0700 | [diff] [blame] | 495 | $ git restore --source=HEAD --staged --worktree :/ |
Jonathan Nieder | 5775616 | 2011-04-14 21:24:01 -0500 | [diff] [blame] | 496 | $ git am a.patch |
| 497 | |
| 498 | If it does not apply correctly, there can be various reasons. |
| 499 | |
| 500 | * The patch itself does not apply cleanly. That is _bad_ but |
| 501 | does not have much to do with your MUA. You might want to rebase |
| 502 | the patch with linkgit:git-rebase[1] before regenerating it in |
| 503 | this case. |
| 504 | |
| 505 | * The MUA corrupted your patch; "am" would complain that |
| 506 | the patch does not apply. Look in the .git/rebase-apply/ subdirectory and |
| 507 | see what 'patch' file contains and check for the common |
| 508 | corruption patterns mentioned above. |
| 509 | |
| 510 | * While at it, check the 'info' and 'final-commit' files as well. |
| 511 | If what is in 'final-commit' is not exactly what you would want to |
| 512 | see in the commit log message, it is very likely that the |
| 513 | receiver would end up hand editing the log message when applying |
| 514 | your patch. Things like "Hi, this is my first patch.\n" in the |
| 515 | patch e-mail should come after the three-dash line that signals |
| 516 | the end of the commit message. |
| 517 | |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 518 | MUA-SPECIFIC HINTS |
| 519 | ------------------ |
| 520 | Here are some hints on how to successfully submit patches inline using |
| 521 | various mailers. |
| 522 | |
Jonathan Nieder | 36c10e6 | 2011-04-14 21:33:57 -0500 | [diff] [blame] | 523 | GMail |
| 524 | ~~~~~ |
| 525 | GMail does not have any way to turn off line wrapping in the web |
| 526 | interface, so it will mangle any emails that you send. You can however |
| 527 | use "git send-email" and send your patches through the GMail SMTP server, or |
| 528 | use any IMAP email client to connect to the google IMAP server and forward |
| 529 | the emails through that. |
| 530 | |
| 531 | For hints on using 'git send-email' to send your patches through the |
| 532 | GMail SMTP server, see the EXAMPLE section of linkgit:git-send-email[1]. |
| 533 | |
| 534 | For hints on submission using the IMAP interface, see the EXAMPLE |
| 535 | section of linkgit:git-imap-send[1]. |
| 536 | |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 537 | Thunderbird |
| 538 | ~~~~~~~~~~~ |
| 539 | By default, Thunderbird will both wrap emails as well as flag |
| 540 | them as being 'format=flowed', both of which will make the |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 541 | resulting email unusable by Git. |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 542 | |
Johannes Sixt | b895960 | 2011-04-18 08:31:16 +0200 | [diff] [blame] | 543 | There are three different approaches: use an add-on to turn off line wraps, |
| 544 | configure Thunderbird to not mangle patches, or use |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 545 | an external editor to keep Thunderbird from mangling the patches. |
| 546 | |
Johannes Sixt | b895960 | 2011-04-18 08:31:16 +0200 | [diff] [blame] | 547 | Approach #1 (add-on) |
| 548 | ^^^^^^^^^^^^^^^^^^^^ |
| 549 | |
| 550 | Install the Toggle Word Wrap add-on that is available from |
| 551 | https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/ |
| 552 | It adds a menu entry "Enable Word Wrap" in the composer's "Options" menu |
| 553 | that you can tick off. Now you can compose the message as you otherwise do |
| 554 | (cut + paste, 'git format-patch' | 'git imap-send', etc), but you have to |
| 555 | insert line breaks manually in any text that you type. |
| 556 | |
| 557 | Approach #2 (configuration) |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 558 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 559 | Three steps: |
| 560 | |
| 561 | 1. Configure your mail server composition as plain text: |
| 562 | Edit...Account Settings...Composition & Addressing, |
| 563 | uncheck "Compose Messages in HTML". |
| 564 | |
| 565 | 2. Configure your general composition window to not wrap. |
| 566 | + |
| 567 | In Thunderbird 2: |
| 568 | Edit..Preferences..Composition, wrap plain text messages at 0 |
| 569 | + |
| 570 | In Thunderbird 3: |
| 571 | Edit..Preferences..Advanced..Config Editor. Search for |
| 572 | "mail.wrap_long_lines". |
Ramsay Jones | f737684 | 2013-10-06 21:51:31 +0100 | [diff] [blame] | 573 | Toggle it to make sure it is set to `false`. Also, search for |
| 574 | "mailnews.wraplength" and set the value to 0. |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 575 | |
| 576 | 3. Disable the use of format=flowed: |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 577 | Edit..Preferences..Advanced..Config Editor. Search for |
| 578 | "mailnews.send_plaintext_flowed". |
| 579 | Toggle it to make sure it is set to `false`. |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 580 | |
| 581 | After that is done, you should be able to compose email as you |
| 582 | otherwise would (cut + paste, 'git format-patch' | 'git imap-send', etc), |
| 583 | and the patches will not be mangled. |
| 584 | |
Johannes Sixt | b895960 | 2011-04-18 08:31:16 +0200 | [diff] [blame] | 585 | Approach #3 (external editor) |
Jonathan Nieder | dc53151 | 2011-04-14 21:28:06 -0500 | [diff] [blame] | 586 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 587 | |
| 588 | The following Thunderbird extensions are needed: |
| 589 | AboutConfig from http://aboutconfig.mozdev.org/ and |
| 590 | External Editor from http://globs.org/articles.php?lng=en&pg=8 |
| 591 | |
| 592 | 1. Prepare the patch as a text file using your method of choice. |
| 593 | |
| 594 | 2. Before opening a compose window, use Edit->Account Settings to |
| 595 | uncheck the "Compose messages in HTML format" setting in the |
| 596 | "Composition & Addressing" panel of the account to be used to |
| 597 | send the patch. |
| 598 | |
| 599 | 3. In the main Thunderbird window, 'before' you open the compose |
| 600 | window for the patch, use Tools->about:config to set the |
| 601 | following to the indicated values: |
| 602 | + |
| 603 | ---------- |
| 604 | mailnews.send_plaintext_flowed => false |
| 605 | mailnews.wraplength => 0 |
| 606 | ---------- |
| 607 | |
| 608 | 4. Open a compose window and click the external editor icon. |
| 609 | |
| 610 | 5. In the external editor window, read in the patch file and exit |
| 611 | the editor normally. |
| 612 | |
| 613 | Side note: it may be possible to do step 2 with |
| 614 | about:config and the following settings but no one's tried yet. |
| 615 | |
| 616 | ---------- |
| 617 | mail.html_compose => false |
| 618 | mail.identity.default.compose_html => false |
| 619 | mail.identity.id?.compose_html => false |
| 620 | ---------- |
| 621 | |
| 622 | There is a script in contrib/thunderbird-patch-inline which can help |
| 623 | you include patches with Thunderbird in an easy way. To use it, do the |
| 624 | steps above and then use the script as the external editor. |
| 625 | |
Jonathan Nieder | 967ab8e | 2011-04-14 21:32:55 -0500 | [diff] [blame] | 626 | KMail |
| 627 | ~~~~~ |
| 628 | This should help you to submit patches inline using KMail. |
| 629 | |
| 630 | 1. Prepare the patch as a text file. |
| 631 | |
| 632 | 2. Click on New Mail. |
| 633 | |
| 634 | 3. Go under "Options" in the Composer window and be sure that |
| 635 | "Word wrap" is not set. |
| 636 | |
| 637 | 4. Use Message -> Insert file... and insert the patch. |
| 638 | |
| 639 | 5. Back in the compose window: add whatever other text you wish to the |
| 640 | message, complete the addressing and subject fields, and press send. |
| 641 | |
Xiaolong Ye | fa2ab86 | 2016-04-26 15:51:22 +0800 | [diff] [blame] | 642 | BASE TREE INFORMATION |
| 643 | --------------------- |
| 644 | |
| 645 | The base tree information block is used for maintainers or third party |
| 646 | testers to know the exact state the patch series applies to. It consists |
| 647 | of the 'base commit', which is a well-known commit that is part of the |
| 648 | stable part of the project history everybody else works off of, and zero |
| 649 | or more 'prerequisite patches', which are well-known patches in flight |
| 650 | that is not yet part of the 'base commit' that need to be applied on top |
| 651 | of 'base commit' in topological order before the patches can be applied. |
| 652 | |
| 653 | The 'base commit' is shown as "base-commit: " followed by the 40-hex of |
| 654 | the commit object name. A 'prerequisite patch' is shown as |
| 655 | "prerequisite-patch-id: " followed by the 40-hex 'patch id', which can |
| 656 | be obtained by passing the patch through the `git patch-id --stable` |
| 657 | command. |
| 658 | |
| 659 | Imagine that on top of the public commit P, you applied well-known |
| 660 | patches X, Y and Z from somebody else, and then built your three-patch |
| 661 | series A, B, C, the history would be like: |
| 662 | |
| 663 | ................................................ |
| 664 | ---P---X---Y---Z---A---B---C |
| 665 | ................................................ |
| 666 | |
| 667 | With `git format-patch --base=P -3 C` (or variants thereof, e.g. with |
Giuseppe Bilotta | 7ba1cee | 2017-04-18 00:32:53 +0200 | [diff] [blame] | 668 | `--cover-letter` or using `Z..C` instead of `-3 C` to specify the |
Xiaolong Ye | fa2ab86 | 2016-04-26 15:51:22 +0800 | [diff] [blame] | 669 | range), the base tree information block is shown at the end of the |
| 670 | first message the command outputs (either the first patch, or the |
| 671 | cover letter), like this: |
| 672 | |
| 673 | ------------ |
| 674 | base-commit: P |
| 675 | prerequisite-patch-id: X |
| 676 | prerequisite-patch-id: Y |
| 677 | prerequisite-patch-id: Z |
| 678 | ------------ |
| 679 | |
| 680 | For non-linear topology, such as |
| 681 | |
| 682 | ................................................ |
| 683 | ---P---X---A---M---C |
| 684 | \ / |
| 685 | Y---Z---B |
| 686 | ................................................ |
| 687 | |
| 688 | You can also use `git format-patch --base=P -3 C` to generate patches |
| 689 | for A, B and C, and the identifiers for P, X, Y, Z are appended at the |
| 690 | end of the first message. |
Jonathan Nieder | e0d4827 | 2011-04-14 21:22:02 -0500 | [diff] [blame] | 691 | |
Xiaolong Ye | 3de6651 | 2016-04-26 15:51:23 +0800 | [diff] [blame] | 692 | If set `--base=auto` in cmdline, it will track base commit automatically, |
| 693 | the base commit will be the merge base of tip commit of the remote-tracking |
| 694 | branch and revision-range specified in cmdline. |
| 695 | For a local branch, you need to track a remote branch by `git branch |
| 696 | --set-upstream-to` before using this option. |
| 697 | |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 698 | EXAMPLES |
| 699 | -------- |
| 700 | |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 701 | * Extract commits between revisions R1 and R2, and apply them on top of |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 702 | the current branch using 'git am' to cherry-pick them: |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 703 | + |
| 704 | ------------ |
Jonathan Nieder | 467c019 | 2008-07-03 00:28:15 -0500 | [diff] [blame] | 705 | $ git format-patch -k --stdout R1..R2 | git am -3 -k |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 706 | ------------ |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 707 | |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 708 | * Extract all commits which are in the current branch but not in the |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 709 | origin branch: |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 710 | + |
| 711 | ------------ |
| 712 | $ git format-patch origin |
| 713 | ------------ |
| 714 | + |
| 715 | For each commit a separate file is created in the current directory. |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 716 | |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 717 | * Extract all commits that lead to 'origin' since the inception of the |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 718 | project: |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 719 | + |
| 720 | ------------ |
Jonathan Nieder | 9c67c75 | 2008-07-02 23:47:05 -0500 | [diff] [blame] | 721 | $ git format-patch --root origin |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 722 | ------------ |
Junio C Hamano | 8a1d076 | 2007-08-28 00:38:48 -0700 | [diff] [blame] | 723 | |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 724 | * The same as the previous one: |
| 725 | + |
| 726 | ------------ |
| 727 | $ git format-patch -M -B origin |
| 728 | ------------ |
| 729 | + |
| 730 | Additionally, it detects and handles renames and complete rewrites |
| 731 | intelligently to produce a renaming patch. A renaming patch reduces |
Stephen Boyd | 50710ce | 2009-04-23 09:16:52 -0700 | [diff] [blame] | 732 | the amount of text output, and generally makes it easier to review. |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 733 | Note that non-Git "patch" programs won't understand renaming patches, so |
| 734 | use it only when you know the recipient uses Git to apply your patch. |
Junio C Hamano | 803f498 | 2005-12-13 01:54:15 -0800 | [diff] [blame] | 735 | |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 736 | * Extract three topmost commits from the current branch and format them |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 737 | as e-mailable patches: |
Christian Couder | 921177f | 2008-05-07 06:29:28 +0200 | [diff] [blame] | 738 | + |
| 739 | ------------ |
| 740 | $ git format-patch -3 |
| 741 | ------------ |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 742 | |
Jeff King | 8e0601f | 2021-05-01 10:13:24 -0400 | [diff] [blame] | 743 | CAVEATS |
| 744 | ------- |
| 745 | |
| 746 | Note that `format-patch` will omit merge commits from the output, even |
| 747 | if they are part of the requested range. A simple "patch" does not |
| 748 | include enough information for the receiving end to reproduce the same |
| 749 | merge commit. |
| 750 | |
Junio C Hamano | 56ae8df | 2008-05-28 16:55:27 -0700 | [diff] [blame] | 751 | SEE ALSO |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 752 | -------- |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 753 | linkgit:git-am[1], linkgit:git-send-email[1] |
Junio C Hamano | 28ffb89 | 2005-11-05 02:55:18 -0800 | [diff] [blame] | 754 | |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 755 | GIT |
| 756 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 757 | Part of the linkgit:git[1] suite |