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