summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2021-05-11 15:27:22 +0900
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-05-11 15:27:23 +0900
commit270f8bfe0038fe84f8a08bdc26f8b4094df10b08 (patch)
treea11c406c829380c050c4ed1c35eb8ce26d88fd0c
parentMerge branch 'jc/test-allows-local' (diff)
parentdocs/format-patch: mention handling of merges (diff)
downloadtgif-270f8bfe0038fe84f8a08bdc26f8b4094df10b08.tar.xz
Merge branch 'jk/doc-format-patch-skips-merges'
Document that "format-patch" skips merges. * jk/doc-format-patch-skips-merges: docs/format-patch: mention handling of merges
-rw-r--r--Documentation/git-format-patch.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 911da181a1..fe2f69d36e 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -36,7 +36,7 @@ SYNOPSIS
DESCRIPTION
-----------
-Prepare each commit with its "patch" in
+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 'git am'.
@@ -740,6 +740,14 @@ use it only when you know the recipient uses Git to apply your patch.
$ git format-patch -3
------------
+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.
+
SEE ALSO
--------
linkgit:git-am[1], linkgit:git-send-email[1]