git-stash.txt 9.97 KB
Newer Older
しらいしななこ's avatar
しらいしななこ committed
1 2 3 4 5 6 7 8 9 10
git-stash(1)
============

NAME
----
git-stash - Stash the changes in a dirty working directory away

SYNOPSIS
--------
[verse]
11
'git stash' list [<options>]
Stephen Boyd's avatar
Stephen Boyd committed
12 13 14
'git stash' show [<stash>]
'git stash' drop [-q|--quiet] [<stash>]
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
15
'git stash' branch <branchname> [<stash>]
16
'git stash' [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17
	     [-u|--include-untracked] [-a|--all] [<message>]]
18
'git stash' clear
19
'git stash' create [<message>]
しらいしななこ's avatar
しらいしななこ committed
20 21 22 23

DESCRIPTION
-----------

24
Use `git stash` when you want to record the current state of the
しらいしななこ's avatar
しらいしななこ committed
25 26 27 28 29
working directory and the index, but want to go back to a clean
working directory.  The command saves your local modifications away
and reverts the working directory to match the `HEAD` commit.

The modifications stashed away by this command can be listed with
30 31 32 33
`git stash list`, inspected with `git stash show`, and restored
(potentially on top of a different commit) with `git stash apply`.
Calling `git stash` without any arguments is equivalent to `git stash save`.
A stash is by default listed as "WIP on 'branchname' ...", but
34 35
you can give a more descriptive message on the command line when
you create one.
しらいしななこ's avatar
しらいしななこ committed
36

37
The latest stash you created is stored in `refs/stash`; older
38
stashes are found in the reflog of this reference and can be named using
39 40
the usual reflog syntax (e.g. `[email protected]{0}` is the most recently
created stash, `[email protected]{1}` is the one before it, `[email protected]{2.hours.ago}`
41
is also possible).
しらいしななこ's avatar
しらいしななこ committed
42 43 44 45

OPTIONS
-------

