diff options
| author |  Jeff King <peff@peff.net> | 2021-05-01 10:13:24 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-05-03 14:32:39 +0900 |
| commit | 8e0601f568ebf512f2edc606bdbf1a508b3c28a6 (patch) | |
| tree | b815b41c65fae5a128c9bc1a1f591f0bb4906ef8 | |
| parent | format-patch: give an overview of what a "patch" message is (diff) | |
| download | tgif-8e0601f568ebf512f2edc606bdbf1a508b3c28a6.tar.xz | |
docs/format-patch: mention handling of merges
Format-patch doesn't have a way to format merges in a way that can be
applied by git-am (or any other tool), and so it just omits them.
However, this may be a surprising implication for users who are not well
versed in how the tool works. Let's add a note to the documentation
making this more clear.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-format-patch.txt | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 5cd8578b6f..49dad1f5b9 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'. @@ -735,6 +735,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] |