Merge branch 'jn/submodule-b-current'
[git] / Documentation / git-stash.txt
1 git-stash(1)
2 ============
3
4 NAME
5 ----
6 git-stash - Stash the changes in a dirty working directory away
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git stash' list [<options>]
12 'git stash' show [<stash>]
13 'git stash' drop [-q|--quiet] [<stash>]
14 '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' clear
18 'git stash' create
19
20 DESCRIPTION
21 -----------
22
23 Use `git stash` when you want to record the current state of the
24 working directory and the index, but want to go back to a clean
25 working directory.  The command saves your local modifications away
26 and reverts the working directory to match the `HEAD` commit.
27
28 The modifications stashed away by this command can be listed with
29 `git stash list`, inspected with `git stash show`, and restored
30 (potentially on top of a different commit) with `git stash apply`.
31 Calling `git stash` without any arguments is equivalent to `git stash save`.
32 A stash is by default listed as "WIP on 'branchname' ...", but
33 you can give a more descriptive message on the command line when
34 you create one.
35
36 The latest stash you created is stored in `refs/stash`; older
37 stashes are found in the reflog of this reference and can be named using
38 the usual reflog syntax (e.g. `stash@\{0}` is the most recently
39 created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}`
40 is also possible).
41
42 OPTIONS
43 -------
44
45 save [--patch] [--[no-]keep-index] [-q|--quiet] [<message>]::
46
47         Save your local modifications to a new 'stash', and run `git reset
48         --hard` to revert them.  The <message> part is optional and gives
49         the description along with the stashed state.  For quickly making
50         a snapshot, you can omit _both_ "save" and <message>, but giving
51         only <message> does not trigger this action to prevent a misspelled
52         subcommand from making an unwanted stash.
53 +
54 If the `--keep-index` option is used, all changes already added to the
55 index are left intact.
56 +
57 With `--patch`, you can interactively select hunks from in the diff
58 between HEAD and the working tree to be stashed.  The stash entry is
59 constructed such that its index state is the same as the index state
60 of your repository, and its worktree contains only the changes you
61 selected interactively.  The selected changes are then rolled back
62 from your worktree.
63 +
64 The `--patch` option implies `--keep-index`.  You can use
65 `--no-keep-index` to override this.
66
67 list [<options>]::
68
69         List the stashes that you currently have.  Each 'stash' is listed
70         with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is
71         the one before, etc.), the name of the branch that was current when the
72         stash was made, and a short description of the commit the stash was
73         based on.
74 +
75 ----------------------------------------------------------------
76 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
77 stash@{1}: On master: 9cc0589... Add git-stash
78 ----------------------------------------------------------------
79 +
80 The command takes options applicable to the 'git log'
81 command to control what is shown and how. See linkgit:git-log[1].
82
83 show [<stash>]::
84
85         Show the changes recorded in the stash as a diff between the
86         stashed state and its original parent. When no `<stash>` is given,
87         shows the latest one. By default, the command shows the diffstat, but
88         it will accept any format known to 'git diff' (e.g., `git stash show
89         -p stash@\{1}` to view the second most recent stash in patch form).
90
91 pop [--index] [-q|--quiet] [<stash>]::
92
93         Remove a single stashed state from the stash list and apply it
94         on top of the current working tree state, i.e., do the inverse
95         operation of `git stash save`. The working directory must
96         match the index.
97 +
98 Applying the state can fail with conflicts; in this case, it is not
99 removed from the stash list. You need to resolve the conflicts by hand
100 and call `git stash drop` manually afterwards.
101 +
102 If the `--index` option is used, then tries to reinstate not only the working
103 tree's changes, but also the index's ones. However, this can fail, when you
104 have conflicts (which are stored in the index, where you therefore can no
105 longer apply the changes as they were originally).
106 +
107 When no `<stash>` is given, `stash@\{0}` is assumed, otherwise `<stash>` must
108 be a reference of the form `stash@\{<revision>}`.
109
110 apply [--index] [-q|--quiet] [<stash>]::
111
112         Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
113         `<stash>` may be any commit that looks like a commit created by
114         `stash save` or `stash create`.
115
116 branch <branchname> [<stash>]::
117
118         Creates and checks out a new branch named `<branchname>` starting from
119         the commit at which the `<stash>` was originally created, applies the
120         changes recorded in `<stash>` to the new working tree and index.
121         If that succeeds, and `<stash>` is a reference of the form
122         `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
123         is given, applies the latest one.
124 +
125 This is useful if the branch on which you ran `git stash save` has
126 changed enough that `git stash apply` fails due to conflicts. Since
127 the stash is applied on top of the commit that was HEAD at the time
128 `git stash` was run, it restores the originally stashed state with
129 no conflicts.
130
131 clear::
132         Remove all the stashed states. Note that those states will then
133         be subject to pruning, and may be impossible to recover (see
134         'Examples' below for a possible strategy).
135
136 drop [-q|--quiet] [<stash>]::
137
138         Remove a single stashed state from the stash list. When no `<stash>`
139         is given, it removes the latest one. i.e. `stash@\{0}`, otherwise
140         `<stash>` must a valid stash log reference of the form
141         `stash@\{<revision>}`.
142
143 create::
144
145         Create a stash (which is a regular commit object) and return its
146         object name, without storing it anywhere in the ref namespace.
147
148
149 DISCUSSION
150 ----------
151
152 A stash is represented as a commit whose tree records the state of the
153 working directory, and its first parent is the commit at `HEAD` when
154 the stash was created.  The tree of the second parent records the
155 state of the index when the stash is made, and it is made a child of
156 the `HEAD` commit.  The ancestry graph looks like this:
157
158             .----W
159            /    /
160      -----H----I
161
162 where `H` is the `HEAD` commit, `I` is a commit that records the state
163 of the index, and `W` is a commit that records the state of the working
164 tree.
165
166
167 EXAMPLES
168 --------
169
170 Pulling into a dirty tree::
171
172 When you are in the middle of something, you learn that there are
173 upstream changes that are possibly relevant to what you are
174 doing.  When your local changes do not conflict with the changes in
175 the upstream, a simple `git pull` will let you move forward.
176 +
177 However, there are cases in which your local changes do conflict with
178 the upstream changes, and `git pull` refuses to overwrite your
179 changes.  In such a case, you can stash your changes away,
180 perform a pull, and then unstash, like this:
181 +
182 ----------------------------------------------------------------
183 $ git pull
184  ...
185 file foobar not up to date, cannot merge.
186 $ git stash
187 $ git pull
188 $ git stash pop
189 ----------------------------------------------------------------
190
191 Interrupted workflow::
192
193 When you are in the middle of something, your boss comes in and
194 demands that you fix something immediately.  Traditionally, you would
195 make a commit to a temporary branch to store your changes away, and
196 return to your original branch to make the emergency fix, like this:
197 +
198 ----------------------------------------------------------------
199 # ... hack hack hack ...
200 $ git checkout -b my_wip
201 $ git commit -a -m "WIP"
202 $ git checkout master
203 $ edit emergency fix
204 $ git commit -a -m "Fix in a hurry"
205 $ git checkout my_wip
206 $ git reset --soft HEAD^
207 # ... continue hacking ...
208 ----------------------------------------------------------------
209 +
210 You can use 'git stash' to simplify the above, like this:
211 +
212 ----------------------------------------------------------------
213 # ... hack hack hack ...
214 $ git stash
215 $ edit emergency fix
216 $ git commit -a -m "Fix in a hurry"
217 $ git stash pop
218 # ... continue hacking ...
219 ----------------------------------------------------------------
220
221 Testing partial commits::
222
223 You can use `git stash save --keep-index` when you want to make two or
224 more commits out of the changes in the work tree, and you want to test
225 each change before committing:
226 +
227 ----------------------------------------------------------------
228 # ... hack hack hack ...
229 $ git add --patch foo            # add just first part to the index
230 $ git stash save --keep-index    # save all other changes to the stash
231 $ edit/build/test first part
232 $ git commit -m 'First part'     # commit fully tested change
233 $ git stash pop                  # prepare to work on all other changes
234 # ... repeat above five steps until one commit remains ...
235 $ edit/build/test remaining parts
236 $ git commit foo -m 'Remaining parts'
237 ----------------------------------------------------------------
238
239 Recovering stashes that were cleared/dropped erroneously::
240
241 If you mistakenly drop or clear stashes, they cannot be recovered
242 through the normal safety mechanisms.  However, you can try the
243 following incantation to get a list of stashes that are still in your
244 repository, but not reachable any more:
245 +
246 ----------------------------------------------------------------
247 git fsck --unreachable |
248 grep commit | cut -d\  -f3 |
249 xargs git log --merges --no-walk --grep=WIP
250 ----------------------------------------------------------------
251
252
253 SEE ALSO
254 --------
255 linkgit:git-checkout[1],
256 linkgit:git-commit[1],
257 linkgit:git-reflog[1],
258 linkgit:git-reset[1]
259
260 AUTHOR
261 ------
262 Written by Nanako Shiraishi <nanako3@bluebottle.com>
263
264 GIT
265 ---
266 Part of the linkgit:git[1] suite