diff options
| author | Julia Evans <julia@jvns.ca> | 2025-10-17 20:05:58 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-10-17 14:30:19 -0700 |
| commit | 0b9583f872cf4f651e13dbbc1c6e80a8764f6417 (patch) | |
| tree | 80375f8a55bdbdb7bb05c5feefe97927e5f7e565 | |
| parent | doc: git-reset: clarify `git reset [mode]` (diff) | |
| download | git-0b9583f872cf4f651e13dbbc1c6e80a8764f6417.tar.gz git-0b9583f872cf4f651e13dbbc1c6e80a8764f6417.zip | |
doc: git-reset: clarify `git reset <pathspec>`
>From user feedback:
- Continued confusion about the terms "tree-ish" and "pathspec"
- The word "hunks" is confusing folks, use "changes" instead.
- On the part about `git restore`, there were a few comments to the
effect of "wait, this doesn't actually update any files? What? Why?"
Be more direct that `git reset` does not update files: there's no
obvious reason to suggest that folks use `git reset` followed by `git
restore`, instead suggest just using `git restore`.
Continue avoiding the use of the word "reset" to
describe what "git reset" does.
Signed-off-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-reset.adoc | 27 |
1 files changed, 11 insertions, 16 deletions
diff --git a/Documentation/git-reset.adoc b/Documentation/git-reset.adoc index fa4bb2b551..52d380a756 100644 --- a/Documentation/git-reset.adoc +++ b/Documentation/git-reset.adoc @@ -79,29 +79,24 @@ linkgit:git-add[1]). `git reset [-q] [<tree-ish>] [--] <pathspec>...`:: `git reset [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]`:: - These forms reset the index entries for all paths that match the - _<pathspec>_ to their state at _<tree-ish>_. (It does not affect - the working tree or the current branch.) + For all specified files or directories, set the staged version to + the version from the given commit or tree (which defaults to `HEAD`). + This means that `git reset <pathspec>` is the opposite of `git add -<pathspec>`. This command is equivalent to -`git restore [--source=<tree-ish>] --staged <pathspec>...`. +<pathspec>`: it unstages all changes to the specified file(s) or +directories. This is equivalent to `git restore --staged <pathspec>...`. + -After running `git reset <pathspec>` to update the index entry, you can -use linkgit:git-restore[1] to check the contents out of the index to -the working tree. Alternatively, using linkgit:git-restore[1] -and specifying a commit with `--source`, you -can copy the contents of a path out of a commit to the index and to the -working tree in one go. +`git reset` only modifies the index: use linkgit:git-restore[1] instead +if you'd like to also update the file in your working directory. `git reset (--patch | -p) [<tree-ish>] [--] [<pathspec>...]`:: - Interactively select hunks in the difference between the index - and _<tree-ish>_ (defaults to `HEAD`). The chosen hunks are applied - in reverse to the index. + Interactively select changes from the difference between the index + and the specified commit or tree (which defaults to `HEAD`). + The chosen changes are unstaged. + This means that `git reset -p` is the opposite of `git add -p`, i.e. -you can use it to selectively reset hunks. See the "Interactive Mode" -section of linkgit:git-add[1] to learn how to operate the `--patch` mode. +you can use it to selectively unstage changes. See the "Interactive Mode" +section of linkgit:git-add[1] to learn how to use the `--patch` option. See "Reset, restore and revert" in linkgit:git[1] for the differences between the three commands. |