summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyễn Thái Ngọc Duy <pclouds@gmail.com>2016-09-07 11:19:40 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-09-21 15:44:41 (GMT)
commit19e5656345cb308ab689932d64af0858a3a92400 (patch)
tree0d9af8d936b3604952b56f51c09af5780bd070ab
parent7f82b24e30e487019fcf6b0e86cf5c6f61a482bc (diff)
downloadgit-19e5656345cb308ab689932d64af0858a3a92400.zip
git-19e5656345cb308ab689932d64af0858a3a92400.tar.gz
git-19e5656345cb308ab689932d64af0858a3a92400.tar.bz2
checkout.txt: document a common case that ignores ambiguation rules
Normally we err on the safe side: if something can be seen as both an SHA1 and a pathspec, we stop and scream. In checkout, there is one exception added in 859fdab (git-checkout: improve error messages, detect ambiguities. - 2008-07-23), to allow the common case "git checkout branch". Let's document this exception. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-checkout.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 7a2201b..8e2c066 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -419,6 +419,18 @@ $ git reflog -2 HEAD # or
$ git log -g -2 HEAD
------------
+ARGUMENT DISAMBIGUATION
+-----------------------
+
+When there is only one argument given and it is not `--` (e.g. "git
+checkout abc"), and when the argument is both a valid `<tree-ish>`
+(e.g. a branch "abc" exists) and a valid `<pathspec>` (e.g. a file
+or a directory whose name is "abc" exists), Git would usually ask
+you to disambiguate. Because checking out a branch is so common an
+operation, however, "git checkout abc" takes "abc" as a `<tree-ish>`
+in such a situation. Use `git checkout -- <pathspec>` if you want
+to checkout these paths out of the index.
+
EXAMPLES
--------