git/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' [--mixed | --soft | --hard] [<commit>]
  12 'git-reset' [--mixed] <commit> [--] <paths>...
  13
  14 DESCRIPTION
  15 -----------
  16 Sets the current head to the specified commit and optionally resets the
  17 index and working tree to match.
  18
  19 This command is useful if you notice some small error in a recent
  20 commit (or set of commits) and want to redo that part without showing
  21 the undo in the history.
  22
  23 If you want to undo a commit other than the latest on a branch,
  24 gitlink:git-revert[1] is your friend.
  25
  26 The second form with 'paths' is used to revert selected paths in
  27 the index from a given commit, without moving HEAD.
  28
  29
  30 OPTIONS
  31 -------
  32 --mixed::
  33         Resets the index but not the working tree (i.e., the changed files
  34         are preserved but not marked for commit) and reports what has not
  35         been updated. This is the default action.
  36
  37 --soft::
  38         Does not touch the index file nor the working tree at all, but
  39         requires them to be in a good order. This leaves all your changed
  40         files "Added but not yet committed", as gitlink:git-status[1] would
  41         put it.
  42
  43 --hard::
  44         Matches the working tree and index to that of the tree being
  45         switched to. Any changes to tracked files in the working tree
  46         since <commit> are lost.
  47
  48 <commit>::
  49         Commit to make the current HEAD.
  50
  51 Examples
  52 --------
  53
  54 Undo a commit and redo::
  55 +
  56 ------------
  57 $ git commit ...
  58 $ git reset --soft HEAD^      <1>
  59 $ edit                        <2>
  60 $ git commit -a -c ORIG_HEAD  <3>
  61 ------------
  62 +
  63 <1> This is most often done when you remembered what you
  64 just committed is incomplete, or you misspelled your commit
  65 message, or both.  Leaves working tree as it was before "reset".
  66 <2> make corrections to working tree files.
  67 <3> "reset" copies the old head to .git/ORIG_HEAD; redo the
  68 commit by starting with its log message.  If you do not need to
  69 edit the message further, you can give -C option instead.
  70 +
  71 See also the --amend option to gitlink:git-commit[1].
  72
  73 Undo commits permanently::
  74 +
  75 ------------
  76 $ git commit ...
  77 $ git reset --hard HEAD~3   <1>
  78 ------------
  79 +
  80 <1> The last three commits (HEAD, HEAD^, and HEAD~2) were bad
  81 and you do not want to ever see them again.  Do *not* do this if
  82 you have already given these commits to somebody else.
  83
  84 Undo a commit, making it a topic branch::
  85 +
  86 ------------
  87 $ git branch topic/wip     <1>
  88 $ git reset --hard HEAD~3  <2>
  89 $ git checkout topic/wip   <3>
  90 ------------
  91 +
  92 <1> You have made some commits, but realize they were premature
  93 to be in the "master" branch.  You want to continue polishing
  94 them in a topic branch, so create "topic/wip" branch off of the
  95 current HEAD.
  96 <2> Rewind the master branch to get rid of those three commits.
  97 <3> Switch to "topic/wip" branch and keep working.
  98
  99 Undo add::
 100 +
 101 ------------
 102 $ edit                                     <1>
 103 $ git add frotz.c filfre.c
 104 $ mailx                                    <2>
 105 $ git reset                                <3>
 106 $ git pull git://info.example.com/ nitfol  <4>
 107 ------------
 108 +
 109 <1> you are happily working on something, and find the changes
 110 in these files are in good order.  You do not want to see them
 111 when you run "git diff", because you plan to work on other files
 112 and changes with these files are distracting.
 113 <2> somebody asks you to pull, and the changes sounds worthy of merging.
 114 <3> however, you already dirtied the index (i.e. your index does
 115 not match the HEAD commit).  But you know the pull you are going
 116 to make does not affect frotz.c nor filfre.c, so you revert the
 117 index changes for these two files.  Your changes in working tree
 118 remain there.
 119 <4> then you can pull and merge, leaving frotz.c and filfre.c
 120 changes still in the working tree.
 121
 122 Undo a merge or pull::
 123 +
 124 ------------
 125 $ git pull                         <1>
 126 Auto-merging nitfol
 127 CONFLICT (content): Merge conflict in nitfol
 128 Automatic merge failed/prevented; fix up by hand
 129 $ git reset --hard                 <2>
 130 $ git pull . topic/branch          <3>
 131 Updating from 41223... to 13134...
 132 Fast forward
 133 $ git reset --hard ORIG_HEAD       <4>
 134 ------------
 135 +
 136 <1> try to update from the upstream resulted in a lot of
 137 conflicts; you were not ready to spend a lot of time merging
 138 right now, so you decide to do that later.
 139 <2> "pull" has not made merge commit, so "git reset --hard"
 140 which is a synonym for "git reset --hard HEAD" clears the mess
 141 from the index file and the working tree.
 142 <3> merge a topic branch into the current branch, which resulted
 143 in a fast forward.
 144 <4> but you decided that the topic branch is not ready for public
 145 consumption yet.  "pull" or "merge" always leaves the original
 146 tip of the current branch in ORIG_HEAD, so resetting hard to it
 147 brings your index file and the working tree back to that state,
 148 and resets the tip of the branch to that commit.
 149
 150 Interrupted workflow::
 151 +
 152 Suppose you are interrupted by an urgent fix request while you
 153 are in the middle of a large change.  The files in your
 154 working tree are not in any shape to be committed yet, but you
 155 need to get to the other branch for a quick bugfix.
 156 +
 157 ------------
 158 $ git checkout feature ;# you were working in "feature" branch and
 159 $ work work work       ;# got interrupted
 160 $ git commit -a -m 'snapshot WIP'                 <1>
 161 $ git checkout master
 162 $ fix fix fix
 163 $ git commit ;# commit with real log
 164 $ git checkout feature
 165 $ git reset --soft HEAD^ ;# go back to WIP state  <2>
 166 $ git reset                                       <3>
 167 ------------
 168 +
 169 <1> This commit will get blown away so a throw-away log message is OK.
 170 <2> This removes the 'WIP' commit from the commit history, and sets
 171     your working tree to the state just before you made that snapshot.
 172 <3> At this point the index file still has all the WIP changes you
 173     committed as 'snapshot WIP'.  This updates the index to show your
 174     WIP files as uncommitted.
 175
 176 Author
 177 ------
 178 Written by Junio C Hamano <junkio@cox.net> and Linus Torvalds <torvalds@osdl.org>
 179
 180 Documentation
 181 --------------
 182 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 183
 184 GIT
 185 ---
 186 Part of the gitlink:git[7] suite