]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-format-patch(1) |
2 | =================== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-format-patch - Prepare patches for e-mail submission |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
50710ce4 | 12 | 'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout] |
f693b7e9 | 13 | [--no-thread | --thread[=<style>]] |
50710ce4 SB |
14 | [(--attach|--inline)[=<boundary>] | --no-attach] |
15 | [-s | --signoff] | |
6622d9c7 | 16 | [--signature=<signature> | --no-signature] |
7022650f | 17 | [--signature-file=<file>] |
a5a27c79 DB |
18 | [-n | --numbered | -N | --no-numbered] |
19 | [--start-number <n>] [--numbered-files] | |
c1a6f21c | 20 | [--in-reply-to=<message id>] [--suffix=.<sfx>] |
552038e2 | 21 | [--ignore-if-in-upstream] [--always] |
bf8e65b3 | 22 | [--cover-from-description=<mode>] |
c1a6f21c | 23 | [--rfc] [--subject-prefix=<subject prefix>] |
68e83a5b | 24 | [(--reroll-count|-v) <n>] |
ae6c098f | 25 | [--to=<email>] [--cc=<email>] |
83d9db78 | 26 | [--[no-]cover-letter] [--quiet] |
19d097e3 | 27 | [--[no-]encode-email-headers] |
83d9db78 | 28 | [--no-notes | --notes[=<ref>]] |
126facf8 | 29 | [--interdiff=<previous>] |
8631bf1c | 30 | [--range-diff=<previous> [--creation-factor=<percent>]] |
3baf58bf | 31 | [--filename-max-length=<n>] |
738e88a2 | 32 | [--progress] |
50710ce4 | 33 | [<common diff options>] |
8a1d076e | 34 | [ <since> | <revision range> ] |
7fc9d69f JH |
35 | |
36 | DESCRIPTION | |
37 | ----------- | |
2052d146 | 38 | |
8e0601f5 | 39 | Prepare each non-merge commit with its "patch" in |
28e29ee3 | 40 | one "message" per commit, formatted to resemble a UNIX mailbox. |
2052d146 | 41 | The output of this command is convenient for e-mail submission or |
0b444cdb | 42 | for use with 'git am'. |
35ef3a4c | 43 | |
28e29ee3 JH |
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 | ||
8a1d076e JH |
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 | |
9d83e382 | 68 | REVISIONS" section in linkgit:gitrevisions[7]) means the |
2f6a3823 JH |
69 | commits in the specified range. |
70 | ||
2d266f9d TR |
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 | |
9e9f132f | 73 | history up until <commit>, use the `--root` option: `git format-patch |
6cf378f0 | 74 | --root <commit>`. If you want to format only <commit> itself, you |
dce5ef14 | 75 | can do this with `git format-patch -1 <commit>`. |
8a1d076e | 76 | |
e6ff0f42 | 77 | By default, each output file is numbered sequentially from 1, and uses the |
2052d146 | 78 | first line of the commit message (massaged for pathname safety) as |
dce5ef14 | 79 | the filename. With the `--numbered-files` option, the output file names |
e6ff0f42 JL |
80 | will only be numbers, without the first line of the commit appended. |
81 | The names of the output files are printed to standard | |
dce5ef14 | 82 | output, unless the `--stdout` option is specified. |
66f04f38 | 83 | |
dce5ef14 | 84 | If `-o` is specified, output files are created in <dir>. Otherwise |
bc6bf2d7 | 85 | they are created in the current working directory. The default path |
ae9f6311 | 86 | can be set with the `format.outputDirectory` configuration option. |
bc6bf2d7 AK |
87 | The `-o` option takes precedence over `format.outputDirectory`. |
88 | To store patches in the current working directory even when | |
edefc318 BW |
89 | `format.outputDirectory` points elsewhere, use `-o .`. All directory |
90 | components will be created. | |
35ef3a4c | 91 | |
52ffe995 JW |
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`. | |
35ef3a4c | 99 | |
dce5ef14 BG |
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 | |
cc35de84 | 103 | reference. |
7fc9d69f JH |
104 | |
105 | OPTIONS | |
106 | ------- | |
c1a95fa6 | 107 | :git-format-patch: 1 |
b8105375 BG |
108 | include::diff-options.txt[] |
109 | ||
ed5f07a6 | 110 | -<n>:: |
2c642ed8 | 111 | Prepare patches from the topmost <n> commits. |
ed5f07a6 | 112 | |
3240240f SB |
113 | -o <dir>:: |
114 | --output-directory <dir>:: | |
35ef3a4c | 115 | Use <dir> to store the resulting files, instead of the |
efd02016 | 116 | current working directory. |
35ef3a4c | 117 | |
3240240f SB |
118 | -n:: |
119 | --numbered:: | |
a567fdcb | 120 | Name output in '[PATCH n/m]' format, even with a single patch. |
35ef3a4c | 121 | |
3240240f SB |
122 | -N:: |
123 | --no-numbered:: | |
49604a4d BG |
124 | Name output in '[PATCH]' format. |
125 | ||
2052d146 DS |
126 | --start-number <n>:: |
127 | Start numbering the patches at <n> instead of 1. | |
128 | ||
e6ff0f42 JL |
129 | --numbered-files:: |
130 | Output file names will be a simple number sequence | |
131 | without the default first line of the commit appended. | |
e6ff0f42 | 132 | |
3240240f SB |
133 | -k:: |
134 | --keep-subject:: | |
35ef3a4c JH |
135 | Do not strip/add '[PATCH]' from the first line of the |
136 | commit log message. | |
137 | ||
3240240f SB |
138 | -s:: |
139 | --signoff:: | |
3abd4a67 | 140 | Add a `Signed-off-by` trailer to the commit message, using |
6f855371 | 141 | the committer identity of yourself. |
b2c150d3 | 142 | See the signoff option in linkgit:git-commit[1] for more information. |
6f855371 | 143 | |
54ba6013 | 144 | --stdout:: |
2052d146 DS |
145 | Print all commits to the standard output in mbox format, |
146 | instead of creating a file for each one. | |
7fc9d69f | 147 | |
c112f689 JS |
148 | --attach[=<boundary>]:: |
149 | Create multipart/mixed attachment, the first part of | |
150 | which is the commit message and the patch itself in the | |
dce5ef14 | 151 | second part, with `Content-Disposition: attachment`. |
c112f689 | 152 | |
0db5260b JW |
153 | --no-attach:: |
154 | Disable the creation of an attachment, overriding the | |
155 | configuration setting. | |
156 | ||
c112f689 JS |
157 | --inline[=<boundary>]:: |
158 | Create multipart/mixed attachment, the first part of | |
159 | which is the commit message and the patch itself in the | |
dce5ef14 | 160 | second part, with `Content-Disposition: inline`. |
a15a44ef | 161 | |
30984ed2 | 162 | --thread[=<style>]:: |
f693b7e9 | 163 | --no-thread:: |
dce5ef14 | 164 | Controls addition of `In-Reply-To` and `References` headers to |
f693b7e9 | 165 | make the second and subsequent mails appear as replies to the |
dce5ef14 | 166 | first. Also controls generation of the `Message-Id` header to |
f693b7e9 | 167 | reference. |
30984ed2 TR |
168 | + |
169 | The optional <style> argument can be either `shallow` or `deep`. | |
fd1ff306 | 170 | 'shallow' threading makes every mail a reply to the head of the |
30984ed2 | 171 | series, where the head is chosen from the cover letter, the |
6cf378f0 | 172 | `--in-reply-to`, and the first patch mail, in this order. 'deep' |
f693b7e9 YD |
173 | threading makes every mail a reply to the previous one. |
174 | + | |
ae9f6311 | 175 | The default is `--no-thread`, unless the `format.thread` configuration |
dce5ef14 | 176 | is set. If `--thread` is specified without a style, it defaults to the |
ae9f6311 | 177 | style specified by `format.thread` if any, or else `shallow`. |
f693b7e9 YD |
178 | + |
179 | Beware that the default for 'git send-email' is to thread emails | |
dce5ef14 BG |
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`. | |
28ffb898 | 182 | |
c1a6f21c | 183 | --in-reply-to=<message id>:: |
dce5ef14 | 184 | Make the first mail (or all the mails with `--no-thread`) appear as a |
c1a6f21c | 185 | reply to the given <message id>, which avoids breaking threads to |
da56645d JT |
186 | provide a new patch series. |
187 | ||
cc75ad67 DK |
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 | ||
552038e2 A |
195 | --always:: |
196 | Include patches for commits that do not introduce any change, | |
197 | which are omitted by default. | |
198 | ||
bf8e65b3 DL |
199 | --cover-from-description=<mode>:: |
200 | Controls which parts of the cover letter will be automatically | |
201 | populated using the branch's description. | |
202 | + | |
203 | If `<mode>` is `message` or `default`, the cover letter subject will be | |
204 | populated with placeholder text. The body of the cover letter will be | |
205 | populated with the branch's description. This is the default mode when | |
206 | no configuration nor command line option is specified. | |
207 | + | |
208 | If `<mode>` is `subject`, the first paragraph of the branch description will | |
209 | populate the cover letter subject. The remainder of the description will | |
210 | populate the body of the cover letter. | |
211 | + | |
212 | If `<mode>` is `auto`, if the first paragraph of the branch description | |
213 | is greater than 100 bytes, then the mode will be `message`, otherwise | |
214 | `subject` will be used. | |
215 | + | |
216 | If `<mode>` is `none`, both the cover letter subject and body will be | |
217 | populated with placeholder text. | |
218 | ||
c1a6f21c | 219 | --subject-prefix=<subject prefix>:: |
2d9e4a47 | 220 | Instead of the standard '[PATCH]' prefix in the subject |
c1a6f21c | 221 | line, instead use '[<subject prefix>]'. This |
2d9e4a47 | 222 | allows for useful naming of a patch series, and can be |
dce5ef14 | 223 | combined with the `--numbered` option. |
2d9e4a47 | 224 | |
3baf58bf JH |
225 | --filename-max-length=<n>:: |
226 | Instead of the standard 64 bytes, chomp the generated output | |
227 | filenames at around '<n>' bytes (too short a value will be | |
228 | silently raised to a reasonable length). Defaults to the | |
229 | value of the `format.filenameMaxLength` configuration | |
230 | variable, or 64 if unconfigured. | |
231 | ||
68e83a5b JT |
232 | --rfc:: |
233 | Alias for `--subject-prefix="RFC PATCH"`. RFC means "Request For | |
234 | Comments"; use this when sending an experimental patch for | |
235 | discussion rather than application. | |
236 | ||
7952ea66 | 237 | -v <n>:: |
4aad08e0 JH |
238 | --reroll-count=<n>:: |
239 | Mark the series as the <n>-th iteration of the topic. The | |
d614f075 | 240 | output filenames have `v<n>` prepended to them, and the |
4aad08e0 JH |
241 | subject prefix ("PATCH" by default, but configurable via the |
242 | `--subject-prefix` option) has ` v<n>` appended to it. E.g. | |
243 | `--reroll-count=4` may produce `v4-0001-add-makefile.patch` | |
244 | file that has "Subject: [PATCH v4 1/20] Add makefile" in it. | |
db91988a ZH |
245 | `<n>` does not have to be an integer (e.g. "--reroll-count=4.4", |
246 | or "--reroll-count=4rev2" are allowed), but the downside of | |
247 | using such a reroll-count is that the range-diff/interdiff | |
248 | with the previous version does not state exactly which | |
249 | version the new interation is compared against. | |
4aad08e0 | 250 | |
ae6c098f SD |
251 | --to=<email>:: |
252 | Add a `To:` header to the email headers. This is in addition | |
253 | to any configured headers, and may be used multiple times. | |
b2cd17b9 TR |
254 | The negated form `--no-to` discards all `To:` headers added so |
255 | far (from config or command line). | |
ae6c098f | 256 | |
736cc67d | 257 | --cc=<email>:: |
dce5ef14 | 258 | Add a `Cc:` header to the email headers. This is in addition |
736cc67d | 259 | to any configured headers, and may be used multiple times. |
b2cd17b9 TR |
260 | The negated form `--no-cc` discards all `Cc:` headers added so |
261 | far (from config or command line). | |
736cc67d | 262 | |
a9080475 JK |
263 | --from:: |
264 | --from=<ident>:: | |
265 | Use `ident` in the `From:` header of each commit email. If the | |
266 | author ident of the commit is not textually identical to the | |
267 | provided `ident`, place a `From:` header in the body of the | |
268 | message with the original author. If no `ident` is given, use | |
269 | the committer ident. | |
270 | + | |
271 | Note that this option is only useful if you are actually sending the | |
272 | emails and want to identify yourself as the sender, but retain the | |
273 | original author (and `git am` will correctly pick up the in-body | |
274 | header). Note also that `git send-email` already handles this | |
275 | transformation for you, and this option should not be used if you are | |
276 | feeding the result to `git send-email`. | |
277 | ||
d7d9c2d0 MH |
278 | --add-header=<header>:: |
279 | Add an arbitrary header to the email headers. This is in addition | |
280 | to any configured headers, and may be used multiple times. | |
b2cd17b9 TR |
281 | For example, `--add-header="Organization: git-foo"`. |
282 | The negated form `--no-add-header` discards *all* (`To:`, | |
283 | `Cc:`, and custom) headers added so far from config or command | |
284 | line. | |
d7d9c2d0 | 285 | |
2a4c2607 | 286 | --[no-]cover-letter:: |
f4912391 | 287 | In addition to the patches, generate a cover letter file |
561d2b79 | 288 | containing the branch description, shortlog and the overall diffstat. You can |
f4912391 | 289 | fill in a description in the file before sending it out. |
a5a27c79 | 290 | |
19d097e3 EB |
291 | --encode-email-headers:: |
292 | --no-encode-email-headers:: | |
293 | Encode email headers that have non-ASCII characters with | |
294 | "Q-encoding" (described in RFC 2047), instead of outputting the | |
295 | headers verbatim. Defaults to the value of the | |
296 | `format.encodeEmailHeaders` configuration variable. | |
297 | ||
126facf8 | 298 | --interdiff=<previous>:: |
ee6cbf71 ES |
299 | As a reviewer aid, insert an interdiff into the cover letter, |
300 | or as commentary of the lone patch of a 1-patch series, showing | |
126facf8 ES |
301 | the differences between the previous version of the patch series and |
302 | the series currently being formatted. `previous` is a single revision | |
303 | naming the tip of the previous series which shares a common base with | |
304 | the series being formatted (for example `git format-patch | |
305 | --cover-letter --interdiff=feature/v1 -3 feature/v2`). | |
306 | ||
31e2617a ES |
307 | --range-diff=<previous>:: |
308 | As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1]) | |
40ce4160 ES |
309 | into the cover letter, or as commentary of the lone patch of a |
310 | 1-patch series, showing the differences between the previous | |
31e2617a | 311 | version of the patch series and the series currently being formatted. |
2e6fd71a ES |
312 | `previous` can be a single revision naming the tip of the previous |
313 | series if it shares a common base with the series being formatted (for | |
31e2617a | 314 | example `git format-patch --cover-letter --range-diff=feature/v1 -3 |
2e6fd71a ES |
315 | feature/v2`), or a revision range if the two versions of the series are |
316 | disjoint (for example `git format-patch --cover-letter | |
317 | --range-diff=feature/v1~3..feature/v1 -3 feature/v2`). | |
d8981c3f JH |
318 | + |
319 | Note that diff options passed to the command affect how the primary | |
320 | product of `format-patch` is generated, and they are not passed to | |
321 | the underlying `range-diff` machinery used to generate the cover-letter | |
322 | material (this may change in the future). | |
31e2617a | 323 | |
8631bf1c ES |
324 | --creation-factor=<percent>:: |
325 | Used with `--range-diff`, tweak the heuristic which matches up commits | |
326 | between the previous and current series of patches by adjusting the | |
327 | creation/deletion cost fudge factor. See linkgit:git-range-diff[1]) | |
328 | for details. | |
329 | ||
e422c0cf | 330 | --notes[=<ref>]:: |
83d9db78 | 331 | --no-notes:: |
e422c0cf JH |
332 | Append the notes (see linkgit:git-notes[1]) for the commit |
333 | after the three-dash line. | |
334 | + | |
335 | The expected use case of this is to write supporting explanation for | |
6454d9f1 PO |
336 | the commit that does not belong to the commit log message proper, |
337 | and include it with the patch submission. While one can simply write | |
338 | these explanations after `format-patch` has run but before sending, | |
2de9b711 | 339 | keeping them as Git notes allows them to be maintained between versions |
6454d9f1 PO |
340 | of the patch series (but see the discussion of the `notes.rewrite` |
341 | configuration options in linkgit:git-notes[1] to use this workflow). | |
13cdf780 DL |
342 | + |
343 | The default is `--no-notes`, unless the `format.notes` configuration is | |
344 | set. | |
e422c0cf | 345 | |
2c7ee986 | 346 | --[no-]signature=<signature>:: |
6622d9c7 SB |
347 | Add a signature to each message produced. Per RFC 3676 the signature |
348 | is separated from the body by a line with '-- ' on it. If the | |
2de9b711 | 349 | signature option is omitted the signature defaults to the Git version |
6622d9c7 SB |
350 | number. |
351 | ||
7022650f JM |
352 | --signature-file=<file>:: |
353 | Works just like --signature except the signature is read from a file. | |
354 | ||
03eeaeae | 355 | --suffix=.<sfx>:: |
917a8f89 | 356 | Instead of using `.patch` as the suffix for generated |
02783075 | 357 | filenames, use specified suffix. A common alternative is |
50710ce4 SB |
358 | `--suffix=.txt`. Leaving this empty will remove the `.patch` |
359 | suffix. | |
03eeaeae | 360 | + |
50710ce4 SB |
361 | Note that the leading character does not have to be a dot; for example, |
362 | you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`. | |
03eeaeae | 363 | |
b7df098c | 364 | -q:: |
b781cfaf CMN |
365 | --quiet:: |
366 | Do not print the names of the generated files to standard output. | |
367 | ||
37c22a4b | 368 | --no-binary:: |
50710ce4 SB |
369 | Do not output contents of changes in binary files, instead |
370 | display a notice that those files changed. Patches generated | |
371 | using this option cannot be applied properly, but they are | |
372 | still useful for code review. | |
37c22a4b | 373 | |
3a30aa17 | 374 | --zero-commit:: |
375 | Output an all-zero hash in each patch's From header instead | |
376 | of the hash of the commit. | |
377 | ||
945dc55d | 378 | --[no-]base[=<commit>]:: |
fa2ab86d XY |
379 | Record the base tree information to identify the state the |
380 | patch series applies to. See the BASE TREE INFORMATION section | |
c1a6f21c | 381 | below for details. If <commit> is "auto", a base commit is |
945dc55d DL |
382 | automatically chosen. The `--no-base` option overrides a |
383 | `format.useAutoBase` configuration. | |
fa2ab86d | 384 | |
2d266f9d TR |
385 | --root:: |
386 | Treat the revision argument as a <revision range>, even if it | |
387 | is just a single commit (that would normally be treated as a | |
388 | <since>). Note that root commits included in the specified | |
389 | range are always formatted as creation patches, independently | |
390 | of this flag. | |
391 | ||
738e88a2 KW |
392 | --progress:: |
393 | Show progress reports on stderr as patches are generated. | |
394 | ||
96ce6d26 MM |
395 | CONFIGURATION |
396 | ------------- | |
50710ce4 SB |
397 | You can specify extra mail header lines to be added to each message, |
398 | defaults for the subject prefix and file suffix, number patches when | |
c1a6f21c DL |
399 | outputting more than one patch, add "To:" or "Cc:" headers, configure |
400 | attachments, change the patch output directory, and sign off patches | |
401 | with configuration variables. | |
96ce6d26 | 402 | |
917a8f89 | 403 | ------------ |
96ce6d26 | 404 | [format] |
7f9d77f2 | 405 | headers = "Organization: git-foo\n" |
da0005b8 | 406 | subjectPrefix = CHANGE |
7f9d77f2 JN |
407 | suffix = .txt |
408 | numbered = auto | |
ae6c098f | 409 | to = <email> |
fe8928e6 | 410 | cc = <email> |
0db5260b | 411 | attach [ = mime-boundary-string ] |
da0005b8 | 412 | signOff = true |
c1a6f21c DL |
413 | outputDirectory = <directory> |
414 | coverLetter = auto | |
bf8e65b3 | 415 | coverFromDescription = auto |
917a8f89 | 416 | ------------ |
03eeaeae | 417 | |
96ce6d26 | 418 | |
e0d48279 JN |
419 | DISCUSSION |
420 | ---------- | |
421 | ||
422 | The patch produced by 'git format-patch' is in UNIX mailbox format, | |
423 | with a fixed "magic" time stamp to indicate that the file is output | |
424 | from format-patch rather than a real mailbox, like so: | |
425 | ||
426 | ------------ | |
427 | From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 | |
428 | From: Tony Luck <tony.luck@intel.com> | |
429 | Date: Tue, 13 Jul 2010 11:42:54 -0700 | |
430 | Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?= | |
431 | =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig=20diet?= | |
432 | MIME-Version: 1.0 | |
433 | Content-Type: text/plain; charset=UTF-8 | |
434 | Content-Transfer-Encoding: 8bit | |
435 | ||
436 | arch/arm config files were slimmed down using a python script | |
437 | (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment) | |
438 | ||
439 | Do the same for ia64 so we can have sleek & trim looking | |
440 | ... | |
441 | ------------ | |
442 | ||
443 | Typically it will be placed in a MUA's drafts folder, edited to add | |
444 | timely commentary that should not go in the changelog after the three | |
445 | dashes, and then sent as a message whose body, in our example, starts | |
446 | with "arch/arm config files were...". On the receiving end, readers | |
447 | can save interesting patches in a UNIX mailbox and apply them with | |
448 | linkgit:git-am[1]. | |
449 | ||
450 | When a patch is part of an ongoing discussion, the patch generated by | |
451 | 'git format-patch' can be tweaked to take advantage of the 'git am | |
452 | --scissors' feature. After your response to the discussion comes a | |
453 | line that consists solely of "`-- >8 --`" (scissors and perforation), | |
454 | followed by the patch with unnecessary header fields removed: | |
455 | ||
456 | ------------ | |
457 | ... | |
458 | > So we should do such-and-such. | |
459 | ||
460 | Makes sense to me. How about this patch? | |
461 | ||
462 | -- >8 -- | |
463 | Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet | |
464 | ||
465 | arch/arm config files were slimmed down using a python script | |
466 | ... | |
467 | ------------ | |
468 | ||
469 | When sending a patch this way, most often you are sending your own | |
470 | patch, so in addition to the "`From $SHA1 $magic_timestamp`" marker you | |
471 | should omit `From:` and `Date:` lines from the patch file. The patch | |
472 | title is likely to be different from the subject of the discussion the | |
473 | patch is in response to, so it is likely that you would want to keep | |
474 | the Subject: line, like the example above. | |
475 | ||
57756161 JN |
476 | Checking for patch corruption |
477 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
478 | Many mailers if not set up properly will corrupt whitespace. Here are | |
479 | two common types of corruption: | |
480 | ||
481 | * Empty context lines that do not have _any_ whitespace. | |
482 | ||
483 | * Non-empty context lines that have one extra whitespace at the | |
484 | beginning. | |
485 | ||
486 | One way to test if your MUA is set up correctly is: | |
487 | ||
488 | * Send the patch to yourself, exactly the way you would, except | |
489 | with To: and Cc: lines that do not contain the list and | |
490 | maintainer address. | |
491 | ||
492 | * Save that patch to a file in UNIX mailbox format. Call it a.patch, | |
493 | say. | |
494 | ||
495 | * Apply it: | |
496 | ||
497 | $ git fetch <project> master:test-apply | |
328c6cb8 | 498 | $ git switch test-apply |
80f537f7 | 499 | $ git restore --source=HEAD --staged --worktree :/ |
57756161 JN |
500 | $ git am a.patch |
501 | ||
502 | If it does not apply correctly, there can be various reasons. | |
503 | ||
504 | * The patch itself does not apply cleanly. That is _bad_ but | |
505 | does not have much to do with your MUA. You might want to rebase | |
506 | the patch with linkgit:git-rebase[1] before regenerating it in | |
507 | this case. | |
508 | ||
509 | * The MUA corrupted your patch; "am" would complain that | |
510 | the patch does not apply. Look in the .git/rebase-apply/ subdirectory and | |
511 | see what 'patch' file contains and check for the common | |
512 | corruption patterns mentioned above. | |
513 | ||
514 | * While at it, check the 'info' and 'final-commit' files as well. | |
515 | If what is in 'final-commit' is not exactly what you would want to | |
516 | see in the commit log message, it is very likely that the | |
517 | receiver would end up hand editing the log message when applying | |
518 | your patch. Things like "Hi, this is my first patch.\n" in the | |
519 | patch e-mail should come after the three-dash line that signals | |
520 | the end of the commit message. | |
521 | ||
dc53151f JN |
522 | MUA-SPECIFIC HINTS |
523 | ------------------ | |
524 | Here are some hints on how to successfully submit patches inline using | |
525 | various mailers. | |
526 | ||
36c10e6d JN |
527 | GMail |
528 | ~~~~~ | |
529 | GMail does not have any way to turn off line wrapping in the web | |
530 | interface, so it will mangle any emails that you send. You can however | |
531 | use "git send-email" and send your patches through the GMail SMTP server, or | |
532 | use any IMAP email client to connect to the google IMAP server and forward | |
533 | the emails through that. | |
534 | ||
535 | For hints on using 'git send-email' to send your patches through the | |
536 | GMail SMTP server, see the EXAMPLE section of linkgit:git-send-email[1]. | |
537 | ||
538 | For hints on submission using the IMAP interface, see the EXAMPLE | |
539 | section of linkgit:git-imap-send[1]. | |
540 | ||
dc53151f JN |
541 | Thunderbird |
542 | ~~~~~~~~~~~ | |
543 | By default, Thunderbird will both wrap emails as well as flag | |
544 | them as being 'format=flowed', both of which will make the | |
2de9b711 | 545 | resulting email unusable by Git. |
dc53151f | 546 | |
b8959605 JS |
547 | There are three different approaches: use an add-on to turn off line wraps, |
548 | configure Thunderbird to not mangle patches, or use | |
dc53151f JN |
549 | an external editor to keep Thunderbird from mangling the patches. |
550 | ||
b8959605 JS |
551 | Approach #1 (add-on) |
552 | ^^^^^^^^^^^^^^^^^^^^ | |
553 | ||
554 | Install the Toggle Word Wrap add-on that is available from | |
555 | https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/ | |
556 | It adds a menu entry "Enable Word Wrap" in the composer's "Options" menu | |
557 | that you can tick off. Now you can compose the message as you otherwise do | |
558 | (cut + paste, 'git format-patch' | 'git imap-send', etc), but you have to | |
559 | insert line breaks manually in any text that you type. | |
560 | ||
561 | Approach #2 (configuration) | |
dc53151f JN |
562 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
563 | Three steps: | |
564 | ||
565 | 1. Configure your mail server composition as plain text: | |
566 | Edit...Account Settings...Composition & Addressing, | |
567 | uncheck "Compose Messages in HTML". | |
568 | ||
569 | 2. Configure your general composition window to not wrap. | |
570 | + | |
571 | In Thunderbird 2: | |
572 | Edit..Preferences..Composition, wrap plain text messages at 0 | |
573 | + | |
574 | In Thunderbird 3: | |
575 | Edit..Preferences..Advanced..Config Editor. Search for | |
576 | "mail.wrap_long_lines". | |
f737684d RJ |
577 | Toggle it to make sure it is set to `false`. Also, search for |
578 | "mailnews.wraplength" and set the value to 0. | |
dc53151f JN |
579 | |
580 | 3. Disable the use of format=flowed: | |
ba170517 JNA |
581 | Edit..Preferences..Advanced..Config Editor. Search for |
582 | "mailnews.send_plaintext_flowed". | |
583 | Toggle it to make sure it is set to `false`. | |
dc53151f JN |
584 | |
585 | After that is done, you should be able to compose email as you | |
586 | otherwise would (cut + paste, 'git format-patch' | 'git imap-send', etc), | |
587 | and the patches will not be mangled. | |
588 | ||
b8959605 | 589 | Approach #3 (external editor) |
dc53151f JN |
590 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
591 | ||
592 | The following Thunderbird extensions are needed: | |
593 | AboutConfig from http://aboutconfig.mozdev.org/ and | |
594 | External Editor from http://globs.org/articles.php?lng=en&pg=8 | |
595 | ||
596 | 1. Prepare the patch as a text file using your method of choice. | |
597 | ||
598 | 2. Before opening a compose window, use Edit->Account Settings to | |
599 | uncheck the "Compose messages in HTML format" setting in the | |
600 | "Composition & Addressing" panel of the account to be used to | |
601 | send the patch. | |
602 | ||
603 | 3. In the main Thunderbird window, 'before' you open the compose | |
604 | window for the patch, use Tools->about:config to set the | |
605 | following to the indicated values: | |
606 | + | |
607 | ---------- | |
608 | mailnews.send_plaintext_flowed => false | |
609 | mailnews.wraplength => 0 | |
610 | ---------- | |
611 | ||
612 | 4. Open a compose window and click the external editor icon. | |
613 | ||
614 | 5. In the external editor window, read in the patch file and exit | |
615 | the editor normally. | |
616 | ||
617 | Side note: it may be possible to do step 2 with | |
618 | about:config and the following settings but no one's tried yet. | |
619 | ||
620 | ---------- | |
621 | mail.html_compose => false | |
622 | mail.identity.default.compose_html => false | |
623 | mail.identity.id?.compose_html => false | |
624 | ---------- | |
625 | ||
626 | There is a script in contrib/thunderbird-patch-inline which can help | |
627 | you include patches with Thunderbird in an easy way. To use it, do the | |
628 | steps above and then use the script as the external editor. | |
629 | ||
967ab8ef JN |
630 | KMail |
631 | ~~~~~ | |
632 | This should help you to submit patches inline using KMail. | |
633 | ||
634 | 1. Prepare the patch as a text file. | |
635 | ||
636 | 2. Click on New Mail. | |
637 | ||
638 | 3. Go under "Options" in the Composer window and be sure that | |
639 | "Word wrap" is not set. | |
640 | ||
641 | 4. Use Message -> Insert file... and insert the patch. | |
642 | ||
643 | 5. Back in the compose window: add whatever other text you wish to the | |
644 | message, complete the addressing and subject fields, and press send. | |
645 | ||
fa2ab86d XY |
646 | BASE TREE INFORMATION |
647 | --------------------- | |
648 | ||
649 | The base tree information block is used for maintainers or third party | |
650 | testers to know the exact state the patch series applies to. It consists | |
651 | of the 'base commit', which is a well-known commit that is part of the | |
652 | stable part of the project history everybody else works off of, and zero | |
653 | or more 'prerequisite patches', which are well-known patches in flight | |
654 | that is not yet part of the 'base commit' that need to be applied on top | |
655 | of 'base commit' in topological order before the patches can be applied. | |
656 | ||
657 | The 'base commit' is shown as "base-commit: " followed by the 40-hex of | |
658 | the commit object name. A 'prerequisite patch' is shown as | |
659 | "prerequisite-patch-id: " followed by the 40-hex 'patch id', which can | |
660 | be obtained by passing the patch through the `git patch-id --stable` | |
661 | command. | |
662 | ||
663 | Imagine that on top of the public commit P, you applied well-known | |
664 | patches X, Y and Z from somebody else, and then built your three-patch | |
665 | series A, B, C, the history would be like: | |
666 | ||
667 | ................................................ | |
668 | ---P---X---Y---Z---A---B---C | |
669 | ................................................ | |
670 | ||
671 | With `git format-patch --base=P -3 C` (or variants thereof, e.g. with | |
7ba1ceef | 672 | `--cover-letter` or using `Z..C` instead of `-3 C` to specify the |
fa2ab86d XY |
673 | range), the base tree information block is shown at the end of the |
674 | first message the command outputs (either the first patch, or the | |
675 | cover letter), like this: | |
676 | ||
677 | ------------ | |
678 | base-commit: P | |
679 | prerequisite-patch-id: X | |
680 | prerequisite-patch-id: Y | |
681 | prerequisite-patch-id: Z | |
682 | ------------ | |
683 | ||
684 | For non-linear topology, such as | |
685 | ||
686 | ................................................ | |
687 | ---P---X---A---M---C | |
688 | \ / | |
689 | Y---Z---B | |
690 | ................................................ | |
691 | ||
692 | You can also use `git format-patch --base=P -3 C` to generate patches | |
693 | for A, B and C, and the identifiers for P, X, Y, Z are appended at the | |
694 | end of the first message. | |
e0d48279 | 695 | |
203eb838 JH |
696 | If set `--base=auto` in cmdline, it will automatically compute |
697 | the base commit as the merge base of tip commit of the remote-tracking | |
3de66517 | 698 | branch and revision-range specified in cmdline. |
203eb838 | 699 | For a local branch, you need to make it to track a remote branch by `git branch |
3de66517 XY |
700 | --set-upstream-to` before using this option. |
701 | ||
28ffb898 JH |
702 | EXAMPLES |
703 | -------- | |
704 | ||
921177f5 | 705 | * Extract commits between revisions R1 and R2, and apply them on top of |
ba170517 | 706 | the current branch using 'git am' to cherry-pick them: |
921177f5 CC |
707 | + |
708 | ------------ | |
467c0197 | 709 | $ git format-patch -k --stdout R1..R2 | git am -3 -k |
921177f5 CC |
710 | ------------ |
711 | ||
712 | * Extract all commits which are in the current branch but not in the | |
ba170517 | 713 | origin branch: |
921177f5 CC |
714 | + |
715 | ------------ | |
716 | $ git format-patch origin | |
717 | ------------ | |
718 | + | |
719 | For each commit a separate file is created in the current directory. | |
720 | ||
721 | * Extract all commits that lead to 'origin' since the inception of the | |
ba170517 | 722 | project: |
921177f5 CC |
723 | + |
724 | ------------ | |
9c67c757 | 725 | $ git format-patch --root origin |
921177f5 CC |
726 | ------------ |
727 | ||
728 | * The same as the previous one: | |
729 | + | |
730 | ------------ | |
731 | $ git format-patch -M -B origin | |
732 | ------------ | |
733 | + | |
734 | Additionally, it detects and handles renames and complete rewrites | |
735 | intelligently to produce a renaming patch. A renaming patch reduces | |
50710ce4 | 736 | the amount of text output, and generally makes it easier to review. |
2de9b711 TA |
737 | Note that non-Git "patch" programs won't understand renaming patches, so |
738 | use it only when you know the recipient uses Git to apply your patch. | |
921177f5 CC |
739 | |
740 | * Extract three topmost commits from the current branch and format them | |
ba170517 | 741 | as e-mailable patches: |
921177f5 CC |
742 | + |
743 | ------------ | |
744 | $ git format-patch -3 | |
745 | ------------ | |
28ffb898 | 746 | |
8e0601f5 JK |
747 | CAVEATS |
748 | ------- | |
749 | ||
750 | Note that `format-patch` will omit merge commits from the output, even | |
751 | if they are part of the requested range. A simple "patch" does not | |
752 | include enough information for the receiving end to reproduce the same | |
753 | merge commit. | |
754 | ||
56ae8df5 | 755 | SEE ALSO |
28ffb898 | 756 | -------- |
5162e697 | 757 | linkgit:git-am[1], linkgit:git-send-email[1] |
28ffb898 | 758 | |
7fc9d69f JH |
759 | GIT |
760 | --- | |
9e1f0a85 | 761 | Part of the linkgit:git[1] suite |