]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-reset(1) |
2 | ============ | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-reset - Reset current HEAD to the specified state |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
6934dec8 | 10 | [verse] |
ceb4cacb | 11 | 'git reset' [-q] [<commit>] [--] <paths>... |
d002ef4d | 12 | 'git reset' --patch [<commit>] [--] [<paths>...] |
7b8cd49d | 13 | 'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>] |
7fc9d69f JH |
14 | |
15 | DESCRIPTION | |
16 | ----------- | |
7b8cd49d | 17 | In the first and second form, copy entries from <commit> to the index. |
d537c749 | 18 | In the third form, set the current branch head (HEAD) to <commit>, optionally |
06cdac5a | 19 | modifying index and working tree to match. The <commit> defaults to HEAD |
7b8cd49d TR |
20 | in all forms. |
21 | ||
22 | 'git reset' [-q] [<commit>] [--] <paths>...:: | |
23 | This form resets the index entries for all <paths> to their | |
d537c749 | 24 | state at <commit>. (It does not affect the working tree, nor |
7b8cd49d TR |
25 | the current branch.) |
26 | + | |
27 | This means that `git reset <paths>` is the opposite of `git add | |
28 | <paths>`. | |
9980d7de MG |
29 | + |
30 | After running `git reset <paths>` to update the index entry, you can | |
31 | use linkgit:git-checkout[1] to check the contents out of the index to | |
32 | the working tree. | |
33 | Alternatively, using linkgit:git-checkout[1] and specifying a commit, you | |
34 | can copy the contents of a path out of a commit to the index and to the | |
35 | working tree in one go. | |
6934dec8 | 36 | |
7b8cd49d TR |
37 | 'git reset' --patch|-p [<commit>] [--] [<paths>...]:: |
38 | Interactively select hunks in the difference between the index | |
39 | and <commit> (defaults to HEAD). The chosen hunks are applied | |
40 | in reverse to the index. | |
41 | + | |
42 | This means that `git reset -p` is the opposite of `git add -p` (see | |
43 | linkgit:git-add[1]). | |
6934dec8 | 44 | |
7b8cd49d | 45 | 'git reset' [--<mode>] [<commit>]:: |
d537c749 MG |
46 | This form resets the current branch head to <commit> and |
47 | possibly updates the index (resetting it to the tree of <commit>) and | |
48 | the working tree depending on <mode>, which | |
49 | must be one of the following: | |
7b8cd49d TR |
50 | + |
51 | -- | |
f67545ea | 52 | --soft:: |
cca5d0b0 MG |
53 | Does not touch the index file nor the working tree at all (but |
54 | resets the head to <commit>, just like all modes do). This leaves | |
55 | all your changed files "Changes to be committed", as 'git status' | |
56 | would put it. | |
7fc9d69f | 57 | |
bb59b7ff TR |
58 | --mixed:: |
59 | Resets the index but not the working tree (i.e., the changed files | |
60 | are preserved but not marked for commit) and reports what has not | |
61 | been updated. This is the default action. | |
62 | ||
f67545ea | 63 | --hard:: |
d537c749 MG |
64 | Resets the index and working tree. Any changes to tracked files in the |
65 | working tree since <commit> are discarded. | |
7fc9d69f | 66 | |
1b5b465f | 67 | --merge:: |
d537c749 MG |
68 | Resets the index and updates the files in the working tree that are |
69 | different between <commit> and HEAD, but keeps those which are | |
70 | different between the index and working tree (i.e. which have changes | |
71 | which have not been added). | |
72 | If a file that is different between <commit> and the index has unstaged | |
73 | changes, reset is aborted. | |
74 | + | |
75 | In other words, --merge does something like a 'git read-tree -u -m <commit>', | |
76 | but carries forward unmerged index entries. | |
1b5b465f | 77 | |
7349df11 | 78 | --keep:: |
8c0db6fd JN |
79 | Resets index entries and updates files in the working tree that are |
80 | different between <commit> and HEAD. | |
d537c749 MG |
81 | If a file that is different between <commit> and HEAD has local changes, |
82 | reset is aborted. | |
7b8cd49d | 83 | -- |
7349df11 | 84 | |
7b8cd49d TR |
85 | If you want to undo a commit other than the latest on a branch, |
86 | linkgit:git-revert[1] is your friend. | |
87 | ||
88 | ||
89 | OPTIONS | |
90 | ------- | |
d002ef4d | 91 | |
521b53e5 | 92 | -q:: |
5d2dcc42 | 93 | --quiet:: |
521b53e5 GP |
94 | Be quiet, only report errors. |
95 | ||
7fc9d69f | 96 | |
28bb4b27 | 97 | EXAMPLES |
2b5f3ed3 | 98 | -------- |
1e2ccd3a | 99 | |
8bb95bbc TR |
100 | Undo add:: |
101 | + | |
102 | ------------ | |
103 | $ edit <1> | |
104 | $ git add frotz.c filfre.c | |
105 | $ mailx <2> | |
106 | $ git reset <3> | |
107 | $ git pull git://info.example.com/ nitfol <4> | |
108 | ------------ | |
109 | + | |
110 | <1> You are happily working on something, and find the changes | |
111 | in these files are in good order. You do not want to see them | |
112 | when you run "git diff", because you plan to work on other files | |
113 | and changes with these files are distracting. | |
114 | <2> Somebody asks you to pull, and the changes sounds worthy of merging. | |
115 | <3> However, you already dirtied the index (i.e. your index does | |
116 | not match the HEAD commit). But you know the pull you are going | |
117 | to make does not affect frotz.c nor filfre.c, so you revert the | |
118 | index changes for these two files. Your changes in working tree | |
119 | remain there. | |
120 | <4> Then you can pull and merge, leaving frotz.c and filfre.c | |
121 | changes still in the working tree. | |
122 | ||
1e2ccd3a JH |
123 | Undo a commit and redo:: |
124 | + | |
125 | ------------ | |
126 | $ git commit ... | |
48aeecdc SE |
127 | $ git reset --soft HEAD^ <1> |
128 | $ edit <2> | |
129 | $ git commit -a -c ORIG_HEAD <3> | |
130 | ------------ | |
131 | + | |
1e2ccd3a JH |
132 | <1> This is most often done when you remembered what you |
133 | just committed is incomplete, or you misspelled your commit | |
134 | message, or both. Leaves working tree as it was before "reset". | |
434e6ef8 | 135 | <2> Make corrections to working tree files. |
1e2ccd3a JH |
136 | <3> "reset" copies the old head to .git/ORIG_HEAD; redo the |
137 | commit by starting with its log message. If you do not need to | |
138 | edit the message further, you can give -C option instead. | |
41728d69 | 139 | + |
5162e697 | 140 | See also the --amend option to linkgit:git-commit[1]. |
1e2ccd3a | 141 | |
1e2ccd3a JH |
142 | Undo a commit, making it a topic branch:: |
143 | + | |
144 | ------------ | |
48aeecdc SE |
145 | $ git branch topic/wip <1> |
146 | $ git reset --hard HEAD~3 <2> | |
147 | $ git checkout topic/wip <3> | |
148 | ------------ | |
149 | + | |
1e2ccd3a JH |
150 | <1> You have made some commits, but realize they were premature |
151 | to be in the "master" branch. You want to continue polishing | |
152 | them in a topic branch, so create "topic/wip" branch off of the | |
153 | current HEAD. | |
154 | <2> Rewind the master branch to get rid of those three commits. | |
155 | <3> Switch to "topic/wip" branch and keep working. | |
1e2ccd3a | 156 | |
6e90f7b8 TR |
157 | Undo commits permanently:: |
158 | + | |
159 | ------------ | |
160 | $ git commit ... | |
161 | $ git reset --hard HEAD~3 <1> | |
162 | ------------ | |
163 | + | |
164 | <1> The last three commits (HEAD, HEAD^, and HEAD~2) were bad | |
165 | and you do not want to ever see them again. Do *not* do this if | |
166 | you have already given these commits to somebody else. (See the | |
167 | "RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1] for | |
168 | the implications of doing so.) | |
169 | ||
3ae854c3 JH |
170 | Undo a merge or pull:: |
171 | + | |
172 | ------------ | |
48aeecdc | 173 | $ git pull <1> |
3ae854c3 JH |
174 | Auto-merging nitfol |
175 | CONFLICT (content): Merge conflict in nitfol | |
ec9f0ea3 | 176 | Automatic merge failed; fix conflicts and then commit the result. |
48aeecdc SE |
177 | $ git reset --hard <2> |
178 | $ git pull . topic/branch <3> | |
179 | Updating from 41223... to 13134... | |
a75d7b54 | 180 | Fast-forward |
48aeecdc SE |
181 | $ git reset --hard ORIG_HEAD <4> |
182 | ------------ | |
183 | + | |
434e6ef8 | 184 | <1> Try to update from the upstream resulted in a lot of |
3ae854c3 JH |
185 | conflicts; you were not ready to spend a lot of time merging |
186 | right now, so you decide to do that later. | |
187 | <2> "pull" has not made merge commit, so "git reset --hard" | |
188 | which is a synonym for "git reset --hard HEAD" clears the mess | |
189 | from the index file and the working tree. | |
434e6ef8 | 190 | <3> Merge a topic branch into the current branch, which resulted |
a75d7b54 | 191 | in a fast-forward. |
434e6ef8 | 192 | <4> But you decided that the topic branch is not ready for public |
3ae854c3 JH |
193 | consumption yet. "pull" or "merge" always leaves the original |
194 | tip of the current branch in ORIG_HEAD, so resetting hard to it | |
195 | brings your index file and the working tree back to that state, | |
196 | and resets the tip of the branch to that commit. | |
1e2ccd3a | 197 | |
06cdac5a | 198 | Undo a merge or pull inside a dirty working tree:: |
1b5b465f JH |
199 | + |
200 | ------------ | |
201 | $ git pull <1> | |
202 | Auto-merging nitfol | |
203 | Merge made by recursive. | |
204 | nitfol | 20 +++++---- | |
205 | ... | |
206 | $ git reset --merge ORIG_HEAD <2> | |
207 | ------------ | |
208 | + | |
209 | <1> Even if you may have local modifications in your | |
210 | working tree, you can safely say "git pull" when you know | |
211 | that the change in the other branch does not overlap with | |
212 | them. | |
213 | <2> After inspecting the result of the merge, you may find | |
214 | that the change in the other branch is unsatisfactory. Running | |
215 | "git reset --hard ORIG_HEAD" will let you go back to where you | |
216 | were, but it will discard your local changes, which you do not | |
217 | want. "git reset --merge" keeps your local changes. | |
218 | ||
219 | ||
a0dfb48a JH |
220 | Interrupted workflow:: |
221 | + | |
8278ac2f BF |
222 | Suppose you are interrupted by an urgent fix request while you |
223 | are in the middle of a large change. The files in your | |
a0dfb48a JH |
224 | working tree are not in any shape to be committed yet, but you |
225 | need to get to the other branch for a quick bugfix. | |
226 | + | |
227 | ------------ | |
228 | $ git checkout feature ;# you were working in "feature" branch and | |
229 | $ work work work ;# got interrupted | |
d336fc09 | 230 | $ git commit -a -m "snapshot WIP" <1> |
a0dfb48a JH |
231 | $ git checkout master |
232 | $ fix fix fix | |
233 | $ git commit ;# commit with real log | |
234 | $ git checkout feature | |
48aeecdc SE |
235 | $ git reset --soft HEAD^ ;# go back to WIP state <2> |
236 | $ git reset <3> | |
237 | ------------ | |
238 | + | |
a0dfb48a | 239 | <1> This commit will get blown away so a throw-away log message is OK. |
8278ac2f BF |
240 | <2> This removes the 'WIP' commit from the commit history, and sets |
241 | your working tree to the state just before you made that snapshot. | |
48aeecdc SE |
242 | <3> At this point the index file still has all the WIP changes you |
243 | committed as 'snapshot WIP'. This updates the index to show your | |
244 | WIP files as uncommitted. | |
53682f0c MH |
245 | + |
246 | See also linkgit:git-stash[1]. | |
a0dfb48a | 247 | |
965053b0 PB |
248 | Reset a single file in the index:: |
249 | + | |
250 | Suppose you have added a file to your index, but later decide you do not | |
251 | want to add it to your commit. You can remove the file from the index | |
252 | while keeping your changes with git reset. | |
253 | + | |
254 | ------------ | |
255 | $ git reset -- frotz.c <1> | |
256 | $ git commit -m "Commit files in index" <2> | |
257 | $ git add frotz.c <3> | |
258 | ------------ | |
259 | + | |
260 | <1> This removes the file from the index while keeping it in the working | |
261 | directory. | |
262 | <2> This commits all other changes in the index. | |
263 | <3> Adds the file to the index again. | |
264 | ||
7349df11 CC |
265 | Keep changes in working tree while discarding some previous commits:: |
266 | + | |
267 | Suppose you are working on something and you commit it, and then you | |
268 | continue working a bit more, but now you think that what you have in | |
269 | your working tree should be in another branch that has nothing to do | |
6b677a28 | 270 | with what you committed previously. You can start a new branch and |
06cdac5a | 271 | reset it while keeping the changes in your working tree. |
7349df11 CC |
272 | + |
273 | ------------ | |
274 | $ git tag start | |
275 | $ git checkout -b branch1 | |
276 | $ edit | |
277 | $ git commit ... <1> | |
278 | $ edit | |
279 | $ git checkout -b branch2 <2> | |
280 | $ git reset --keep start <3> | |
281 | ------------ | |
282 | + | |
283 | <1> This commits your first edits in branch1. | |
284 | <2> In the ideal world, you could have realized that the earlier | |
285 | commit did not belong to the new topic when you created and switched | |
286 | to branch2 (i.e. "git checkout -b branch2 start"), but nobody is | |
287 | perfect. | |
288 | <3> But you can use "reset --keep" to remove the unwanted commit after | |
289 | you switched to "branch2". | |
290 | ||
28bb4b27 TR |
291 | |
292 | DISCUSSION | |
293 | ---------- | |
294 | ||
295 | The tables below show what happens when running: | |
296 | ||
297 | ---------- | |
298 | git reset --option target | |
299 | ---------- | |
300 | ||
301 | to reset the HEAD to another commit (`target`) with the different | |
302 | reset options depending on the state of the files. | |
303 | ||
304 | In these tables, A, B, C and D are some different states of a | |
305 | file. For example, the first line of the first table means that if a | |
306 | file is in state A in the working tree, in state B in the index, in | |
307 | state C in HEAD and in state D in the target, then "git reset --soft | |
aad84414 MG |
308 | target" will leave the file in the working tree in state A and in the |
309 | index in state B. It resets (i.e. moves) the HEAD (i.e. the tip of | |
310 | the current branch, if you are on one) to "target" (which has the file | |
311 | in state D). | |
28bb4b27 TR |
312 | |
313 | working index HEAD target working index HEAD | |
314 | ---------------------------------------------------- | |
315 | A B C D --soft A B D | |
316 | --mixed A D D | |
317 | --hard D D D | |
318 | --merge (disallowed) | |
319 | --keep (disallowed) | |
320 | ||
321 | working index HEAD target working index HEAD | |
322 | ---------------------------------------------------- | |
323 | A B C C --soft A B C | |
324 | --mixed A C C | |
325 | --hard C C C | |
326 | --merge (disallowed) | |
327 | --keep A C C | |
328 | ||
329 | working index HEAD target working index HEAD | |
330 | ---------------------------------------------------- | |
331 | B B C D --soft B B D | |
332 | --mixed B D D | |
333 | --hard D D D | |
334 | --merge D D D | |
335 | --keep (disallowed) | |
336 | ||
337 | working index HEAD target working index HEAD | |
338 | ---------------------------------------------------- | |
339 | B B C C --soft B B C | |
340 | --mixed B C C | |
341 | --hard C C C | |
342 | --merge C C C | |
343 | --keep B C C | |
344 | ||
345 | working index HEAD target working index HEAD | |
346 | ---------------------------------------------------- | |
347 | B C C D --soft B C D | |
348 | --mixed B D D | |
349 | --hard D D D | |
350 | --merge (disallowed) | |
351 | --keep (disallowed) | |
352 | ||
353 | working index HEAD target working index HEAD | |
354 | ---------------------------------------------------- | |
355 | B C C C --soft B C C | |
356 | --mixed B C C | |
357 | --hard C C C | |
358 | --merge B C C | |
359 | --keep B C C | |
360 | ||
361 | "reset --merge" is meant to be used when resetting out of a conflicted | |
06cdac5a | 362 | merge. Any mergy operation guarantees that the working tree file that is |
28bb4b27 | 363 | involved in the merge does not have local change wrt the index before |
06cdac5a | 364 | it starts, and that it writes the result out to the working tree. So if |
28bb4b27 | 365 | we see some difference between the index and the target and also |
06cdac5a | 366 | between the index and the working tree, then it means that we are not |
28bb4b27 TR |
367 | resetting out from a state that a mergy operation left after failing |
368 | with a conflict. That is why we disallow --merge option in this case. | |
369 | ||
370 | "reset --keep" is meant to be used when removing some of the last | |
371 | commits in the current branch while keeping changes in the working | |
372 | tree. If there could be conflicts between the changes in the commit we | |
373 | want to remove and the changes in the working tree we want to keep, | |
374 | the reset is disallowed. That's why it is disallowed if there are both | |
375 | changes between the working tree and HEAD, and between HEAD and the | |
376 | target. To be safe, it is also disallowed when there are unmerged | |
377 | entries. | |
378 | ||
379 | The following tables show what happens when there are unmerged | |
380 | entries: | |
381 | ||
382 | working index HEAD target working index HEAD | |
383 | ---------------------------------------------------- | |
384 | X U A B --soft (disallowed) | |
385 | --mixed X B B | |
386 | --hard B B B | |
387 | --merge B B B | |
388 | --keep (disallowed) | |
389 | ||
390 | working index HEAD target working index HEAD | |
391 | ---------------------------------------------------- | |
392 | X U A A --soft (disallowed) | |
393 | --mixed X A A | |
394 | --hard A A A | |
395 | --merge A A A | |
396 | --keep (disallowed) | |
397 | ||
398 | X means any state and U means an unmerged index. | |
399 | ||
7fc9d69f JH |
400 | GIT |
401 | --- | |
9e1f0a85 | 402 | Part of the linkgit:git[1] suite |