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>])
  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
  26 save`.  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 [<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 list [<options>]::
  47
  48         List the stashes that you currently have.  Each 'stash' is listed
  49         with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is
  50         the one before, etc.), the name of the branch that was current when the
  51         stash was made, and a short description of the commit the stash was
  52         based on.
  53 +
  54 ----------------------------------------------------------------
  55 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
  56 stash@{1}: On master: 9cc0589... Add git-stash
  57 ----------------------------------------------------------------
  58 +
  59 The command takes options applicable to the linkgit:git-log[1]
  60 command to control what is shown and how.
  61
  62 show [<stash>]::
  63
  64         Show the changes recorded in the stash as a diff between the
  65         stashed state and its original parent. When no `<stash>` is given,
  66         shows the latest one. By default, the command shows the diffstat, but
  67         it will accept any format known to `git-diff` (e.g., `git-stash show
  68         -p stash@\{1}` to view the second most recent stash in patch form).
  69
  70 apply [--index] [<stash>]::
  71
  72         Restore the changes recorded in the stash on top of the current
  73         working tree state.  When no `<stash>` is given, applies the latest
  74         one.  The working directory must match the index.
  75 +
  76 This operation can fail with conflicts; you need to resolve them
  77 by hand in the working tree.
  78 +
  79 If the `--index` option is used, then tries to reinstate not only the working
  80 tree's changes, but also the index's ones. However, this can fail, when you
  81 have conflicts (which are stored in the index, where you therefore can no
  82 longer apply the changes as they were originally).
  83
  84 clear::
  85         Remove all the stashed states. Note that those states will then
  86         be subject to pruning, and may be difficult or impossible to recover.
  87
  88 drop [<stash>]::
  89
  90         Remove a single stashed state from the stash list. When no `<stash>`
  91         is given, it removes the latest one. i.e. `stash@\{0}`
  92
  93
  94 DISCUSSION
  95 ----------
  96
  97 A stash is represented as a commit whose tree records the state of the
  98 working directory, and its first parent is the commit at `HEAD` when
  99 the stash was created.  The tree of the second parent records the
 100 state of the index when the stash is made, and it is made a child of
 101 the `HEAD` commit.  The ancestry graph looks like this:
 102
 103             .----W
 104            /    /
 105      -----H----I
 106
 107 where `H` is the `HEAD` commit, `I` is a commit that records the state
 108 of the index, and `W` is a commit that records the state of the working
 109 tree.
 110
 111
 112 EXAMPLES
 113 --------
 114
 115 Pulling into a dirty tree::
 116
 117 When you are in the middle of something, you learn that there are
 118 upstream changes that are possibly relevant to what you are
 119 doing.  When your local changes do not conflict with the changes in
 120 the upstream, a simple `git pull` will let you move forward.
 121 +
 122 However, there are cases in which your local changes do conflict with
 123 the upstream changes, and `git pull` refuses to overwrite your
 124 changes.  In such a case, you can stash your changes away,
 125 perform a pull, and then unstash, like this:
 126 +
 127 ----------------------------------------------------------------
 128 $ git pull
 129 ...
 130 file foobar not up to date, cannot merge.
 131 $ git stash
 132 $ git pull
 133 $ git stash apply
 134 ----------------------------------------------------------------
 135
 136 Interrupted workflow::
 137
 138 When you are in the middle of something, your boss comes in and
 139 demands that you fix something immediately.  Traditionally, you would
 140 make a commit to a temporary branch to store your changes away, and
 141 return to your original branch to make the emergency fix, like this:
 142 +
 143 ----------------------------------------------------------------
 144 ... hack hack hack ...
 145 $ git checkout -b my_wip
 146 $ git commit -a -m "WIP"
 147 $ git checkout master
 148 $ edit emergency fix
 149 $ git commit -a -m "Fix in a hurry"
 150 $ git checkout my_wip
 151 $ git reset --soft HEAD^
 152 ... continue hacking ...
 153 ----------------------------------------------------------------
 154 +
 155 You can use `git-stash` to simplify the above, like this:
 156 +
 157 ----------------------------------------------------------------
 158 ... hack hack hack ...
 159 $ git stash
 160 $ edit emergency fix
 161 $ git commit -a -m "Fix in a hurry"
 162 $ git stash apply
 163 ... continue hacking ...
 164 ----------------------------------------------------------------
 165
 166 SEE ALSO
 167 --------
 168 linkgit:git-checkout[1],
 169 linkgit:git-commit[1],
 170 linkgit:git-reflog[1],
 171 linkgit:git-reset[1]
 172
 173 AUTHOR
 174 ------
 175 Written by Nanako Shiraishi <nanako3@bluebottle.com>
 176
 177 GIT
 178 ---
 179 Part of the linkgit:git[7] suite