git-stash.txt 11.4 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' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17
	     [-u|--include-untracked] [-a|--all] [-m|--message <message>]
18
	     [--] [<pathspec>...]]
19
'git stash' clear
20
'git stash' create [<message>]
21
'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
しらいしななこ's avatar
しらいしななこ committed
22 23 24 25

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

26
Use `git stash` when you want to record the current state of the
しらいしななこ's avatar
しらいしななこ committed
27 28 29 30 31
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
32 33
`git stash list`, inspected with `git stash show`, and restored
(potentially on top of a different commit) with `git stash apply`.
34
Calling `git stash` without any arguments is equivalent to `git stash push`.
35
A stash is by default listed as "WIP on 'branchname' ...", but
36 37
you can give a more descriptive message on the command line when
you create one.
しらいしななこ's avatar
しらいしななこ committed
38

39
The latest stash you created is stored in `refs/stash`; older
40
stashes are found in the reflog of this reference and can be named using
41 42
the usual reflog syntax (e.g. `stash@{0}` is the most recently
created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}`
43 44
is also possible). Stashes may also be referenced by specifying just the
stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
しらいしななこ's avatar
しらいしななこ committed
45 46 47 48

OPTIONS
-------

49
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
しらいしななこ's avatar
しらいしななこ committed
50

51
	Save your local modifications to a new 'stash entry' and roll them
52 53
	back to HEAD (in the working tree and in the index).
	The <message> part is optional and gives
54 55 56 57
	the description along with the stashed state.
+
For quickly making a snapshot, you can omit "push".  In this mode,
non-option arguments are not allowed to prevent a misspelled
58
subcommand from making an unwanted stash entry.  The two exceptions to this
59 60
are `stash -p` which acts as alias for `stash push -p` and pathspecs,
which are allowed after a double hyphen `--` for disambiguation.
61
+
62
When pathspec is given to 'git stash push', the new stash entry records the
63 64 65 66 67
modified states only for the files that match the pathspec.  The index
entries and working tree files are then rolled back to the state in
HEAD only for these files, too, leaving files that do not match the
pathspec intact.
+
68 69
If the `--keep-index` option is used, all changes already added to the
index are left intact.
70
+
71 72 73 74 75
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.
+
76
With `--patch`, you can interactively select hunks from the diff
77 78 79 80
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
81
from your worktree. See the ``Interactive Mode'' section of
82
linkgit:git-add[1] to learn how to operate the `--patch` mode.
83 84 85
+
The `--patch` option implies `--keep-index`.  You can use
`--no-keep-index` to override this.
しらいしななこ's avatar
しらいしななこ committed
86

87 88 89 90 91 92
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::

	This option is deprecated in favour of 'git stash push'.  It
	differs from "stash push" in that it cannot take pathspecs,
	and any non-option arguments form the message.

93
list [<options>]::
しらいしななこ's avatar
しらいしななこ committed
94

95 96
	List the stash entries that you currently have.  Each 'stash entry' is
	listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is
97
	the one before, etc.), the name of the branch that was current when the
98
	entry was made, and a short description of the commit the entry was
しらいしななこ's avatar
しらいしななこ committed
99 100 101
	based on.
+
----------------------------------------------------------------
102 103
stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
stash@{1}: On master: 9cc0589... Add git-stash
しらいしななこ's avatar
しらいしななこ committed
104
----------------------------------------------------------------
105
+
106
The command takes options applicable to the 'git log'
107
command to control what is shown and how. See linkgit:git-log[1].
しらいしななこ's avatar
しらいしななこ committed
108 109 110

show [<stash>]::

111 112 113 114 115 116
	Show the changes recorded in the stash entry as a diff between the
	stashed contents and the commit back when the stash entry was first
	created. When no `<stash>` is given, it shows the latest one.
	By default, the command shows the diffstat, but it will accept any
	format known to 'git diff' (e.g., `git stash show -p stash@{1}`
	to view the second most recent entry in patch form).
117 118
	You can use stash.showStat and/or stash.showPatch config variables
	to change the default behavior.
しらいしななこ's avatar
しらいしななこ committed
119

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

122 123
	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
124
	operation of `git stash push`. The working directory must
125
	match the index.
126
+
127 128 129 130
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.
+
131 132 133 134
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).
135
+
136 137
When no `<stash>` is given, `stash@{0}` is assumed, otherwise `<stash>` must
be a reference of the form `stash@{<revision>}`.
138

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

141 142
	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
143
	`stash push` or `stash create`.
しらいしななこ's avatar
しらいしななこ committed
144

145 146 147 148
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
149 150 151
	changes recorded in `<stash>` to the new working tree and index.
	If that succeeds, and `<stash>` is a reference of the form
	`stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
152 153
	is given, applies the latest one.
