1git-stash(1) 2============ 3 4NAME 5---- 6git-stash - Stash the changes in a dirty working directory away 7 8SYNOPSIS 9-------- 10[verse] 11'git-stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) 12'git-stash' [save [<message>]] 13 14DESCRIPTION 15----------- 16 17Use 'git-stash' when you want to record the current state of the 18working directory and the index, but want to go back to a clean 19working directory. The command saves your local modifications away 20and reverts the working directory to match the `HEAD` commit. 21 22The 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`. 25Calling git-stash without any arguments is equivalent to `git-stash 26save`. A stash is by default listed as "WIP on 'branchname' ...", but 27you can give a more descriptive message on the command line when 28you create one. 29 30The latest stash you created is stored in `$GIT_DIR/refs/stash`; older 31stashes are found in the reflog of this reference and can be named using 32the usual reflog syntax (e.g. `stash@\{0}` is the most recently 33created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}` 34is also possible). 35 36OPTIONS 37------- 38 39save [<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 46list [<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---------------------------------------------------------------- 55stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation 56stash@{1}: On master: 9cc0589... Add git-stash 57---------------------------------------------------------------- 58+ 59The command takes options applicable to the linkgit:git-log[1] 60command to control what is shown and how. 61 62show [<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 70apply [--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+ 76This operation can fail with conflicts; you need to resolve them 77by hand in the working tree. 78+ 79If the `--index` option is used, then tries to reinstate not only the working 80tree's changes, but also the index's ones. However, this can fail, when you 81have conflicts (which are stored in the index, where you therefore can no 82longer apply the changes as they were originally). 83 84clear:: 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 88drop [<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 93pop [<stash>]:: 94 95 Remove a single stashed state from the stash list and apply on top 96 of the current working tree state. When no `<stash>` is given, 97 `stash@\{0}` is assumed. See also `apply`. 98 99 100DISCUSSION 101---------- 102 103A stash is represented as a commit whose tree records the state of the 104working directory, and its first parent is the commit at `HEAD` when 105the stash was created. The tree of the second parent records the 106state of the index when the stash is made, and it is made a child of 107the `HEAD` commit. The ancestry graph looks like this: 108 109 .----W 110 / / 111 -----H----I 112 113where `H` is the `HEAD` commit, `I` is a commit that records the state 114of the index, and `W` is a commit that records the state of the working 115tree. 116 117 118EXAMPLES 119-------- 120 121Pulling into a dirty tree:: 122 123When you are in the middle of something, you learn that there are 124upstream changes that are possibly relevant to what you are 125doing. When your local changes do not conflict with the changes in 126the upstream, a simple `git pull` will let you move forward. 127+ 128However, there are cases in which your local changes do conflict with 129the upstream changes, and `git pull` refuses to overwrite your 130changes. In such a case, you can stash your changes away, 131perform a pull, and then unstash, like this: 132+ 133---------------------------------------------------------------- 134$ git pull 135... 136file foobar not up to date, cannot merge. 137$ git stash 138$ git pull 139$ git stash apply 140---------------------------------------------------------------- 141 142Interrupted workflow:: 143 144When you are in the middle of something, your boss comes in and 145demands that you fix something immediately. Traditionally, you would 146make a commit to a temporary branch to store your changes away, and 147return to your original branch to make the emergency fix, like this: 148+ 149---------------------------------------------------------------- 150... hack hack hack ... 151$ git checkout -b my_wip 152$ git commit -a -m "WIP" 153$ git checkout master 154$ edit emergency fix 155$ git commit -a -m "Fix in a hurry" 156$ git checkout my_wip 157$ git reset --soft HEAD^ 158... continue hacking ... 159---------------------------------------------------------------- 160+ 161You can use `git-stash` to simplify the above, like this: 162+ 163---------------------------------------------------------------- 164... hack hack hack ... 165$ git stash 166$ edit emergency fix 167$ git commit -a -m "Fix in a hurry" 168$ git stash apply 169... continue hacking ... 170---------------------------------------------------------------- 171 172SEE ALSO 173-------- 174linkgit:git-checkout[1], 175linkgit:git-commit[1], 176linkgit:git-reflog[1], 177linkgit:git-reset[1] 178 179AUTHOR 180------ 181Written by Nanako Shiraishi <nanako3@bluebottle.com> 182 183GIT 184--- 185Part of the linkgit:git[7] suite