mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
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>
This commit is contained in:
parent
28e29ee38b
commit
8e0601f568
|
@ -36,7 +36,7 @@ SYNOPSIS
|
||||||
DESCRIPTION
|
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.
|
one "message" per commit, formatted to resemble a UNIX mailbox.
|
||||||
The output of this command is convenient for e-mail submission or
|
The output of this command is convenient for e-mail submission or
|
||||||
for use with 'git am'.
|
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
|
$ 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
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
linkgit:git-am[1], linkgit:git-send-email[1]
|
linkgit:git-am[1], linkgit:git-send-email[1]
|
||||||
|
|
Loading…
Reference in a new issue