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