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