| blob | 657f70b07ae1d51dfb4163b3981671a3a8cd413f |
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>
427 </div></div>
428 </div>
431 <div class="paragraph"><p>Use <tt>git stash</tt> when you want to record the current state of the
432 working directory and the index, but want to go back to a clean
433 working directory. The command saves your local modifications away
439 A stash is by default listed as "WIP on <em>branchname</em> …", but
440 you can give a more descriptive message on the command line when
441 you create one.</p></div>
443 stashes are found in the reflog of this reference and can be named using
446 is also possible).</p></div>
447 </div>
453 </dt>
454 <dd>
455 <p>
458 the description along with the stashed state. For quickly making
461 subcommand from making an unwanted stash.
462 </p>
463 <div class="paragraph"><p>If the <tt>--keep-index</tt> option is used, all changes already added to the
464 index are left intact.</p></div>
465 <div class="paragraph"><p>With <tt>--patch</tt>, you can interactively select hunks from in the diff
466 between HEAD and the working tree to be stashed. The stash entry is
467 constructed such that its index state is the same as the index state
468 of your repository, and its worktree contains only the changes you
469 selected interactively. The selected changes are then rolled back
470 from your worktree.</p></div>
471 <div class="paragraph"><p>The <tt>--patch</tt> option implies <tt>--keep-index</tt>. You can use
473 </dd>
476 </dt>
477 <dd>
478 <p>
481 the one before, etc.), the name of the branch that was current when the
482 stash was made, and a short description of the commit the stash was
483 based on.
484 </p>
489 </div></div>
492 </dd>
495 </dt>
496 <dd>
497 <p>
498 Show the changes recorded in the stash as a diff between the
500 shows the latest one. By default, the command shows the diffstat, but
503 </p>
504 </dd>
507 </dt>
508 <dd>
509 <p>
510 Remove a single stashed state from the stash list and apply it
511 on top of the current working tree state, i.e., do the inverse
513 match the index.
514 </p>
516 removed from the stash list. You need to resolve the conflicts by hand
518 <div class="paragraph"><p>If the <tt>--index</tt> option is used, then tries to reinstate not only the working
520 have conflicts (which are stored in the index, where you therefore can no
521 longer apply the changes as they were originally).</p></div>
522 <div class="paragraph"><p>When no <tt><stash></tt> is given, <tt>stash@{0}</tt> is assumed, otherwise <tt><stash></tt> must
524 </dd>
527 </dt>
528 <dd>
529 <p>
533 </p>
534 </dd>
537 </dt>
538 <dd>
539 <p>
544 <tt>stash@{<revision>}</tt>, it then drops the <tt><stash></tt>. When no <tt><stash></tt>
545 is given, applies the latest one.
546 </p>
547 <div class="paragraph"><p>This is useful if the branch on which you ran <tt>git stash save</tt> has
549 the stash is applied on top of the commit that was HEAD at the time
551 no conflicts.</p></div>
552 </dd>
554 clear
555 </dt>
556 <dd>
557 <p>
558 Remove all the stashed states. Note that those states will then
559 be subject to pruning, and may be impossible to recover (see
561 </p>
562 </dd>
565 </dt>
566 <dd>
567 <p>
572 </p>
573 </dd>
575 create
576 </dt>
577 <dd>
578 <p>
579 Create a stash (which is a regular commit object) and return its
580 object name, without storing it anywhere in the ref namespace.
581 </p>
582 </dd>
583 </dl></div>
584 </div>
587 <div class="paragraph"><p>A stash is represented as a commit whose tree records the state of the
589 the stash was created. The tree of the second parent records the
590 state of the index when the stash is made, and it is made a child of
594 <pre><tt> .----W
595 / /
596 -----H----I</tt></pre>
597 </div></div>
598 <div class="paragraph"><p>where <tt>H</tt> is the <tt>HEAD</tt> commit, <tt>I</tt> is a commit that records the state
600 tree.</p></div>
601 </div>
606 Pulling into a dirty tree
607 </dt>
608 <dd>
609 <p>
610 When you are in the middle of something, you learn that there are
611 upstream changes that are possibly relevant to what you are
612 doing. When your local changes do not conflict with the changes in
614 </p>
617 changes. In such a case, you can stash your changes away,
618 perform a pull, and then unstash, like this:</p></div>
621 <pre><tt>$ git pull
622 ...
623 file foobar not up to date, cannot merge.
624 $ git stash
625 $ git pull
626 $ git stash pop</tt></pre>
627 </div></div>
628 </dd>
630 Interrupted workflow
631 </dt>
632 <dd>
633 <p>
634 When you are in the middle of something, your boss comes in and
635 demands that you fix something immediately. Traditionally, you would
636 make a commit to a temporary branch to store your changes away, and
637 return to your original branch to make the emergency fix, like this:
638 </p>
641 <pre><tt># ... hack hack hack ...
642 $ git checkout -b my_wip
643 $ git commit -a -m "WIP"
644 $ git checkout master
645 $ edit emergency fix
646 $ git commit -a -m "Fix in a hurry"
647 $ git checkout my_wip
648 $ git reset --soft HEAD^
649 # ... continue hacking ...</tt></pre>
650 </div></div>
651 <div class="paragraph"><p>You can use <em>git stash</em> to simplify the above, like this:</p></div>
654 <pre><tt># ... hack hack hack ...
655 $ git stash
656 $ edit emergency fix
657 $ git commit -a -m "Fix in a hurry"
658 $ git stash pop
659 # ... continue hacking ...</tt></pre>
660 </div></div>
661 </dd>
663 Testing partial commits
664 </dt>
665 <dd>
666 <p>
668 more commits out of the changes in the work tree, and you want to test
669 each change before committing:
670 </p>
673 <pre><tt># ... hack hack hack ...
674 $ git add --patch foo # add just first part to the index
675 $ git stash save --keep-index # save all other changes to the stash
676 $ edit/build/test first part
677 $ git commit -m 'First part' # commit fully tested change
678 $ git stash pop # prepare to work on all other changes
679 # ... repeat above five steps until one commit remains ...
680 $ edit/build/test remaining parts
681 $ git commit foo -m 'Remaining parts'</tt></pre>
682 </div></div>
683 </dd>
685 Recovering stashes that were cleared/dropped erroneously
686 </dt>
687 <dd>
688 <p>
689 If you mistakenly drop or clear stashes, they cannot be recovered
690 through the normal safety mechanisms. However, you can try the
691 following incantation to get a list of stashes that are still in your
692 repository, but not reachable any more:
693 </p>
696 <pre><tt>git fsck --unreachable |
697 grep commit | cut -d\ -f3 |
698 xargs git log --merges --no-walk --grep=WIP</tt></pre>
699 </div></div>
700 </dd>
701 </dl></div>
702 </div>
709 </div>
713 </div>
717 </div>
718 </div>
719 </body>
720 </html>