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