summaryrefslogtreecommitdiff
path: root/Documentation/git-checkout.txt
diff options
context:
space:
mode:
authorMatthieu Moy <Matthieu.Moy@imag.fr>2009-04-07 12:43:53 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-04-08 04:57:12 (GMT)
commit39470cf961e584ddb505f51bb9c452ebcfd5c569 (patch)
tree851484291850cbbe60b0063513b6d77f30ed4144 /Documentation/git-checkout.txt
parentce8936c342a15a08029c71fdc92e283e3624bc18 (diff)
downloadgit-39470cf961e584ddb505f51bb9c452ebcfd5c569.zip
git-39470cf961e584ddb505f51bb9c452ebcfd5c569.tar.gz
git-39470cf961e584ddb505f51bb9c452ebcfd5c569.tar.bz2
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>
Diffstat (limited to 'Documentation/git-checkout.txt')
-rw-r--r--Documentation/git-checkout.txt8
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 8830479..19510de 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'.