Code

format-patch documentation: mention the special case of showing a single commit
authorJunio C Hamano <gitster@pobox.com>
Mon, 3 Nov 2008 04:45:55 +0000 (20:45 -0800)
committerJunio C Hamano <gitster@pobox.com>
Mon, 3 Nov 2008 04:45:55 +0000 (20:45 -0800)
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>
Documentation/git-format-patch.txt

index adb4ea7b1b6c70fb6fc2486487ef34ed280ec015..7426109f6251b7e4b3b37e0b785157c0d46ee9f7 100644 (file)
@@ -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