aboutsummaryrefslogtreecommitdiffstats
path: root/git.c
diff options
context:
space:
mode:
authorJulia Evans <julia@jvns.ca>2025-10-17 20:05:56 +0000
committerJunio C Hamano <gitster@pobox.com>2025-10-17 14:30:18 -0700
commitc7049edf399326790eeab1fe33e2485d2fba7a29 (patch)
treeab70f9bae0a1c184faa9e4324541678493914b2e /git.c
parentdoc: git-reset: reorder the forms (diff)
downloadgit-c7049edf399326790eeab1fe33e2485d2fba7a29.tar.gz
git-c7049edf399326790eeab1fe33e2485d2fba7a29.zip
doc: git-reset: clarify intro
>From user feedback, there were several points of confusion: - What "tree-ish", "entries", "working tree", "HEAD", and "index" mean ("I have no clue what the index is", "I've been using git for 20 years and still don't know what a tree-ish is"). Avoid using these terms where it makes sense. - What "optionally modifying index and working tree to match" means ("to match what?" "optionally based on what?") Remove this from the intro, we can say it later when giving more details. - One user suggested that "The <tree-ish>/<commit> defaults to HEAD in all forms." should be repeated later on, since it's easy to miss. Instead say that HEAD is the default in each case later. Another issue is that `git reset` consistently describes the action it does as "Reset ...", commands should not use their name to describe themselves, and that the word "mode" is used to mean several different things on this page. Address these by being more clear about two use cases for `git reset` ("to undo operations" and "to update staged files"), and explaining what the conditions are for each case instead of forcing the user to figure out the pattern is in first form vs the other 3 forms. Signed-off-by: Julia Evans <julia@jvns.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'git.c')
0 files changed, 0 insertions, 0 deletions