]>
Commit | Line | Data |
---|---|---|
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 [<log-options>] | |
12 | 'git stash' show [-u|--include-untracked|--only-untracked] [<diff-options>] [<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' [push [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet] | |
17 | [-u|--include-untracked] [-a|--all] [-m|--message <message>] | |
18 | [--pathspec-from-file=<file> [--pathspec-file-nul]] | |
19 | [--] [<pathspec>...]] | |
20 | 'git stash' clear | |
21 | 'git stash' create [<message>] | |
22 | 'git stash' store [-m|--message <message>] [-q|--quiet] <commit> | |
23 | ||
24 | DESCRIPTION | |
25 | ----------- | |
26 | ||
27 | Use `git stash` when you want to record the current state of the | |
28 | working directory and the index, but want to go back to a clean | |
29 | working directory. The command saves your local modifications away | |
30 | and reverts the working directory to match the `HEAD` commit. | |
31 | ||
32 | The modifications stashed away by this command can be listed with | |
33 | `git stash list`, inspected with `git stash show`, and restored | |
34 | (potentially on top of a different commit) with `git stash apply`. | |
35 | Calling `git stash` without any arguments is equivalent to `git stash push`. | |
36 | A stash is by default listed as "WIP on 'branchname' ...", but | |
37 | you can give a more descriptive message on the command line when | |
38 | you create one. | |
39 | ||
40 | The latest stash you created is stored in `refs/stash`; older | |
41 | stashes are found in the reflog of this reference and can be named using | |
42 | the usual reflog syntax (e.g. `stash@{0}` is the most recently | |
43 | created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}` | |
44 | is also possible). Stashes may also be referenced by specifying just the | |
45 | stash index (e.g. the integer `n` is equivalent to `stash@{n}`). | |
46 | ||
47 | COMMANDS | |
48 | -------- | |
49 | ||
50 | push [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--pathspec-from-file=<file> [--pathspec-file-nul]] [--] [<pathspec>...]:: | |
51 | ||
52 | Save your local modifications to a new 'stash entry' and roll them | |
53 | back to HEAD (in the working tree and in the index). | |
54 | The <message> part is optional and gives | |
55 | the description along with the stashed state. | |
56 | + | |
57 | For quickly making a snapshot, you can omit "push". In this mode, | |
58 | non-option arguments are not allowed to prevent a misspelled | |
59 | subcommand from making an unwanted stash entry. The two exceptions to this | |
60 | are `stash -p` which acts as alias for `stash push -p` and pathspec elements, | |
61 | which are allowed after a double hyphen `--` for disambiguation. | |
62 | ||
63 | save [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: | |
64 | ||
65 | This option is deprecated in favour of 'git stash push'. It | |
66 | differs from "stash push" in that it cannot take pathspec. | |
67 | Instead, all non-option arguments are concatenated to form the stash | |
68 | message. | |
69 | ||
70 | list [<log-options>]:: | |
71 | ||
72 | List the stash entries that you currently have. Each 'stash entry' is | |
73 | listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is | |
74 | the one before, etc.), the name of the branch that was current when the | |
75 | entry was made, and a short description of the commit the entry was | |
76 | based on. | |
77 | + | |
78 | ---------------------------------------------------------------- | |
79 | stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation | |
80 | stash@{1}: On master: 9cc0589... Add git-stash | |
81 | ---------------------------------------------------------------- | |
82 | + | |
83 | The command takes options applicable to the 'git log' | |
84 | command to control what is shown and how. See linkgit:git-log[1]. | |
85 | ||
86 | show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]:: | |
87 | ||
88 | Show the changes recorded in the stash entry as a diff between the | |
89 | stashed contents and the commit back when the stash entry was first | |
90 | created. | |
91 | By default, the command shows the diffstat, but it will accept any | |
92 | format known to 'git diff' (e.g., `git stash show -p stash@{1}` | |
93 | to view the second most recent entry in patch form). | |
94 | If no `<diff-option>` is provided, the default behavior will be given | |
95 | by the `stash.showStat`, and `stash.showPatch` config variables. You | |
96 | can also use `stash.showIncludeUntracked` to set whether | |
97 | `--include-untracked` is enabled by default. | |
98 | ||
99 | pop [--index] [-q|--quiet] [<stash>]:: | |
100 | ||
101 | Remove a single stashed state from the stash list and apply it | |
102 | on top of the current working tree state, i.e., do the inverse | |
103 | operation of `git stash push`. The working directory must | |
104 | match the index. | |
105 | + | |
106 | Applying the state can fail with conflicts; in this case, it is not | |
107 | removed from the stash list. You need to resolve the conflicts by hand | |
108 | and call `git stash drop` manually afterwards. | |
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 push` 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>`. | |
123 | + | |
124 | This is useful if the branch on which you ran `git stash push` has | |
125 | changed enough that `git stash apply` fails due to conflicts. Since | |
126 | the stash entry is applied on top of the commit that was HEAD at the | |
127 | time `git stash` was run, it restores the originally stashed state | |
128 | with no conflicts. | |
129 | ||
130 | clear:: | |
131 | Remove all the stash entries. Note that those entries will then | |
132 | be subject to pruning, and may be impossible to recover (see | |
133 | 'Examples' below for a possible strategy). | |
134 | ||
135 | drop [-q|--quiet] [<stash>]:: | |
136 | ||
137 | Remove a single stash entry from the list of stash entries. | |
138 | ||
139 | create:: | |
140 | ||
141 | Create a stash entry (which is a regular commit object) and | |
142 | return its object name, without storing it anywhere in the ref | |
143 | namespace. | |
144 | This is intended to be useful for scripts. It is probably not | |
145 | the command you want to use; see "push" above. | |
146 | ||
147 | store:: | |
148 | ||
149 | Store a given stash created via 'git stash create' (which is a | |
150 | dangling merge commit) in the stash ref, updating the stash | |
151 | reflog. This is intended to be useful for scripts. It is | |
152 | probably not the command you want to use; see "push" above. | |
153 | ||
154 | OPTIONS | |
155 | ------- | |
156 | -a:: | |
157 | --all:: | |
158 | This option is only valid for `push` and `save` commands. | |
159 | + | |
160 | All ignored and untracked files are also stashed and then cleaned | |
161 | up with `git clean`. | |
162 | ||
163 | -u:: | |
164 | --include-untracked:: | |
165 | --no-include-untracked:: | |
166 | When used with the `push` and `save` commands, | |
167 | all untracked files are also stashed and then cleaned up with | |
168 | `git clean`. | |
169 | + | |
170 | When used with the `show` command, show the untracked files in the stash | |
171 | entry as part of the diff. | |
172 | ||
173 | --only-untracked:: | |
174 | This option is only valid for the `show` command. | |
175 | + | |
176 | Show only the untracked files in the stash entry as part of the diff. | |
177 | ||
178 | --index:: | |
179 | This option is only valid for `pop` and `apply` commands. | |
180 | + | |
181 | Tries to reinstate not only the working tree's changes, but also | |
182 | the index's ones. However, this can fail, when you have conflicts | |
183 | (which are stored in the index, where you therefore can no longer | |
184 | apply the changes as they were originally). | |
185 | ||
186 | -k:: | |
187 | --keep-index:: | |
188 | --no-keep-index:: | |
189 | This option is only valid for `push` and `save` commands. | |
190 | + | |
191 | All changes already added to the index are left intact. | |
192 | ||
193 | -p:: | |
194 | --patch:: | |
195 | This option is only valid for `push` and `save` commands. | |
196 | + | |
197 | Interactively select hunks from the diff between HEAD and the | |
198 | working tree to be stashed. The stash entry is constructed such | |
199 | that its index state is the same as the index state of your | |
200 | repository, and its worktree contains only the changes you selected | |
201 | interactively. The selected changes are then rolled back from your | |
202 | worktree. See the ``Interactive Mode'' section of linkgit:git-add[1] | |
203 | to learn how to operate the `--patch` mode. | |
204 | + | |
205 | The `--patch` option implies `--keep-index`. You can use | |
206 | `--no-keep-index` to override this. | |
207 | ||
208 | -S:: | |
209 | --staged:: | |
210 | This option is only valid for `push` and `save` commands. | |
211 | + | |
212 | Stash only the changes that are currently staged. This is similar to | |
213 | basic `git commit` except the state is committed to the stash instead | |
214 | of current branch. | |
215 | + | |
216 | The `--patch` option has priority over this one. | |
217 | ||
218 | --pathspec-from-file=<file>:: | |
219 | This option is only valid for `push` command. | |
220 | + | |
221 | Pathspec is passed in `<file>` instead of commandline args. If | |
222 | `<file>` is exactly `-` then standard input is used. Pathspec | |
223 | elements are separated by LF or CR/LF. Pathspec elements can be | |
224 | quoted as explained for the configuration variable `core.quotePath` | |
225 | (see linkgit:git-config[1]). See also `--pathspec-file-nul` and | |
226 | global `--literal-pathspecs`. | |
227 | ||
228 | --pathspec-file-nul:: | |
229 | This option is only valid for `push` command. | |
230 | + | |
231 | Only meaningful with `--pathspec-from-file`. Pathspec elements are | |
232 | separated with NUL character and all other characters are taken | |
233 | literally (including newlines and quotes). | |
234 | ||
235 | -q:: | |
236 | --quiet:: | |
237 | This option is only valid for `apply`, `drop`, `pop`, `push`, | |
238 | `save`, `store` commands. | |
239 | + | |
240 | Quiet, suppress feedback messages. | |
241 | ||
242 | \--:: | |
243 | This option is only valid for `push` command. | |
244 | + | |
245 | Separates pathspec from options for disambiguation purposes. | |
246 | ||
247 | <pathspec>...:: | |
248 | This option is only valid for `push` command. | |
249 | + | |
250 | The new stash entry records the modified states only for the files | |
251 | that match the pathspec. The index entries and working tree files | |
252 | are then rolled back to the state in HEAD only for these files, | |
253 | too, leaving files that do not match the pathspec intact. | |
254 | + | |
255 | For more details, see the 'pathspec' entry in linkgit:gitglossary[7]. | |
256 | ||
257 | <stash>:: | |
258 | This option is only valid for `apply`, `branch`, `drop`, `pop`, | |
259 | `show` commands. | |
260 | + | |
261 | A reference of the form `stash@{<revision>}`. When no `<stash>` is | |
262 | given, the latest stash is assumed (that is, `stash@{0}`). | |
263 | ||
264 | DISCUSSION | |
265 | ---------- | |
266 | ||
267 | A stash entry is represented as a commit whose tree records the state | |
268 | of the working directory, and its first parent is the commit at `HEAD` | |
269 | when the entry was created. The tree of the second parent records the | |
270 | state of the index when the entry is made, and it is made a child of | |
271 | the `HEAD` commit. The ancestry graph looks like this: | |
272 | ||
273 | .----W | |
274 | / / | |
275 | -----H----I | |
276 | ||
277 | where `H` is the `HEAD` commit, `I` is a commit that records the state | |
278 | of the index, and `W` is a commit that records the state of the working | |
279 | tree. | |
280 | ||
281 | ||
282 | EXAMPLES | |
283 | -------- | |
284 | ||
285 | Pulling into a dirty tree:: | |
286 | ||
287 | When you are in the middle of something, you learn that there are | |
288 | upstream changes that are possibly relevant to what you are | |
289 | doing. When your local changes do not conflict with the changes in | |
290 | the upstream, a simple `git pull` will let you move forward. | |
291 | + | |
292 | However, there are cases in which your local changes do conflict with | |
293 | the upstream changes, and `git pull` refuses to overwrite your | |
294 | changes. In such a case, you can stash your changes away, | |
295 | perform a pull, and then unstash, like this: | |
296 | + | |
297 | ---------------------------------------------------------------- | |
298 | $ git pull | |
299 | ... | |
300 | file foobar not up to date, cannot merge. | |
301 | $ git stash | |
302 | $ git pull | |
303 | $ git stash pop | |
304 | ---------------------------------------------------------------- | |
305 | ||
306 | Interrupted workflow:: | |
307 | ||
308 | When you are in the middle of something, your boss comes in and | |
309 | demands that you fix something immediately. Traditionally, you would | |
310 | make a commit to a temporary branch to store your changes away, and | |
311 | return to your original branch to make the emergency fix, like this: | |
312 | + | |
313 | ---------------------------------------------------------------- | |
314 | # ... hack hack hack ... | |
315 | $ git switch -c my_wip | |
316 | $ git commit -a -m "WIP" | |
317 | $ git switch master | |
318 | $ edit emergency fix | |
319 | $ git commit -a -m "Fix in a hurry" | |
320 | $ git switch my_wip | |
321 | $ git reset --soft HEAD^ | |
322 | # ... continue hacking ... | |
323 | ---------------------------------------------------------------- | |
324 | + | |
325 | You can use 'git stash' to simplify the above, like this: | |
326 | + | |
327 | ---------------------------------------------------------------- | |
328 | # ... hack hack hack ... | |
329 | $ git stash | |
330 | $ edit emergency fix | |
331 | $ git commit -a -m "Fix in a hurry" | |
332 | $ git stash pop | |
333 | # ... continue hacking ... | |
334 | ---------------------------------------------------------------- | |
335 | ||
336 | Testing partial commits:: | |
337 | ||
338 | You can use `git stash push --keep-index` when you want to make two or | |
339 | more commits out of the changes in the work tree, and you want to test | |
340 | each change before committing: | |
341 | + | |
342 | ---------------------------------------------------------------- | |
343 | # ... hack hack hack ... | |
344 | $ git add --patch foo # add just first part to the index | |
345 | $ git stash push --keep-index # save all other changes to the stash | |
346 | $ edit/build/test first part | |
347 | $ git commit -m 'First part' # commit fully tested change | |
348 | $ git stash pop # prepare to work on all other changes | |
349 | # ... repeat above five steps until one commit remains ... | |
350 | $ edit/build/test remaining parts | |
351 | $ git commit foo -m 'Remaining parts' | |
352 | ---------------------------------------------------------------- | |
353 | ||
354 | Saving unrelated changes for future use:: | |
355 | ||
356 | When you are in the middle of massive changes and you find some | |
357 | unrelated issue that you don't want to forget to fix, you can do the | |
358 | change(s), stage them, and use `git stash push --staged` to stash them | |
359 | out for future use. This is similar to committing the staged changes, | |
360 | only the commit ends-up being in the stash and not on the current branch. | |
361 | + | |
362 | ---------------------------------------------------------------- | |
363 | # ... hack hack hack ... | |
364 | $ git add --patch foo # add unrelated changes to the index | |
365 | $ git stash push --staged # save these changes to the stash | |
366 | # ... hack hack hack, finish curent changes ... | |
367 | $ git commit -m 'Massive' # commit fully tested changes | |
368 | $ git switch fixup-branch # switch to another branch | |
369 | $ git stash pop # to finish work on the saved changes | |
370 | ---------------------------------------------------------------- | |
371 | ||
372 | Recovering stash entries that were cleared/dropped erroneously:: | |
373 | ||
374 | If you mistakenly drop or clear stash entries, they cannot be recovered | |
375 | through the normal safety mechanisms. However, you can try the | |
376 | following incantation to get a list of stash entries that are still in | |
377 | your repository, but not reachable any more: | |
378 | + | |
379 | ---------------------------------------------------------------- | |
380 | git fsck --unreachable | | |
381 | grep commit | cut -d\ -f3 | | |
382 | xargs git log --merges --no-walk --grep=WIP | |
383 | ---------------------------------------------------------------- | |
384 | ||
385 | ||
386 | SEE ALSO | |
387 | -------- | |
388 | linkgit:git-checkout[1], | |
389 | linkgit:git-commit[1], | |
390 | linkgit:git-reflog[1], | |
391 | linkgit:git-reset[1], | |
392 | linkgit:git-switch[1] | |
393 | ||
394 | GIT | |
395 | --- | |
396 | Part of the linkgit:git[1] suite |