| blob | 89ddc85c2e4e79f6172fafa69f8622f6d8d4cef5 |
1 git-reset(1)
2 ============
4 NAME
5 ----
6 git-reset - Reset current HEAD to the specified state
8 SYNOPSIS
9 --------
10 [verse]
11 'git reset' [-q] [<tree-ish>] [--] <pathspec>...
12 'git reset' [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]
13 'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]
14 'git reset' [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
16 DESCRIPTION
17 -----------
18 In the first three forms, copy entries from `<tree-ish>` to the index.
19 In the last form, set the current branch head (`HEAD`) to `<commit>`,
20 optionally modifying index and working tree to match.
21 The `<tree-ish>`/`<commit>` defaults to `HEAD` in all forms.
23 'git reset' [-q] [<tree-ish>] [--] <pathspec>...::
24 'git reset' [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]::
25 These forms reset the index entries for all paths that match the
26 `<pathspec>` to their state at `<tree-ish>`. (It does not affect
27 the working tree or the current branch.)
28 +
29 This means that `git reset <pathspec>` is the opposite of `git add
30 <pathspec>`. This command is equivalent to
31 `git restore [--source=<tree-ish>] --staged <pathspec>...`.
32 +
33 After running `git reset <pathspec>` to update the index entry, you can
34 use linkgit:git-restore[1] to check the contents out of the index to
35 the working tree. Alternatively, using linkgit:git-restore[1]
36 and specifying a commit with `--source`, you
37 can copy the contents of a path out of a commit to the index and to the
38 working tree in one go.
40 'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]::
41 Interactively select hunks in the difference between the index
42 and `<tree-ish>` (defaults to `HEAD`). The chosen hunks are applied
43 in reverse to the index.
44 +
45 This means that `git reset -p` is the opposite of `git add -p`, i.e.
46 you can use it to selectively reset hunks. See the ``Interactive Mode''
47 section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
49 'git reset' [<mode>] [<commit>]::
50 This form resets the current branch head to `<commit>` and
51 possibly updates the index (resetting it to the tree of `<commit>`) and
52 the working tree depending on `<mode>`. If `<mode>` is omitted,
53 defaults to `--mixed`. The `<mode>` must be one of the following:
54 +
55 --
56 --soft::
57 Does not touch the index file or the working tree at all (but
58 resets the head to `<commit>`, just like all modes do). This leaves
59 all your changed files "Changes to be committed", as `git status`
60 would put it.
62 --mixed::
63 Resets the index but not the working tree (i.e., the changed files
64 are preserved but not marked for commit) and reports what has not
65 been updated. This is the default action.
66 +
67 If `-N` is specified, removed paths are marked as intent-to-add (see
68 linkgit:git-add[1]).
70 --hard::
71 Resets the index and working tree. Any changes to tracked files in the
72 working tree since `<commit>` are discarded. Any untracked files or
73 directories in the way of writing any tracked files are simply deleted.
75 --merge::
76 Resets the index and updates the files in the working tree that are
77 different between `<commit>` and `HEAD`, but keeps those which are
78 different between the index and working tree (i.e. which have changes
79 which have not been added).
80 If a file that is different between `<commit>` and the index has
81 unstaged changes, reset is aborted.
82 +
83 In other words, `--merge` does something like a `git read-tree -u -m <commit>`,
84 but carries forward unmerged index entries.
86 --keep::
87 Resets index entries and updates files in the working tree that are
88 different between `<commit>` and `HEAD`.
89 If a file that is different between `<commit>` and `HEAD` has local
90 changes, reset is aborted.
92 --[no-]recurse-submodules::
93 When the working tree is updated, using --recurse-submodules will
94 also recursively reset the working tree of all active submodules
95 according to the commit recorded in the superproject, also setting
96 the submodules' HEAD to be detached at that commit.
97 --
99 See "Reset, restore and revert" in linkgit:git[1] for the differences
100 between the three commands.
103 OPTIONS
104 -------
106 -q::
107 --quiet::
108 --no-quiet::
109 Be quiet, only report errors. The default behavior is set by the
110 `reset.quiet` config option. `--quiet` and `--no-quiet` will
111 override the default behavior.
113 --refresh::
114 --no-refresh::
115 Proactively refresh the index after a mixed reset. If unspecified, the
116 behavior falls back on the `reset.refresh` config option. If neither
117 `--[no-]refresh` nor `reset.refresh` are set, the default behavior is
118 decided by the `--[no-]quiet` option and/or `reset.quiet` config.
119 If `--quiet` is specified or `reset.quiet` is set with no command-line
120 "quiet" setting, refresh is disabled. Otherwise, refresh is enabled.
122 --pathspec-from-file=<file>::
123 Pathspec is passed in `<file>` instead of commandline args. If
124 `<file>` is exactly `-` then standard input is used. Pathspec
125 elements are separated by LF or CR/LF. Pathspec elements can be
126 quoted as explained for the configuration variable `core.quotePath`
127 (see linkgit:git-config[1]). See also `--pathspec-file-nul` and
128 global `--literal-pathspecs`.
130 --pathspec-file-nul::
131 Only meaningful with `--pathspec-from-file`. Pathspec elements are
132 separated with NUL character and all other characters are taken
133 literally (including newlines and quotes).
135 \--::
136 Do not interpret any more arguments as options.
138 <pathspec>...::
139 Limits the paths affected by the operation.
140 +
141 For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
143 EXAMPLES
144 --------
146 Undo add::
147 +
148 ------------
149 $ edit <1>
150 $ git add frotz.c filfre.c
151 $ mailx <2>
152 $ git reset <3>
153 $ git pull git://info.example.com/ nitfol <4>
154 ------------
155 +
156 <1> You are happily working on something, and find the changes
157 in these files are in good order. You do not want to see them
158 when you run `git diff`, because you plan to work on other files
159 and changes with these files are distracting.
160 <2> Somebody asks you to pull, and the changes sound worthy of merging.
161 <3> However, you already dirtied the index (i.e. your index does
162 not match the `HEAD` commit). But you know the pull you are going
163 to make does not affect `frotz.c` or `filfre.c`, so you revert the
164 index changes for these two files. Your changes in working tree
165 remain there.
166 <4> Then you can pull and merge, leaving `frotz.c` and `filfre.c`
167 changes still in the working tree.
169 Undo a commit and redo::
170 +
171 ------------
172 $ git commit ...
173 $ git reset --soft HEAD^ <1>
174 $ edit <2>
175 $ git commit -a -c ORIG_HEAD <3>
176 ------------
177 +
178 <1> This is most often done when you remembered what you
179 just committed is incomplete, or you misspelled your commit
180 message, or both. Leaves working tree as it was before "reset".
181 <2> Make corrections to working tree files.
182 <3> "reset" copies the old head to `.git/ORIG_HEAD`; redo the
183 commit by starting with its log message. If you do not need to
184 edit the message further, you can give `-C` option instead.
185 +
186 See also the `--amend` option to linkgit:git-commit[1].
188 Undo a commit, making it a topic branch::
189 +
190 ------------
191 $ git branch topic/wip <1>
192 $ git reset --hard HEAD~3 <2>
193 $ git switch topic/wip <3>
194 ------------
195 +
196 <1> You have made some commits, but realize they were premature
197 to be in the `master` branch. You want to continue polishing
198 them in a topic branch, so create `topic/wip` branch off of the
199 current `HEAD`.
200 <2> Rewind the master branch to get rid of those three commits.
201 <3> Switch to `topic/wip` branch and keep working.
203 Undo commits permanently::
204 +
205 ------------
206 $ git commit ...
207 $ git reset --hard HEAD~3 <1>
208 ------------
209 +
210 <1> The last three commits (`HEAD`, `HEAD^`, and `HEAD~2`) were bad
211 and you do not want to ever see them again. Do *not* do this if
212 you have already given these commits to somebody else. (See the
213 "RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1]
214 for the implications of doing so.)
216 Undo a merge or pull::
217 +
218 ------------
219 $ git pull <1>
220 Auto-merging nitfol
221 CONFLICT (content): Merge conflict in nitfol
222 Automatic merge failed; fix conflicts and then commit the result.
223 $ git reset --hard <2>
224 $ git pull . topic/branch <3>
225 Updating from 41223... to 13134...
226 Fast-forward
227 $ git reset --hard ORIG_HEAD <4>
228 ------------
229 +
230 <1> Try to update from the upstream resulted in a lot of
231 conflicts; you were not ready to spend a lot of time merging
232 right now, so you decide to do that later.
233 <2> "pull" has not made merge commit, so `git reset --hard`
234 which is a synonym for `git reset --hard HEAD` clears the mess
235 from the index file and the working tree.
236 <3> Merge a topic branch into the current branch, which resulted
237 in a fast-forward.
238 <4> But you decided that the topic branch is not ready for public
239 consumption yet. "pull" or "merge" always leaves the original
240 tip of the current branch in `ORIG_HEAD`, so resetting hard to it
241 brings your index file and the working tree back to that state,
242 and resets the tip of the branch to that commit.
244 Undo a merge or pull inside a dirty working tree::
245 +
246 ------------
247 $ git pull <1>
248 Auto-merging nitfol
249 Merge made by recursive.
250 nitfol | 20 +++++----
251 ...
252 $ git reset --merge ORIG_HEAD <2>
253 ------------
254 +
255 <1> Even if you may have local modifications in your
256 working tree, you can safely say `git pull` when you know
257 that the change in the other branch does not overlap with
258 them.
259 <2> After inspecting the result of the merge, you may find
260 that the change in the other branch is unsatisfactory. Running
261 `git reset --hard ORIG_HEAD` will let you go back to where you
262 were, but it will discard your local changes, which you do not
263 want. `git reset --merge` keeps your local changes.
266 Interrupted workflow::
267 +
268 Suppose you are interrupted by an urgent fix request while you
269 are in the middle of a large change. The files in your
270 working tree are not in any shape to be committed yet, but you
271 need to get to the other branch for a quick bugfix.
272 +
273 ------------
274 $ git switch feature ;# you were working in "feature" branch and
275 $ work work work ;# got interrupted
276 $ git commit -a -m "snapshot WIP" <1>
277 $ git switch master
278 $ fix fix fix
279 $ git commit ;# commit with real log
280 $ git switch feature
281 $ git reset --soft HEAD^ ;# go back to WIP state <2>
282 $ git reset <3>
283 ------------
284 +
285 <1> This commit will get blown away so a throw-away log message is OK.
286 <2> This removes the 'WIP' commit from the commit history, and sets
287 your working tree to the state just before you made that snapshot.
288 <3> At this point the index file still has all the WIP changes you
289 committed as 'snapshot WIP'. This updates the index to show your
290 WIP files as uncommitted.
291 +
292 See also linkgit:git-stash[1].
294 Reset a single file in the index::
295 +
296 Suppose you have added a file to your index, but later decide you do not
297 want to add it to your commit. You can remove the file from the index
298 while keeping your changes with git reset.
299 +
300 ------------
301 $ git reset -- frotz.c <1>
302 $ git commit -m "Commit files in index" <2>
303 $ git add frotz.c <3>
304 ------------
305 +
306 <1> This removes the file from the index while keeping it in the working
307 directory.
308 <2> This commits all other changes in the index.
309 <3> Adds the file to the index again.
311 Keep changes in working tree while discarding some previous commits::
312 +
313 Suppose you are working on something and you commit it, and then you
314 continue working a bit more, but now you think that what you have in
315 your working tree should be in another branch that has nothing to do
316 with what you committed previously. You can start a new branch and
317 reset it while keeping the changes in your working tree.
318 +
319 ------------
320 $ git tag start
321 $ git switch -c branch1
322 $ edit
323 $ git commit ... <1>
324 $ edit
325 $ git switch -c branch2 <2>
326 $ git reset --keep start <3>
327 ------------
328 +
329 <1> This commits your first edits in `branch1`.
330 <2> In the ideal world, you could have realized that the earlier
331 commit did not belong to the new topic when you created and switched
332 to `branch2` (i.e. `git switch -c branch2 start`), but nobody is
333 perfect.
334 <3> But you can use `reset --keep` to remove the unwanted commit after
335 you switched to `branch2`.
337 Split a commit apart into a sequence of commits::
338 +
339 Suppose that you have created lots of logically separate changes and committed
340 them together. Then, later you decide that it might be better to have each
341 logical chunk associated with its own commit. You can use git reset to rewind
342 history without changing the contents of your local files, and then successively
343 use `git add -p` to interactively select which hunks to include into each commit,
344 using `git commit -c` to pre-populate the commit message.
345 +
346 ------------
347 $ git reset -N HEAD^ <1>
348 $ git add -p <2>
349 $ git diff --cached <3>
350 $ git commit -c HEAD@{1} <4>
351 ... <5>
352 $ git add ... <6>
353 $ git diff --cached <7>
354 $ git commit ... <8>
355 ------------
356 +
357 <1> First, reset the history back one commit so that we remove the original
358 commit, but leave the working tree with all the changes. The -N ensures
359 that any new files added with `HEAD` are still marked so that `git add -p`
360 will find them.
361 <2> Next, we interactively select diff hunks to add using the `git add -p`
362 facility. This will ask you about each diff hunk in sequence and you can
363 use simple commands such as "yes, include this", "No don't include this"
364 or even the very powerful "edit" facility.
365 <3> Once satisfied with the hunks you want to include, you should verify what
366 has been prepared for the first commit by using `git diff --cached`. This
367 shows all the changes that have been moved into the index and are about
368 to be committed.
369 <4> Next, commit the changes stored in the index. The `-c` option specifies to
370 pre-populate the commit message from the original message that you started
371 with in the first commit. This is helpful to avoid retyping it. The
372 `HEAD@{1}` is a special notation for the commit that `HEAD` used to be at
373 prior to the original reset commit (1 change ago).
374 See linkgit:git-reflog[1] for more details. You may also use any other
375 valid commit reference.
376 <5> You can repeat steps 2-4 multiple times to break the original code into
377 any number of commits.
378 <6> Now you've split out many of the changes into their own commits, and might
379 no longer use the patch mode of `git add`, in order to select all remaining
380 uncommitted changes.
381 <7> Once again, check to verify that you've included what you want to. You may
382 also wish to verify that git diff doesn't show any remaining changes to be
383 committed later.
384 <8> And finally create the final commit.
387 DISCUSSION
388 ----------
390 The tables below show what happens when running:
392 ----------
393 git reset --option target
394 ----------
396 to reset the `HEAD` to another commit (`target`) with the different
397 reset options depending on the state of the files.
399 In these tables, `A`, `B`, `C` and `D` are some different states of a
400 file. For example, the first line of the first table means that if a
401 file is in state `A` in the working tree, in state `B` in the index, in
402 state `C` in `HEAD` and in state `D` in the target, then `git reset --soft
403 target` will leave the file in the working tree in state `A` and in the
404 index in state `B`. It resets (i.e. moves) the `HEAD` (i.e. the tip of
405 the current branch, if you are on one) to `target` (which has the file
406 in state `D`).
408 ....
409 working index HEAD target working index HEAD
410 ----------------------------------------------------
411 A B C D --soft A B D
412 --mixed A D D
413 --hard D D D
414 --merge (disallowed)
415 --keep (disallowed)
416 ....
418 ....
419 working index HEAD target working index HEAD
420 ----------------------------------------------------
421 A B C C --soft A B C
422 --mixed A C C
423 --hard C C C
424 --merge (disallowed)
425 --keep A C C
426 ....
428 ....
429 working index HEAD target working index HEAD
430 ----------------------------------------------------
431 B B C D --soft B B D
432 --mixed B D D
433 --hard D D D
434 --merge D D D
435 --keep (disallowed)
436 ....
438 ....
439 working index HEAD target working index HEAD
440 ----------------------------------------------------
441 B B C C --soft B B C
442 --mixed B C C
443 --hard C C C
444 --merge C C C
445 --keep B C C
446 ....
448 ....
449 working index HEAD target working index HEAD
450 ----------------------------------------------------
451 B C C D --soft B C D
452 --mixed B D D
453 --hard D D D
454 --merge (disallowed)
455 --keep (disallowed)
456 ....
458 ....
459 working index HEAD target working index HEAD
460 ----------------------------------------------------
461 B C C C --soft B C C
462 --mixed B C C
463 --hard C C C
464 --merge B C C
465 --keep B C C
466 ....
468 `reset --merge` is meant to be used when resetting out of a conflicted
469 merge. Any mergy operation guarantees that the working tree file that is
470 involved in the merge does not have a local change with respect to the index
471 before it starts, and that it writes the result out to the working tree. So if
472 we see some difference between the index and the target and also
473 between the index and the working tree, then it means that we are not
474 resetting out from a state that a mergy operation left after failing
475 with a conflict. That is why we disallow `--merge` option in this case.
477 `reset --keep` is meant to be used when removing some of the last
478 commits in the current branch while keeping changes in the working
479 tree. If there could be conflicts between the changes in the commit we
480 want to remove and the changes in the working tree we want to keep,
481 the reset is disallowed. That's why it is disallowed if there are both
482 changes between the working tree and `HEAD`, and between `HEAD` and the
483 target. To be safe, it is also disallowed when there are unmerged
484 entries.
486 The following tables show what happens when there are unmerged
487 entries:
489 ....
490 working index HEAD target working index HEAD
491 ----------------------------------------------------
492 X U A B --soft (disallowed)
493 --mixed X B B
494 --hard B B B
495 --merge B B B
496 --keep (disallowed)
497 ....
499 ....
500 working index HEAD target working index HEAD
501 ----------------------------------------------------
502 X U A A --soft (disallowed)
503 --mixed X A A
504 --hard A A A
505 --merge A A A
506 --keep (disallowed)
507 ....
509 `X` means any state and `U` means an unmerged index.
511 GIT
512 ---
513 Part of the linkgit:git[1] suite