| blob | 02a5a295f8ea5dc925842c30c0ea36a140f56faa |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-stash(1) Manual Page
407 </h1>
410 <p>git-stash -
411 Stash the changes in a dirty working directory away
412 </p>
413 </div>
414 </div>
428 </div></div>
429 </div>
432 <div class="paragraph"><p>Use <tt>git stash</tt> when you want to record the current state of the
433 working directory and the index, but want to go back to a clean
434 working directory. The command saves your local modifications away
440 A stash is by default listed as "WIP on <em>branchname</em> …", but
441 you can give a more descriptive message on the command line when
442 you create one.</p></div>
444 stashes are found in the reflog of this reference and can be named using
447 is also possible).</p></div>
448 </div>
453 save [-p|--patch] [--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]
454 </dt>
455 <dd>
456 <p>
459 the description along with the stashed state. For quickly making
462 subcommand from making an unwanted stash.
463 </p>
464 <div class="paragraph"><p>If the <tt>--keep-index</tt> option is used, all changes already added to the
465 index are left intact.</p></div>
466 <div class="paragraph"><p>If the <tt>--include-untracked</tt> option is used, all untracked files are also
469 ignored files are stashed and cleaned in addition to the untracked files.</p></div>
470 <div class="paragraph"><p>With <tt>--patch</tt>, you can interactively select hunks from the diff
471 between HEAD and the working tree to be stashed. The stash entry is
472 constructed such that its index state is the same as the index state
473 of your repository, and its worktree contains only the changes you
474 selected interactively. The selected changes are then rolled back
476 <a href="git-add.html">git-add(1)</a> to learn how to operate the <tt>--patch</tt> mode.</p></div>
477 <div class="paragraph"><p>The <tt>--patch</tt> option implies <tt>--keep-index</tt>. You can use
479 </dd>
482 </dt>
483 <dd>
484 <p>
487 the one before, etc.), the name of the branch that was current when the
488 stash was made, and a short description of the commit the stash was
489 based on.
490 </p>
495 </div></div>
498 </dd>
501 </dt>
502 <dd>
503 <p>
504 Show the changes recorded in the stash as a diff between the
506 shows the latest one. By default, the command shows the diffstat, but
509 </p>
510 </dd>
513 </dt>
514 <dd>
515 <p>
516 Remove a single stashed state from the stash list and apply it
517 on top of the current working tree state, i.e., do the inverse
519 match the index.
520 </p>
522 removed from the stash list. You need to resolve the conflicts by hand
524 <div class="paragraph"><p>If the <tt>--index</tt> option is used, then tries to reinstate not only the working
526 have conflicts (which are stored in the index, where you therefore can no
527 longer apply the changes as they were originally).</p></div>
528 <div class="paragraph"><p>When no <tt><stash></tt> is given, <tt>stash@{0}</tt> is assumed, otherwise <tt><stash></tt> must
530 </dd>
533 </dt>
534 <dd>
535 <p>
539 </p>
540 </dd>
543 </dt>
544 <dd>
545 <p>
550 <tt>stash@{<revision>}</tt>, it then drops the <tt><stash></tt>. When no <tt><stash></tt>
551 is given, applies the latest one.
552 </p>
553 <div class="paragraph"><p>This is useful if the branch on which you ran <tt>git stash save</tt> has
555 the stash is applied on top of the commit that was HEAD at the time
557 no conflicts.</p></div>
558 </dd>
560 clear
561 </dt>
562 <dd>
563 <p>
564 Remove all the stashed states. Note that those states will then
565 be subject to pruning, and may be impossible to recover (see
567 </p>
568 </dd>
571 </dt>
572 <dd>
573 <p>
578 </p>
579 </dd>
581 create
582 </dt>
583 <dd>
584 <p>
585 Create a stash (which is a regular commit object) and return its
586 object name, without storing it anywhere in the ref namespace.
587 </p>
588 </dd>
589 </dl></div>
590 </div>
593 <div class="paragraph"><p>A stash is represented as a commit whose tree records the state of the
595 the stash was created. The tree of the second parent records the
596 state of the index when the stash is made, and it is made a child of
600 <pre><tt> .----W
601 / /
602 -----H----I</tt></pre>
603 </div></div>
604 <div class="paragraph"><p>where <tt>H</tt> is the <tt>HEAD</tt> commit, <tt>I</tt> is a commit that records the state
606 tree.</p></div>
607 </div>
612 Pulling into a dirty tree
613 </dt>
614 <dd>
615 <p>
616 When you are in the middle of something, you learn that there are
617 upstream changes that are possibly relevant to what you are
618 doing. When your local changes do not conflict with the changes in
620 </p>
623 changes. In such a case, you can stash your changes away,
624 perform a pull, and then unstash, like this:</p></div>
627 <pre><tt>$ git pull
628 ...
629 file foobar not up to date, cannot merge.
630 $ git stash
631 $ git pull
632 $ git stash pop</tt></pre>
633 </div></div>
634 </dd>
636 Interrupted workflow
637 </dt>
638 <dd>
639 <p>
640 When you are in the middle of something, your boss comes in and
641 demands that you fix something immediately. Traditionally, you would
642 make a commit to a temporary branch to store your changes away, and
643 return to your original branch to make the emergency fix, like this:
644 </p>
647 <pre><tt># ... hack hack hack ...
648 $ git checkout -b my_wip
649 $ git commit -a -m "WIP"
650 $ git checkout master
651 $ edit emergency fix
652 $ git commit -a -m "Fix in a hurry"
653 $ git checkout my_wip
654 $ git reset --soft HEAD^
655 # ... continue hacking ...</tt></pre>
656 </div></div>
657 <div class="paragraph"><p>You can use <em>git stash</em> to simplify the above, like this:</p></div>
660 <pre><tt># ... hack hack hack ...
661 $ git stash
662 $ edit emergency fix
663 $ git commit -a -m "Fix in a hurry"
664 $ git stash pop
665 # ... continue hacking ...</tt></pre>
666 </div></div>
667 </dd>
669 Testing partial commits
670 </dt>
671 <dd>
672 <p>
674 more commits out of the changes in the work tree, and you want to test
675 each change before committing:
676 </p>
679 <pre><tt># ... hack hack hack ...
680 $ git add --patch foo # add just first part to the index
681 $ git stash save --keep-index # save all other changes to the stash
682 $ edit/build/test first part
683 $ git commit -m 'First part' # commit fully tested change
684 $ git stash pop # prepare to work on all other changes
685 # ... repeat above five steps until one commit remains ...
686 $ edit/build/test remaining parts
687 $ git commit foo -m 'Remaining parts'</tt></pre>
688 </div></div>
689 </dd>
691 Recovering stashes that were cleared/dropped erroneously
692 </dt>
693 <dd>
694 <p>
695 If you mistakenly drop or clear stashes, they cannot be recovered
696 through the normal safety mechanisms. However, you can try the
697 following incantation to get a list of stashes that are still in your
698 repository, but not reachable any more:
699 </p>
702 <pre><tt>git fsck --unreachable |
703 grep commit | cut -d\ -f3 |
704 xargs git log --merges --no-walk --grep=WIP</tt></pre>
705 </div></div>
706 </dd>
707 </dl></div>
708 </div>
715 </div>
719 </div>
723 </div>
724 </div>
725 </body>
726 </html>