git-stash.txt 7.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>]
Stephen Boyd's avatar
Stephen Boyd committed
16
'git stash' [save [--keep-index] [-q|--quiet] [<message>]]
17
'git stash' clear
18
'git stash' create
しらいしななこ's avatar
しらいしななこ committed
19 20 21 22

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

23
Use 'git stash' when you want to record the current state of the
しらいしななこ's avatar
しらいしななこ committed
24 25 26 27 28
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
29 30 31 32
`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
33 34
you can give a more descriptive message on the command line when
you create one.
しらいしななこ's avatar
しらいしななこ committed
35 36

The latest stash you created is stored in `$GIT_DIR/refs/stash`; older
37
stashes are found in the reflog of this reference and can be named using
38 39
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}`
40
is also possible).
しらいしななこ's avatar
しらいしななこ committed
41 42 43 44

OPTIONS
-------

Stephen Boyd's avatar
Stephen Boyd committed
45
save [--keep-index] [-q|--quiet] [<message>]::
しらいしななこ's avatar
しらいしななこ committed
46

47
	Save your local modifications to a new 'stash', and run `git reset
48
	--hard` to revert them.  This is the default action when no
49 50
	subcommand is given. The <message> part is optional and gives
	the description along with the stashed state.
51 52 53
+
If the `--keep-index` option is used, all changes already added to the
index are left intact.
しらいしななこ's avatar
しらいしななこ committed
54

55
list [<options>]::
しらいしななこ's avatar
しらいしななこ committed
56 57

	List the stashes that you currently have.  Each 'stash' is listed
58
	with its name (e.g. `[email protected]\{0}` is the latest stash, `[email protected]\{1}` is
59
	the one before, etc.), the name of the branch that was current when the
しらいしななこ's avatar
しらいしななこ committed
60 61 62 63
	stash was made, and a short description of the commit the stash was
	based on.
+
----------------------------------------------------------------
64 65
[email protected]{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
[email protected]{1}: On master: 9cc0589... Add git-stash
しらいしななこ's avatar
しらいしななこ committed
66
----------------------------------------------------------------
67
+
68
The command takes options applicable to the 'git-log'
69
command to control what is shown and how. See linkgit:git-log[1].
しらいしななこ's avatar
しらいしななこ committed
70 71 72

show [<stash>]::

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

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

81 82 83 84
	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.
85
+
86 87 88 89
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.
+
90 91 92 93
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).
94 95 96
+
When no `<stash>` is given, `[email protected]\{0}` is assumed.

Stephen Boyd's avatar
Stephen Boyd committed
97
apply [--index] [-q|--quiet] [<stash>]::
98 99

	Like `pop`, but do not remove the state from the stash list.
しらいしななこ's avatar
しらいしななこ committed
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114
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
	changes recorded in `<stash>` to the new working tree and index, then
	drops the `<stash>` if that completes successfully. When no `<stash>`
	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
115
clear::
116 117
	Remove all the stashed states. Note that those states will then
	be subject to pruning, and may be difficult or impossible to recover.
しらいしななこ's avatar
しらいしななこ committed
118

Stephen Boyd's avatar
Stephen Boyd committed
119
drop [-q|--quiet] [<stash>]::
120 121 122 123

	Remove a single stashed state from the stash list. When no `<stash>`
	is given, it removes the latest one. i.e. `[email protected]\{0}`

124 125 126 127 128
create::

	Create a stash (which is a regular commit object) and return its
	object name, without storing it anywhere in the ref namespace.

しらいしななこ's avatar
しらいしななこ committed
129 130 131 132 133 134 135 136 137 138 139 140

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
141
     -----H----I
しらいしななこ's avatar
しらいしななこ committed
142 143 144 145 146 147 148 149 150 151 152 153

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
154 155
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
156 157 158 159
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
160
changes.  In such a case, you can stash your changes away,
しらいしななこ's avatar
しらいしななこ committed
161 162 163 164
perform a pull, and then unstash, like this:
+
----------------------------------------------------------------
$ git pull
165
 ...
しらいしななこ's avatar
しらいしななこ committed
166 167 168
file foobar not up to date, cannot merge.
$ git stash
$ git pull
169
$ git stash pop
しらいしななこ's avatar
しらいしななこ committed
170 171 172 173 174
----------------------------------------------------------------

Interrupted workflow::

When you are in the middle of something, your boss comes in and
175
demands that you fix something immediately.  Traditionally, you would
しらいしななこ's avatar
しらいしななこ committed
176
make a commit to a temporary branch to store your changes away, and
177
return to your original branch to make the emergency fix, like this:
しらいしななこ's avatar
しらいしななこ committed
178 179
+
----------------------------------------------------------------
180
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
181 182 183 184 185 186 187
$ 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^
188
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
189 190
----------------------------------------------------------------
+
191
You can use 'git-stash' to simplify the above, like this:
しらいしななこ's avatar
しらいしななこ committed
192 193
+
----------------------------------------------------------------
194
# ... hack hack hack ...
しらいしななこ's avatar
しらいしななこ committed
195 196 197
$ git stash
$ edit emergency fix
$ git commit -a -m "Fix in a hurry"
198
$ git stash pop
199
# ... continue hacking ...
しらいしななこ's avatar
しらいしななこ committed
200 201
----------------------------------------------------------------

202 203 204 205 206 207 208
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:
+
----------------------------------------------------------------
209
# ... hack hack hack ...
210 211 212
$ 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
213
$ git commit -m 'First part'     # commit fully tested change
214
$ git stash pop                  # prepare to work on all other changes
215
# ... repeat above five steps until one commit remains ...
216 217
$ edit/build/test remaining parts
$ git commit foo -m 'Remaining parts'
218 219
----------------------------------------------------------------

しらいしななこ's avatar
しらいしななこ committed
220 221
SEE ALSO
--------
222 223 224 225
linkgit:git-checkout[1],
linkgit:git-commit[1],
linkgit:git-reflog[1],
linkgit:git-reset[1]
しらいしななこ's avatar
しらいしななこ committed
226 227 228 229 230 231 232

AUTHOR
------
Written by Nanako Shiraishi <[email protected]>

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