diff options
| author | Julia Evans <julia@jvns.ca> | 2025-10-17 20:05:57 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-10-17 14:30:19 -0700 |
| commit | 84aed17da6ceb8c976526cf42b7d2d2d1587c5c5 (patch) | |
| tree | ead2302d8e31658633c6910ce60110c4b701043e /notes-utils.h | |
| parent | doc: git-reset: clarify intro (diff) | |
| download | git-84aed17da6ceb8c976526cf42b7d2d2d1587c5c5.tar.gz git-84aed17da6ceb8c976526cf42b7d2d2d1587c5c5.zip | |
doc: git-reset: clarify `git reset [mode]`
>From user feedback, there was some confusion about the differences
between the modes, including:
1. Sometimes it says "index" and sometimes "index file".
Fix by replacing "index file" with "index".
2. Many comments about not being able to understand what `--merge` does.
Fix by mentioning `git merge --abort` since my best guess is that
most folks want to use that instead of `git reset --merge`.
3. Issues telling the difference between --soft and --mixed, as well as
--keep. Leave --keep alone because I couldn't understand its use case,
but change `--soft` / `--mixed` / `--hard` as follows:
--mixed is the default, so put it first.
Describe --soft/--mixed/--hard with the following structure:
* Start by saying what happens to the files in the working directory,
because the thing users want to avoid most is irretrievably losing
changes to their working directory files.
* Then describe what happens to the staging area. Right now it seems to
frame leaving the index alone as being a sort of neutral action.
I think this is part of what's confusing users, because in Git when
you update HEAD, Git almost always updates the index to match HEAD.
So leaving the index unchanged while updating HEAD is actually quite
unusual, and it deserves to be flagged.
* Finally, give an example for --soft to explain a common use case.
Signed-off-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'notes-utils.h')
0 files changed, 0 insertions, 0 deletions
