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