| blob | 7e20e619f72b90ee1900473ab8db9d20fa46e347 |
1 '\" t
2 .\" Title: git-stash
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 10/27/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.38.1.220.g9388e93f00
8 .\" Language: English
9 .\"
10 .TH "GIT\-STASH" "1" "10/27/2022" "Git 2\&.38\&.1\&.220\&.g9388e9" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-stash \- Stash the changes in a dirty working directory away
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit stash\fR list [<log\-options>]
36 \fIgit stash\fR show [\-u|\-\-include\-untracked|\-\-only\-untracked] [<diff\-options>] [<stash>]
37 \fIgit stash\fR drop [\-q|\-\-quiet] [<stash>]
38 \fIgit stash\fR ( pop | apply ) [\-\-index] [\-q|\-\-quiet] [<stash>]
39 \fIgit stash\fR branch <branchname> [<stash>]
40 \fIgit stash\fR [push [\-p|\-\-patch] [\-S|\-\-staged] [\-k|\-\-[no\-]keep\-index] [\-q|\-\-quiet]
41 [\-u|\-\-include\-untracked] [\-a|\-\-all] [\-m|\-\-message <message>]
42 [\-\-pathspec\-from\-file=<file> [\-\-pathspec\-file\-nul]]
43 [\-\-] [<pathspec>\&...]]
44 \fIgit stash\fR clear
45 \fIgit stash\fR create [<message>]
46 \fIgit stash\fR store [\-m|\-\-message <message>] [\-q|\-\-quiet] <commit>
47 .fi
48 .sp
49 .SH "DESCRIPTION"
50 .sp
51 Use \fBgit stash\fR when you want to record the current state of the 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 \fBHEAD\fR commit\&.
52 .sp
53 The modifications stashed away by this command can be listed with \fBgit stash list\fR, inspected with \fBgit stash show\fR, and restored (potentially on top of a different commit) with \fBgit stash apply\fR\&. Calling \fBgit stash\fR without any arguments is equivalent to \fBgit stash push\fR\&. A stash is by default listed as "WIP on \fIbranchname\fR \&...", but you can give a more descriptive message on the command line when you create one\&.
54 .sp
55 The latest stash you created is stored in \fBrefs/stash\fR; older stashes are found in the reflog of this reference and can be named using the usual reflog syntax (e\&.g\&. \fBstash@{0}\fR is the most recently created stash, \fBstash@{1}\fR is the one before it, \fBstash@{2\&.hours\&.ago}\fR is also possible)\&. Stashes may also be referenced by specifying just the stash index (e\&.g\&. the integer \fBn\fR is equivalent to \fBstash@{n}\fR)\&.
56 .SH "COMMANDS"
57 .PP
58 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>\&...]
59 .RS 4
60 Save your local modifications to a new
61 \fIstash entry\fR
62 and roll them back to HEAD (in the working tree and in the index)\&. The <message> part is optional and gives the description along with the stashed state\&.
63 .sp
64 For quickly making a snapshot, you can omit "push"\&. In this mode, non\-option arguments are not allowed to prevent a misspelled subcommand from making an unwanted stash entry\&. The two exceptions to this are
65 \fBstash \-p\fR
66 which acts as alias for
67 \fBstash push \-p\fR
68 and pathspec elements, which are allowed after a double hyphen
69 \fB\-\-\fR
70 for disambiguation\&.
71 .RE
72 .PP
73 save [\-p|\-\-patch] [\-S|\-\-staged] [\-k|\-\-[no\-]keep\-index] [\-u|\-\-include\-untracked] [\-a|\-\-all] [\-q|\-\-quiet] [<message>]
74 .RS 4
75 This option is deprecated in favour of
76 \fIgit stash push\fR\&. It differs from "stash push" in that it cannot take pathspec\&. Instead, all non\-option arguments are concatenated to form the stash message\&.
77 .RE
78 .PP
79 list [<log\-options>]
80 .RS 4
81 List the stash entries that you currently have\&. Each
82 \fIstash entry\fR
83 is listed with its name (e\&.g\&.
84 \fBstash@{0}\fR
85 is the latest entry,
86 \fBstash@{1}\fR
87 is the one before, etc\&.), the name of the branch that was current when the entry was made, and a short description of the commit the entry was based on\&.
88 .sp
89 .if n \{\
90 .RS 4
91 .\}
92 .nf
93 stash@{0}: WIP on submit: 6ebd0e2\&.\&.\&. Update git\-stash documentation
94 stash@{1}: On master: 9cc0589\&.\&.\&. Add git\-stash
95 .fi
96 .if n \{\
97 .RE
98 .\}
99 .sp
100 The command takes options applicable to the
101 \fIgit log\fR
102 command to control what is shown and how\&. See
103 \fBgit-log\fR(1)\&.
104 .RE
105 .PP
106 show [\-u|\-\-include\-untracked|\-\-only\-untracked] [<diff\-options>] [<stash>]
107 .RS 4
108 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\&. By default, the command shows the diffstat, but it will accept any format known to
109 \fIgit diff\fR
110 (e\&.g\&.,
111 \fBgit stash show \-p stash@{1}\fR
112 to view the second most recent entry in patch form)\&. If no
113 \fB<diff\-option>\fR
114 is provided, the default behavior will be given by the
115 \fBstash\&.showStat\fR, and
116 \fBstash\&.showPatch\fR
117 config variables\&. You can also use
118 \fBstash\&.showIncludeUntracked\fR
119 to set whether
120 \fB\-\-include\-untracked\fR
121 is enabled by default\&.
122 .RE
123 .PP
124 pop [\-\-index] [\-q|\-\-quiet] [<stash>]
125 .RS 4
126 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
127 \fBgit stash push\fR\&. The working directory must match the index\&.
128 .sp
129 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
130 \fBgit stash drop\fR
131 manually afterwards\&.
132 .RE
133 .PP
134 apply [\-\-index] [\-q|\-\-quiet] [<stash>]
135 .RS 4
136 Like
137 \fBpop\fR, but do not remove the state from the stash list\&. Unlike
138 \fBpop\fR,
139 \fB<stash>\fR
140 may be any commit that looks like a commit created by
141 \fBstash push\fR
142 or
143 \fBstash create\fR\&.
144 .RE
145 .PP
146 branch <branchname> [<stash>]
147 .RS 4
148 Creates and checks out a new branch named
149 \fB<branchname>\fR
150 starting from the commit at which the
151 \fB<stash>\fR
152 was originally created, applies the changes recorded in
153 \fB<stash>\fR
154 to the new working tree and index\&. If that succeeds, and
155 \fB<stash>\fR
156 is a reference of the form
157 \fBstash@{<revision>}\fR, it then drops the
158 \fB<stash>\fR\&.
159 .sp
160 This is useful if the branch on which you ran
161 \fBgit stash push\fR
162 has changed enough that
163 \fBgit stash apply\fR
164 fails due to conflicts\&. Since the stash entry is applied on top of the commit that was HEAD at the time
165 \fBgit stash\fR
166 was run, it restores the originally stashed state with no conflicts\&.
167 .RE
168 .PP
169 clear
170 .RS 4
171 Remove all the stash entries\&. Note that those entries will then be subject to pruning, and may be impossible to recover (see
172 \fIExamples\fR
173 below for a possible strategy)\&.
174 .RE
175 .PP
176 drop [\-q|\-\-quiet] [<stash>]
177 .RS 4
178 Remove a single stash entry from the list of stash entries\&.
179 .RE
180 .PP
181 create
182 .RS 4
183 Create a stash entry (which is a regular commit object) and return its object name, without storing it anywhere in the ref namespace\&. This is intended to be useful for scripts\&. It is probably not the command you want to use; see "push" above\&.
184 .RE
185 .PP
186 store
187 .RS 4
188 Store a given stash created via
189 \fIgit stash create\fR
190 (which is a dangling merge commit) in the stash ref, updating the stash reflog\&. This is intended to be useful for scripts\&. It is probably not the command you want to use; see "push" above\&.
191 .RE
192 .SH "OPTIONS"
193 .PP
194 \-a, \-\-all
195 .RS 4
196 This option is only valid for
197 \fBpush\fR
198 and
199 \fBsave\fR
200 commands\&.
201 .sp
202 All ignored and untracked files are also stashed and then cleaned up with
203 \fBgit clean\fR\&.
204 .RE
205 .PP
206 \-u, \-\-include\-untracked, \-\-no\-include\-untracked
207 .RS 4
208 When used with the
209 \fBpush\fR
210 and
211 \fBsave\fR
212 commands, all untracked files are also stashed and then cleaned up with
213 \fBgit clean\fR\&.
214 .sp
215 When used with the
216 \fBshow\fR
217 command, show the untracked files in the stash entry as part of the diff\&.
218 .RE
219 .PP
220 \-\-only\-untracked
221 .RS 4
222 This option is only valid for the
223 \fBshow\fR
224 command\&.
225 .sp
226 Show only the untracked files in the stash entry as part of the diff\&.
227 .RE
228 .PP
229 \-\-index
230 .RS 4
231 This option is only valid for
232 \fBpop\fR
233 and
234 \fBapply\fR
235 commands\&.
236 .sp
237 Tries to reinstate not only the working tree\(cqs changes, but also the index\(cqs 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)\&.
238 .RE
239 .PP
240 \-k, \-\-keep\-index, \-\-no\-keep\-index
241 .RS 4
242 This option is only valid for
243 \fBpush\fR
244 and
245 \fBsave\fR
246 commands\&.
247 .sp
248 All changes already added to the index are left intact\&.
249 .RE
250 .PP
251 \-p, \-\-patch
252 .RS 4
253 This option is only valid for
254 \fBpush\fR
255 and
256 \fBsave\fR
257 commands\&.
258 .sp
259 Interactively select hunks from 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\&. See the \(lqInteractive Mode\(rq section of
260 \fBgit-add\fR(1)
261 to learn how to operate the
262 \fB\-\-patch\fR
263 mode\&.
264 .sp
265 The
266 \fB\-\-patch\fR
267 option implies
268 \fB\-\-keep\-index\fR\&. You can use
269 \fB\-\-no\-keep\-index\fR
270 to override this\&.
271 .RE
272 .PP
273 \-S, \-\-staged
274 .RS 4
275 This option is only valid for
276 \fBpush\fR
277 and
278 \fBsave\fR
279 commands\&.
280 .sp
281 Stash only the changes that are currently staged\&. This is similar to basic
282 \fBgit commit\fR
283 except the state is committed to the stash instead of current branch\&.
284 .sp
285 The
286 \fB\-\-patch\fR
287 option has priority over this one\&.
288 .RE
289 .PP
290 \-\-pathspec\-from\-file=<file>
291 .RS 4
292 This option is only valid for
293 \fBpush\fR
294 command\&.
295 .sp
296 Pathspec is passed in
297 \fB<file>\fR
298 instead of commandline args\&. If
299 \fB<file>\fR
300 is exactly
301 \fB\-\fR
302 then standard input is used\&. Pathspec elements are separated by LF or CR/LF\&. Pathspec elements can be quoted as explained for the configuration variable
303 \fBcore\&.quotePath\fR
304 (see
305 \fBgit-config\fR(1))\&. See also
306 \fB\-\-pathspec\-file\-nul\fR
307 and global
308 \fB\-\-literal\-pathspecs\fR\&.
309 .RE
310 .PP
311 \-\-pathspec\-file\-nul
312 .RS 4
313 This option is only valid for
314 \fBpush\fR
315 command\&.
316 .sp
317 Only meaningful with
318 \fB\-\-pathspec\-from\-file\fR\&. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)\&.
319 .RE
320 .PP
321 \-q, \-\-quiet
322 .RS 4
323 This option is only valid for
324 \fBapply\fR,
325 \fBdrop\fR,
326 \fBpop\fR,
327 \fBpush\fR,
328 \fBsave\fR,
329 \fBstore\fR
330 commands\&.
331 .sp
332 Quiet, suppress feedback messages\&.
333 .RE
334 .PP
335 \-\-
336 .RS 4
337 This option is only valid for
338 \fBpush\fR
339 command\&.
340 .sp
341 Separates pathspec from options for disambiguation purposes\&.
342 .RE
343 .PP
344 <pathspec>\&...
345 .RS 4
346 This option is only valid for
347 \fBpush\fR
348 command\&.
349 .sp
350 The new stash entry records the 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\&.
351 .sp
352 For more details, see the
353 \fIpathspec\fR
354 entry in
355 \fBgitglossary\fR(7)\&.
356 .RE
357 .PP
358 <stash>
359 .RS 4
360 This option is only valid for
361 \fBapply\fR,
362 \fBbranch\fR,
363 \fBdrop\fR,
364 \fBpop\fR,
365 \fBshow\fR
366 commands\&.
367 .sp
368 A reference of the form
369 \fBstash@{<revision>}\fR\&. When no
370 \fB<stash>\fR
371 is given, the latest stash is assumed (that is,
372 \fBstash@{0}\fR)\&.
373 .RE
374 .SH "DISCUSSION"
375 .sp
376 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 \fBHEAD\fR 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 the \fBHEAD\fR commit\&. The ancestry graph looks like this:
377 .sp
378 .if n \{\
379 .RS 4
380 .\}
381 .nf
382 \&.\-\-\-\-W
383 / /
384 \-\-\-\-\-H\-\-\-\-I
385 .fi
386 .if n \{\
387 .RE
388 .\}
389 .sp
390 where \fBH\fR is the \fBHEAD\fR commit, \fBI\fR is a commit that records the state of the index, and \fBW\fR is a commit that records the state of the working tree\&.
391 .SH "EXAMPLES"
392 .PP
393 Pulling into a dirty tree
394 .RS 4
395 When you are in the middle of something, you learn that there are upstream changes that are possibly relevant to what you are doing\&. When your local changes do not conflict with the changes in the upstream, a simple
396 \fBgit pull\fR
397 will let you move forward\&.
398 .sp
399 However, there are cases in which your local changes do conflict with the upstream changes, and
400 \fBgit pull\fR
401 refuses to overwrite your changes\&. In such a case, you can stash your changes away, perform a pull, and then unstash, like this:
402 .sp
403 .if n \{\
404 .RS 4
405 .\}
406 .nf
407 $ git pull
408 \&.\&.\&.
409 file foobar not up to date, cannot merge\&.
410 $ git stash
411 $ git pull
412 $ git stash pop
413 .fi
414 .if n \{\
415 .RE
416 .\}
417 .sp
418 .RE
419 .PP
420 Interrupted workflow
421 .RS 4
422 When you are in the middle of something, your boss comes in and demands that you fix something immediately\&. Traditionally, you would make a commit to a temporary branch to store your changes away, and return to your original branch to make the emergency fix, like this:
423 .sp
424 .if n \{\
425 .RS 4
426 .\}
427 .nf
428 # \&.\&.\&. hack hack hack \&.\&.\&.
429 $ git switch \-c my_wip
430 $ git commit \-a \-m "WIP"
431 $ git switch master
432 $ edit emergency fix
433 $ git commit \-a \-m "Fix in a hurry"
434 $ git switch my_wip
435 $ git reset \-\-soft HEAD^
436 # \&.\&.\&. continue hacking \&.\&.\&.
437 .fi
438 .if n \{\
439 .RE
440 .\}
441 .sp
442 You can use
443 \fIgit stash\fR
444 to simplify the above, like this:
445 .sp
446 .if n \{\
447 .RS 4
448 .\}
449 .nf
450 # \&.\&.\&. hack hack hack \&.\&.\&.
451 $ git stash
452 $ edit emergency fix
453 $ git commit \-a \-m "Fix in a hurry"
454 $ git stash pop
455 # \&.\&.\&. continue hacking \&.\&.\&.
456 .fi
457 .if n \{\
458 .RE
459 .\}
460 .sp
461 .RE
462 .PP
463 Testing partial commits
464 .RS 4
465 You can use
466 \fBgit stash push \-\-keep\-index\fR
467 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:
468 .sp
469 .if n \{\
470 .RS 4
471 .\}
472 .nf
473 # \&.\&.\&. hack hack hack \&.\&.\&.
474 $ git add \-\-patch foo # add just first part to the index
475 $ git stash push \-\-keep\-index # save all other changes to the stash
476 $ edit/build/test first part
477 $ git commit \-m \(aqFirst part\(aq # commit fully tested change
478 $ git stash pop # prepare to work on all other changes
479 # \&.\&.\&. repeat above five steps until one commit remains \&.\&.\&.
480 $ edit/build/test remaining parts
481 $ git commit foo \-m \(aqRemaining parts\(aq
482 .fi
483 .if n \{\
484 .RE
485 .\}
486 .sp
487 .RE
488 .PP
489 Saving unrelated changes for future use
490 .RS 4
491 When you are in the middle of massive changes and you find some unrelated issue that you don\(cqt want to forget to fix, you can do the change(s), stage them, and use
492 \fBgit stash push \-\-staged\fR
493 to stash them out for future use\&. This is similar to committing the staged changes, only the commit ends\-up being in the stash and not on the current branch\&.
494 .sp
495 .if n \{\
496 .RS 4
497 .\}
498 .nf
499 # \&.\&.\&. hack hack hack \&.\&.\&.
500 $ git add \-\-patch foo # add unrelated changes to the index
501 $ git stash push \-\-staged # save these changes to the stash
502 # \&.\&.\&. hack hack hack, finish curent changes \&.\&.\&.
503 $ git commit \-m \(aqMassive\(aq # commit fully tested changes
504 $ git switch fixup\-branch # switch to another branch
505 $ git stash pop # to finish work on the saved changes
506 .fi
507 .if n \{\
508 .RE
509 .\}
510 .sp
511 .RE
512 .PP
513 Recovering stash entries that were cleared/dropped erroneously
514 .RS 4
515 If you mistakenly drop or clear stash entries, they cannot be recovered through the normal safety mechanisms\&. However, you can try the following incantation to get a list of stash entries that are still in your repository, but not reachable any more:
516 .sp
517 .if n \{\
518 .RS 4
519 .\}
520 .nf
521 git fsck \-\-unreachable |
522 grep commit | cut \-d\e \-f3 |
523 xargs git log \-\-merges \-\-no\-walk \-\-grep=WIP
524 .fi
525 .if n \{\
526 .RE
527 .\}
528 .sp
529 .RE
530 .SH "CONFIGURATION"
531 .sp
532 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
533 .PP
534 stash\&.showIncludeUntracked
535 .RS 4
536 If this is set to true, the
537 \fBgit stash show\fR
538 command will show the untracked files of a stash entry\&. Defaults to false\&. See description of
539 \fIshow\fR
540 command in
541 \fBgit-stash\fR(1)\&.
542 .RE
543 .PP
544 stash\&.showPatch
545 .RS 4
546 If this is set to true, the
547 \fBgit stash show\fR
548 command without an option will show the stash entry in patch form\&. Defaults to false\&. See description of
549 \fIshow\fR
550 command in
551 \fBgit-stash\fR(1)\&.
552 .RE
553 .PP
554 stash\&.showStat
555 .RS 4
556 If this is set to true, the
557 \fBgit stash show\fR
558 command without an option will show diffstat of the stash entry\&. Defaults to true\&. See description of
559 \fIshow\fR
560 command in
561 \fBgit-stash\fR(1)\&.
562 .RE
563 .SH "SEE ALSO"
564 .sp
565 \fBgit-checkout\fR(1), \fBgit-commit\fR(1), \fBgit-reflog\fR(1), \fBgit-reset\fR(1), \fBgit-switch\fR(1)
566 .SH "GIT"
567 .sp
568 Part of the \fBgit\fR(1) suite