]> git.ipfire.org Git - thirdparty/git.git/commit
doc: git-checkout: clarify restoring files section
authorJulia Evans <julia@jvns.ca>
Wed, 10 Sep 2025 19:14:29 +0000 (19:14 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 10 Sep 2025 21:32:05 +0000 (14:32 -0700)
commit83a9405e59e9cdfb587b19c50f0c040f346dd4ea
tree45c0d224fcb9837f04e155430079251c84566880
parentbfe7b17c253eaeefc024ed7fef80787dd80d45fd
doc: git-checkout: clarify restoring files section

From user feedback on this section: 3 users don't know what "tree-ish"
means and 3 users don't know what "pathspec" means. One user also says
that the section is very confusing and that they don't understand what
the "index" is.

From conversations on Mastodon, several users said that their impression
is that "the index" means the same thing as "HEAD". It would be good to
give those users (and other users who do not know what "index" means) a
hint as to its meaning.

Make this section more accessible to users who don't know what the terms
"pathspec", "tree-ish", and "index" mean by using more familiar language,
adding examples, and using simpler sentence structures.

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