git-reset - Reset current HEAD to the specified state
git reset [-q] [<tree-ish>] [--] <pathspec>…
git reset [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]
git reset (--patch | -p) [<tree-ish>] [--] [<pathspec>…]
git reset [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
In the first three forms, copy entries from <tree-ish>
to the index. In the last form, set the current branch head (HEAD
) to <commit>
, optionally modifying index and working tree to match. The <tree-ish>
/<commit>
defaults to HEAD
in all forms.
- 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.)
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>...
.
After running git reset <pathspec>
to update the index entry, you can use git-restore[1] to check the contents out of the index to the working tree. Alternatively, using 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 (--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.
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 git-add[1] to learn how to operate the --patch
mode.
- git reset [<mode>] [<commit>]
-
This form resets the current branch head to <commit>
and possibly updates the index (resetting it to the tree of <commit>
) and the working tree depending on <mode>
. Before the operation, ORIG_HEAD
is set to the tip of the current branch. If <mode>
is omitted, defaults to --mixed
. The <mode>
must be one of the following:
- --soft
-
Does not touch the index file or the working tree at all (but resets the head to <commit>
, just like all modes do). This leaves all your changed files "Changes to be committed", as git status
would put it.
- --mixed
-
Resets the index but not the working tree (i.e., the changed files are preserved but not marked for commit) and reports what has not been updated. This is the default action.
If -N
is specified, removed paths are marked as intent-to-add (see git-add[1]).
- --hard
-
Resets the index and working tree. Any changes to tracked files in the working tree since <commit>
are discarded. Any untracked files or directories in the way of writing any tracked files are simply deleted.
- --merge
-
Resets the index and updates the files in the working tree that are different between <commit>
and HEAD
, but keeps those which are different between the index and working tree (i.e. which have changes which have not been added). If a file that is different between <commit>
and the index has unstaged changes, reset is aborted.
In other words, --merge
does something like a git read-tree -u -m <commit>
, but carries forward unmerged index entries.
- --keep
-
Resets index entries and updates files in the working tree that are different between <commit>
and HEAD
. If a file that is different between <commit>
and HEAD
has local changes, reset is aborted.
- --[no-]recurse-submodules
-
When the working tree is updated, using --recurse-submodules will also recursively reset the working tree of all active submodules according to the commit recorded in the superproject, also setting the submodules' HEAD to be detached at that commit.
See "Reset, restore and revert" in git[1] for the differences between the three commands.
The tables below show what happens when running:
git reset --option target
to reset the HEAD
to another commit (target
) with the different reset options depending on the state of the files.
In these tables, A
, B
, C
and D
are some different states of a file. For example, the first line of the first table means that if a file is in state A
in the working tree, in state B
in the index, in state C
in HEAD
and in state D
in the target, then git reset --soft
target
will leave the file in the working tree in state A
and in the index in state B
. It resets (i.e. moves) the HEAD
(i.e. the tip of the current branch, if you are on one) to target
(which has the file in state D
).
working index HEAD target working index HEAD
----------------------------------------------------
A B C D --soft A B D
--mixed A D D
--hard D D D
--merge (disallowed)
--keep (disallowed)
working index HEAD target working index HEAD
----------------------------------------------------
A B C C --soft A B C
--mixed A C C
--hard C C C
--merge (disallowed)
--keep A C C
working index HEAD target working index HEAD
----------------------------------------------------
B B C D --soft B B D
--mixed B D D
--hard D D D
--merge D D D
--keep (disallowed)
working index HEAD target working index HEAD
----------------------------------------------------
B B C C --soft B B C
--mixed B C C
--hard C C C
--merge C C C
--keep B C C
working index HEAD target working index HEAD
----------------------------------------------------
B C C D --soft B C D
--mixed B D D
--hard D D D
--merge (disallowed)
--keep (disallowed)
working index HEAD target working index HEAD
----------------------------------------------------
B C C C --soft B C C
--mixed B C C
--hard C C C
--merge B C C
--keep B C C
reset --merge
is meant to be used when resetting out of a conflicted merge. Any mergy operation guarantees that the working tree file that is involved in the merge does not have a local change with respect to the index before it starts, and that it writes the result out to the working tree. So if we see some difference between the index and the target and also between the index and the working tree, then it means that we are not resetting out from a state that a mergy operation left after failing with a conflict. That is why we disallow --merge
option in this case.
reset --keep
is meant to be used when removing some of the last commits in the current branch while keeping changes in the working tree. If there could be conflicts between the changes in the commit we want to remove and the changes in the working tree we want to keep, the reset is disallowed. That’s why it is disallowed if there are both changes between the working tree and HEAD
, and between HEAD
and the target. To be safe, it is also disallowed when there are unmerged entries.
The following tables show what happens when there are unmerged entries:
working index HEAD target working index HEAD
----------------------------------------------------
X U A B --soft (disallowed)
--mixed X B B
--hard B B B
--merge B B B
--keep (disallowed)
working index HEAD target working index HEAD
----------------------------------------------------
X U A A --soft (disallowed)
--mixed X A A
--hard A A A
--merge A A A
--keep (disallowed)
X
means any state and U
means an unmerged index.