]> git.ipfire.org Git - thirdparty/git.git/commit
doc: git-checkout: clarify ARGUMENT DISAMBIGUATION
authorJulia Evans <julia@jvns.ca>
Wed, 10 Sep 2025 19:14:24 +0000 (19:14 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 10 Sep 2025 21:32:03 +0000 (14:32 -0700)
commitea03d5ae5cf7b256eca80634b424d3555da2cb8f
tree74daae6086bcf4fa259aecb8138edbff9e133401
parent21a5f9442e3a9640c46d3bc28b41a7238bb4ee9c
doc: git-checkout: clarify ARGUMENT DISAMBIGUATION

There's no need to use the terms "pathspec" or "tree-ish" in the
ARGUMENT DISAMBIGUATION section, which are terms that (from user
feedback on this page) many users do not understand.

"tree-ish" is actually not accurate here: `git checkout` in this case
takes a commit-ish, not a tree-ish. So we can say "branch or commit"
instead of "tree-ish" which is both more accurate and uses more familiar
terms.

And now that the intro to the man pages mentions that `git checkout` has
"two main modes", it makes sense to refer to this disambiguation section
to understand how Git decides which one to use when there's an overlap
in syntax.

Signed-off-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-checkout.adoc