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