2005-09-08 00:26:23 +00:00
|
|
|
git-format-patch(1)
|
|
|
|
===================
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2006-03-09 16:24:50 +00:00
|
|
|
git-format-patch - Prepare patches for e-mail submission
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2005-12-31 17:37:15 +00:00
|
|
|
[verse]
|
2009-04-23 16:16:52 +00:00
|
|
|
'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]
|
2009-07-22 21:39:31 +00:00
|
|
|
[--no-thread | --thread[=<style>]]
|
2009-04-23 16:16:52 +00:00
|
|
|
[(--attach|--inline)[=<boundary>] | --no-attach]
|
|
|
|
[-s | --signoff]
|
2010-06-16 05:59:25 +00:00
|
|
|
[--signature=<signature> | --no-signature]
|
2014-05-24 04:08:14 +00:00
|
|
|
[--signature-file=<file>]
|
2008-02-19 03:56:13 +00:00
|
|
|
[-n | --numbered | -N | --no-numbered]
|
|
|
|
[--start-number <n>] [--numbered-files]
|
2019-08-27 04:05:17 +00:00
|
|
|
[--in-reply-to=<message id>] [--suffix=.<sfx>]
|
2021-12-09 07:25:53 +00:00
|
|
|
[--ignore-if-in-upstream] [--always]
|
2019-10-15 09:06:40 +00:00
|
|
|
[--cover-from-description=<mode>]
|
2019-08-27 04:05:17 +00:00
|
|
|
[--rfc] [--subject-prefix=<subject prefix>]
|
2016-09-20 04:23:25 +00:00
|
|
|
[(--reroll-count|-v) <n>]
|
2010-02-16 23:39:34 +00:00
|
|
|
[--to=<email>] [--cc=<email>]
|
2019-05-10 18:37:03 +00:00
|
|
|
[--[no-]cover-letter] [--quiet]
|
2020-04-08 04:31:38 +00:00
|
|
|
[--[no-]encode-email-headers]
|
2019-05-10 18:37:03 +00:00
|
|
|
[--no-notes | --notes[=<ref>]]
|
2018-07-22 09:57:05 +00:00
|
|
|
[--interdiff=<previous>]
|
2018-07-22 09:57:16 +00:00
|
|
|
[--range-diff=<previous> [--creation-factor=<percent>]]
|
format-patch: make output filename configurable
For the past 15 years, we've used the hardcoded 64 as the length
limit of the filename of the output from the "git format-patch"
command. Since the value is shorter than the 80-column terminal, it
could grow without line wrapping a bit. At the same time, since the
value is longer than half of the 80-column terminal, we could fit
two or more of them in "ls" output on such a terminal if we allowed
to lower it.
Introduce a new command line option --filename-max-length=<n> and a
new configuration variable format.filenameMaxLength to override the
hardcoded default.
While we are at it, remove a check that the name of output directory
does not exceed PATH_MAX---this check is pointless in that by the
time control reaches the function, the caller would already have
done an equivalent of "mkdir -p", so if the system does not like an
overly long directory name, the control wouldn't have reached here,
and otherwise, we know that the system allowed the output directory
to exist. In the worst case, we will get an error when we try to
open the output file and handle the error correctly anyway.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-11-06 21:56:24 +00:00
|
|
|
[--filename-max-length=<n>]
|
2017-08-10 18:32:55 +00:00
|
|
|
[--progress]
|
2009-04-23 16:16:52 +00:00
|
|
|
[<common diff options>]
|
2007-08-28 07:38:48 +00:00
|
|
|
[ <since> | <revision range> ]
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2006-05-31 14:14:08 +00:00
|
|
|
|
2021-05-01 14:13:24 +00:00
|
|
|
Prepare each non-merge commit with its "patch" in
|
2021-03-24 17:35:40 +00:00
|
|
|
one "message" per commit, formatted to resemble a UNIX mailbox.
|
2006-05-31 14:14:08 +00:00
|
|
|
The output of this command is convenient for e-mail submission or
|
2010-01-09 23:33:00 +00:00
|
|
|
for use with 'git am'.
|
2005-09-08 06:04:52 +00:00
|
|
|
|
2021-03-24 17:35:40 +00:00
|
|
|
A "message" generated by the command consists of three parts:
|
|
|
|
|
|
|
|
* A brief metadata header that begins with `From <commit>`
|
|
|
|
with a fixed `Mon Sep 17 00:00:00 2001` 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).
|
|
|
|
|
|
|
|
* The second and subsequent paragraphs of the commit log message.
|
|
|
|
|
|
|
|
* The "patch", which is the "diff -p --stat" output (see
|
|
|
|
linkgit:git-diff[1]) between the commit and its parent.
|
|
|
|
|
2023-10-08 06:45:09 +00:00
|
|
|
The log message and the patch are separated by a line with a
|
2021-03-24 17:35:40 +00:00
|
|
|
three-dash line.
|
|
|
|
|
2007-08-28 07:38:48 +00:00
|
|
|
There are two ways to specify which commits to operate on.
|
|
|
|
|
|
|
|
1. 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.
|
|
|
|
|
|
|
|
2. Generic <revision range> expression (see "SPECIFYING
|
2010-10-11 16:03:32 +00:00
|
|
|
REVISIONS" section in linkgit:gitrevisions[7]) means the
|
2007-08-29 04:58:53 +00:00
|
|
|
commits in the specified range.
|
|
|
|
|
2009-03-26 17:29:25 +00:00
|
|
|
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
|
2018-04-17 19:15:26 +00:00
|
|
|
history up until <commit>, use the `--root` option: `git format-patch
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
--root <commit>`. If you want to format only <commit> itself, you
|
2009-11-07 09:53:07 +00:00
|
|
|
can do this with `git format-patch -1 <commit>`.
|
2007-08-28 07:38:48 +00:00
|
|
|
|
2007-06-05 20:06:53 +00:00
|
|
|
By default, each output file is numbered sequentially from 1, and uses the
|
2006-05-31 14:14:08 +00:00
|
|
|
first line of the commit message (massaged for pathname safety) as
|
2009-11-07 09:53:07 +00:00
|
|
|
the filename. With the `--numbered-files` option, the output file names
|
2007-06-05 20:06:53 +00:00
|
|
|
will only be numbers, without the first line of the commit appended.
|
|
|
|
The names of the output files are printed to standard
|
2009-11-07 09:53:07 +00:00
|
|
|
output, unless the `--stdout` option is specified.
|
2006-02-07 09:37:54 +00:00
|
|
|
|
2009-11-07 09:53:07 +00:00
|
|
|
If `-o` is specified, output files are created in <dir>. Otherwise
|
2016-01-13 13:20:11 +00:00
|
|
|
they are created in the current working directory. The default path
|
2016-06-08 17:23:16 +00:00
|
|
|
can be set with the `format.outputDirectory` configuration option.
|
2016-01-13 13:20:11 +00:00
|
|
|
The `-o` option takes precedence over `format.outputDirectory`.
|
|
|
|
To store patches in the current working directory even when
|
2019-10-11 08:36:41 +00:00
|
|
|
`format.outputDirectory` points elsewhere, use `-o .`. All directory
|
|
|
|
components will be created.
|
2005-09-08 06:04:52 +00:00
|
|
|
|
2012-09-13 22:27:09 +00:00
|
|
|
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 linkgit:git-commit[1]).
|
|
|
|
|
|
|
|
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 `-n`.
|
|
|
|
To omit patch numbers from the subject, use `-N`.
|
2005-09-08 06:04:52 +00:00
|
|
|
|
2009-11-07 09:53:07 +00:00
|
|
|
If given `--thread`, `git-format-patch` will generate `In-Reply-To` and
|
|
|
|
`References` headers to make the second and subsequent patch mails appear
|
2022-12-16 01:47:19 +00:00
|
|
|
as replies to the first mail; this also generates a `Message-ID` header to
|
2006-07-15 00:49:04 +00:00
|
|
|
reference.
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
-------
|
2007-11-15 13:19:29 +00:00
|
|
|
:git-format-patch: 1
|
2007-03-06 03:27:44 +00:00
|
|
|
include::diff-options.txt[]
|
|
|
|
|
2007-07-03 23:38:29 +00:00
|
|
|
-<n>::
|
2010-08-27 20:28:16 +00:00
|
|
|
Prepare patches from the topmost <n> commits.
|
2007-07-03 23:38:29 +00:00
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-o <dir>::
|
|
|
|
--output-directory <dir>::
|
2005-09-08 06:04:52 +00:00
|
|
|
Use <dir> to store the resulting files, instead of the
|
2006-06-06 15:46:23 +00:00
|
|
|
current working directory.
|
2005-09-08 06:04:52 +00:00
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-n::
|
|
|
|
--numbered::
|
2008-10-02 20:55:39 +00:00
|
|
|
Name output in '[PATCH n/m]' format, even with a single patch.
|
2005-09-08 06:04:52 +00:00
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-N::
|
|
|
|
--no-numbered::
|
2007-11-04 03:38:24 +00:00
|
|
|
Name output in '[PATCH]' format.
|
|
|
|
|
2006-05-31 14:14:08 +00:00
|
|
|
--start-number <n>::
|
|
|
|
Start numbering the patches at <n> instead of 1.
|
|
|
|
|
2007-06-05 20:06:53 +00:00
|
|
|
--numbered-files::
|
|
|
|
Output file names will be a simple number sequence
|
|
|
|
without the default first line of the commit appended.
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-k::
|
|
|
|
--keep-subject::
|
2005-09-08 06:04:52 +00:00
|
|
|
Do not strip/add '[PATCH]' from the first line of the
|
|
|
|
commit log message.
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-s::
|
|
|
|
--signoff::
|
Documentation: stylistically normalize references to Signed-off-by:
Ted reported an old typo in the git-commit.txt and merge-options.txt.
Namely, the phrase "Signed-off-by line" was used without either a
definite nor indefinite article.
Upon examination, it seems that the documentation (including items in
Documentation/, but also option help strings) have been quite
inconsistent on usage when referring to `Signed-off-by`.
First, very few places used a definite or indefinite article with the
phrase "Signed-off-by line", but that was the initial typo that led
to this investigation. So, normalize using either an indefinite or
definite article consistently.
The original phrasing, in Commit 3f971fc425b (Documentation updates,
2005-08-14), is "Add Signed-off-by line". Commit 6f855371a53 (Add
--signoff, --check, and long option-names. 2005-12-09) switched to
using "Add `Signed-off-by:` line", but didn't normalize the former
commit to match. Later commits seem to have cut and pasted from one
or the other, which is likely how the usage became so inconsistent.
Junio stated on the git mailing list in
<xmqqy2k1dfoh.fsf@gitster.c.googlers.com> a preference to leave off
the colon. Thus, prefer `Signed-off-by` (with backticks) for the
documentation files and Signed-off-by (without backticks) for option
help strings.
Additionally, Junio argued that "trailer" is now the standard term to
refer to `Signed-off-by`, saying that "becomes plenty clear that we
are not talking about any random line in the log message". As such,
prefer "trailer" over "line" anywhere the former word fits.
However, leave alone those few places in documentation that use
Signed-off-by to refer to the process (rather than the specific
trailer), or in places where mail headers are generally discussed in
comparison with Signed-off-by.
Reported-by: "Theodore Y. Ts'o" <tytso@mit.edu>
Signed-off-by: Bradley M. Kuhn <bkuhn@sfconservancy.org>
Acked-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-10-20 01:03:55 +00:00
|
|
|
Add a `Signed-off-by` trailer to the commit message, using
|
2005-12-08 23:28:05 +00:00
|
|
|
the committer identity of yourself.
|
2016-01-05 19:20:26 +00:00
|
|
|
See the signoff option in linkgit:git-commit[1] for more information.
|
2005-12-08 23:28:05 +00:00
|
|
|
|
2005-10-06 21:25:52 +00:00
|
|
|
--stdout::
|
2006-05-31 14:14:08 +00:00
|
|
|
Print all commits to the standard output in mbox format,
|
|
|
|
instead of creating a file for each one.
|
2005-08-23 08:49:47 +00:00
|
|
|
|
2007-03-03 23:12:06 +00:00
|
|
|
--attach[=<boundary>]::
|
|
|
|
Create multipart/mixed attachment, the first part of
|
|
|
|
which is the commit message and the patch itself in the
|
2009-11-07 09:53:07 +00:00
|
|
|
second part, with `Content-Disposition: attachment`.
|
2007-03-03 23:12:06 +00:00
|
|
|
|
2009-02-12 15:51:55 +00:00
|
|
|
--no-attach::
|
|
|
|
Disable the creation of an attachment, overriding the
|
|
|
|
configuration setting.
|
|
|
|
|
2007-03-03 23:12:06 +00:00
|
|
|
--inline[=<boundary>]::
|
|
|
|
Create multipart/mixed attachment, the first part of
|
|
|
|
which is the commit message and the patch itself in the
|
2009-11-07 09:53:07 +00:00
|
|
|
second part, with `Content-Disposition: inline`.
|
2006-03-10 04:47:24 +00:00
|
|
|
|
2009-02-19 21:26:33 +00:00
|
|
|
--thread[=<style>]::
|
2009-07-22 21:39:31 +00:00
|
|
|
--no-thread::
|
2009-11-07 09:53:07 +00:00
|
|
|
Controls addition of `In-Reply-To` and `References` headers to
|
2009-07-22 21:39:31 +00:00
|
|
|
make the second and subsequent mails appear as replies to the
|
2022-12-16 01:47:19 +00:00
|
|
|
first. Also controls generation of the `Message-ID` header to
|
2009-07-22 21:39:31 +00:00
|
|
|
reference.
|
2009-02-19 21:26:33 +00:00
|
|
|
+
|
|
|
|
The optional <style> argument can be either `shallow` or `deep`.
|
2009-04-23 09:37:57 +00:00
|
|
|
'shallow' threading makes every mail a reply to the head of the
|
2009-02-19 21:26:33 +00:00
|
|
|
series, where the head is chosen from the cover letter, the
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
`--in-reply-to`, and the first patch mail, in this order. 'deep'
|
2009-07-22 21:39:31 +00:00
|
|
|
threading makes every mail a reply to the previous one.
|
|
|
|
+
|
2016-06-08 17:23:16 +00:00
|
|
|
The default is `--no-thread`, unless the `format.thread` configuration
|
2023-04-03 04:07:24 +00:00
|
|
|
is set. `--thread` without an argument is equivalent to `--thread=shallow`.
|
2009-07-22 21:39:31 +00:00
|
|
|
+
|
|
|
|
Beware that the default for 'git send-email' is to thread emails
|
2009-11-07 09:53:07 +00:00
|
|
|
itself. If you want `git format-patch` to take care of threading, you
|
|
|
|
will want to ensure that threading is disabled for `git send-email`.
|
2005-11-05 10:55:18 +00:00
|
|
|
|
2019-08-27 04:05:17 +00:00
|
|
|
--in-reply-to=<message id>::
|
2009-11-07 09:53:07 +00:00
|
|
|
Make the first mail (or all the mails with `--no-thread`) appear as a
|
2019-08-27 04:05:17 +00:00
|
|
|
reply to the given <message id>, which avoids breaking threads to
|
2006-07-15 00:49:08 +00:00
|
|
|
provide a new patch series.
|
|
|
|
|
2007-01-18 11:27:35 +00:00
|
|
|
--ignore-if-in-upstream::
|
|
|
|
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.
|
|
|
|
|
2021-12-09 07:25:53 +00:00
|
|
|
--always::
|
|
|
|
Include patches for commits that do not introduce any change,
|
|
|
|
which are omitted by default.
|
|
|
|
|
2019-10-15 09:06:40 +00:00
|
|
|
--cover-from-description=<mode>::
|
|
|
|
Controls which parts of the cover letter will be automatically
|
|
|
|
populated using the branch's description.
|
|
|
|
+
|
|
|
|
If `<mode>` is `message` or `default`, the cover letter subject will be
|
|
|
|
populated with placeholder text. The body of the cover letter will be
|
|
|
|
populated with the branch's description. This is the default mode when
|
|
|
|
no configuration nor command line option is specified.
|
|
|
|
+
|
|
|
|
If `<mode>` is `subject`, 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.
|
|
|
|
+
|
|
|
|
If `<mode>` is `auto`, if the first paragraph of the branch description
|
|
|
|
is greater than 100 bytes, then the mode will be `message`, otherwise
|
|
|
|
`subject` will be used.
|
|
|
|
+
|
|
|
|
If `<mode>` is `none`, both the cover letter subject and body will be
|
|
|
|
populated with placeholder text.
|
|
|
|
|
2023-08-21 17:07:20 +00:00
|
|
|
--description-file=<file>::
|
|
|
|
Use the contents of <file> instead of the branch's description
|
|
|
|
for generating the cover letter.
|
|
|
|
|
2019-08-27 04:05:17 +00:00
|
|
|
--subject-prefix=<subject prefix>::
|
2007-04-11 23:58:07 +00:00
|
|
|
Instead of the standard '[PATCH]' prefix in the subject
|
2023-08-30 06:43:33 +00:00
|
|
|
line, instead use '[<subject prefix>]'. This can be used
|
|
|
|
to name a patch series, and can be combined with the
|
|
|
|
`--numbered` option.
|
|
|
|
+
|
|
|
|
The configuration variable `format.subjectPrefix` may also be used
|
|
|
|
to configure a subject prefix to apply to a given repository for
|
|
|
|
all patches. This is often useful on mailing lists which receive
|
|
|
|
patches for several repositories and can be used to disambiguate
|
|
|
|
the patches (with a value of e.g. "PATCH my-project").
|
2007-04-11 23:58:07 +00:00
|
|
|
|
format-patch: make output filename configurable
For the past 15 years, we've used the hardcoded 64 as the length
limit of the filename of the output from the "git format-patch"
command. Since the value is shorter than the 80-column terminal, it
could grow without line wrapping a bit. At the same time, since the
value is longer than half of the 80-column terminal, we could fit
two or more of them in "ls" output on such a terminal if we allowed
to lower it.
Introduce a new command line option --filename-max-length=<n> and a
new configuration variable format.filenameMaxLength to override the
hardcoded default.
While we are at it, remove a check that the name of output directory
does not exceed PATH_MAX---this check is pointless in that by the
time control reaches the function, the caller would already have
done an equivalent of "mkdir -p", so if the system does not like an
overly long directory name, the control wouldn't have reached here,
and otherwise, we know that the system allowed the output directory
to exist. In the worst case, we will get an error when we try to
open the output file and handle the error correctly anyway.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-11-06 21:56:24 +00:00
|
|
|
--filename-max-length=<n>::
|
|
|
|
Instead of the standard 64 bytes, chomp the generated output
|
|
|
|
filenames at around '<n>' bytes (too short a value will be
|
|
|
|
silently raised to a reasonable length). Defaults to the
|
|
|
|
value of the `format.filenameMaxLength` configuration
|
|
|
|
variable, or 64 if unconfigured.
|
|
|
|
|
2016-09-20 04:23:25 +00:00
|
|
|
--rfc::
|
2023-08-30 06:43:33 +00:00
|
|
|
Prepends "RFC" to the subject prefix (producing "RFC PATCH" by
|
|
|
|
default). RFC means "Request For Comments"; use this when sending
|
|
|
|
an experimental patch for discussion rather than application.
|
2016-09-20 04:23:25 +00:00
|
|
|
|
2013-01-02 22:19:05 +00:00
|
|
|
-v <n>::
|
2013-01-02 22:16:07 +00:00
|
|
|
--reroll-count=<n>::
|
|
|
|
Mark the series as the <n>-th iteration of the topic. The
|
2015-06-10 21:01:14 +00:00
|
|
|
output filenames have `v<n>` prepended to them, and the
|
2013-01-02 22:16:07 +00:00
|
|
|
subject prefix ("PATCH" by default, but configurable via the
|
|
|
|
`--subject-prefix` option) has ` v<n>` appended to it. E.g.
|
|
|
|
`--reroll-count=4` may produce `v4-0001-add-makefile.patch`
|
|
|
|
file that has "Subject: [PATCH v4 1/20] Add makefile" in it.
|
2021-03-23 11:12:25 +00:00
|
|
|
`<n>` 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
|
2023-06-07 19:26:47 +00:00
|
|
|
version the new iteration is compared against.
|
2013-01-02 22:16:07 +00:00
|
|
|
|
2010-02-16 23:39:34 +00:00
|
|
|
--to=<email>::
|
|
|
|
Add a `To:` header to the email headers. This is in addition
|
|
|
|
to any configured headers, and may be used multiple times.
|
2011-08-29 20:10:49 +00:00
|
|
|
The negated form `--no-to` discards all `To:` headers added so
|
|
|
|
far (from config or command line).
|
2010-02-16 23:39:34 +00:00
|
|
|
|
2008-02-19 07:40:35 +00:00
|
|
|
--cc=<email>::
|
2009-11-07 09:53:07 +00:00
|
|
|
Add a `Cc:` header to the email headers. This is in addition
|
2008-02-19 07:40:35 +00:00
|
|
|
to any configured headers, and may be used multiple times.
|
2011-08-29 20:10:49 +00:00
|
|
|
The negated form `--no-cc` discards all `Cc:` headers added so
|
|
|
|
far (from config or command line).
|
2008-02-19 07:40:35 +00:00
|
|
|
|
teach format-patch to place other authors into in-body "From"
Format-patch generates emails with the "From" address set to the
author of each patch. If you are going to send the emails, however,
you would want to replace the author identity with yours (if they
are not the same), and bump the author identity to an in-body
header.
Normally this is handled by git-send-email, which does the
transformation before sending out the emails. However, some
workflows may not use send-email (e.g., imap-send, or a custom
script which feeds the mbox to a non-git MUA). They could each
implement this feature themselves, but getting it right is
non-trivial (one must canonicalize the identities by reversing any
RFC2047 encoding or RFC822 quoting of the headers, which has caused
many bugs in send-email over the years).
This patch takes a different approach: it teaches format-patch a
"--from" option which handles the ident check and in-body header
while it is writing out the email. It's much simpler to do at this
level (because we haven't done any quoting yet), and any workflow
based on format-patch can easily turn it on.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-03 07:08:22 +00:00
|
|
|
--from::
|
|
|
|
--from=<ident>::
|
|
|
|
Use `ident` in the `From:` header of each commit email. If the
|
|
|
|
author ident of the commit is not textually identical to the
|
|
|
|
provided `ident`, place a `From:` header in the body of the
|
|
|
|
message with the original author. If no `ident` is given, use
|
|
|
|
the committer ident.
|
|
|
|
+
|
|
|
|
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 `git am` will correctly pick up the in-body
|
|
|
|
header). Note also that `git send-email` already handles this
|
|
|
|
transformation for you, and this option should not be used if you are
|
|
|
|
feeding the result to `git send-email`.
|
|
|
|
|
2022-08-29 21:38:36 +00:00
|
|
|
--[no-]force-in-body-from::
|
|
|
|
With the e-mail sender specified via the `--from` option, by
|
|
|
|
default, an in-body "From:" to identify the real author of
|
|
|
|
the commit is added at the top of the commit log message if
|
|
|
|
the sender is different from the author. With this option,
|
|
|
|
the in-body "From:" is added even when the sender and the
|
|
|
|
author have the same name and address, which may help if the
|
|
|
|
mailing list software mangles the sender's identity.
|
2022-08-29 21:38:37 +00:00
|
|
|
Defaults to the value of the `format.forceInBodyFrom`
|
|
|
|
configuration variable.
|
2022-08-29 21:38:36 +00:00
|
|
|
|
2009-03-26 16:51:05 +00:00
|
|
|
--add-header=<header>::
|
|
|
|
Add an arbitrary header to the email headers. This is in addition
|
|
|
|
to any configured headers, and may be used multiple times.
|
2011-08-29 20:10:49 +00:00
|
|
|
For example, `--add-header="Organization: git-foo"`.
|
|
|
|
The negated form `--no-add-header` discards *all* (`To:`,
|
|
|
|
`Cc:`, and custom) headers added so far from config or command
|
|
|
|
line.
|
2009-03-26 16:51:05 +00:00
|
|
|
|
2013-04-07 17:46:23 +00:00
|
|
|
--[no-]cover-letter::
|
2008-08-14 17:37:41 +00:00
|
|
|
In addition to the patches, generate a cover letter file
|
2015-09-14 14:10:53 +00:00
|
|
|
containing the branch description, shortlog and the overall diffstat. You can
|
2008-08-14 17:37:41 +00:00
|
|
|
fill in a description in the file before sending it out.
|
2008-02-19 03:56:13 +00:00
|
|
|
|
2020-04-08 04:31:38 +00:00
|
|
|
--encode-email-headers::
|
|
|
|
--no-encode-email-headers::
|
|
|
|
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
|
|
|
|
`format.encodeEmailHeaders` configuration variable.
|
|
|
|
|
2018-07-22 09:57:05 +00:00
|
|
|
--interdiff=<previous>::
|
2018-07-22 09:57:09 +00:00
|
|
|
As a reviewer aid, insert an interdiff into the cover letter,
|
|
|
|
or as commentary of the lone patch of a 1-patch series, showing
|
2018-07-22 09:57:05 +00:00
|
|
|
the differences between the previous version of the patch series and
|
|
|
|
the series currently being formatted. `previous` is a single revision
|
|
|
|
naming the tip of the previous series which shares a common base with
|
|
|
|
the series being formatted (for example `git format-patch
|
|
|
|
--cover-letter --interdiff=feature/v1 -3 feature/v2`).
|
|
|
|
|
2018-07-22 09:57:13 +00:00
|
|
|
--range-diff=<previous>::
|
|
|
|
As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1])
|
2018-07-22 09:57:17 +00:00
|
|
|
into the cover letter, or as commentary of the lone patch of a
|
|
|
|
1-patch series, showing the differences between the previous
|
2018-07-22 09:57:13 +00:00
|
|
|
version of the patch series and the series currently being formatted.
|
2018-07-22 09:57:14 +00:00
|
|
|
`previous` can be a single revision naming the tip of the previous
|
|
|
|
series if it shares a common base with the series being formatted (for
|
2018-07-22 09:57:13 +00:00
|
|
|
example `git format-patch --cover-letter --range-diff=feature/v1 -3
|
2018-07-22 09:57:14 +00:00
|
|
|
feature/v2`), or a revision range if the two versions of the series are
|
|
|
|
disjoint (for example `git format-patch --cover-letter
|
|
|
|
--range-diff=feature/v1~3..feature/v1 -3 feature/v2`).
|
2018-11-30 04:27:11 +00:00
|
|
|
+
|
|
|
|
Note that diff options passed to the command affect how the primary
|
|
|
|
product of `format-patch` is generated, and they are not passed to
|
|
|
|
the underlying `range-diff` machinery used to generate the cover-letter
|
|
|
|
material (this may change in the future).
|
2018-07-22 09:57:13 +00:00
|
|
|
|
2018-07-22 09:57:16 +00:00
|
|
|
--creation-factor=<percent>::
|
|
|
|
Used with `--range-diff`, tweak the heuristic which matches up commits
|
|
|
|
between the previous and current series of patches by adjusting the
|
|
|
|
creation/deletion cost fudge factor. See linkgit:git-range-diff[1])
|
|
|
|
for details.
|
|
|
|
|
2012-10-19 20:01:05 +00:00
|
|
|
--notes[=<ref>]::
|
2019-05-10 18:37:03 +00:00
|
|
|
--no-notes::
|
2012-10-19 20:01:05 +00:00
|
|
|
Append the notes (see linkgit:git-notes[1]) for the commit
|
|
|
|
after the three-dash line.
|
|
|
|
+
|
|
|
|
The expected use case of this is to write supporting explanation for
|
2012-10-21 21:34:10 +00:00
|
|
|
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 `format-patch` has run but before sending,
|
2013-01-21 19:17:53 +00:00
|
|
|
keeping them as Git notes allows them to be maintained between versions
|
2012-10-21 21:34:10 +00:00
|
|
|
of the patch series (but see the discussion of the `notes.rewrite`
|
|
|
|
configuration options in linkgit:git-notes[1] to use this workflow).
|
2019-05-16 23:14:14 +00:00
|
|
|
+
|
|
|
|
The default is `--no-notes`, unless the `format.notes` configuration is
|
|
|
|
set.
|
2012-10-19 20:01:05 +00:00
|
|
|
|
2017-03-20 13:20:29 +00:00
|
|
|
--[no-]signature=<signature>::
|
2010-06-16 05:59:25 +00:00
|
|
|
Add a signature to each message produced. Per RFC 3676 the signature
|
|
|
|
is separated from the body by a line with '-- ' on it. If the
|
2013-01-21 19:17:53 +00:00
|
|
|
signature option is omitted the signature defaults to the Git version
|
2010-06-16 05:59:25 +00:00
|
|
|
number.
|
|
|
|
|
2014-05-24 04:08:14 +00:00
|
|
|
--signature-file=<file>::
|
|
|
|
Works just like --signature except the signature is read from a file.
|
|
|
|
|
2007-01-17 19:12:03 +00:00
|
|
|
--suffix=.<sfx>::
|
2007-01-17 23:03:39 +00:00
|
|
|
Instead of using `.patch` as the suffix for generated
|
2007-08-24 00:44:13 +00:00
|
|
|
filenames, use specified suffix. A common alternative is
|
2009-04-23 16:16:52 +00:00
|
|
|
`--suffix=.txt`. Leaving this empty will remove the `.patch`
|
|
|
|
suffix.
|
2007-01-17 19:12:03 +00:00
|
|
|
+
|
2009-04-23 16:16:52 +00:00
|
|
|
Note that the leading character does not have to be a dot; for example,
|
|
|
|
you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
|
2007-01-17 19:12:03 +00:00
|
|
|
|
2013-08-03 11:51:20 +00:00
|
|
|
-q::
|
2011-04-12 15:51:37 +00:00
|
|
|
--quiet::
|
|
|
|
Do not print the names of the generated files to standard output.
|
|
|
|
|
2008-05-09 22:55:43 +00:00
|
|
|
--no-binary::
|
2009-04-23 16:16:52 +00:00
|
|
|
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.
|
2008-05-09 22:55:43 +00:00
|
|
|
|
2015-12-15 01:52:04 +00:00
|
|
|
--zero-commit::
|
|
|
|
Output an all-zero hash in each patch's From header instead
|
|
|
|
of the hash of the commit.
|
|
|
|
|
2019-12-04 21:25:06 +00:00
|
|
|
--[no-]base[=<commit>]::
|
format-patch: add '--base' option to record base tree info
Maintainers or third party testers may want to know the exact base tree
the patch series applies to. Teach git format-patch a '--base' option
to record the base tree info and append it at the end of the first
message (either the cover letter or the first patch in the series).
The base tree info consists of the "base commit", 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 "prerequisite patches", which are
well-known patches in flight that is not yet part of the "base commit"
that need to be applied on top of "base commit" in topological order
before the patches can be applied.
The "base commit" is shown as "base-commit: " followed by the 40-hex of
the commit object name. A "prerequisite patch" is shown as
"prerequisite-patch-id: " followed by the 40-hex "patch id", which can
be obtained by passing the patch through the "git patch-id --stable"
command.
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:
---P---X---Y---Z---A---B---C
With "git format-patch --base=P -3 C" (or variants thereof, e.g. with
"--cover-letter" of using "Z..C" instead of "-3 C" 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:
base-commit: P
prerequisite-patch-id: X
prerequisite-patch-id: Y
prerequisite-patch-id: Z
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Wu Fengguang <fengguang.wu@intel.com>
Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-04-26 07:51:22 +00:00
|
|
|
Record the base tree information to identify the state the
|
|
|
|
patch series applies to. See the BASE TREE INFORMATION section
|
2019-08-27 04:05:17 +00:00
|
|
|
below for details. If <commit> is "auto", a base commit is
|
2019-12-04 21:25:06 +00:00
|
|
|
automatically chosen. The `--no-base` option overrides a
|
|
|
|
`format.useAutoBase` configuration.
|
format-patch: add '--base' option to record base tree info
Maintainers or third party testers may want to know the exact base tree
the patch series applies to. Teach git format-patch a '--base' option
to record the base tree info and append it at the end of the first
message (either the cover letter or the first patch in the series).
The base tree info consists of the "base commit", 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 "prerequisite patches", which are
well-known patches in flight that is not yet part of the "base commit"
that need to be applied on top of "base commit" in topological order
before the patches can be applied.
The "base commit" is shown as "base-commit: " followed by the 40-hex of
the commit object name. A "prerequisite patch" is shown as
"prerequisite-patch-id: " followed by the 40-hex "patch id", which can
be obtained by passing the patch through the "git patch-id --stable"
command.
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:
---P---X---Y---Z---A---B---C
With "git format-patch --base=P -3 C" (or variants thereof, e.g. with
"--cover-letter" of using "Z..C" instead of "-3 C" 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:
base-commit: P
prerequisite-patch-id: X
prerequisite-patch-id: Y
prerequisite-patch-id: Z
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Wu Fengguang <fengguang.wu@intel.com>
Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-04-26 07:51:22 +00:00
|
|
|
|
2009-03-26 17:29:25 +00:00
|
|
|
--root::
|
|
|
|
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.
|
|
|
|
|
2017-08-10 18:32:55 +00:00
|
|
|
--progress::
|
|
|
|
Show progress reports on stderr as patches are generated.
|
|
|
|
|
2006-03-10 04:47:59 +00:00
|
|
|
CONFIGURATION
|
|
|
|
-------------
|
2009-04-23 16:16:52 +00:00
|
|
|
You can specify extra mail header lines to be added to each message,
|
|
|
|
defaults for the subject prefix and file suffix, number patches when
|
2019-08-27 04:05:17 +00:00
|
|
|
outputting more than one patch, add "To:" or "Cc:" headers, configure
|
|
|
|
attachments, change the patch output directory, and sign off patches
|
|
|
|
with configuration variables.
|
2006-03-10 04:47:59 +00:00
|
|
|
|
2007-01-17 23:03:39 +00:00
|
|
|
------------
|
2006-03-10 04:47:59 +00:00
|
|
|
[format]
|
2008-07-03 05:03:54 +00:00
|
|
|
headers = "Organization: git-foo\n"
|
2015-03-11 20:32:45 +00:00
|
|
|
subjectPrefix = CHANGE
|
2008-07-03 05:03:54 +00:00
|
|
|
suffix = .txt
|
|
|
|
numbered = auto
|
2010-02-16 23:39:34 +00:00
|
|
|
to = <email>
|
2008-04-26 21:19:06 +00:00
|
|
|
cc = <email>
|
2009-02-12 15:51:55 +00:00
|
|
|
attach [ = mime-boundary-string ]
|
2015-03-11 20:32:45 +00:00
|
|
|
signOff = true
|
2019-08-27 04:05:17 +00:00
|
|
|
outputDirectory = <directory>
|
|
|
|
coverLetter = auto
|
2019-10-15 09:06:40 +00:00
|
|
|
coverFromDescription = auto
|
2007-01-17 23:03:39 +00:00
|
|
|
------------
|
2007-01-17 19:12:03 +00:00
|
|
|
|
2006-03-10 04:47:59 +00:00
|
|
|
|
2011-04-15 02:22:02 +00:00
|
|
|
DISCUSSION
|
|
|
|
----------
|
|
|
|
|
|
|
|
The patch produced by 'git format-patch' 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:
|
|
|
|
|
|
|
|
------------
|
|
|
|
From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001
|
|
|
|
From: Tony Luck <tony.luck@intel.com>
|
|
|
|
Date: Tue, 13 Jul 2010 11:42:54 -0700
|
|
|
|
Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?=
|
|
|
|
=?UTF-8?q?Uwe=20Kleine-K=C3=B6nig=20diet?=
|
|
|
|
MIME-Version: 1.0
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
arch/arm config files were slimmed down using a python script
|
|
|
|
(See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment)
|
|
|
|
|
|
|
|
Do the same for ia64 so we can have sleek & trim looking
|
|
|
|
...
|
|
|
|
------------
|
|
|
|
|
|
|
|
Typically it will be placed in a MUA's 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
|
|
|
|
linkgit:git-am[1].
|
|
|
|
|
|
|
|
When a patch is part of an ongoing discussion, the patch generated by
|
|
|
|
'git format-patch' can be tweaked to take advantage of the 'git am
|
|
|
|
--scissors' feature. After your response to the discussion comes a
|
|
|
|
line that consists solely of "`-- >8 --`" (scissors and perforation),
|
|
|
|
followed by the patch with unnecessary header fields removed:
|
|
|
|
|
|
|
|
------------
|
|
|
|
...
|
|
|
|
> So we should do such-and-such.
|
|
|
|
|
|
|
|
Makes sense to me. How about this patch?
|
|
|
|
|
|
|
|
-- >8 --
|
|
|
|
Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet
|
|
|
|
|
|
|
|
arch/arm config files were slimmed down using a python script
|
|
|
|
...
|
|
|
|
------------
|
|
|
|
|
|
|
|
When sending a patch this way, most often you are sending your own
|
|
|
|
patch, so in addition to the "`From $SHA1 $magic_timestamp`" marker you
|
|
|
|
should omit `From:` and `Date:` 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.
|
|
|
|
|
2011-04-15 02:24:01 +00:00
|
|
|
Checking for patch corruption
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Many mailers if not set up properly will corrupt whitespace. Here are
|
|
|
|
two common types of corruption:
|
|
|
|
|
|
|
|
* Empty context lines that do not have _any_ whitespace.
|
|
|
|
|
|
|
|
* Non-empty context lines that have one extra whitespace at the
|
|
|
|
beginning.
|
|
|
|
|
|
|
|
One way to test if your MUA is set up correctly is:
|
|
|
|
|
|
|
|
* 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.
|
|
|
|
|
|
|
|
* Save that patch to a file in UNIX mailbox format. Call it a.patch,
|
|
|
|
say.
|
|
|
|
|
|
|
|
* Apply it:
|
|
|
|
|
|
|
|
$ git fetch <project> master:test-apply
|
2019-03-29 10:39:19 +00:00
|
|
|
$ git switch test-apply
|
2019-04-25 09:45:58 +00:00
|
|
|
$ git restore --source=HEAD --staged --worktree :/
|
2011-04-15 02:24:01 +00:00
|
|
|
$ git am a.patch
|
|
|
|
|
|
|
|
If it does not apply correctly, there can be various reasons.
|
|
|
|
|
|
|
|
* The patch itself does not apply cleanly. That is _bad_ but
|
|
|
|
does not have much to do with your MUA. You might want to rebase
|
|
|
|
the patch with linkgit:git-rebase[1] before regenerating it in
|
|
|
|
this case.
|
|
|
|
|
|
|
|
* The MUA corrupted your patch; "am" would complain that
|
|
|
|
the patch does not apply. Look in the .git/rebase-apply/ subdirectory and
|
|
|
|
see what 'patch' file contains and check for the common
|
|
|
|
corruption patterns mentioned above.
|
|
|
|
|
|
|
|
* While at it, check the 'info' and 'final-commit' files as well.
|
|
|
|
If what is in 'final-commit' 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.\n" in the
|
|
|
|
patch e-mail should come after the three-dash line that signals
|
|
|
|
the end of the commit message.
|
|
|
|
|
2011-04-15 02:28:06 +00:00
|
|
|
MUA-SPECIFIC HINTS
|
|
|
|
------------------
|
|
|
|
Here are some hints on how to successfully submit patches inline using
|
|
|
|
various mailers.
|
|
|
|
|
2011-04-15 02:33:57 +00:00
|
|
|
GMail
|
|
|
|
~~~~~
|
|
|
|
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.
|
|
|
|
|
|
|
|
For hints on using 'git send-email' to send your patches through the
|
|
|
|
GMail SMTP server, see the EXAMPLE section of linkgit:git-send-email[1].
|
|
|
|
|
|
|
|
For hints on submission using the IMAP interface, see the EXAMPLE
|
|
|
|
section of linkgit:git-imap-send[1].
|
|
|
|
|
2011-04-15 02:28:06 +00:00
|
|
|
Thunderbird
|
|
|
|
~~~~~~~~~~~
|
|
|
|
By default, Thunderbird will both wrap emails as well as flag
|
|
|
|
them as being 'format=flowed', both of which will make the
|
2013-01-21 19:17:53 +00:00
|
|
|
resulting email unusable by Git.
|
2011-04-15 02:28:06 +00:00
|
|
|
|
2011-04-18 06:31:16 +00:00
|
|
|
There are three different approaches: use an add-on to turn off line wraps,
|
|
|
|
configure Thunderbird to not mangle patches, or use
|
2011-04-15 02:28:06 +00:00
|
|
|
an external editor to keep Thunderbird from mangling the patches.
|
|
|
|
|
2011-04-18 06:31:16 +00:00
|
|
|
Approach #1 (add-on)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
Install the Toggle Word Wrap add-on that is available from
|
|
|
|
https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/
|
|
|
|
It adds a menu entry "Enable Word Wrap" in the composer's "Options" menu
|
|
|
|
that you can tick off. Now you can compose the message as you otherwise do
|
|
|
|
(cut + paste, 'git format-patch' | 'git imap-send', etc), but you have to
|
|
|
|
insert line breaks manually in any text that you type.
|
|
|
|
|
|
|
|
Approach #2 (configuration)
|
2011-04-15 02:28:06 +00:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Three steps:
|
|
|
|
|
|
|
|
1. Configure your mail server composition as plain text:
|
|
|
|
Edit...Account Settings...Composition & Addressing,
|
|
|
|
uncheck "Compose Messages in HTML".
|
|
|
|
|
|
|
|
2. Configure your general composition window to not wrap.
|
|
|
|
+
|
|
|
|
In Thunderbird 2:
|
|
|
|
Edit..Preferences..Composition, wrap plain text messages at 0
|
|
|
|
+
|
|
|
|
In Thunderbird 3:
|
|
|
|
Edit..Preferences..Advanced..Config Editor. Search for
|
|
|
|
"mail.wrap_long_lines".
|
2013-10-06 20:51:31 +00:00
|
|
|
Toggle it to make sure it is set to `false`. Also, search for
|
|
|
|
"mailnews.wraplength" and set the value to 0.
|
2011-04-15 02:28:06 +00:00
|
|
|
|
|
|
|
3. Disable the use of format=flowed:
|
2019-01-22 20:16:35 +00:00
|
|
|
Edit..Preferences..Advanced..Config Editor. Search for
|
|
|
|
"mailnews.send_plaintext_flowed".
|
|
|
|
Toggle it to make sure it is set to `false`.
|
2011-04-15 02:28:06 +00:00
|
|
|
|
|
|
|
After that is done, you should be able to compose email as you
|
|
|
|
otherwise would (cut + paste, 'git format-patch' | 'git imap-send', etc),
|
|
|
|
and the patches will not be mangled.
|
|
|
|
|
2011-04-18 06:31:16 +00:00
|
|
|
Approach #3 (external editor)
|
2011-04-15 02:28:06 +00:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The following Thunderbird extensions are needed:
|
|
|
|
AboutConfig from http://aboutconfig.mozdev.org/ and
|
|
|
|
External Editor from http://globs.org/articles.php?lng=en&pg=8
|
|
|
|
|
|
|
|
1. Prepare the patch as a text file using your method of choice.
|
|
|
|
|
|
|
|
2. 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.
|
|
|
|
|
|
|
|
3. In the main Thunderbird window, 'before' you open the compose
|
|
|
|
window for the patch, use Tools->about:config to set the
|
|
|
|
following to the indicated values:
|
|
|
|
+
|
|
|
|
----------
|
|
|
|
mailnews.send_plaintext_flowed => false
|
|
|
|
mailnews.wraplength => 0
|
|
|
|
----------
|
|
|
|
|
|
|
|
4. Open a compose window and click the external editor icon.
|
|
|
|
|
|
|
|
5. In the external editor window, read in the patch file and exit
|
|
|
|
the editor normally.
|
|
|
|
|
|
|
|
Side note: it may be possible to do step 2 with
|
|
|
|
about:config and the following settings but no one's tried yet.
|
|
|
|
|
|
|
|
----------
|
|
|
|
mail.html_compose => false
|
|
|
|
mail.identity.default.compose_html => false
|
|
|
|
mail.identity.id?.compose_html => false
|
|
|
|
----------
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
2011-04-15 02:32:55 +00:00
|
|
|
KMail
|
|
|
|
~~~~~
|
|
|
|
This should help you to submit patches inline using KMail.
|
|
|
|
|
|
|
|
1. Prepare the patch as a text file.
|
|
|
|
|
|
|
|
2. Click on New Mail.
|
|
|
|
|
|
|
|
3. Go under "Options" in the Composer window and be sure that
|
|
|
|
"Word wrap" is not set.
|
|
|
|
|
|
|
|
4. Use Message -> Insert file... and insert the patch.
|
|
|
|
|
|
|
|
5. Back in the compose window: add whatever other text you wish to the
|
|
|
|
message, complete the addressing and subject fields, and press send.
|
|
|
|
|
format-patch: add '--base' option to record base tree info
Maintainers or third party testers may want to know the exact base tree
the patch series applies to. Teach git format-patch a '--base' option
to record the base tree info and append it at the end of the first
message (either the cover letter or the first patch in the series).
The base tree info consists of the "base commit", 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 "prerequisite patches", which are
well-known patches in flight that is not yet part of the "base commit"
that need to be applied on top of "base commit" in topological order
before the patches can be applied.
The "base commit" is shown as "base-commit: " followed by the 40-hex of
the commit object name. A "prerequisite patch" is shown as
"prerequisite-patch-id: " followed by the 40-hex "patch id", which can
be obtained by passing the patch through the "git patch-id --stable"
command.
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:
---P---X---Y---Z---A---B---C
With "git format-patch --base=P -3 C" (or variants thereof, e.g. with
"--cover-letter" of using "Z..C" instead of "-3 C" 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:
base-commit: P
prerequisite-patch-id: X
prerequisite-patch-id: Y
prerequisite-patch-id: Z
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Wu Fengguang <fengguang.wu@intel.com>
Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-04-26 07:51:22 +00:00
|
|
|
BASE TREE INFORMATION
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
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 'base commit', 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 'prerequisite patches', which are well-known patches in flight
|
|
|
|
that is not yet part of the 'base commit' that need to be applied on top
|
|
|
|
of 'base commit' in topological order before the patches can be applied.
|
|
|
|
|
|
|
|
The 'base commit' is shown as "base-commit: " followed by the 40-hex of
|
|
|
|
the commit object name. A 'prerequisite patch' is shown as
|
|
|
|
"prerequisite-patch-id: " followed by the 40-hex 'patch id', which can
|
|
|
|
be obtained by passing the patch through the `git patch-id --stable`
|
|
|
|
command.
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
................................................
|
|
|
|
---P---X---Y---Z---A---B---C
|
|
|
|
................................................
|
|
|
|
|
|
|
|
With `git format-patch --base=P -3 C` (or variants thereof, e.g. with
|
2017-04-17 22:32:53 +00:00
|
|
|
`--cover-letter` or using `Z..C` instead of `-3 C` to specify the
|
format-patch: add '--base' option to record base tree info
Maintainers or third party testers may want to know the exact base tree
the patch series applies to. Teach git format-patch a '--base' option
to record the base tree info and append it at the end of the first
message (either the cover letter or the first patch in the series).
The base tree info consists of the "base commit", 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 "prerequisite patches", which are
well-known patches in flight that is not yet part of the "base commit"
that need to be applied on top of "base commit" in topological order
before the patches can be applied.
The "base commit" is shown as "base-commit: " followed by the 40-hex of
the commit object name. A "prerequisite patch" is shown as
"prerequisite-patch-id: " followed by the 40-hex "patch id", which can
be obtained by passing the patch through the "git patch-id --stable"
command.
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:
---P---X---Y---Z---A---B---C
With "git format-patch --base=P -3 C" (or variants thereof, e.g. with
"--cover-letter" of using "Z..C" instead of "-3 C" 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:
base-commit: P
prerequisite-patch-id: X
prerequisite-patch-id: Y
prerequisite-patch-id: Z
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Wu Fengguang <fengguang.wu@intel.com>
Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-04-26 07:51:22 +00:00
|
|
|
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:
|
|
|
|
|
|
|
|
------------
|
|
|
|
base-commit: P
|
|
|
|
prerequisite-patch-id: X
|
|
|
|
prerequisite-patch-id: Y
|
|
|
|
prerequisite-patch-id: Z
|
|
|
|
------------
|
|
|
|
|
|
|
|
For non-linear topology, such as
|
|
|
|
|
|
|
|
................................................
|
|
|
|
---P---X---A---M---C
|
|
|
|
\ /
|
|
|
|
Y---Z---B
|
|
|
|
................................................
|
|
|
|
|
|
|
|
You can also use `git format-patch --base=P -3 C` 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.
|
2011-04-15 02:22:02 +00:00
|
|
|
|
2021-10-23 21:01:33 +00:00
|
|
|
If set `--base=auto` in cmdline, it will automatically compute
|
|
|
|
the base commit as the merge base of tip commit of the remote-tracking
|
2016-04-26 07:51:23 +00:00
|
|
|
branch and revision-range specified in cmdline.
|
2021-10-23 21:01:33 +00:00
|
|
|
For a local branch, you need to make it to track a remote branch by `git branch
|
2016-04-26 07:51:23 +00:00
|
|
|
--set-upstream-to` before using this option.
|
|
|
|
|
2005-11-05 10:55:18 +00:00
|
|
|
EXAMPLES
|
|
|
|
--------
|
|
|
|
|
2008-05-07 04:29:28 +00:00
|
|
|
* Extract commits between revisions R1 and R2, and apply them on top of
|
2019-01-22 20:16:35 +00:00
|
|
|
the current branch using 'git am' to cherry-pick them:
|
2008-05-07 04:29:28 +00:00
|
|
|
+
|
|
|
|
------------
|
2008-07-03 05:28:15 +00:00
|
|
|
$ git format-patch -k --stdout R1..R2 | git am -3 -k
|
2008-05-07 04:29:28 +00:00
|
|
|
------------
|
|
|
|
|
|
|
|
* Extract all commits which are in the current branch but not in the
|
2019-01-22 20:16:35 +00:00
|
|
|
origin branch:
|
2008-05-07 04:29:28 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git format-patch origin
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
For each commit a separate file is created in the current directory.
|
|
|
|
|
|
|
|
* Extract all commits that lead to 'origin' since the inception of the
|
2019-01-22 20:16:35 +00:00
|
|
|
project:
|
2008-05-07 04:29:28 +00:00
|
|
|
+
|
|
|
|
------------
|
2008-07-03 04:47:05 +00:00
|
|
|
$ git format-patch --root origin
|
2008-05-07 04:29:28 +00:00
|
|
|
------------
|
|
|
|
|
|
|
|
* The same as the previous one:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git format-patch -M -B origin
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
Additionally, it detects and handles renames and complete rewrites
|
|
|
|
intelligently to produce a renaming patch. A renaming patch reduces
|
2009-04-23 16:16:52 +00:00
|
|
|
the amount of text output, and generally makes it easier to review.
|
2013-01-21 19:17:53 +00:00
|
|
|
Note that non-Git "patch" programs won't understand renaming patches, so
|
|
|
|
use it only when you know the recipient uses Git to apply your patch.
|
2008-05-07 04:29:28 +00:00
|
|
|
|
|
|
|
* Extract three topmost commits from the current branch and format them
|
2019-01-22 20:16:35 +00:00
|
|
|
as e-mailable patches:
|
2008-05-07 04:29:28 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git format-patch -3
|
|
|
|
------------
|
2005-11-05 10:55:18 +00:00
|
|
|
|
2021-05-01 14:13:24 +00:00
|
|
|
CAVEATS
|
|
|
|
-------
|
|
|
|
|
|
|
|
Note that `format-patch` 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.
|
|
|
|
|
2008-05-28 23:55:27 +00:00
|
|
|
SEE ALSO
|
2005-11-05 10:55:18 +00:00
|
|
|
--------
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-am[1], linkgit:git-send-email[1]
|
2005-11-05 10:55:18 +00:00
|
|
|
|
2005-08-23 08:49:47 +00:00
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|