pack-objects: turn off bitmaps when we split packs
[git.git] / Documentation / git-format-patch.txt
blob5c0a4ab2d6d4c123899fa32e8f147a8c077f2130
1 git-format-patch(1)
2 ===================
4 NAME
5 ----
6 git-format-patch - Prepare patches for e-mail submission
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                    [-n | --numbered | -N | --no-numbered]
18                    [--start-number <n>] [--numbered-files]
19                    [--in-reply-to=Message-Id] [--suffix=.<sfx>]
20                    [--ignore-if-in-upstream]
21                    [--subject-prefix=Subject-Prefix] [(--reroll-count|-v) <n>]
22                    [--to=<email>] [--cc=<email>]
23                    [--[no-]cover-letter] [--quiet] [--notes[=<ref>]]
24                    [<common diff options>]
25                    [ <since> | <revision range> ]
27 DESCRIPTION
28 -----------
30 Prepare each commit with its patch in
31 one file per commit, formatted to resemble UNIX mailbox format.
32 The output of this command is convenient for e-mail submission or
33 for use with 'git am'.
35 There are two ways to specify which commits to operate on.
37 1. A single commit, <since>, specifies that the commits leading
38    to the tip of the current branch that are not in the history
39    that leads to the <since> to be output.
41 2. Generic <revision range> expression (see "SPECIFYING
42    REVISIONS" section in linkgit:gitrevisions[7]) means the
43    commits in the specified range.
45 The first rule takes precedence in the case of a single <commit>.  To
46 apply the second rule, i.e., format everything since the beginning of
47 history up until <commit>, use the '\--root' option: `git format-patch
48 --root <commit>`.  If you want to format only <commit> itself, you
49 can do this with `git format-patch -1 <commit>`.
51 By default, each output file is numbered sequentially from 1, and uses the
52 first line of the commit message (massaged for pathname safety) as
53 the filename. With the `--numbered-files` option, the output file names
54 will only be numbers, without the first line of the commit appended.
55 The names of the output files are printed to standard
56 output, unless the `--stdout` option is specified.
58 If `-o` is specified, output files are created in <dir>.  Otherwise
59 they are created in the current working directory.
61 By default, the subject of a single patch is "[PATCH] " followed by
62 the concatenation of lines from the commit message up to the first blank
63 line (see the DISCUSSION section of linkgit:git-commit[1]).
65 When multiple patches are output, the subject prefix will instead be
66 "[PATCH n/m] ".  To force 1/1 to be added for a single patch, use `-n`.
67 To omit patch numbers from the subject, use `-N`.
69 If given `--thread`, `git-format-patch` will generate `In-Reply-To` and
70 `References` headers to make the second and subsequent patch mails appear
71 as replies to the first mail; this also generates a `Message-Id` header to
72 reference.
74 OPTIONS
75 -------
76 :git-format-patch: 1
77 include::diff-options.txt[]
79 -<n>::
80         Prepare patches from the topmost <n> commits.
82 -o <dir>::
83 --output-directory <dir>::
84         Use <dir> to store the resulting files, instead of the
85         current working directory.
87 -n::
88 --numbered::
89         Name output in '[PATCH n/m]' format, even with a single patch.
91 -N::
92 --no-numbered::
93         Name output in '[PATCH]' format.
95 --start-number <n>::
96         Start numbering the patches at <n> instead of 1.
98 --numbered-files::
99         Output file names will be a simple number sequence
100         without the default first line of the commit appended.
102 -k::
103 --keep-subject::
104         Do not strip/add '[PATCH]' from the first line of the
105         commit log message.
107 -s::
108 --signoff::
109         Add `Signed-off-by:` line to the commit message, using
110         the committer identity of yourself.
112 --stdout::
113         Print all commits to the standard output in mbox format,
114         instead of creating a file for each one.
116 --attach[=<boundary>]::
117         Create multipart/mixed attachment, the first part of
118         which is the commit message and the patch itself in the
119         second part, with `Content-Disposition: attachment`.
121 --no-attach::
122         Disable the creation of an attachment, overriding the
123         configuration setting.
125 --inline[=<boundary>]::
126         Create multipart/mixed attachment, the first part of
127         which is the commit message and the patch itself in the
128         second part, with `Content-Disposition: inline`.
130 --thread[=<style>]::
131 --no-thread::
132         Controls addition of `In-Reply-To` and `References` headers to
133         make the second and subsequent mails appear as replies to the
134         first.  Also controls generation of the `Message-Id` header to
135         reference.
137 The optional <style> argument can be either `shallow` or `deep`.
138 'shallow' threading makes every mail a reply to the head of the
139 series, where the head is chosen from the cover letter, the
140 `--in-reply-to`, and the first patch mail, in this order.  'deep'
141 threading makes every mail a reply to the previous one.
143 The default is `--no-thread`, unless the 'format.thread' configuration
144 is set.  If `--thread` is specified without a style, it defaults to the
145 style specified by 'format.thread' if any, or else `shallow`.
147 Beware that the default for 'git send-email' is to thread emails
148 itself.  If you want `git format-patch` to take care of threading, you
149 will want to ensure that threading is disabled for `git send-email`.
151 --in-reply-to=Message-Id::
152         Make the first mail (or all the mails with `--no-thread`) appear as a
153         reply to the given Message-Id, which avoids breaking threads to
154         provide a new patch series.
156 --ignore-if-in-upstream::
157         Do not include a patch that matches a commit in
158         <until>..<since>.  This will examine all patches reachable
159         from <since> but not from <until> and compare them with the
160         patches being generated, and any patch that matches is
161         ignored.
163 --subject-prefix=<Subject-Prefix>::
164         Instead of the standard '[PATCH]' prefix in the subject
165         line, instead use '[<Subject-Prefix>]'. This
166         allows for useful naming of a patch series, and can be
167         combined with the `--numbered` option.
169 -v <n>::
170 --reroll-count=<n>::
171         Mark the series as the <n>-th iteration of the topic. The
172         output filenames have `v<n>` pretended to them, and the
173         subject prefix ("PATCH" by default, but configurable via the
174         `--subject-prefix` option) has ` v<n>` appended to it.  E.g.
175         `--reroll-count=4` may produce `v4-0001-add-makefile.patch`
176         file that has "Subject: [PATCH v4 1/20] Add makefile" in it.
178 --to=<email>::
179         Add a `To:` header to the email headers. This is in addition
180         to any configured headers, and may be used multiple times.
181         The negated form `--no-to` discards all `To:` headers added so
182         far (from config or command line).
184 --cc=<email>::
185         Add a `Cc:` header to the email headers. This is in addition
186         to any configured headers, and may be used multiple times.
187         The negated form `--no-cc` discards all `Cc:` headers added so
188         far (from config or command line).
190 --from::
191 --from=<ident>::
192         Use `ident` in the `From:` header of each commit email. If the
193         author ident of the commit is not textually identical to the
194         provided `ident`, place a `From:` header in the body of the
195         message with the original author. If no `ident` is given, use
196         the committer ident.
198 Note that this option is only useful if you are actually sending the
199 emails and want to identify yourself as the sender, but retain the
200 original author (and `git am` will correctly pick up the in-body
201 header). Note also that `git send-email` already handles this
202 transformation for you, and this option should not be used if you are
203 feeding the result to `git send-email`.
205 --add-header=<header>::
206         Add an arbitrary header to the email headers.  This is in addition
207         to any configured headers, and may be used multiple times.
208         For example, `--add-header="Organization: git-foo"`.
209         The negated form `--no-add-header` discards *all* (`To:`,
210         `Cc:`, and custom) headers added so far from config or command
211         line.
213 --[no-]cover-letter::
214         In addition to the patches, generate a cover letter file
215         containing the shortlog and the overall diffstat.  You can
216         fill in a description in the file before sending it out.
218 --notes[=<ref>]::
219         Append the notes (see linkgit:git-notes[1]) for the commit
220         after the three-dash line.
222 The expected use case of this is to write supporting explanation for
223 the commit that does not belong to the commit log message proper,
224 and include it with the patch submission. While one can simply write
225 these explanations after `format-patch` has run but before sending,
226 keeping them as Git notes allows them to be maintained between versions
227 of the patch series (but see the discussion of the `notes.rewrite`
228 configuration options in linkgit:git-notes[1] to use this workflow).
230 --[no]-signature=<signature>::
231         Add a signature to each message produced. Per RFC 3676 the signature
232         is separated from the body by a line with '-- ' on it. If the
233         signature option is omitted the signature defaults to the Git version
234         number.
236 --suffix=.<sfx>::
237         Instead of using `.patch` as the suffix for generated
238         filenames, use specified suffix.  A common alternative is
239         `--suffix=.txt`.  Leaving this empty will remove the `.patch`
240         suffix.
242 Note that the leading character does not have to be a dot; for example,
243 you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
245 -q::
246 --quiet::
247         Do not print the names of the generated files to standard output.
249 --no-binary::
250         Do not output contents of changes in binary files, instead
251         display a notice that those files changed.  Patches generated
252         using this option cannot be applied properly, but they are
253         still useful for code review.
255 --root::
256         Treat the revision argument as a <revision range>, even if it
257         is just a single commit (that would normally be treated as a
258         <since>).  Note that root commits included in the specified
259         range are always formatted as creation patches, independently
260         of this flag.
262 CONFIGURATION
263 -------------
264 You can specify extra mail header lines to be added to each message,
265 defaults for the subject prefix and file suffix, number patches when
266 outputting more than one patch, add "To" or "Cc:" headers, configure
267 attachments, and sign off patches with configuration variables.
269 ------------
270 [format]
271         headers = "Organization: git-foo\n"
272         subjectprefix = CHANGE
273         suffix = .txt
274         numbered = auto
275         to = <email>
276         cc = <email>
277         attach [ = mime-boundary-string ]
278         signoff = true
279         coverletter = auto
280 ------------
283 DISCUSSION
284 ----------
286 The patch produced by 'git format-patch' is in UNIX mailbox format,
287 with a fixed "magic" time stamp to indicate that the file is output
288 from format-patch rather than a real mailbox, like so:
290 ------------
291 From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001
292 From: Tony Luck <tony.luck@intel.com>
293 Date: Tue, 13 Jul 2010 11:42:54 -0700
294 Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?=
295  =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig=20diet?=
296 MIME-Version: 1.0
297 Content-Type: text/plain; charset=UTF-8
298 Content-Transfer-Encoding: 8bit
300 arch/arm config files were slimmed down using a python script
301 (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment)
303 Do the same for ia64 so we can have sleek & trim looking
305 ------------
307 Typically it will be placed in a MUA's drafts folder, edited to add
308 timely commentary that should not go in the changelog after the three
309 dashes, and then sent as a message whose body, in our example, starts
310 with "arch/arm config files were...".  On the receiving end, readers
311 can save interesting patches in a UNIX mailbox and apply them with
312 linkgit:git-am[1].
314 When a patch is part of an ongoing discussion, the patch generated by
315 'git format-patch' can be tweaked to take advantage of the 'git am
316 --scissors' feature.  After your response to the discussion comes a
317 line that consists solely of "`-- >8 --`" (scissors and perforation),
318 followed by the patch with unnecessary header fields removed:
320 ------------
322 > So we should do such-and-such.
324 Makes sense to me.  How about this patch?
326 -- >8 --
327 Subject: [IA64] Put ia64 config files on the Uwe Kleine-K├Ânig diet
329 arch/arm config files were slimmed down using a python script
331 ------------
333 When sending a patch this way, most often you are sending your own
334 patch, so in addition to the "`From $SHA1 $magic_timestamp`" marker you
335 should omit `From:` and `Date:` lines from the patch file.  The patch
336 title is likely to be different from the subject of the discussion the
337 patch is in response to, so it is likely that you would want to keep
338 the Subject: line, like the example above.
340 Checking for patch corruption
341 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
342 Many mailers if not set up properly will corrupt whitespace.  Here are
343 two common types of corruption:
345 * Empty context lines that do not have _any_ whitespace.
347 * Non-empty context lines that have one extra whitespace at the
348   beginning.
350 One way to test if your MUA is set up correctly is:
352 * Send the patch to yourself, exactly the way you would, except
353   with To: and Cc: lines that do not contain the list and
354   maintainer address.
356 * Save that patch to a file in UNIX mailbox format.  Call it a.patch,
357   say.
359 * Apply it:
361     $ git fetch <project> master:test-apply
362     $ git checkout test-apply
363     $ git reset --hard
364     $ git am a.patch
366 If it does not apply correctly, there can be various reasons.
368 * The patch itself does not apply cleanly.  That is _bad_ but
369   does not have much to do with your MUA.  You might want to rebase
370   the patch with linkgit:git-rebase[1] before regenerating it in
371   this case.
373 * The MUA corrupted your patch; "am" would complain that
374   the patch does not apply.  Look in the .git/rebase-apply/ subdirectory and
375   see what 'patch' file contains and check for the common
376   corruption patterns mentioned above.
378 * While at it, check the 'info' and 'final-commit' files as well.
379   If what is in 'final-commit' is not exactly what you would want to
380   see in the commit log message, it is very likely that the
381   receiver would end up hand editing the log message when applying
382   your patch.  Things like "Hi, this is my first patch.\n" in the
383   patch e-mail should come after the three-dash line that signals
384   the end of the commit message.
386 MUA-SPECIFIC HINTS
387 ------------------
388 Here are some hints on how to successfully submit patches inline using
389 various mailers.
391 GMail
392 ~~~~~
393 GMail does not have any way to turn off line wrapping in the web
394 interface, so it will mangle any emails that you send.  You can however
395 use "git send-email" and send your patches through the GMail SMTP server, or
396 use any IMAP email client to connect to the google IMAP server and forward
397 the emails through that.
399 For hints on using 'git send-email' to send your patches through the
400 GMail SMTP server, see the EXAMPLE section of linkgit:git-send-email[1].
402 For hints on submission using the IMAP interface, see the EXAMPLE
403 section of linkgit:git-imap-send[1].
405 Thunderbird
406 ~~~~~~~~~~~
407 By default, Thunderbird will both wrap emails as well as flag
408 them as being 'format=flowed', both of which will make the
409 resulting email unusable by Git.
411 There are three different approaches: use an add-on to turn off line wraps,
412 configure Thunderbird to not mangle patches, or use
413 an external editor to keep Thunderbird from mangling the patches.
415 Approach #1 (add-on)
416 ^^^^^^^^^^^^^^^^^^^^
418 Install the Toggle Word Wrap add-on that is available from
419 https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/
420 It adds a menu entry "Enable Word Wrap" in the composer's "Options" menu
421 that you can tick off. Now you can compose the message as you otherwise do
422 (cut + paste, 'git format-patch' | 'git imap-send', etc), but you have to
423 insert line breaks manually in any text that you type.
425 Approach #2 (configuration)
426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
427 Three steps:
429 1. Configure your mail server composition as plain text:
430    Edit...Account Settings...Composition & Addressing,
431    uncheck "Compose Messages in HTML".
433 2. Configure your general composition window to not wrap.
435 In Thunderbird 2:
436 Edit..Preferences..Composition, wrap plain text messages at 0
438 In Thunderbird 3:
439 Edit..Preferences..Advanced..Config Editor.  Search for
440 "mail.wrap_long_lines".
441 Toggle it to make sure it is set to `false`. Also, search for
442 "mailnews.wraplength" and set the value to 0.
444 3. Disable the use of format=flowed:
445 Edit..Preferences..Advanced..Config Editor.  Search for
446 "mailnews.send_plaintext_flowed".
447 Toggle it to make sure it is set to `false`.
449 After that is done, you should be able to compose email as you
450 otherwise would (cut + paste, 'git format-patch' | 'git imap-send', etc),
451 and the patches will not be mangled.
453 Approach #3 (external editor)
454 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
456 The following Thunderbird extensions are needed:
457 AboutConfig from http://aboutconfig.mozdev.org/ and
458 External Editor from http://globs.org/articles.php?lng=en&pg=8
460 1. Prepare the patch as a text file using your method of choice.
462 2. Before opening a compose window, use Edit->Account Settings to
463    uncheck the "Compose messages in HTML format" setting in the
464    "Composition & Addressing" panel of the account to be used to
465    send the patch.
467 3. In the main Thunderbird window, 'before' you open the compose
468    window for the patch, use Tools->about:config to set the
469    following to the indicated values:
471 ----------
472         mailnews.send_plaintext_flowed  => false
473         mailnews.wraplength             => 0
474 ----------
476 4. Open a compose window and click the external editor icon.
478 5. In the external editor window, read in the patch file and exit
479    the editor normally.
481 Side note: it may be possible to do step 2 with
482 about:config and the following settings but no one's tried yet.
484 ----------
485         mail.html_compose                       => false
486         mail.identity.default.compose_html      => false
487         mail.identity.id?.compose_html          => false
488 ----------
490 There is a script in contrib/thunderbird-patch-inline which can help
491 you include patches with Thunderbird in an easy way. To use it, do the
492 steps above and then use the script as the external editor.
494 KMail
495 ~~~~~
496 This should help you to submit patches inline using KMail.
498 1. Prepare the patch as a text file.
500 2. Click on New Mail.
502 3. Go under "Options" in the Composer window and be sure that
503    "Word wrap" is not set.
505 4. Use Message -> Insert file... and insert the patch.
507 5. Back in the compose window: add whatever other text you wish to the
508    message, complete the addressing and subject fields, and press send.
511 EXAMPLES
512 --------
514 * Extract commits between revisions R1 and R2, and apply them on top of
515 the current branch using 'git am' to cherry-pick them:
517 ------------
518 $ git format-patch -k --stdout R1..R2 | git am -3 -k
519 ------------
521 * Extract all commits which are in the current branch but not in the
522 origin branch:
524 ------------
525 $ git format-patch origin
526 ------------
528 For each commit a separate file is created in the current directory.
530 * Extract all commits that lead to 'origin' since the inception of the
531 project:
533 ------------
534 $ git format-patch --root origin
535 ------------
537 * The same as the previous one:
539 ------------
540 $ git format-patch -M -B origin
541 ------------
543 Additionally, it detects and handles renames and complete rewrites
544 intelligently to produce a renaming patch.  A renaming patch reduces
545 the amount of text output, and generally makes it easier to review.
546 Note that non-Git "patch" programs won't understand renaming patches, so
547 use it only when you know the recipient uses Git to apply your patch.
549 * Extract three topmost commits from the current branch and format them
550 as e-mailable patches:
552 ------------
553 $ git format-patch -3
554 ------------
556 SEE ALSO
557 --------
558 linkgit:git-am[1], linkgit:git-send-email[1]
562 Part of the linkgit:git[1] suite