git-stash.txt 8.49 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 [--patch] [-k|--[no-]keep-index] [-q|--quiet] [<message>]]
17
'git stash' [-p|--patch|-k|--keep-index]
18
'git stash' clear
19
'git stash' create
しらいしななこ'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 `$GIT_DIR/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 [--patch] [--[no-]keep-index] [-q|--quiet] [<message>]::
しらいしななこ's avatar
しらいしななこ committed
47

48
	Save your local modifications to a new 'stash', and run `git reset
49
	--hard` to revert them.  This is the default action when no
50 51
	subcommand is given. The <message> part is optional and gives
	the description along with the stashed state.
52 53 54
+
If the `--keep-index` option is used, all changes already added to the
index are left intact.
55 56 57 58 59 60 61 62 63 64
+
With `--patch`, you can interactively select hunks from in the diff
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
from your worktree.
+
The `--patch` option implies `--keep-index`.  You can use
`--no-keep-index` to override this.
しらいしななこ's avatar
しらいしななこ committed
65

66
list [<options>]::
しらいしななこ's avatar
しらいしななこ committed
67 68

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

show [<stash>]::

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

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

92 93 94 95
	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.
96
+
97 98 99 100
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.
+
101 102 103 104
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).
105 106 107
+
When no `<stash>` is given, `[email protected]\{0}` is assumed.

Stephen Boyd's avatar
Stephen Boyd committed
108
apply [--index] [-q|--quiet] [<stash>]::
109 110

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

112 113 114 115 116 117 118 119 120 121 122 123 124 125
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
126
clear::
127 128
	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
129

Stephen Boyd's avatar
Stephen Boyd committed
130
drop [-q|--quiet] [<stash>]::
131 132 133 134

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

135 136 137 138 139
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
140 141 142 143 144 145 146 147 148 149 150 151

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
152
     -----H----I
しらいしななこ's avatar
しらいしななこ committed
153 154 155 156 157 158 159 160 161 162 163 164

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
165 166
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
167 168 169 170
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
171
changes.  In such a case, you can stash your changes away,
しらいしななこ's avatar
しらいしななこ committed
172 173 174 175
perform a pull, and then unstash, like this:
+
----------------------------------------------------------------
$ git pull
176
 ...
しらいしななこ's avatar
しらいしななこ committed
177 178 179
file foobar not up to date, cannot merge.
$ git stash
$ git pull
180
$ git stash pop
しらいしななこ's avatar
しらいしななこ committed
181 182 183 184 185
----------------------------------------------------------------

Interrupted workflow::

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

213 214 215 216 217 218 219
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:
+
----------------------------------------------------------------
220
# ... hack hack hack ...
221 222 223
$ 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
224
$ git commit -m 'First part'     # commit fully tested change
225
$ git stash pop                  # prepare to work on all other changes
226
# ... repeat above five steps until one commit remains ...
227 228
$ edit/build/test remaining parts
$ git commit foo -m 'Remaining parts'
229 230
----------------------------------------------------------------

しらいしななこ's avatar
しらいしななこ committed
231 232
SEE ALSO
--------
233 234 235 236
linkgit:git-checkout[1],
linkgit:git-commit[1],
linkgit:git-reflog[1],
linkgit:git-reset[1]
しらいしななこ's avatar
しらいしななこ committed
237 238 239 240 241 242 243

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

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