Autogenerated manpages for v2.36.1-74-g277cf0
[git-manpages.git] / man1 / git-format-patch.1
blob4282ccced13c267868ebf49f3f7d04d2885d24a4
1 '\" t
2 .\"     Title: git-format-patch
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 05/11/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.36.1.74.g277cf0bc36
8 .\"  Language: English
9 .\"
10 .TH "GIT\-FORMAT\-PATCH" "1" "05/11/2022" "Git 2\&.36\&.1\&.74\&.g277cf0b" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-format-patch \- Prepare patches for e\-mail submission
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit format\-patch\fR [\-k] [(\-o|\-\-output\-directory) <dir> | \-\-stdout]
36                    [\-\-no\-thread | \-\-thread[=<style>]]
37                    [(\-\-attach|\-\-inline)[=<boundary>] | \-\-no\-attach]
38                    [\-s | \-\-signoff]
39                    [\-\-signature=<signature> | \-\-no\-signature]
40                    [\-\-signature\-file=<file>]
41                    [\-n | \-\-numbered | \-N | \-\-no\-numbered]
42                    [\-\-start\-number <n>] [\-\-numbered\-files]
43                    [\-\-in\-reply\-to=<message id>] [\-\-suffix=\&.<sfx>]
44                    [\-\-ignore\-if\-in\-upstream] [\-\-always]
45                    [\-\-cover\-from\-description=<mode>]
46                    [\-\-rfc] [\-\-subject\-prefix=<subject prefix>]
47                    [(\-\-reroll\-count|\-v) <n>]
48                    [\-\-to=<email>] [\-\-cc=<email>]
49                    [\-\-[no\-]cover\-letter] [\-\-quiet]
50                    [\-\-[no\-]encode\-email\-headers]
51                    [\-\-no\-notes | \-\-notes[=<ref>]]
52                    [\-\-interdiff=<previous>]
53                    [\-\-range\-diff=<previous> [\-\-creation\-factor=<percent>]]
54                    [\-\-filename\-max\-length=<n>]
55                    [\-\-progress]
56                    [<common diff options>]
57                    [ <since> | <revision range> ]
58 .fi
59 .sp
60 .SH "DESCRIPTION"
61 .sp
62 Prepare each non\-merge commit with its "patch" in one "message" per commit, formatted to resemble a UNIX mailbox\&. The output of this command is convenient for e\-mail submission or for use with \fIgit am\fR\&.
63 .sp
64 A "message" generated by the command consists of three parts:
65 .sp
66 .RS 4
67 .ie n \{\
68 \h'-04'\(bu\h'+03'\c
69 .\}
70 .el \{\
71 .sp -1
72 .IP \(bu 2.3
73 .\}
74 A brief metadata header that begins with
75 \fBFrom <commit>\fR
76 with a fixed
77 \fBMon Sep 17 00:00:00 2001\fR
78 datestamp to help programs like "file(1)" to recognize that the file is an output from this command, fields that record the author identity, the author date, and the title of the change (taken from the first paragraph of the commit log message)\&.
79 .RE
80 .sp
81 .RS 4
82 .ie n \{\
83 \h'-04'\(bu\h'+03'\c
84 .\}
85 .el \{\
86 .sp -1
87 .IP \(bu 2.3
88 .\}
89 The second and subsequent paragraphs of the commit log message\&.
90 .RE
91 .sp
92 .RS 4
93 .ie n \{\
94 \h'-04'\(bu\h'+03'\c
95 .\}
96 .el \{\
97 .sp -1
98 .IP \(bu 2.3
99 .\}
100 The "patch", which is the "diff \-p \-\-stat" output (see
101 \fBgit-diff\fR(1)) between the commit and its parent\&.
104 The log message and the patch is separated by a line with a three\-dash line\&.
106 There are two ways to specify which commits to operate on\&.
108 .RS 4
109 .ie n \{\
110 \h'-04' 1.\h'+01'\c
112 .el \{\
113 .sp -1
114 .IP "  1." 4.2
116 A single commit, <since>, specifies that the commits leading to the tip of the current branch that are not in the history that leads to the <since> to be output\&.
119 .RS 4
120 .ie n \{\
121 \h'-04' 2.\h'+01'\c
123 .el \{\
124 .sp -1
125 .IP "  2." 4.2
127 Generic <revision range> expression (see "SPECIFYING REVISIONS" section in
128 \fBgitrevisions\fR(7)) means the commits in the specified range\&.
131 The first rule takes precedence in the case of a single <commit>\&. To apply the second rule, i\&.e\&., format everything since the beginning of history up until <commit>, use the \fB\-\-root\fR option: \fBgit format\-patch \-\-root <commit>\fR\&. If you want to format only <commit> itself, you can do this with \fBgit format\-patch \-1 <commit>\fR\&.
133 By default, each output file is numbered sequentially from 1, and uses the first line of the commit message (massaged for pathname safety) as the filename\&. With the \fB\-\-numbered\-files\fR option, the output file names will only be numbers, without the first line of the commit appended\&. The names of the output files are printed to standard output, unless the \fB\-\-stdout\fR option is specified\&.
135 If \fB\-o\fR is specified, output files are created in <dir>\&. Otherwise they are created in the current working directory\&. The default path can be set with the \fBformat\&.outputDirectory\fR configuration option\&. The \fB\-o\fR option takes precedence over \fBformat\&.outputDirectory\fR\&. To store patches in the current working directory even when \fBformat\&.outputDirectory\fR points elsewhere, use \fB\-o \&.\fR\&. All directory components will be created\&.
137 By default, the subject of a single patch is "[PATCH] " followed by the concatenation of lines from the commit message up to the first blank line (see the DISCUSSION section of \fBgit-commit\fR(1))\&.
139 When multiple patches are output, the subject prefix will instead be "[PATCH n/m] "\&. To force 1/1 to be added for a single patch, use \fB\-n\fR\&. To omit patch numbers from the subject, use \fB\-N\fR\&.
141 If given \fB\-\-thread\fR, \fBgit\-format\-patch\fR will generate \fBIn\-Reply\-To\fR and \fBReferences\fR headers to make the second and subsequent patch mails appear as replies to the first mail; this also generates a \fBMessage\-Id\fR header to reference\&.
142 .SH "OPTIONS"
144 \-p, \-\-no\-stat
145 .RS 4
146 Generate plain patches without any diffstats\&.
149 \-U<n>, \-\-unified=<n>
150 .RS 4
151 Generate diffs with <n> lines of context instead of the usual three\&.
154 \-\-output=<file>
155 .RS 4
156 Output to a specific file instead of stdout\&.
159 \-\-output\-indicator\-new=<char>, \-\-output\-indicator\-old=<char>, \-\-output\-indicator\-context=<char>
160 .RS 4
161 Specify the character used to indicate new, old or context lines in the generated patch\&. Normally they are
162 \fI+\fR,
163 \fI\-\fR
164 and \(aq \(aq respectively\&.
167 \-\-indent\-heuristic
168 .RS 4
169 Enable the heuristic that shifts diff hunk boundaries to make patches easier to read\&. This is the default\&.
172 \-\-no\-indent\-heuristic
173 .RS 4
174 Disable the indent heuristic\&.
177 \-\-minimal
178 .RS 4
179 Spend extra time to make sure the smallest possible diff is produced\&.
182 \-\-patience
183 .RS 4
184 Generate a diff using the "patience diff" algorithm\&.
187 \-\-histogram
188 .RS 4
189 Generate a diff using the "histogram diff" algorithm\&.
192 \-\-anchored=<text>
193 .RS 4
194 Generate a diff using the "anchored diff" algorithm\&.
196 This option may be specified more than once\&.
198 If a line exists in both the source and destination, exists only once, and starts with this text, this algorithm attempts to prevent it from appearing as a deletion or addition in the output\&. It uses the "patience diff" algorithm internally\&.
201 \-\-diff\-algorithm={patience|minimal|histogram|myers}
202 .RS 4
203 Choose a diff algorithm\&. The variants are as follows:
205 \fBdefault\fR, \fBmyers\fR
206 .RS 4
207 The basic greedy diff algorithm\&. Currently, this is the default\&.
210 \fBminimal\fR
211 .RS 4
212 Spend extra time to make sure the smallest possible diff is produced\&.
215 \fBpatience\fR
216 .RS 4
217 Use "patience diff" algorithm when generating patches\&.
220 \fBhistogram\fR
221 .RS 4
222 This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
225 For instance, if you configured the
226 \fBdiff\&.algorithm\fR
227 variable to a non\-default value and want to use the default one, then you have to use
228 \fB\-\-diff\-algorithm=default\fR
229 option\&.
232 \-\-stat[=<width>[,<name\-width>[,<count>]]]
233 .RS 4
234 Generate a diffstat\&. By default, as much space as necessary will be used for the filename part, and the rest for the graph part\&. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by
235 \fB<width>\fR\&. The width of the filename part can be limited by giving another width
236 \fB<name\-width>\fR
237 after a comma\&. The width of the graph part can be limited by using
238 \fB\-\-stat\-graph\-width=<width>\fR
239 (affects all commands generating a stat graph) or by setting
240 \fBdiff\&.statGraphWidth=<width>\fR
241 (does not affect
242 \fBgit format\-patch\fR)\&. By giving a third parameter
243 \fB<count>\fR, you can limit the output to the first
244 \fB<count>\fR
245 lines, followed by
246 \fB\&.\&.\&.\fR
247 if there are more\&.
249 These parameters can also be set individually with
250 \fB\-\-stat\-width=<width>\fR,
251 \fB\-\-stat\-name\-width=<name\-width>\fR
253 \fB\-\-stat\-count=<count>\fR\&.
256 \-\-compact\-summary
257 .RS 4
258 Output a condensed summary of extended header information such as file creations or deletions ("new" or "gone", optionally "+l" if it\(cqs a symlink) and mode changes ("+x" or "\-x" for adding or removing executable bit respectively) in diffstat\&. The information is put between the filename part and the graph part\&. Implies
259 \fB\-\-stat\fR\&.
262 \-\-numstat
263 .RS 4
264 Similar to
265 \fB\-\-stat\fR, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly\&. For binary files, outputs two
266 \fB\-\fR
267 instead of saying
268 \fB0 0\fR\&.
271 \-\-shortstat
272 .RS 4
273 Output only the last line of the
274 \fB\-\-stat\fR
275 format containing total number of modified files, as well as number of added and deleted lines\&.
278 \-X[<param1,param2,\&...>], \-\-dirstat[=<param1,param2,\&...>]
279 .RS 4
280 Output the distribution of relative amount of changes for each sub\-directory\&. The behavior of
281 \fB\-\-dirstat\fR
282 can be customized by passing it a comma separated list of parameters\&. The defaults are controlled by the
283 \fBdiff\&.dirstat\fR
284 configuration variable (see
285 \fBgit-config\fR(1))\&. The following parameters are available:
287 \fBchanges\fR
288 .RS 4
289 Compute the dirstat numbers by counting the lines that have been removed from the source, or added to the destination\&. This ignores the amount of pure code movements within a file\&. In other words, rearranging lines in a file is not counted as much as other changes\&. This is the default behavior when no parameter is given\&.
292 \fBlines\fR
293 .RS 4
294 Compute the dirstat numbers by doing the regular line\-based diff analysis, and summing the removed/added line counts\&. (For binary files, count 64\-byte chunks instead, since binary files have no natural concept of lines)\&. This is a more expensive
295 \fB\-\-dirstat\fR
296 behavior than the
297 \fBchanges\fR
298 behavior, but it does count rearranged lines within a file as much as other changes\&. The resulting output is consistent with what you get from the other
299 \fB\-\-*stat\fR
300 options\&.
303 \fBfiles\fR
304 .RS 4
305 Compute the dirstat numbers by counting the number of files changed\&. Each changed file counts equally in the dirstat analysis\&. This is the computationally cheapest
306 \fB\-\-dirstat\fR
307 behavior, since it does not have to look at the file contents at all\&.
310 \fBcumulative\fR
311 .RS 4
312 Count changes in a child directory for the parent directory as well\&. Note that when using
313 \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
314 \fBnoncumulative\fR
315 parameter\&.
318 <limit>
319 .RS 4
320 An integer parameter specifies a cut\-off percent (3% by default)\&. Directories contributing less than this percentage of the changes are not shown in the output\&.
323 Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories:
324 \fB\-\-dirstat=files,10,cumulative\fR\&.
327 \-\-cumulative
328 .RS 4
329 Synonym for \-\-dirstat=cumulative
332 \-\-dirstat\-by\-file[=<param1,param2>\&...]
333 .RS 4
334 Synonym for \-\-dirstat=files,param1,param2\&...
337 \-\-summary
338 .RS 4
339 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
342 \-\-no\-renames
343 .RS 4
344 Turn off rename detection, even when the configuration file gives the default to do so\&.
347 \-\-[no\-]rename\-empty
348 .RS 4
349 Whether to use empty blobs as rename source\&.
352 \-\-full\-index
353 .RS 4
354 Instead of the first handful of characters, show the full pre\- and post\-image blob object names on the "index" line when generating patch format output\&.
357 \-\-binary
358 .RS 4
359 In addition to
360 \fB\-\-full\-index\fR, output a binary diff that can be applied with
361 \fBgit\-apply\fR\&.
364 \-\-abbrev[=<n>]
365 .RS 4
366 Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show the shortest prefix that is at least
367 \fI<n>\fR
368 hexdigits long that uniquely refers the object\&. In diff\-patch output format,
369 \fB\-\-full\-index\fR
370 takes higher precedence, i\&.e\&. if
371 \fB\-\-full\-index\fR
372 is specified, full blob names will be shown regardless of
373 \fB\-\-abbrev\fR\&. Non default number of digits can be specified with
374 \fB\-\-abbrev=<n>\fR\&.
377 \-B[<n>][/<m>], \-\-break\-rewrites[=[<n>][/<m>]]
378 .RS 4
379 Break complete rewrite changes into pairs of delete and create\&. This serves two purposes:
381 It affects the way a change that amounts to a total rewrite of a file not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of everything new, and the number
382 \fBm\fR
383 controls this aspect of the \-B option (defaults to 60%)\&.
384 \fB\-B/70%\fR
385 specifies that less than 30% of the original should remain in the result for Git to consider it a total rewrite (i\&.e\&. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines)\&.
387 When used with \-M, a totally\-rewritten file is also considered as the source of a rename (usually \-M only considers a file that disappeared as the source of a rename), and the number
388 \fBn\fR
389 controls this aspect of the \-B option (defaults to 50%)\&.
390 \fB\-B20%\fR
391 specifies that a change with addition and deletion compared to 20% or more of the file\(cqs size are eligible for being picked up as a possible source of a rename to another file\&.
394 \-M[<n>], \-\-find\-renames[=<n>]
395 .RS 4
396 Detect renames\&. If
397 \fBn\fR
398 is specified, it is a threshold on the similarity index (i\&.e\&. amount of addition/deletions compared to the file\(cqs size)\&. For example,
399 \fB\-M90%\fR
400 means Git should consider a delete/add pair to be a rename if more than 90% of the file hasn\(cqt changed\&. Without a
401 \fB%\fR
402 sign, the number is to be read as a fraction, with a decimal point before it\&. I\&.e\&.,
403 \fB\-M5\fR
404 becomes 0\&.5, and is thus the same as
405 \fB\-M50%\fR\&. Similarly,
406 \fB\-M05\fR
407 is the same as
408 \fB\-M5%\fR\&. To limit detection to exact renames, use
409 \fB\-M100%\fR\&. The default similarity index is 50%\&.
412 \-C[<n>], \-\-find\-copies[=<n>]
413 .RS 4
414 Detect copies as well as renames\&. See also
415 \fB\-\-find\-copies\-harder\fR\&. If
416 \fBn\fR
417 is specified, it has the same meaning as for
418 \fB\-M<n>\fR\&.
421 \-\-find\-copies\-harder
422 .RS 4
423 For performance reasons, by default,
424 \fB\-C\fR
425 option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&. Giving more than one
426 \fB\-C\fR
427 option has the same effect\&.
430 \-D, \-\-irreversible\-delete
431 .RS 4
432 Omit the preimage for deletes, i\&.e\&. print only the header but not the diff between the preimage and
433 \fB/dev/null\fR\&. The resulting patch is not meant to be applied with
434 \fBpatch\fR
436 \fBgit apply\fR; this is solely for people who want to just concentrate on reviewing the text after the change\&. In addition, the output obviously lacks enough information to apply such a patch in reverse, even manually, hence the name of the option\&.
438 When used together with
439 \fB\-B\fR, omit also the preimage in the deletion part of a delete/create pair\&.
442 \-l<num>
443 .RS 4
445 \fB\-M\fR
447 \fB\-C\fR
448 options involve some preliminary steps that can detect subsets of renames/copies cheaply, followed by an exhaustive fallback portion that compares all remaining unpaired destinations to all relevant sources\&. (For renames, only remaining unpaired sources are relevant; for copies, all original sources are relevant\&.) For N sources and destinations, this exhaustive check is O(N^2)\&. This option prevents the exhaustive portion of rename/copy detection from running if the number of source/destination files involved exceeds the specified number\&. Defaults to diff\&.renameLimit\&. Note that a value of 0 is treated as unlimited\&.
451 \-O<orderfile>
452 .RS 4
453 Control the order in which files appear in the output\&. This overrides the
454 \fBdiff\&.orderFile\fR
455 configuration variable (see
456 \fBgit-config\fR(1))\&. To cancel
457 \fBdiff\&.orderFile\fR, use
458 \fB\-O/dev/null\fR\&.
460 The output order is determined by the order of glob patterns in <orderfile>\&. All files with pathnames that match the first pattern are output first, all files with pathnames that match the second pattern (but not the first) are output next, and so on\&. All files with pathnames that do not match any pattern are output last, as if there was an implicit match\-all pattern at the end of the file\&. If multiple pathnames have the same rank (they match the same pattern but no earlier patterns), their output order relative to each other is the normal order\&.
462 <orderfile> is parsed as follows:
464 .RS 4
465 .ie n \{\
466 \h'-04'\(bu\h'+03'\c
468 .el \{\
469 .sp -1
470 .IP \(bu 2.3
472 Blank lines are ignored, so they can be used as separators for readability\&.
475 .RS 4
476 .ie n \{\
477 \h'-04'\(bu\h'+03'\c
479 .el \{\
480 .sp -1
481 .IP \(bu 2.3
483 Lines starting with a hash ("\fB#\fR") are ignored, so they can be used for comments\&. Add a backslash ("\fB\e\fR") to the beginning of the pattern if it starts with a hash\&.
486 .RS 4
487 .ie n \{\
488 \h'-04'\(bu\h'+03'\c
490 .el \{\
491 .sp -1
492 .IP \(bu 2.3
494 Each other line contains a single pattern\&.
497 Patterns have the same syntax and semantics as patterns used for fnmatch(3) without the FNM_PATHNAME flag, except a pathname also matches a pattern if removing any number of the final pathname components matches the pattern\&. For example, the pattern "\fBfoo*bar\fR" matches "\fBfooasdfbar\fR" and "\fBfoo/bar/baz/asdf\fR" but not "\fBfoobarx\fR"\&.
500 \-\-skip\-to=<file>, \-\-rotate\-to=<file>
501 .RS 4
502 Discard the files before the named <file> from the output (i\&.e\&.
503 \fIskip to\fR), or move them to the end of the output (i\&.e\&.
504 \fIrotate to\fR)\&. These were invented primarily for use of the
505 \fBgit difftool\fR
506 command, and may not be very useful otherwise\&.
509 \-\-relative[=<path>], \-\-no\-relative
510 .RS 4
511 When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option\&. When you are not in a subdirectory (e\&.g\&. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument\&.
512 \fB\-\-no\-relative\fR
513 can be used to countermand both
514 \fBdiff\&.relative\fR
515 config option and previous
516 \fB\-\-relative\fR\&.
519 \-a, \-\-text
520 .RS 4
521 Treat all files as text\&.
524 \-\-ignore\-cr\-at\-eol
525 .RS 4
526 Ignore carriage\-return at the end of line when doing a comparison\&.
529 \-\-ignore\-space\-at\-eol
530 .RS 4
531 Ignore changes in whitespace at EOL\&.
534 \-b, \-\-ignore\-space\-change
535 .RS 4
536 Ignore changes in amount of whitespace\&. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent\&.
539 \-w, \-\-ignore\-all\-space
540 .RS 4
541 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
544 \-\-ignore\-blank\-lines
545 .RS 4
546 Ignore changes whose lines are all blank\&.
549 \-I<regex>, \-\-ignore\-matching\-lines=<regex>
550 .RS 4
551 Ignore changes whose all lines match <regex>\&. This option may be specified more than once\&.
554 \-\-inter\-hunk\-context=<lines>
555 .RS 4
556 Show the context between diff hunks, up to the specified number of lines, thereby fusing hunks that are close to each other\&. Defaults to
557 \fBdiff\&.interHunkContext\fR
558 or 0 if the config option is unset\&.
561 \-W, \-\-function\-context
562 .RS 4
563 Show whole function as context lines for each change\&. The function names are determined in the same way as
564 \fBgit diff\fR
565 works out patch hunk headers (see
566 \fIDefining a custom hunk\-header\fR
568 \fBgitattributes\fR(5))\&.
571 \-\-ext\-diff
572 .RS 4
573 Allow an external diff helper to be executed\&. If you set an external diff driver with
574 \fBgitattributes\fR(5), you need to use this option with
575 \fBgit-log\fR(1)
576 and friends\&.
579 \-\-no\-ext\-diff
580 .RS 4
581 Disallow external diff drivers\&.
584 \-\-textconv, \-\-no\-textconv
585 .RS 4
586 Allow (or disallow) external text conversion filters to be run when comparing binary files\&. See
587 \fBgitattributes\fR(5)
588 for details\&. Because textconv filters are typically a one\-way conversion, the resulting diff is suitable for human consumption, but cannot be applied\&. For this reason, textconv filters are enabled by default only for
589 \fBgit-diff\fR(1)
591 \fBgit-log\fR(1), but not for
592 \fBgit-format-patch\fR(1)
593 or diff plumbing commands\&.
596 \-\-ignore\-submodules[=<when>]
597 .RS 4
598 Ignore changes to submodules in the diff generation\&. <when> can be either "none", "untracked", "dirty" or "all", which is the default\&. Using "none" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the
599 \fIignore\fR
600 option in
601 \fBgit-config\fR(1)
603 \fBgitmodules\fR(5)\&. When "untracked" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content)\&. Using "dirty" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior until 1\&.7\&.0)\&. Using "all" hides all changes to submodules\&.
606 \-\-src\-prefix=<prefix>
607 .RS 4
608 Show the given source prefix instead of "a/"\&.
611 \-\-dst\-prefix=<prefix>
612 .RS 4
613 Show the given destination prefix instead of "b/"\&.
616 \-\-no\-prefix
617 .RS 4
618 Do not show any source or destination prefix\&.
621 \-\-line\-prefix=<prefix>
622 .RS 4
623 Prepend an additional prefix to every line of output\&.
626 \-\-ita\-invisible\-in\-index
627 .RS 4
628 By default entries added by "git add \-N" appear as an existing empty file in "git diff" and a new file in "git diff \-\-cached"\&. This option makes the entry appear as a new file in "git diff" and non\-existent in "git diff \-\-cached"\&. This option could be reverted with
629 \fB\-\-ita\-visible\-in\-index\fR\&. Both options are experimental and could be removed in future\&.
632 For more detailed explanation on these common options, see also \fBgitdiffcore\fR(7)\&.
634 \-<n>
635 .RS 4
636 Prepare patches from the topmost <n> commits\&.
639 \-o <dir>, \-\-output\-directory <dir>
640 .RS 4
641 Use <dir> to store the resulting files, instead of the current working directory\&.
644 \-n, \-\-numbered
645 .RS 4
646 Name output in
647 \fI[PATCH n/m]\fR
648 format, even with a single patch\&.
651 \-N, \-\-no\-numbered
652 .RS 4
653 Name output in
654 \fI[PATCH]\fR
655 format\&.
658 \-\-start\-number <n>
659 .RS 4
660 Start numbering the patches at <n> instead of 1\&.
663 \-\-numbered\-files
664 .RS 4
665 Output file names will be a simple number sequence without the default first line of the commit appended\&.
668 \-k, \-\-keep\-subject
669 .RS 4
670 Do not strip/add
671 \fI[PATCH]\fR
672 from the first line of the commit log message\&.
675 \-s, \-\-signoff
676 .RS 4
677 Add a
678 \fBSigned\-off\-by\fR
679 trailer to the commit message, using the committer identity of yourself\&. See the signoff option in
680 \fBgit-commit\fR(1)
681 for more information\&.
684 \-\-stdout
685 .RS 4
686 Print all commits to the standard output in mbox format, instead of creating a file for each one\&.
689 \-\-attach[=<boundary>]
690 .RS 4
691 Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the second part, with
692 \fBContent\-Disposition: attachment\fR\&.
695 \-\-no\-attach
696 .RS 4
697 Disable the creation of an attachment, overriding the configuration setting\&.
700 \-\-inline[=<boundary>]
701 .RS 4
702 Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the second part, with
703 \fBContent\-Disposition: inline\fR\&.
706 \-\-thread[=<style>], \-\-no\-thread
707 .RS 4
708 Controls addition of
709 \fBIn\-Reply\-To\fR
711 \fBReferences\fR
712 headers to make the second and subsequent mails appear as replies to the first\&. Also controls generation of the
713 \fBMessage\-Id\fR
714 header to reference\&.
716 The optional <style> argument can be either
717 \fBshallow\fR
719 \fBdeep\fR\&.
720 \fIshallow\fR
721 threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the
722 \fB\-\-in\-reply\-to\fR, and the first patch mail, in this order\&.
723 \fIdeep\fR
724 threading makes every mail a reply to the previous one\&.
726 The default is
727 \fB\-\-no\-thread\fR, unless the
728 \fBformat\&.thread\fR
729 configuration is set\&. If
730 \fB\-\-thread\fR
731 is specified without a style, it defaults to the style specified by
732 \fBformat\&.thread\fR
733 if any, or else
734 \fBshallow\fR\&.
736 Beware that the default for
737 \fIgit send\-email\fR
738 is to thread emails itself\&. If you want
739 \fBgit format\-patch\fR
740 to take care of threading, you will want to ensure that threading is disabled for
741 \fBgit send\-email\fR\&.
744 \-\-in\-reply\-to=<message id>
745 .RS 4
746 Make the first mail (or all the mails with
747 \fB\-\-no\-thread\fR) appear as a reply to the given <message id>, which avoids breaking threads to provide a new patch series\&.
750 \-\-ignore\-if\-in\-upstream
751 .RS 4
752 Do not include a patch that matches a commit in <until>\&.\&.<since>\&. This will examine all patches reachable from <since> but not from <until> and compare them with the patches being generated, and any patch that matches is ignored\&.
755 \-\-always
756 .RS 4
757 Include patches for commits that do not introduce any change, which are omitted by default\&.
760 \-\-cover\-from\-description=<mode>
761 .RS 4
762 Controls which parts of the cover letter will be automatically populated using the branch\(cqs description\&.
765 \fB<mode>\fR
767 \fBmessage\fR
769 \fBdefault\fR, the cover letter subject will be populated with placeholder text\&. The body of the cover letter will be populated with the branch\(cqs description\&. This is the default mode when no configuration nor command line option is specified\&.
772 \fB<mode>\fR
774 \fBsubject\fR, the first paragraph of the branch description will populate the cover letter subject\&. The remainder of the description will populate the body of the cover letter\&.
777 \fB<mode>\fR
779 \fBauto\fR, if the first paragraph of the branch description is greater than 100 bytes, then the mode will be
780 \fBmessage\fR, otherwise
781 \fBsubject\fR
782 will be used\&.
785 \fB<mode>\fR
787 \fBnone\fR, both the cover letter subject and body will be populated with placeholder text\&.
790 \-\-subject\-prefix=<subject prefix>
791 .RS 4
792 Instead of the standard
793 \fI[PATCH]\fR
794 prefix in the subject line, instead use
795 \fI[<subject prefix>]\fR\&. This allows for useful naming of a patch series, and can be combined with the
796 \fB\-\-numbered\fR
797 option\&.
800 \-\-filename\-max\-length=<n>
801 .RS 4
802 Instead of the standard 64 bytes, chomp the generated output filenames at around
803 \fI<n>\fR
804 bytes (too short a value will be silently raised to a reasonable length)\&. Defaults to the value of the
805 \fBformat\&.filenameMaxLength\fR
806 configuration variable, or 64 if unconfigured\&.
809 \-\-rfc
810 .RS 4
811 Alias for
812 \fB\-\-subject\-prefix="RFC PATCH"\fR\&. RFC means "Request For Comments"; use this when sending an experimental patch for discussion rather than application\&.
815 \-v <n>, \-\-reroll\-count=<n>
816 .RS 4
817 Mark the series as the <n>\-th iteration of the topic\&. The output filenames have
818 \fBv<n>\fR
819 prepended to them, and the subject prefix ("PATCH" by default, but configurable via the
820 \fB\-\-subject\-prefix\fR
821 option) has ` v<n>` appended to it\&. E\&.g\&.
822 \fB\-\-reroll\-count=4\fR
823 may produce
824 \fBv4\-0001\-add\-makefile\&.patch\fR
825 file that has "Subject: [PATCH v4 1/20] Add makefile" in it\&.
826 \fB<n>\fR
827 does not have to be an integer (e\&.g\&. "\-\-reroll\-count=4\&.4", or "\-\-reroll\-count=4rev2" are allowed), but the downside of using such a reroll\-count is that the range\-diff/interdiff with the previous version does not state exactly which version the new interation is compared against\&.
830 \-\-to=<email>
831 .RS 4
832 Add a
833 \fBTo:\fR
834 header to the email headers\&. This is in addition to any configured headers, and may be used multiple times\&. The negated form
835 \fB\-\-no\-to\fR
836 discards all
837 \fBTo:\fR
838 headers added so far (from config or command line)\&.
841 \-\-cc=<email>
842 .RS 4
843 Add a
844 \fBCc:\fR
845 header to the email headers\&. This is in addition to any configured headers, and may be used multiple times\&. The negated form
846 \fB\-\-no\-cc\fR
847 discards all
848 \fBCc:\fR
849 headers added so far (from config or command line)\&.
852 \-\-from, \-\-from=<ident>
853 .RS 4
855 \fBident\fR
856 in the
857 \fBFrom:\fR
858 header of each commit email\&. If the author ident of the commit is not textually identical to the provided
859 \fBident\fR, place a
860 \fBFrom:\fR
861 header in the body of the message with the original author\&. If no
862 \fBident\fR
863 is given, use the committer ident\&.
865 Note that this option is only useful if you are actually sending the emails and want to identify yourself as the sender, but retain the original author (and
866 \fBgit am\fR
867 will correctly pick up the in\-body header)\&. Note also that
868 \fBgit send\-email\fR
869 already handles this transformation for you, and this option should not be used if you are feeding the result to
870 \fBgit send\-email\fR\&.
873 \-\-add\-header=<header>
874 .RS 4
875 Add an arbitrary header to the email headers\&. This is in addition to any configured headers, and may be used multiple times\&. For example,
876 \fB\-\-add\-header="Organization: git\-foo"\fR\&. The negated form
877 \fB\-\-no\-add\-header\fR
878 discards
879 \fBall\fR
880 (\fBTo:\fR,
881 \fBCc:\fR, and custom) headers added so far from config or command line\&.
884 \-\-[no\-]cover\-letter
885 .RS 4
886 In addition to the patches, generate a cover letter file containing the branch description, shortlog and the overall diffstat\&. You can fill in a description in the file before sending it out\&.
889 \-\-encode\-email\-headers, \-\-no\-encode\-email\-headers
890 .RS 4
891 Encode email headers that have non\-ASCII characters with "Q\-encoding" (described in RFC 2047), instead of outputting the headers verbatim\&. Defaults to the value of the
892 \fBformat\&.encodeEmailHeaders\fR
893 configuration variable\&.
896 \-\-interdiff=<previous>
897 .RS 4
898 As a reviewer aid, insert an interdiff into the cover letter, or as commentary of the lone patch of a 1\-patch series, showing the differences between the previous version of the patch series and the series currently being formatted\&.
899 \fBprevious\fR
900 is a single revision naming the tip of the previous series which shares a common base with the series being formatted (for example
901 \fBgit format\-patch \-\-cover\-letter \-\-interdiff=feature/v1 \-3 feature/v2\fR)\&.
904 \-\-range\-diff=<previous>
905 .RS 4
906 As a reviewer aid, insert a range\-diff (see
907 \fBgit-range-diff\fR(1)) into the cover letter, or as commentary of the lone patch of a 1\-patch series, showing the differences between the previous version of the patch series and the series currently being formatted\&.
908 \fBprevious\fR
909 can be a single revision naming the tip of the previous series if it shares a common base with the series being formatted (for example
910 \fBgit format\-patch \-\-cover\-letter \-\-range\-diff=feature/v1 \-3 feature/v2\fR), or a revision range if the two versions of the series are disjoint (for example
911 \fBgit format\-patch \-\-cover\-letter \-\-range\-diff=feature/v1~3\&.\&.feature/v1 \-3 feature/v2\fR)\&.
913 Note that diff options passed to the command affect how the primary product of
914 \fBformat\-patch\fR
915 is generated, and they are not passed to the underlying
916 \fBrange\-diff\fR
917 machinery used to generate the cover\-letter material (this may change in the future)\&.
920 \-\-creation\-factor=<percent>
921 .RS 4
922 Used with
923 \fB\-\-range\-diff\fR, tweak the heuristic which matches up commits between the previous and current series of patches by adjusting the creation/deletion cost fudge factor\&. See
924 \fBgit-range-diff\fR(1)) for details\&.
927 \-\-notes[=<ref>], \-\-no\-notes
928 .RS 4
929 Append the notes (see
930 \fBgit-notes\fR(1)) for the commit after the three\-dash line\&.
932 The expected use case of this is to write supporting explanation for the commit that does not belong to the commit log message proper, and include it with the patch submission\&. While one can simply write these explanations after
933 \fBformat\-patch\fR
934 has run but before sending, keeping them as Git notes allows them to be maintained between versions of the patch series (but see the discussion of the
935 \fBnotes\&.rewrite\fR
936 configuration options in
937 \fBgit-notes\fR(1)
938 to use this workflow)\&.
940 The default is
941 \fB\-\-no\-notes\fR, unless the
942 \fBformat\&.notes\fR
943 configuration is set\&.
946 \-\-[no\-]signature=<signature>
947 .RS 4
948 Add a signature to each message produced\&. Per RFC 3676 the signature is separated from the body by a line with \(aq\-\- \(aq on it\&. If the signature option is omitted the signature defaults to the Git version number\&.
951 \-\-signature\-file=<file>
952 .RS 4
953 Works just like \-\-signature except the signature is read from a file\&.
956 \-\-suffix=\&.<sfx>
957 .RS 4
958 Instead of using
959 \fB\&.patch\fR
960 as the suffix for generated filenames, use specified suffix\&. A common alternative is
961 \fB\-\-suffix=\&.txt\fR\&. Leaving this empty will remove the
962 \fB\&.patch\fR
963 suffix\&.
965 Note that the leading character does not have to be a dot; for example, you can use
966 \fB\-\-suffix=\-patch\fR
967 to get
968 \fB0001\-description\-of\-my\-change\-patch\fR\&.
971 \-q, \-\-quiet
972 .RS 4
973 Do not print the names of the generated files to standard output\&.
976 \-\-no\-binary
977 .RS 4
978 Do not output contents of changes in binary files, instead display a notice that those files changed\&. Patches generated using this option cannot be applied properly, but they are still useful for code review\&.
981 \-\-zero\-commit
982 .RS 4
983 Output an all\-zero hash in each patch\(cqs From header instead of the hash of the commit\&.
986 \-\-[no\-]base[=<commit>]
987 .RS 4
988 Record the base tree information to identify the state the patch series applies to\&. See the BASE TREE INFORMATION section below for details\&. If <commit> is "auto", a base commit is automatically chosen\&. The
989 \fB\-\-no\-base\fR
990 option overrides a
991 \fBformat\&.useAutoBase\fR
992 configuration\&.
995 \-\-root
996 .RS 4
997 Treat the revision argument as a <revision range>, even if it is just a single commit (that would normally be treated as a <since>)\&. Note that root commits included in the specified range are always formatted as creation patches, independently of this flag\&.
1000 \-\-progress
1001 .RS 4
1002 Show progress reports on stderr as patches are generated\&.
1004 .SH "CONFIGURATION"
1006 You can specify extra mail header lines to be added to each message, defaults for the subject prefix and file suffix, number patches when outputting more than one patch, add "To:" or "Cc:" headers, configure attachments, change the patch output directory, and sign off patches with configuration variables\&.
1008 .if n \{\
1009 .RS 4
1012 [format]
1013         headers = "Organization: git\-foo\en"
1014         subjectPrefix = CHANGE
1015         suffix = \&.txt
1016         numbered = auto
1017         to = <email>
1018         cc = <email>
1019         attach [ = mime\-boundary\-string ]
1020         signOff = true
1021         outputDirectory = <directory>
1022         coverLetter = auto
1023         coverFromDescription = auto
1025 .if n \{\
1029 .SH "DISCUSSION"
1031 The patch produced by \fIgit format\-patch\fR is in UNIX mailbox format, with a fixed "magic" time stamp to indicate that the file is output from format\-patch rather than a real mailbox, like so:
1033 .if n \{\
1034 .RS 4
1037 From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001
1038 From: Tony Luck <tony\&.luck@intel\&.com>
1039 Date: Tue, 13 Jul 2010 11:42:54 \-0700
1040 Subject: [PATCH] =?UTF\-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?=
1041  =?UTF\-8?q?Uwe=20Kleine\-K=C3=B6nig=20diet?=
1042 MIME\-Version: 1\&.0
1043 Content\-Type: text/plain; charset=UTF\-8
1044 Content\-Transfer\-Encoding: 8bit
1046 arch/arm config files were slimmed down using a python script
1047 (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment)
1049 Do the same for ia64 so we can have sleek & trim looking
1050 \&.\&.\&.
1052 .if n \{\
1057 Typically it will be placed in a MUA\(cqs drafts folder, edited to add timely commentary that should not go in the changelog after the three dashes, and then sent as a message whose body, in our example, starts with "arch/arm config files were\&..."\&. On the receiving end, readers can save interesting patches in a UNIX mailbox and apply them with \fBgit-am\fR(1)\&.
1059 When a patch is part of an ongoing discussion, the patch generated by \fIgit format\-patch\fR can be tweaked to take advantage of the \fIgit am \-\-scissors\fR feature\&. After your response to the discussion comes a line that consists solely of "\fB\-\- >8 \-\-\fR" (scissors and perforation), followed by the patch with unnecessary header fields removed:
1061 .if n \{\
1062 .RS 4
1065 \&.\&.\&.
1066 > So we should do such\-and\-such\&.
1068 Makes sense to me\&.  How about this patch?
1070 \-\- >8 \-\-
1071 Subject: [IA64] Put ia64 config files on the Uwe Kleine\-K\(:onig diet
1073 arch/arm config files were slimmed down using a python script
1074 \&.\&.\&.
1076 .if n \{\
1081 When sending a patch this way, most often you are sending your own patch, so in addition to the "\fBFrom $SHA1 $magic_timestamp\fR" marker you should omit \fBFrom:\fR and \fBDate:\fR lines from the patch file\&. The patch title is likely to be different from the subject of the discussion the patch is in response to, so it is likely that you would want to keep the Subject: line, like the example above\&.
1082 .SS "Checking for patch corruption"
1084 Many mailers if not set up properly will corrupt whitespace\&. Here are two common types of corruption:
1086 .RS 4
1087 .ie n \{\
1088 \h'-04'\(bu\h'+03'\c
1090 .el \{\
1091 .sp -1
1092 .IP \(bu 2.3
1094 Empty context lines that do not have
1095 \fIany\fR
1096 whitespace\&.
1099 .RS 4
1100 .ie n \{\
1101 \h'-04'\(bu\h'+03'\c
1103 .el \{\
1104 .sp -1
1105 .IP \(bu 2.3
1107 Non\-empty context lines that have one extra whitespace at the beginning\&.
1110 One way to test if your MUA is set up correctly is:
1112 .RS 4
1113 .ie n \{\
1114 \h'-04'\(bu\h'+03'\c
1116 .el \{\
1117 .sp -1
1118 .IP \(bu 2.3
1120 Send the patch to yourself, exactly the way you would, except with To: and Cc: lines that do not contain the list and maintainer address\&.
1123 .RS 4
1124 .ie n \{\
1125 \h'-04'\(bu\h'+03'\c
1127 .el \{\
1128 .sp -1
1129 .IP \(bu 2.3
1131 Save that patch to a file in UNIX mailbox format\&. Call it a\&.patch, say\&.
1134 .RS 4
1135 .ie n \{\
1136 \h'-04'\(bu\h'+03'\c
1138 .el \{\
1139 .sp -1
1140 .IP \(bu 2.3
1142 Apply it:
1144 .if n \{\
1145 .RS 4
1148 $ git fetch <project> master:test\-apply
1149 $ git switch test\-apply
1150 $ git restore \-\-source=HEAD \-\-staged \-\-worktree :/
1151 $ git am a\&.patch
1153 .if n \{\
1158 If it does not apply correctly, there can be various reasons\&.
1160 .RS 4
1161 .ie n \{\
1162 \h'-04'\(bu\h'+03'\c
1164 .el \{\
1165 .sp -1
1166 .IP \(bu 2.3
1168 The patch itself does not apply cleanly\&. That is
1169 \fIbad\fR
1170 but does not have much to do with your MUA\&. You might want to rebase the patch with
1171 \fBgit-rebase\fR(1)
1172 before regenerating it in this case\&.
1175 .RS 4
1176 .ie n \{\
1177 \h'-04'\(bu\h'+03'\c
1179 .el \{\
1180 .sp -1
1181 .IP \(bu 2.3
1183 The MUA corrupted your patch; "am" would complain that the patch does not apply\&. Look in the \&.git/rebase\-apply/ subdirectory and see what
1184 \fIpatch\fR
1185 file contains and check for the common corruption patterns mentioned above\&.
1188 .RS 4
1189 .ie n \{\
1190 \h'-04'\(bu\h'+03'\c
1192 .el \{\
1193 .sp -1
1194 .IP \(bu 2.3
1196 While at it, check the
1197 \fIinfo\fR
1199 \fIfinal\-commit\fR
1200 files as well\&. If what is in
1201 \fIfinal\-commit\fR
1202 is not exactly what you would want to see in the commit log message, it is very likely that the receiver would end up hand editing the log message when applying your patch\&. Things like "Hi, this is my first patch\&.\en" in the patch e\-mail should come after the three\-dash line that signals the end of the commit message\&.
1204 .SH "MUA\-SPECIFIC HINTS"
1206 Here are some hints on how to successfully submit patches inline using various mailers\&.
1207 .SS "GMail"
1209 GMail does not have any way to turn off line wrapping in the web interface, so it will mangle any emails that you send\&. You can however use "git send\-email" and send your patches through the GMail SMTP server, or use any IMAP email client to connect to the google IMAP server and forward the emails through that\&.
1211 For hints on using \fIgit send\-email\fR to send your patches through the GMail SMTP server, see the EXAMPLE section of \fBgit-send-email\fR(1)\&.
1213 For hints on submission using the IMAP interface, see the EXAMPLE section of \fBgit-imap-send\fR(1)\&.
1214 .SS "Thunderbird"
1216 By default, Thunderbird will both wrap emails as well as flag them as being \fIformat=flowed\fR, both of which will make the resulting email unusable by Git\&.
1218 There are three different approaches: use an add\-on to turn off line wraps, configure Thunderbird to not mangle patches, or use an external editor to keep Thunderbird from mangling the patches\&.
1220 .it 1 an-trap
1221 .nr an-no-space-flag 1
1222 .nr an-break-flag 1
1224 .ps +1
1225 \fBApproach #1 (add-on)\fR
1226 .RS 4
1228 Install the Toggle Word Wrap add\-on that is available from \m[blue]\fBhttps://addons\&.mozilla\&.org/thunderbird/addon/toggle\-word\-wrap/\fR\m[] It adds a menu entry "Enable Word Wrap" in the composer\(cqs "Options" menu that you can tick off\&. Now you can compose the message as you otherwise do (cut + paste, \fIgit format\-patch\fR | \fIgit imap\-send\fR, etc), but you have to insert line breaks manually in any text that you type\&.
1231 .it 1 an-trap
1232 .nr an-no-space-flag 1
1233 .nr an-break-flag 1
1235 .ps +1
1236 \fBApproach #2 (configuration)\fR
1237 .RS 4
1239 Three steps:
1241 .RS 4
1242 .ie n \{\
1243 \h'-04' 1.\h'+01'\c
1245 .el \{\
1246 .sp -1
1247 .IP "  1." 4.2
1249 Configure your mail server composition as plain text: Edit\&...Account Settings\&...Composition & Addressing, uncheck "Compose Messages in HTML"\&.
1252 .RS 4
1253 .ie n \{\
1254 \h'-04' 2.\h'+01'\c
1256 .el \{\
1257 .sp -1
1258 .IP "  2." 4.2
1260 Configure your general composition window to not wrap\&.
1262 In Thunderbird 2: Edit\&.\&.Preferences\&.\&.Composition, wrap plain text messages at 0
1264 In Thunderbird 3: Edit\&.\&.Preferences\&.\&.Advanced\&.\&.Config Editor\&. Search for "mail\&.wrap_long_lines"\&. Toggle it to make sure it is set to
1265 \fBfalse\fR\&. Also, search for "mailnews\&.wraplength" and set the value to 0\&.
1268 .RS 4
1269 .ie n \{\
1270 \h'-04' 3.\h'+01'\c
1272 .el \{\
1273 .sp -1
1274 .IP "  3." 4.2
1276 Disable the use of format=flowed: Edit\&.\&.Preferences\&.\&.Advanced\&.\&.Config Editor\&. Search for "mailnews\&.send_plaintext_flowed"\&. Toggle it to make sure it is set to
1277 \fBfalse\fR\&.
1280 After that is done, you should be able to compose email as you otherwise would (cut + paste, \fIgit format\-patch\fR | \fIgit imap\-send\fR, etc), and the patches will not be mangled\&.
1283 .it 1 an-trap
1284 .nr an-no-space-flag 1
1285 .nr an-break-flag 1
1287 .ps +1
1288 \fBApproach #3 (external editor)\fR
1289 .RS 4
1291 The following Thunderbird extensions are needed: AboutConfig from \m[blue]\fBhttp://aboutconfig\&.mozdev\&.org/\fR\m[] and External Editor from \m[blue]\fBhttp://globs\&.org/articles\&.php?lng=en&pg=8\fR\m[]
1293 .RS 4
1294 .ie n \{\
1295 \h'-04' 1.\h'+01'\c
1297 .el \{\
1298 .sp -1
1299 .IP "  1." 4.2
1301 Prepare the patch as a text file using your method of choice\&.
1304 .RS 4
1305 .ie n \{\
1306 \h'-04' 2.\h'+01'\c
1308 .el \{\
1309 .sp -1
1310 .IP "  2." 4.2
1312 Before opening a compose window, use Edit\(->Account Settings to uncheck the "Compose messages in HTML format" setting in the "Composition & Addressing" panel of the account to be used to send the patch\&.
1315 .RS 4
1316 .ie n \{\
1317 \h'-04' 3.\h'+01'\c
1319 .el \{\
1320 .sp -1
1321 .IP "  3." 4.2
1323 In the main Thunderbird window,
1324 \fIbefore\fR
1325 you open the compose window for the patch, use Tools\(->about:config to set the following to the indicated values:
1327 .if n \{\
1328 .RS 4
1331         mailnews\&.send_plaintext_flowed  => false
1332         mailnews\&.wraplength             => 0
1334 .if n \{\
1340 .RS 4
1341 .ie n \{\
1342 \h'-04' 4.\h'+01'\c
1344 .el \{\
1345 .sp -1
1346 .IP "  4." 4.2
1348 Open a compose window and click the external editor icon\&.
1351 .RS 4
1352 .ie n \{\
1353 \h'-04' 5.\h'+01'\c
1355 .el \{\
1356 .sp -1
1357 .IP "  5." 4.2
1359 In the external editor window, read in the patch file and exit the editor normally\&.
1362 Side note: it may be possible to do step 2 with about:config and the following settings but no one\(cqs tried yet\&.
1364 .if n \{\
1365 .RS 4
1368         mail\&.html_compose                       => false
1369         mail\&.identity\&.default\&.compose_html      => false
1370         mail\&.identity\&.id?\&.compose_html          => false
1372 .if n \{\
1377 There is a script in contrib/thunderbird\-patch\-inline which can help you include patches with Thunderbird in an easy way\&. To use it, do the steps above and then use the script as the external editor\&.
1379 .SS "KMail"
1381 This should help you to submit patches inline using KMail\&.
1383 .RS 4
1384 .ie n \{\
1385 \h'-04' 1.\h'+01'\c
1387 .el \{\
1388 .sp -1
1389 .IP "  1." 4.2
1391 Prepare the patch as a text file\&.
1394 .RS 4
1395 .ie n \{\
1396 \h'-04' 2.\h'+01'\c
1398 .el \{\
1399 .sp -1
1400 .IP "  2." 4.2
1402 Click on New Mail\&.
1405 .RS 4
1406 .ie n \{\
1407 \h'-04' 3.\h'+01'\c
1409 .el \{\
1410 .sp -1
1411 .IP "  3." 4.2
1413 Go under "Options" in the Composer window and be sure that "Word wrap" is not set\&.
1416 .RS 4
1417 .ie n \{\
1418 \h'-04' 4.\h'+01'\c
1420 .el \{\
1421 .sp -1
1422 .IP "  4." 4.2
1424 Use Message \(-> Insert file\&... and insert the patch\&.
1427 .RS 4
1428 .ie n \{\
1429 \h'-04' 5.\h'+01'\c
1431 .el \{\
1432 .sp -1
1433 .IP "  5." 4.2
1435 Back in the compose window: add whatever other text you wish to the message, complete the addressing and subject fields, and press send\&.
1437 .SH "BASE TREE INFORMATION"
1439 The base tree information block is used for maintainers or third party testers to know the exact state the patch series applies to\&. It consists of the \fIbase commit\fR, which is a well\-known commit that is part of the stable part of the project history everybody else works off of, and zero or more \fIprerequisite patches\fR, which are well\-known patches in flight that is not yet part of the \fIbase commit\fR that need to be applied on top of \fIbase commit\fR in topological order before the patches can be applied\&.
1441 The \fIbase commit\fR is shown as "base\-commit: " followed by the 40\-hex of the commit object name\&. A \fIprerequisite patch\fR is shown as "prerequisite\-patch\-id: " followed by the 40\-hex \fIpatch id\fR, which can be obtained by passing the patch through the \fBgit patch\-id \-\-stable\fR command\&.
1443 Imagine that on top of the public commit P, you applied well\-known patches X, Y and Z from somebody else, and then built your three\-patch series A, B, C, the history would be like:
1445 .if n \{\
1446 .RS 4
1449 \-\-\-P\-\-\-X\-\-\-Y\-\-\-Z\-\-\-A\-\-\-B\-\-\-C
1451 .if n \{\
1455 With \fBgit format\-patch \-\-base=P \-3 C\fR (or variants thereof, e\&.g\&. with \fB\-\-cover\-letter\fR or using \fBZ\&.\&.C\fR instead of \fB\-3 C\fR to specify the range), the base tree information block is shown at the end of the first message the command outputs (either the first patch, or the cover letter), like this:
1457 .if n \{\
1458 .RS 4
1461 base\-commit: P
1462 prerequisite\-patch\-id: X
1463 prerequisite\-patch\-id: Y
1464 prerequisite\-patch\-id: Z
1466 .if n \{\
1471 For non\-linear topology, such as
1473 .if n \{\
1474 .RS 4
1477 \-\-\-P\-\-\-X\-\-\-A\-\-\-M\-\-\-C
1478     \e         /
1479      Y\-\-\-Z\-\-\-B
1481 .if n \{\
1485 You can also use \fBgit format\-patch \-\-base=P \-3 C\fR to generate patches for A, B and C, and the identifiers for P, X, Y, Z are appended at the end of the first message\&.
1487 If set \fB\-\-base=auto\fR in cmdline, it will automatically compute the base commit as the merge base of tip commit of the remote\-tracking branch and revision\-range specified in cmdline\&. For a local branch, you need to make it to track a remote branch by \fBgit branch \-\-set\-upstream\-to\fR before using this option\&.
1488 .SH "EXAMPLES"
1490 .RS 4
1491 .ie n \{\
1492 \h'-04'\(bu\h'+03'\c
1494 .el \{\
1495 .sp -1
1496 .IP \(bu 2.3
1498 Extract commits between revisions R1 and R2, and apply them on top of the current branch using
1499 \fIgit am\fR
1500 to cherry\-pick them:
1502 .if n \{\
1503 .RS 4
1506 $ git format\-patch \-k \-\-stdout R1\&.\&.R2 | git am \-3 \-k
1508 .if n \{\
1514 .RS 4
1515 .ie n \{\
1516 \h'-04'\(bu\h'+03'\c
1518 .el \{\
1519 .sp -1
1520 .IP \(bu 2.3
1522 Extract all commits which are in the current branch but not in the origin branch:
1524 .if n \{\
1525 .RS 4
1528 $ git format\-patch origin
1530 .if n \{\
1534 For each commit a separate file is created in the current directory\&.
1537 .RS 4
1538 .ie n \{\
1539 \h'-04'\(bu\h'+03'\c
1541 .el \{\
1542 .sp -1
1543 .IP \(bu 2.3
1545 Extract all commits that lead to
1546 \fIorigin\fR
1547 since the inception of the project:
1549 .if n \{\
1550 .RS 4
1553 $ git format\-patch \-\-root origin
1555 .if n \{\
1561 .RS 4
1562 .ie n \{\
1563 \h'-04'\(bu\h'+03'\c
1565 .el \{\
1566 .sp -1
1567 .IP \(bu 2.3
1569 The same as the previous one:
1571 .if n \{\
1572 .RS 4
1575 $ git format\-patch \-M \-B origin
1577 .if n \{\
1581 Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch\&. A renaming patch reduces the amount of text output, and generally makes it easier to review\&. Note that non\-Git "patch" programs won\(cqt understand renaming patches, so use it only when you know the recipient uses Git to apply your patch\&.
1584 .RS 4
1585 .ie n \{\
1586 \h'-04'\(bu\h'+03'\c
1588 .el \{\
1589 .sp -1
1590 .IP \(bu 2.3
1592 Extract three topmost commits from the current branch and format them as e\-mailable patches:
1594 .if n \{\
1595 .RS 4
1598 $ git format\-patch \-3
1600 .if n \{\
1605 .SH "CAVEATS"
1607 Note that \fBformat\-patch\fR will omit merge commits from the output, even if they are part of the requested range\&. A simple "patch" does not include enough information for the receiving end to reproduce the same merge commit\&.
1608 .SH "SEE ALSO"
1610 \fBgit-am\fR(1), \fBgit-send-email\fR(1)
1611 .SH "GIT"
1613 Part of the \fBgit\fR(1) suite