Documentation/git-reset.txt

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