Documentation/git-stash.txt

   1 git-stash(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-stash - Stash the changes in a dirty working directory away
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git stash' list [<options>]
  12 'git stash' show [<stash>]
  13 'git stash' drop [-q|--quiet] [<stash>]
  14 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
  15 'git stash' branch <branchname> [<stash>]
  16 'git stash' [save [--patch] [--[no-]keep-index] [-q|--quiet] [<message>]]
  17 'git stash' clear
  18 'git stash' create
  19
  20 DESCRIPTION
  21 -----------
  22
  23 Use 'git stash' when you want to record the current state of the
  24 working directory and the index, but want to go back to a clean
  25 working directory.  The command saves your local modifications away
  26 and reverts the working directory to match the `HEAD` commit.
  27
  28 The modifications stashed away by this command can be listed with
  29 `git stash list`, inspected with `git stash show`, and restored
  30 (potentially on top of a different commit) with `git stash apply`.
  31 Calling `git stash` without any arguments is equivalent to `git stash save`.
  32 A stash is by default listed as "WIP on 'branchname' ...", but
  33 you can give a more descriptive message on the command line when
  34 you create one.
  35
  36 The latest stash you created is stored in `$GIT_DIR/refs/stash`; older
  37 stashes are found in the reflog of this reference and can be named using
  38 the usual reflog syntax (e.g. `stash@\{0}` is the most recently
  39 created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}`
  40 is also possible).
  41
  42 OPTIONS
  43 -------
  44
  45 save [--patch] [--[no-]keep-index] [-q|--quiet] [<message>]::
  46
  47         Save your local modifications to a new 'stash', and run `git reset
  48         --hard` to revert them.  This is the default action when no
  49         subcommand is given. The <message> part is optional and gives
  50         the description along with the stashed state.
  51 +
  52 If the `--keep-index` option is used, all changes already added to the
  53 index are left intact.
  54 +
  55 With `--patch`, you can interactively select hunks from in the diff
  56 between HEAD and the working tree to be stashed.  The stash entry is
  57 constructed such that its index state is the same as the index state
  58 of your repository, and its worktree contains only the changes you
  59 selected interactively.  The selected changes are then rolled back
  60 from your worktree.
  61 +
  62 The `--patch` option implies `--keep-index`.  You can use
  63 `--no-keep-index` to override this.
  64
  65 list [<options>]::
  66
  67         List the stashes that you currently have.  Each 'stash' is listed
  68         with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is
  69         the one before, etc.), the name of the branch that was current when the
  70         stash was made, and a short description of the commit the stash was
  71         based on.
  72 +
  73 ----------------------------------------------------------------
  74 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
  75 stash@{1}: On master: 9cc0589... Add git-stash
  76 ----------------------------------------------------------------
  77 +
  78 The command takes options applicable to the 'git-log'
  79 command to control what is shown and how. See linkgit:git-log[1].
  80
  81 show [<stash>]::
  82
  83         Show the changes recorded in the stash as a diff between the
  84         stashed state and its original parent. When no `<stash>` is given,
  85         shows the latest one. By default, the command shows the diffstat, but
  86         it will accept any format known to 'git-diff' (e.g., `git stash show
  87         -p stash@\{1}` to view the second most recent stash in patch form).
  88
  89 pop [--index] [-q|--quiet] [<stash>]::
  90
  91         Remove a single stashed state from the stash list and apply it
  92         on top of the current working tree state, i.e., do the inverse
  93         operation of `git stash save`. The working directory must
  94         match the index.
  95 +
  96 Applying the state can fail with conflicts; in this case, it is not
  97 removed from the stash list. You need to resolve the conflicts by hand
  98 and call `git stash drop` manually afterwards.
  99 +
 100 If the `--index` option is used, then tries to reinstate not only the working
 101 tree's changes, but also the index's ones. However, this can fail, when you
 102 have conflicts (which are stored in the index, where you therefore can no
 103 longer apply the changes as they were originally).
 104 +
 105 When no `<stash>` is given, `stash@\{0}` is assumed.
 106
 107 apply [--index] [-q|--quiet] [<stash>]::
 108
 109         Like `pop`, but do not remove the state from the stash list.
 110
 111 branch <branchname> [<stash>]::
 112
 113         Creates and checks out a new branch named `<branchname>` starting from
 114         the commit at which the `<stash>` was originally created, applies the
 115         changes recorded in `<stash>` to the new working tree and index, then
 116         drops the `<stash>` if that completes successfully. When no `<stash>`
 117         is given, applies the latest one.
 118 +
 119 This is useful if the branch on which you ran `git stash save` has
 120 changed enough that `git stash apply` fails due to conflicts. Since
 121 the stash is applied on top of the commit that was HEAD at the time
 122 `git stash` was run, it restores the originally stashed state with
 123 no conflicts.
 124
 125 clear::
 126         Remove all the stashed states. Note that those states will then
 127         be subject to pruning, and may be difficult or impossible to recover.
 128
 129 drop [-q|--quiet] [<stash>]::
 130
 131         Remove a single stashed state from the stash list. When no `<stash>`
 132         is given, it removes the latest one. i.e. `stash@\{0}`
 133
 134 create::
 135
 136         Create a stash (which is a regular commit object) and return its
 137         object name, without storing it anywhere in the ref namespace.
 138
 139
 140 DISCUSSION
 141 ----------
 142
 143 A stash is represented as a commit whose tree records the state of the
 144 working directory, and its first parent is the commit at `HEAD` when
 145 the stash was created.  The tree of the second parent records the
 146 state of the index when the stash is made, and it is made a child of
 147 the `HEAD` commit.  The ancestry graph looks like this:
 148
 149             .----W
 150            /    /
 151      -----H----I
 152
 153 where `H` is the `HEAD` commit, `I` is a commit that records the state
 154 of the index, and `W` is a commit that records the state of the working
 155 tree.
 156
 157
 158 EXAMPLES
 159 --------
 160
 161 Pulling into a dirty tree::
 162
 163 When you are in the middle of something, you learn that there are
 164 upstream changes that are possibly relevant to what you are
 165 doing.  When your local changes do not conflict with the changes in
 166 the upstream, a simple `git pull` will let you move forward.
 167 +
 168 However, there are cases in which your local changes do conflict with
 169 the upstream changes, and `git pull` refuses to overwrite your
 170 changes.  In such a case, you can stash your changes away,
 171 perform a pull, and then unstash, like this:
 172 +
 173 ----------------------------------------------------------------
 174 $ git pull
 175  ...
 176 file foobar not up to date, cannot merge.
 177 $ git stash
 178 $ git pull
 179 $ git stash pop
 180 ----------------------------------------------------------------
 181
 182 Interrupted workflow::
 183
 184 When you are in the middle of something, your boss comes in and
 185 demands that you fix something immediately.  Traditionally, you would
 186 make a commit to a temporary branch to store your changes away, and
 187 return to your original branch to make the emergency fix, like this:
 188 +
 189 ----------------------------------------------------------------
 190 # ... hack hack hack ...
 191 $ git checkout -b my_wip
 192 $ git commit -a -m "WIP"
 193 $ git checkout master
 194 $ edit emergency fix
 195 $ git commit -a -m "Fix in a hurry"
 196 $ git checkout my_wip
 197 $ git reset --soft HEAD^
 198 # ... continue hacking ...
 199 ----------------------------------------------------------------
 200 +
 201 You can use 'git-stash' to simplify the above, like this:
 202 +
 203 ----------------------------------------------------------------
 204 # ... hack hack hack ...
 205 $ git stash
 206 $ edit emergency fix
 207 $ git commit -a -m "Fix in a hurry"
 208 $ git stash pop
 209 # ... continue hacking ...
 210 ----------------------------------------------------------------
 211
 212 Testing partial commits::
 213
 214 You can use `git stash save --keep-index` when you want to make two or
 215 more commits out of the changes in the work tree, and you want to test
 216 each change before committing:
 217 +
 218 ----------------------------------------------------------------
 219 # ... hack hack hack ...
 220 $ git add --patch foo            # add just first part to the index
 221 $ git stash save --keep-index    # save all other changes to the stash
 222 $ edit/build/test first part
 223 $ git commit -m 'First part'     # commit fully tested change
 224 $ git stash pop                  # prepare to work on all other changes
 225 # ... repeat above five steps until one commit remains ...
 226 $ edit/build/test remaining parts
 227 $ git commit foo -m 'Remaining parts'
 228 ----------------------------------------------------------------
 229
 230 SEE ALSO
 231 --------
 232 linkgit:git-checkout[1],
 233 linkgit:git-commit[1],
 234 linkgit:git-reflog[1],
 235 linkgit:git-reset[1]
 236
 237 AUTHOR
 238 ------
 239 Written by Nanako Shiraishi <nanako3@bluebottle.com>
 240
 241 GIT
 242 ---
 243 Part of the linkgit:git[1] suite