X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fgit-format-patch.txt;h=111d7c60bf1832bbfc27f8b819da77b8761236da;hb=7891a2811dc7cae375e34c9f4fa6c8ecaef0f6d7;hp=67425dc0359ee9774200e1a2e12913d570117e7c;hpb=182a8dabd5f5f646608f3857f10f3ac18c3d1445;p=git.git
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 67425dc03..111d7c60b 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -9,9 +9,11 @@ git-format-patch - Prepare patches for e-mail submission
SYNOPSIS
--------
[verse]
-'git-format-patch' [-n | -k] [-o
| --stdout] [--attach] [--thread]
- [-s | --signoff] [--diff-options] [--start-number ]
- [--in-reply-to=Message-Id]
+'git-format-patch' [-n | -k] [-o | --stdout] [--thread]
+ [--attach[=] | --inline[=]]
+ [-s | --signoff] [] [--start-number ]
+ [--in-reply-to=Message-Id] [--suffix=.]
+ [--ignore-if-in-upstream]
[..]
DESCRIPTION
@@ -20,7 +22,9 @@ DESCRIPTION
Prepare each commit between and with its patch in
one file per commit, formatted to resemble UNIX mailbox format.
If .. is not specified, the head of the current working
-tree is implied.
+tree is implied. For a more complete list of ways to spell
+ and , see "SPECIFYING REVISIONS" section in
+gitlink:git-rev-parse[1].
The output of this command is convenient for e-mail submission or
for use with gitlink:git-am[1].
@@ -43,6 +47,8 @@ reference.
OPTIONS
-------
+include::diff-options.txt[]
+
-o|--output-directory ::
Use to store the resulting files, instead of the
current working directory.
@@ -65,8 +71,15 @@ OPTIONS
Print all commits to the standard output in mbox format,
instead of creating a file for each one.
---attach::
- Create attachments instead of inlining patches.
+--attach[=]::
+ Create multipart/mixed attachment, the first part of
+ which is the commit message and the patch itself in the
+ second part, with "Content-Disposition: attachment".
+
+--inline[=]::
+ Create multipart/mixed attachment, the first part of
+ which is the commit message and the patch itself in the
+ second part, with "Content-Disposition: inline".
--thread::
Add In-Reply-To and References headers to make the second and
@@ -78,13 +91,34 @@ OPTIONS
reply to the given Message-Id, which avoids breaking threads to
provide a new patch series.
+--ignore-if-in-upstream::
+ Do not include a patch that matches a commit in
+ ... This will examine all patches reachable
+ from but not from and compare them with the
+ patches being generated, and any patch that matches is
+ ignored.
+
+--suffix=.::
+ Instead of using `.patch` as the suffix for generated
+ filenames, use specifed suffix. A common alternative is
+ `--suffix=.txt`.
++
+Note that you would need to include the leading dot `.` if you
+want a filename like `0001-description-of-my-change.patch`, and
+the first letter does not have to be a dot. Leaving it empty would
+not add any suffix.
+
CONFIGURATION
-------------
You can specify extra mail header lines to be added to each
-message in the repository configuration as follows:
+message in the repository configuration. Also you can specify
+the default suffix different from the built-in one:
+------------
[format]
headers = "Organization: git-foo\n"
+ suffix = .txt
+------------
EXAMPLES
@@ -109,6 +143,9 @@ git-format-patch -M -B origin::
understand renaming patches, so use it only when you know
the recipient uses git to apply your patch.
+git-format-patch -3::
+ Extract three topmost commits from the current branch
+ and format them as e-mailable patches.
See Also
--------