+
154
This is useful if the branch on which you ran `git stash push` has
155
changed enough that `git stash apply` fails due to conflicts. Since
156 157 158
the stash entry 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.
159

しらいしななこ's avatar
しらいしななこ committed
160
clear::
161
	Remove all the stash entries. Note that those entries will then
162 163
	be subject to pruning, and may be impossible to recover (see
	'Examples' below for a possible strategy).
しらいしななこ's avatar
しらいしななこ committed
164

Stephen Boyd's avatar
Stephen Boyd committed
165
drop [-q|--quiet] [<stash>]::
166

167 168 169 170
	Remove a single stash entry from the list of stash entries.
	When no `<stash>` is given, it removes the latest one.
	i.e. `stash@{0}`, otherwise `<stash>` must be a valid stash
	log reference of the form `stash@{<revision>}`.
171

172 173
create::

174 175 176
	Create a stash entry (which is a regular commit object) and
	return its object name, without storing it anywhere in the ref
	namespace.
177
	This is intended to be useful for scripts.  It is probably not
178
	the command you want to use; see "push" above.
179

180 181 182 183 184
store::

	Store a given stash created via 'git stash create' (which is a
	dangling merge commit) in the stash ref, updating the stash
	reflog.  This is intended to be useful for scripts.  It is
185
	probably not the command you want to use; see "push" above.
しらいしななこ's avatar
しらいしななこ committed
186 187 188 189

DISCUSSION
----------

190 191 192 193
A stash entry 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 entry was created.  The tree of the second parent records the
state of the index when the entry is made, and it is made a child of
しらいしななこ's avatar
しらいしななこ committed
194 195 196 197
the `HEAD` commit.  The ancestry graph looks like this:

            .----W
           /    /
Junio C Hamano's avatar
Junio C Hamano committed
198
     -----H----I
しらいしななこ's avatar
しらいしななこ committed
199 200 201 202 203 204 205 206 207 208 209 210

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
211 212
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
213 214 215 216
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
217
changes.  In such a case, you can stash your changes away,
しらいしななこ's avatar
しらいしななこ committed
218 219 220 221
perform a pull, and then unstash, like this:
+
----------------------------------------------------------------
$ git pull
222
 ...
しらいしななこ's avatar
しらいしななこ committed
223 224 225
file foobar not up to date, cannot merge.
$ git stash
$ git pull
226
$ git stash pop
しらいしななこ's avatar
しらいしななこ committed
227 228 229 230 231
----------------------------------------------------------------

Interrupted workflow::

When you are in the middle of something, your boss comes in and
232
demands that you fix something immediately.  Traditionally, you would
しらいしななこ's avatar
しらいしななこ committed
233
make a commit to a temporary branch to store your changes away, and
234
return to your original branch to make the emergency fix, like this:
しらいしななこ's avatar
しらいしななこ committed
235 236
+
----------------------------------------------------------------
237
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
238 239 240 241 242 243 244
$ 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^
245
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
246 247
----------------------------------------------------------------
+
248
You can use 'git stash' to simplify the above, like this:
しらいしななこ's avatar
しらいしななこ committed
249 250
+
----------------------------------------------------------------
251
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
252 253 254
$ git stash
$ edit emergency fix
$ git commit -a -m "Fix in a hurry"
255
$ git stash pop
256
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
257 258
----------------------------------------------------------------

259 260
Testing partial commits::

261
You can use `git stash push --keep-index` when you want to make two or
262 263 264 265
more commits out of the changes in the work tree, and you want to test
each change before committing:
+
----------------------------------------------------------------
266
# ... hack hack hack ...
267
$ git add --patch foo            # add just first part to the index
268
$ git stash push --keep-index    # save all other changes to the stash
269
$ edit/build/test first part
270
$ git commit -m 'First part'     # commit fully tested change
271
$ git stash pop                  # prepare to work on all other changes
272
# ... repeat above five steps until one commit remains ...
273 274
$ edit/build/test remaining parts
$ git commit foo -m 'Remaining parts'
275 276
----------------------------------------------------------------

277
Recovering stash entries that were cleared/dropped erroneously::
278

279
If you mistakenly drop or clear stash entries, they cannot be recovered
280
through the normal safety mechanisms.  However, you can try the
281 282
following incantation to get a list of stash entries that are still in
your repository, but not reachable any more:
283 284 285 286 287 288 289 290
+
----------------------------------------------------------------
git fsck --unreachable |
grep commit | cut -d\  -f3 |
xargs git log --merges --no-walk --grep=WIP
----------------------------------------------------------------


しらいしななこ's avatar
しらいしななこ committed
291 292
SEE ALSO
--------
293 294 295 296
linkgit:git-checkout[1],
linkgit:git-commit[1],
linkgit:git-reflog[1],
linkgit:git-reset[1]
しらいしななこ's avatar
しらいしななこ committed
297 298 299

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