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>
Junio C Hamano committed
Nov 2, 2008 at 20:45 UTC
16088d8870b7da6d4dd280be2d1728dd3be346b5
1 file changed
+2
-1
Documentation/git-format-patch.txt
+2
-1
@@ -46,7 +46,8 @@ applies to that command line and you do not get "everything
46
since the beginning of the time". If you want to format
47
everything since project inception to one commit, say "git
48
format-patch \--root <commit>" to make it clear that it is the
49
-latter case.
49
+latter case. If you want to format a single commit, you can do
50
+this with "git format-patch -1 <commit>".
51
52
By default, each output file is numbered sequentially from 1, and uses the
53
first line of the commit message (massaged for pathname safety) as