Skip to content

Commit ecc03c1

Browse files
Nanako Shiraishigitster
authored andcommitted
Clarify documentation of "git checkout <tree-ish> paths" syntax
The SYNOPSIS section of the manual writes: git checkout [options] [<tree-ish>] [--] <paths>... but the DESCRIPTION says that this form checks the paths out "from the index, or from a named commit." A later sentence refers to the same argument as "<tree-ish> argument", but it is not clear that these two sentences are talking about the same command line argument for first-time readers. Signed-off-by: Nanako Shiraishi <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b4955fb commit ecc03c1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/git-checkout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ the first namespace level.
2727

2828
When <paths> are given, this command does *not* switch
2929
branches. It updates the named paths in the working tree from
30-
the index file, or from a named commit. In
30+
the index file, or from a named <tree-ish> (most often a commit). In
3131
this case, the `-b` options is meaningless and giving
3232
either of them results in an error. <tree-ish> argument can be
3333
used to specify a specific tree-ish (i.e. commit, tag or tree)

0 commit comments

Comments
 (0)