format-patch documentation: reword to hint "--root <one-commit>" more clearly
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Aug 28, 2007 at 21:58 UTC
2f6a3823700cbfda236c2c1f023c43601adae9af
1 file changed
+10
-7
Documentation/git-format-patch.txt
+10
-7
@@ -34,13 +34,16 @@ There are two ways to specify which commits to operate on.
34
35
2. Generic <revision range> expression (see "SPECIFYING
36
REVISIONS" section in gitlink:git-rev-parse[1]) means the
37
- commits in the specified range. A single commit, when
38
- interpreted as a <revision range> expression, means
39
- "everything that leads to that commit", but that is taken as
40
- the special case above. If you want to format everything
41
- since project inception to one commit, say "git format-patch
42
- \--root <that-commit>", as showing the root commit as patch
43
- requires \--root option anyway.
37
+ commits in the specified range.
38
+
39
+A single commit, when interpreted as a <revision range>
40
+expression, means "everything that leads to that commit", but
41
+if you write 'git format-patch <commit>', the previous rule
42
+applies to that command line and you do not get "everything
43
+since the beginning of the time". If you want to format
44
+everything since project inception to one commit, say "git
45
+format-patch \--root <commit>" to make it clear that it is the
46
+latter case.
47
48
By default, each output file is numbered sequentially from 1, and uses the
49
first line of the commit message (massaged for pathname safety) as