46
save [-p|--patch] [--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
しらいしななこ's avatar
しらいしななこ committed
47

48
	Save your local modifications to a new 'stash', and run `git reset
49 50 51 52 53
	--hard` to revert them.  The <message> part is optional and gives
	the description along with the stashed state.  For quickly making
	a snapshot, you can omit _both_ "save" and <message>, but giving
	only <message> does not trigger this action to prevent a misspelled
	subcommand from making an unwanted stash.
54 55 56
+
If the `--keep-index` option is used, all changes already added to the
index are left intact.
57
+
58 59 60 61 62
If the `--include-untracked` option is used, all untracked files are also
stashed and then cleaned up with `git clean`, leaving the working directory
in a very clean state. If the `--all` option is used instead then the
ignored files are stashed and cleaned in addition to the untracked files.
+
63
With `--patch`, you can interactively select hunks from the diff
64 65 66 67
between HEAD and the working tree to be stashed.  The stash entry is
constructed such that its index state is the same as the index state
of your repository, and its worktree contains only the changes you
selected interactively.  The selected changes are then rolled back
68
from your worktree. See the ``Interactive Mode'' section of
69
linkgit:git-add[1] to learn how to operate the `--patch` mode.
70 71 72
+
The `--patch` option implies `--keep-index`.  You can use
`--no-keep-index` to override this.
しらいしななこ's avatar
しらいしななこ committed
73

74
list [<options>]::
しらいしななこ's avatar
しらいしななこ committed
75 76

	List the stashes that you currently have.  Each 'stash' is listed
77
	with its name (e.g. `[email protected]{0}` is the latest stash, `[email protected]{1}` is
78
	the one before, etc.), the name of the branch that was current when the
しらいしななこ's avatar
しらいしななこ committed
79 80 81 82
	stash was made, and a short description of the commit the stash was
	based on.
+
----------------------------------------------------------------
83 84
[email protected]{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
[email protected]{1}: On master: 9cc0589... Add git-stash
しらいしななこ's avatar
しらいしななこ committed
85
----------------------------------------------------------------
86
+
87
The command takes options applicable to the 'git log'
88
command to control what is shown and how. See linkgit:git-log[1].
しらいしななこ's avatar
しらいしななこ committed
89 90 91

show [<stash>]::

92
	Show the changes recorded in the stash as a diff between the
93 94
	stashed state and its original parent. When no `<stash>` is given,
	shows the latest one. By default, the command shows the diffstat, but
95
	it will accept any format known to 'git diff' (e.g., `git stash show
96
	-p [email protected]{1}` to view the second most recent stash in patch form).
しらいしななこ's avatar
しらいしななこ committed
97

Stephen Boyd's avatar
Stephen Boyd committed
98
pop [--index] [-q|--quiet] [<stash>]::
しらいしななこ's avatar
しらいしななこ committed
99

100 101 102 103
	Remove a single stashed state from the stash list and apply it
	on top of the current working tree state, i.e., do the inverse
	operation of `git stash save`. The working directory must
	match the index.
104
+
105 106 107 108
Applying the state can fail with conflicts; in this case, it is not
removed from the stash list. You need to resolve the conflicts by hand
and call `git stash drop` manually afterwards.
+
109 110 111 112
If the `--index` option is used, then tries to reinstate not only the working
tree's changes, but also the index's ones. However, this can fail, when you
have conflicts (which are stored in the index, where you therefore can no
longer apply the changes as they were originally).
113
+
114 115
When no `<stash>` is given, `[email protected]{0}` is assumed, otherwise `<stash>` must
be a reference of the form `[email protected]{<revision>}`.
116

Stephen Boyd's avatar
Stephen Boyd committed
117
apply [--index] [-q|--quiet] [<stash>]::
118

119 120 121
	Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
	`<stash>` may be any commit that looks like a commit created by
	`stash save` or `stash create`.
しらいしななこ's avatar
しらいしななこ committed
122

123 124 125 126
branch <branchname> [<stash>]::

	Creates and checks out a new branch named `<branchname>` starting from
	the commit at which the `<stash>` was originally created, applies the
127 128 129
	changes recorded in `<stash>` to the new working tree and index.
	If that succeeds, and `<stash>` is a reference of the form
	`[email protected]{<revision>}`, it then drops the `<stash>`. When no `<stash>`
130 131 132 133 134 135 136 137
	is given, applies the latest one.
+
This is useful if the branch on which you ran `git stash save` has
changed enough that `git stash apply` fails due to conflicts. Since
the stash is applied on top of the commit that was HEAD at the time
`git stash` was run, it restores the originally stashed state with
no conflicts.

しらいしななこ's avatar
しらいしななこ committed
138
clear::
139
	Remove all the stashed states. Note that those states will then
140 141
	be subject to pruning, and may be impossible to recover (see
	'Examples' below for a possible strategy).
しらいしななこ's avatar
しらいしななこ committed
142

Stephen Boyd's avatar
Stephen Boyd committed
143
drop [-q|--quiet] [<stash>]::
144 145

	Remove a single stashed state from the stash list. When no `<stash>`
146
	is given, it removes the latest one. i.e. `[email protected]{0}`, otherwise
147
	`<stash>` must be a valid stash log reference of the form
148
	`[email protected]{<revision>}`.
149

150 151 152 153
create::

	Create a stash (which is a regular commit object) and return its
	object name, without storing it anywhere in the ref namespace.
154 155
	This is intended to be useful for scripts.  It is probably not
	the command you want to use; see "save" above.
156

しらいしななこ's avatar
しらいしななこ committed
157 158 159 160 161 162 163 164 165 166 167 168

DISCUSSION
----------

A stash is represented as a commit whose tree records the state of the
working directory, and its first parent is the commit at `HEAD` when
the stash was created.  The tree of the second parent records the
state of the index when the stash is made, and it is made a child of
the `HEAD` commit.  The ancestry graph looks like this:

            .----W
           /    /
Junio C Hamano's avatar
Junio C Hamano committed
169
     -----H----I
しらいしななこ's avatar
しらいしななこ committed
170 171 172 173 174 175 176 177 178 179 180 181

where `H` is the `HEAD` commit, `I` is a commit that records the state
of the index, and `W` is a commit that records the state of the working
tree.


EXAMPLES
--------

Pulling into a dirty tree::

When you are in the middle of something, you learn that there are
182 183
upstream changes that are possibly relevant to what you are
doing.  When your local changes do not conflict with the changes in
しらいしななこ's avatar
しらいしななこ committed
184 185 186 187
the upstream, a simple `git pull` will let you move forward.
+
However, there are cases in which your local changes do conflict with
the upstream changes, and `git pull` refuses to overwrite your
188
changes.  In such a case, you can stash your changes away,
しらいしななこ's avatar
しらいしななこ committed
189 190 191 192
perform a pull, and then unstash, like this:
+
----------------------------------------------------------------
$ git pull
193
 ...
しらいしななこ's avatar
しらいしななこ committed
194 195 196
file foobar not up to date, cannot merge.
$ git stash
$ git pull
197
$ git stash pop
しらいしななこ's avatar
しらいしななこ committed
198 199 200 201 202
----------------------------------------------------------------

Interrupted workflow::

When you are in the middle of something, your boss comes in and
203
demands that you fix something immediately.  Traditionally, you would
しらいしななこ's avatar
しらいしななこ committed
204
make a commit to a temporary branch to store your changes away, and
205
return to your original branch to make the emergency fix, like this:
しらいしななこ's avatar
しらいしななこ committed
206 207
+
----------------------------------------------------------------
208
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
209 210 211 212 213 214 215
$ git checkout -b my_wip
$ git commit -a -m "WIP"
$ git checkout master
$ edit emergency fix
$ git commit -a -m "Fix in a hurry"
$ git checkout my_wip
$ git reset --soft HEAD^
216
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
217 218
----------------------------------------------------------------
+
219
You can use 'git stash' to simplify the above, like this:
しらいしななこ's avatar
しらいしななこ committed
220 221
+
----------------------------------------------------------------
222
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
223 224 225
$ git stash
$ edit emergency fix
$ git commit -a -m "Fix in a hurry"
226
$ git stash pop
227
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
228 229
----------------------------------------------------------------

230 231 232 233 234 235 236
Testing partial commits::

You can use `git stash save --keep-index` when you want to make two or
more commits out of the changes in the work tree, and you want to test
each change before committing:
+
----------------------------------------------------------------
237
# ... hack hack hack ...
238 239 240
$ git add --patch foo            # add just first part to the index
$ git stash save --keep-index    # save all other changes to the stash
$ edit/build/test first part
241
$ git commit -m 'First part'     # commit fully tested change
242
$ git stash pop                  # prepare to work on all other changes
243
# ... repeat above five steps until one commit remains ...
244 245
$ edit/build/test remaining parts
$ git commit foo -m 'Remaining parts'
246 247
----------------------------------------------------------------

248 249 250 251 252 253 254 255 256 257 258 259 260 261
Recovering stashes that were cleared/dropped erroneously::

If you mistakenly drop or clear stashes, they cannot be recovered
through the normal safety mechanisms.  However, you can try the
following incantation to get a list of stashes that are still in your
repository, but not reachable any more:
+
----------------------------------------------------------------
git fsck --unreachable |
grep commit | cut -d\  -f3 |
xargs git log --merges --no-walk --grep=WIP
----------------------------------------------------------------


しらいしななこ's avatar
しらいしななこ committed
262 263
SEE ALSO
--------
264 265 266 267
linkgit:git-checkout[1],
linkgit:git-commit[1],
linkgit:git-reflog[1],
linkgit:git-reset[1]
しらいしななこ's avatar
しらいしななこ committed
268 269 270

GIT
---
271
Part of the linkgit:git[1] suite