Skip to content

Commit 2d266f9

Browse files
trastgitster
authored andcommitted
Documentation: format-patch --root clarifications
Users were confused about the meaning and use of the --root option. Notably, since 68c2ec7 (format-patch: show patch text for the root commit, 2009-01-10), --root has nothing to do with showing the patch text for the root commit any more. Shorten and clarify the corresponding paragraph in the DESCRIPTION section, document --root under OPTIONS, and add an explicit note that root commits are formatted regardless. Signed-off-by: Thomas Rast <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5d83f9c commit 2d266f9

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

Documentation/git-format-patch.txt

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,11 @@ There are two ways to specify which commits to operate on.
3939
REVISIONS" section in linkgit:git-rev-parse[1]) means the
4040
commits in the specified range.
4141

42-
A single commit, when interpreted as a <revision range>
43-
expression, means "everything that leads to that commit", but
44-
if you write 'git format-patch <commit>', the previous rule
45-
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. If you want to format a single commit, you can do
50-
this with "git format-patch -1 <commit>".
42+
The first rule takes precedence in the case of a single <commit>. To
43+
apply the second rule, i.e., format everything since the beginning of
44+
history up until <commit>, use the '\--root' option: "git format-patch
45+
\--root <commit>". If you want to format only <commit> itself, you
46+
can do this with "git format-patch -1 <commit>".
5147

5248
By default, each output file is numbered sequentially from 1, and uses the
5349
first line of the commit message (massaged for pathname safety) as
@@ -170,6 +166,13 @@ not add any suffix.
170166
applied. By default the contents of changes in those files are
171167
encoded in the patch.
172168

169+
--root::
170+
Treat the revision argument as a <revision range>, even if it
171+
is just a single commit (that would normally be treated as a
172+
<since>). Note that root commits included in the specified
173+
range are always formatted as creation patches, independently
174+
of this flag.
175+
173176
CONFIGURATION
174177
-------------
175178
You can specify extra mail header lines to be added to each message

0 commit comments

Comments
 (0)