| blob | 65e42d843d39430c96891ee28c4fca553cbd84af |
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 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
471 <a href="git-add.html">git-add(1)</a> to learn how to operate the <tt>--patch</tt> mode.</p></div>
472 <div class="paragraph"><p>The <tt>--patch</tt> option implies <tt>--keep-index</tt>. You can use
474 </dd>
477 </dt>
478 <dd>
479 <p>
482 the one before, etc.), the name of the branch that was current when the
483 stash was made, and a short description of the commit the stash was
484 based on.
485 </p>
490 </div></div>
493 </dd>
496 </dt>
497 <dd>
498 <p>
499 Show the changes recorded in the stash as a diff between the
501 shows the latest one. By default, the command shows the diffstat, but
504 </p>
505 </dd>
508 </dt>
509 <dd>
510 <p>
511 Remove a single stashed state from the stash list and apply it
512 on top of the current working tree state, i.e., do the inverse
514 match the index.
515 </p>
517 removed from the stash list. You need to resolve the conflicts by hand
519 <div class="paragraph"><p>If the <tt>--index</tt> option is used, then tries to reinstate not only the working
521 have conflicts (which are stored in the index, where you therefore can no
522 longer apply the changes as they were originally).</p></div>
523 <div class="paragraph"><p>When no <tt><stash></tt> is given, <tt>stash@{0}</tt> is assumed, otherwise <tt><stash></tt> must
525 </dd>
528 </dt>
529 <dd>
530 <p>
534 </p>
535 </dd>
538 </dt>
539 <dd>
540 <p>
545 <tt>stash@{<revision>}</tt>, it then drops the <tt><stash></tt>. When no <tt><stash></tt>
546 is given, applies the latest one.
547 </p>
548 <div class="paragraph"><p>This is useful if the branch on which you ran <tt>git stash save</tt> has
550 the stash is applied on top of the commit that was HEAD at the time
552 no conflicts.</p></div>
553 </dd>
555 clear
556 </dt>
557 <dd>
558 <p>
559 Remove all the stashed states. Note that those states will then
560 be subject to pruning, and may be impossible to recover (see
562 </p>
563 </dd>
566 </dt>
567 <dd>
568 <p>
573 </p>
574 </dd>
576 create
577 </dt>
578 <dd>
579 <p>
580 Create a stash (which is a regular commit object) and return its
581 object name, without storing it anywhere in the ref namespace.
582 </p>
583 </dd>
584 </dl></div>
585 </div>
588 <div class="paragraph"><p>A stash is represented as a commit whose tree records the state of the
590 the stash was created. The tree of the second parent records the
591 state of the index when the stash is made, and it is made a child of
595 <pre><tt> .----W
596 / /
597 -----H----I</tt></pre>
598 </div></div>
599 <div class="paragraph"><p>where <tt>H</tt> is the <tt>HEAD</tt> commit, <tt>I</tt> is a commit that records the state
601 tree.</p></div>
602 </div>
607 Pulling into a dirty tree
608 </dt>
609 <dd>
610 <p>
611 When you are in the middle of something, you learn that there are
612 upstream changes that are possibly relevant to what you are
613 doing. When your local changes do not conflict with the changes in
615 </p>
618 changes. In such a case, you can stash your changes away,
619 perform a pull, and then unstash, like this:</p></div>
622 <pre><tt>$ git pull
623 ...
624 file foobar not up to date, cannot merge.
625 $ git stash
626 $ git pull
627 $ git stash pop</tt></pre>
628 </div></div>
629 </dd>
631 Interrupted workflow
632 </dt>
633 <dd>
634 <p>
635 When you are in the middle of something, your boss comes in and
636 demands that you fix something immediately. Traditionally, you would
637 make a commit to a temporary branch to store your changes away, and
638 return to your original branch to make the emergency fix, like this:
639 </p>
642 <pre><tt># ... hack hack hack ...
643 $ git checkout -b my_wip
644 $ git commit -a -m "WIP"
645 $ git checkout master
646 $ edit emergency fix
647 $ git commit -a -m "Fix in a hurry"
648 $ git checkout my_wip
649 $ git reset --soft HEAD^
650 # ... continue hacking ...</tt></pre>
651 </div></div>
652 <div class="paragraph"><p>You can use <em>git stash</em> to simplify the above, like this:</p></div>
655 <pre><tt># ... hack hack hack ...
656 $ git stash
657 $ edit emergency fix
658 $ git commit -a -m "Fix in a hurry"
659 $ git stash pop
660 # ... continue hacking ...</tt></pre>
661 </div></div>
662 </dd>
664 Testing partial commits
665 </dt>
666 <dd>
667 <p>
669 more commits out of the changes in the work tree, and you want to test
670 each change before committing:
671 </p>
674 <pre><tt># ... hack hack hack ...
675 $ git add --patch foo # add just first part to the index
676 $ git stash save --keep-index # save all other changes to the stash
677 $ edit/build/test first part
678 $ git commit -m 'First part' # commit fully tested change
679 $ git stash pop # prepare to work on all other changes
680 # ... repeat above five steps until one commit remains ...
681 $ edit/build/test remaining parts
682 $ git commit foo -m 'Remaining parts'</tt></pre>
683 </div></div>
684 </dd>
686 Recovering stashes that were cleared/dropped erroneously
687 </dt>
688 <dd>
689 <p>
690 If you mistakenly drop or clear stashes, they cannot be recovered
691 through the normal safety mechanisms. However, you can try the
692 following incantation to get a list of stashes that are still in your
693 repository, but not reachable any more:
694 </p>
697 <pre><tt>git fsck --unreachable |
698 grep commit | cut -d\ -f3 |
699 xargs git log --merges --no-walk --grep=WIP</tt></pre>
700 </div></div>
701 </dd>
702 </dl></div>
703 </div>
710 </div>
714 </div>
718 </div>
719 </div>
720 </body>
721 </html>