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 <nanako3@lavabit.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Nanako Shiraishi committed
Dec 18, 2008 at 12:34 UTC
ecc03c1c6db0917c06415ec3c6e1510217e59805
1 file changed
+1
-1
Documentation/git-checkout.txt
+1
-1
@@ -27,7 +27,7 @@ the first namespace level.
27
28
When <paths> are given, this command does *not* switch
29
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
31
this case, the `-b` options is meaningless and giving
32
either of them results in an error. <tree-ish> argument can be
33
used to specify a specific tree-ish (i.e. commit, tag or tree)