diff options
| author |  Nguyễn Thái Ngọc Duy <pclouds@gmail.com> | 2016-09-07 18:19:40 +0700 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2016-09-21 08:44:41 -0700 |
| commit | 19e5656345cb308ab689932d64af0858a3a92400 (patch) | |
| tree | 0d9af8d936b3604952b56f51c09af5780bd070ab | |
| parent | checkout: add some spaces between code and comment (diff) | |
| download | tgif-19e5656345cb308ab689932d64af0858a3a92400.tar.xz | |
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.txt | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 7a2201b051..8e2c0662dd 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 -------- |