path: root/Documentation/git-checkout.txt
diff options
authorNanako Shiraishi <>2008-12-18 03:34:56 (GMT)
committerJunio C Hamano <>2008-12-18 06:00:54 (GMT)
commitecc03c1c6db0917c06415ec3c6e1510217e59805 (patch)
tree50fc637252e1837ef488db5db37bfddc395fdfca /Documentation/git-checkout.txt
parentb4955fb611ce407ef0e522862c60ae0472dbfe5e (diff)
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 <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-checkout.txt')
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 168333a..79824f4 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -27,7 +27,7 @@ the first namespace level.
When <paths> are given, this command does *not* switch
branches. It updates the named paths in the working tree from
-the index file, or from a named commit. In
+the index file, or from a named <tree-ish> (most often a commit). In
this case, the `-b` options is meaningless and giving
either of them results in an error. <tree-ish> argument can be
used to specify a specific tree-ish (i.e. commit, tag or tree)