From: Matthieu Moy <Matthieu.Moy@imag.fr>
Date: Tue, 7 Apr 2009 12:43:53 +0000 (+0200)
Subject: git-checkout.txt: clarify that <branch> applies when no path is given.
X-Git-Tag: v1.6.2.3~1^2~1^2~2
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=39470cf961e584ddb505f51bb9c452ebcfd5c569;p=git.git

git-checkout.txt: clarify that <branch> applies when no path is given.

Otherwise, the sentence "Defaults to HEAD." can be mis-read to mean
that "git checkout -- hello.c" checks-out from HEAD.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 883047982..19510de15 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -85,9 +85,13 @@ should result in deletion of the path).
 <new_branch>::
 	Name for the new branch.
 
+<tree-ish>::
+	Tree to checkout from (when paths are given). If not specified,
+	the index will be used.
+
 <branch>::
-	Branch to checkout; may be any object ID that resolves to a
-	commit.  Defaults to HEAD.
+	Branch to checkout (when no paths are given); may be any object
+	ID that resolves to a commit.  Defaults to HEAD.
 +
 When this parameter names a non-branch (but still a valid commit object),
 your HEAD becomes 'detached'.