aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2008-11-02 20:45:55 -0800
committerJunio C Hamano <gitster@pobox.com>2008-11-02 20:45:55 -0800
commit16088d8870b7da6d4dd280be2d1728dd3be346b5 (patch)
tree8d74f2788dd2d6bc98d806024ed5e756ca1b953b /Documentation/git-format-patch.txt
parenta5a323f33cd25829e0dde3939b196cf743d7d9d8 (diff)
downloadgit-16088d8870b7da6d4dd280be2d1728dd3be346b5.tar.gz
git-16088d8870b7da6d4dd280be2d1728dd3be346b5.tar.xz
format-patch documentation: mention the special case of showing a single commit
Even long timers seem to have missed that "format-patch -1 $commit" is a much simpler and more obvious way to say "format-patch $commit^..$commit" from the current documentation (and an example "format-patch -3 $commit" to get three patches). Add an explicit instruction in a much earlier part of the documentation to make it easier to find. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-format-patch.txt')
-rw-r--r--Documentation/git-format-patch.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index adb4ea7b1..7426109f6 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -46,7 +46,8 @@ applies to that command line and you do not get "everything
since the beginning of the time". If you want to format
everything since project inception to one commit, say "git
format-patch \--root <commit>" to make it clear that it is the
-latter case.
+latter case. If you want to format a single commit, you can do
+this with "git format-patch -1 <commit>".
By default, each output file is numbered sequentially from 1, and uses the
first line of the commit message (massaged for pathname safety) as