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