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