From 0808723b5065cc2141c2715a2df78882c158d4ef Mon Sep 17 00:00:00 2001 From: Jeff King Date: Mon, 13 Apr 2009 07:21:04 -0400 Subject: [PATCH] docs/checkout: clarify what "non-branch" means In the code we literally stick "refs/heads/" on the front and see if it resolves, so that is probably the best explanation. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/git-checkout.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 4a1fb5309..ad4b31e89 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -114,11 +114,11 @@ the conflicted merge in the specified paths. "merge" style, shows the original contents). :: - 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'. + Branch to checkout; if it refers to a branch (i.e., a name that, + when prepended with "refs/heads/", is a valid ref), then that + branch is checked out. Otherwise, if it refers to a valid + commit, your HEAD becomes "detached" and you are no longer on + any branch (see below for details). + As a special case, the `"@\{-N\}"` syntax for the N-th last branch checks out the branch (instead of detaching). You may also specify -- 2.30.2