1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>git-stash(
1)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
478 function tocEntries(el
, toclevels
) {
479 var result
= new Array
;
480 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
484 var iterate = function (el
) {
485 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
486 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
487 var mo
= re
.exec(i
.tagName
);
488 if (mo
&& (i
.getAttribute("class") || i
.getAttribute("className")) != "float") {
489 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
499 var toc
= document
.getElementById("toc");
500 var entries
= tocEntries(document
.getElementById("content"), toclevels
);
501 for (var i
= 0; i
< entries
.length
; ++i
) {
502 var entry
= entries
[i
];
503 if (entry
.element
.id
== "")
504 entry
.element
.id
= "_toc_" + i
;
505 var a
= document
.createElement("a");
506 a
.href
= "#" + entry
.element
.id
;
507 a
.appendChild(document
.createTextNode(entry
.text
));
508 var div
= document
.createElement("div");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note
= spans
[i
].innerHTML
.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder
.innerHTML
+=
539 "<div class='footnote' id='_footnote_" + n
+ "'>" +
540 "<a href='#_footnoteref_" + n
+ "' title='Return to text'>" +
541 n
+ "</a>. " + note
+ "</div>";
543 "[<a id='_footnoteref_" + n
+ "' href='#_footnote_" + n
+
544 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
545 var id
=spans
[i
].getAttribute("id");
546 if (id
!= null) refs
["#"+id
] = n
;
550 noteholder
.parentNode
.removeChild(noteholder
);
552 // Process footnoterefs.
553 for (i
=0; i
<spans
.length
; i
++) {
554 if (spans
[i
].className
== "footnoteref") {
555 var href
= spans
[i
].getElementsByTagName("a")[0].getAttribute("href");
556 href
= href
.match(/#.*/)[0]; // Because IE return full URL.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 git-stash(
1) Manual Page
576 <div class=
"sectionbody">
578 Stash the changes in a dirty working directory away
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git stash
</em> list [
<options
>]
587 <em>git stash
</em> show [
<stash
>]
588 <em>git stash
</em> drop [-q|--quiet] [
<stash
>]
589 <em>git stash
</em> ( pop | apply ) [--index] [-q|--quiet] [
<stash
>]
590 <em>git stash
</em> branch
<branchname
> [
<stash
>]
591 <em>git stash
</em> [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
592 [-u|--include-untracked] [-a|--all] [
<message
>]]
593 <em>git stash
</em> clear
594 <em>git stash
</em> create
</div>
595 <div class=
"verseblock-attribution">
598 <h2 id=
"_description">DESCRIPTION
</h2>
599 <div class=
"sectionbody">
600 <div class=
"paragraph"><p>Use
<tt>git stash
</tt> when you want to record the current state of the
601 working directory and the index, but want to go back to a clean
602 working directory. The command saves your local modifications away
603 and reverts the working directory to match the
<tt>HEAD
</tt> commit.
</p></div>
604 <div class=
"paragraph"><p>The modifications stashed away by this command can be listed with
605 <tt>git stash list
</tt>, inspected with
<tt>git stash show
</tt>, and restored
606 (potentially on top of a different commit) with
<tt>git stash apply
</tt>.
607 Calling
<tt>git stash
</tt> without any arguments is equivalent to
<tt>git stash save
</tt>.
608 A stash is by default listed as
"WIP on <em>branchname</em> …", but
609 you can give a more descriptive message on the command line when
610 you create one.
</p></div>
611 <div class=
"paragraph"><p>The latest stash you created is stored in
<tt>refs/stash
</tt>; older
612 stashes are found in the reflog of this reference and can be named using
613 the usual reflog syntax (e.g.
<tt>stash@{
0}
</tt> is the most recently
614 created stash,
<tt>stash@{
1}
</tt> is the one before it,
<tt>stash@{
2.hours.ago}
</tt>
615 is also possible).
</p></div>
617 <h2 id=
"_options">OPTIONS
</h2>
618 <div class=
"sectionbody">
619 <div class=
"dlist"><dl>
621 save [-p|--patch] [--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [
<message
>]
625 Save your local modifications to a new
<em>stash
</em>, and run
<tt>git reset
626 --hard
</tt> to revert them. The
<message
> part is optional and gives
627 the description along with the stashed state. For quickly making
628 a snapshot, you can omit
<em>both
</em> "save" and
<message
>, but giving
629 only
<message
> does not trigger this action to prevent a misspelled
630 subcommand from making an unwanted stash.
632 <div class=
"paragraph"><p>If the
<tt>--keep-index
</tt> option is used, all changes already added to the
633 index are left intact.
</p></div>
634 <div class=
"paragraph"><p>If the
<tt>--include-untracked
</tt> option is used, all untracked files are also
635 stashed and then cleaned up with
<tt>git clean
</tt>, leaving the working directory
636 in a very clean state. If the
<tt>--all
</tt> option is used instead then the
637 ignored files are stashed and cleaned in addition to the untracked files.
</p></div>
638 <div class=
"paragraph"><p>With
<tt>--patch
</tt>, you can interactively select hunks from the diff
639 between HEAD and the working tree to be stashed. The stash entry is
640 constructed such that its index state is the same as the index state
641 of your repository, and its worktree contains only the changes you
642 selected interactively. The selected changes are then rolled back
643 from your worktree. See the
“Interactive Mode
” section of
644 <a href=
"git-add.html">git-add(
1)
</a> to learn how to operate the
<tt>--patch
</tt> mode.
</p></div>
645 <div class=
"paragraph"><p>The
<tt>--patch
</tt> option implies
<tt>--keep-index
</tt>. You can use
646 <tt>--no-keep-index
</tt> to override this.
</p></div>
649 list [
<options
>]
653 List the stashes that you currently have. Each
<em>stash
</em> is listed
654 with its name (e.g.
<tt>stash@{
0}
</tt> is the latest stash,
<tt>stash@{
1}
</tt> is
655 the one before, etc.), the name of the branch that was current when the
656 stash was made, and a short description of the commit the stash was
659 <div class=
"listingblock">
660 <div class=
"content">
661 <pre><tt>stash@{
0}: WIP on submit:
6ebd0e2... Update git-stash documentation
662 stash@{
1}: On master:
9cc0589... Add git-stash
</tt></pre>
664 <div class=
"paragraph"><p>The command takes options applicable to the
<em>git log
</em>
665 command to control what is shown and how. See
<a href=
"git-log.html">git-log(
1)
</a>.
</p></div>
672 Show the changes recorded in the stash as a diff between the
673 stashed state and its original parent. When no
<tt><stash
></tt> is given,
674 shows the latest one. By default, the command shows the diffstat, but
675 it will accept any format known to
<em>git diff
</em> (e.g.,
<tt>git stash show
676 -p stash@{
1}
</tt> to view the second most recent stash in patch form).
680 pop [--index] [-q|--quiet] [
<stash
>]
684 Remove a single stashed state from the stash list and apply it
685 on top of the current working tree state, i.e., do the inverse
686 operation of
<tt>git stash save
</tt>. The working directory must
689 <div class=
"paragraph"><p>Applying the state can fail with conflicts; in this case, it is not
690 removed from the stash list. You need to resolve the conflicts by hand
691 and call
<tt>git stash drop
</tt> manually afterwards.
</p></div>
692 <div class=
"paragraph"><p>If the
<tt>--index
</tt> option is used, then tries to reinstate not only the working
693 tree
’s changes, but also the index
’s ones. However, this can fail, when you
694 have conflicts (which are stored in the index, where you therefore can no
695 longer apply the changes as they were originally).
</p></div>
696 <div class=
"paragraph"><p>When no
<tt><stash
></tt> is given,
<tt>stash@{
0}
</tt> is assumed, otherwise
<tt><stash
></tt> must
697 be a reference of the form
<tt>stash@{
<revision
>}
</tt>.
</p></div>
700 apply [--index] [-q|--quiet] [
<stash
>]
704 Like
<tt>pop
</tt>, but do not remove the state from the stash list. Unlike
<tt>pop
</tt>,
705 <tt><stash
></tt> may be any commit that looks like a commit created by
706 <tt>stash save
</tt> or
<tt>stash create
</tt>.
710 branch
<branchname
> [
<stash
>]
714 Creates and checks out a new branch named
<tt><branchname
></tt> starting from
715 the commit at which the
<tt><stash
></tt> was originally created, applies the
716 changes recorded in
<tt><stash
></tt> to the new working tree and index.
717 If that succeeds, and
<tt><stash
></tt> is a reference of the form
718 <tt>stash@{
<revision
>}
</tt>, it then drops the
<tt><stash
></tt>. When no
<tt><stash
></tt>
719 is given, applies the latest one.
721 <div class=
"paragraph"><p>This is useful if the branch on which you ran
<tt>git stash save
</tt> has
722 changed enough that
<tt>git stash apply
</tt> fails due to conflicts. Since
723 the stash is applied on top of the commit that was HEAD at the time
724 <tt>git stash
</tt> was run, it restores the originally stashed state with
725 no conflicts.
</p></div>
732 Remove all the stashed states. Note that those states will then
733 be subject to pruning, and may be impossible to recover (see
734 <em>Examples
</em> below for a possible strategy).
738 drop [-q|--quiet] [
<stash
>]
742 Remove a single stashed state from the stash list. When no
<tt><stash
></tt>
743 is given, it removes the latest one. i.e.
<tt>stash@{
0}
</tt>, otherwise
744 <tt><stash
></tt> must a valid stash log reference of the form
745 <tt>stash@{
<revision
>}
</tt>.
753 Create a stash (which is a regular commit object) and return its
754 object name, without storing it anywhere in the ref namespace.
759 <h2 id=
"_discussion">DISCUSSION
</h2>
760 <div class=
"sectionbody">
761 <div class=
"paragraph"><p>A stash is represented as a commit whose tree records the state of the
762 working directory, and its first parent is the commit at
<tt>HEAD
</tt> when
763 the stash was created. The tree of the second parent records the
764 state of the index when the stash is made, and it is made a child of
765 the
<tt>HEAD
</tt> commit. The ancestry graph looks like this:
</p></div>
766 <div class=
"literalblock">
767 <div class=
"content">
770 -----H----I
</tt></pre>
772 <div class=
"paragraph"><p>where
<tt>H
</tt> is the
<tt>HEAD
</tt> commit,
<tt>I
</tt> is a commit that records the state
773 of the index, and
<tt>W
</tt> is a commit that records the state of the working
776 <h2 id=
"_examples">EXAMPLES
</h2>
777 <div class=
"sectionbody">
778 <div class=
"dlist"><dl>
780 Pulling into a dirty tree
784 When you are in the middle of something, you learn that there are
785 upstream changes that are possibly relevant to what you are
786 doing. When your local changes do not conflict with the changes in
787 the upstream, a simple
<tt>git pull
</tt> will let you move forward.
789 <div class=
"paragraph"><p>However, there are cases in which your local changes do conflict with
790 the upstream changes, and
<tt>git pull
</tt> refuses to overwrite your
791 changes. In such a case, you can stash your changes away,
792 perform a pull, and then unstash, like this:
</p></div>
793 <div class=
"listingblock">
794 <div class=
"content">
797 file foobar not up to date, cannot merge.
800 $ git stash pop
</tt></pre>
808 When you are in the middle of something, your boss comes in and
809 demands that you fix something immediately. Traditionally, you would
810 make a commit to a temporary branch to store your changes away, and
811 return to your original branch to make the emergency fix, like this:
813 <div class=
"listingblock">
814 <div class=
"content">
815 <pre><tt># ... hack hack hack ...
816 $ git checkout -b my_wip
817 $ git commit -a -m
"WIP"
818 $ git checkout master
820 $ git commit -a -m
"Fix in a hurry"
821 $ git checkout my_wip
822 $ git reset --soft HEAD^
823 # ... continue hacking ...
</tt></pre>
825 <div class=
"paragraph"><p>You can use
<em>git stash
</em> to simplify the above, like this:
</p></div>
826 <div class=
"listingblock">
827 <div class=
"content">
828 <pre><tt># ... hack hack hack ...
831 $ git commit -a -m
"Fix in a hurry"
833 # ... continue hacking ...
</tt></pre>
837 Testing partial commits
841 You can use
<tt>git stash save --keep-index
</tt> when you want to make two or
842 more commits out of the changes in the work tree, and you want to test
843 each change before committing:
845 <div class=
"listingblock">
846 <div class=
"content">
847 <pre><tt># ... hack hack hack ...
848 $ git add --patch foo # add just first part to the index
849 $ git stash save --keep-index # save all other changes to the stash
850 $ edit/build/test first part
851 $ git commit -m 'First part' # commit fully tested change
852 $ git stash pop # prepare to work on all other changes
853 # ... repeat above five steps until one commit remains ...
854 $ edit/build/test remaining parts
855 $ git commit foo -m 'Remaining parts'
</tt></pre>
859 Recovering stashes that were cleared/dropped erroneously
863 If you mistakenly drop or clear stashes, they cannot be recovered
864 through the normal safety mechanisms. However, you can try the
865 following incantation to get a list of stashes that are still in your
866 repository, but not reachable any more:
868 <div class=
"listingblock">
869 <div class=
"content">
870 <pre><tt>git fsck --unreachable |
871 grep commit | cut -d\ -f3 |
872 xargs git log --merges --no-walk --grep=WIP
</tt></pre>
877 <h2 id=
"_see_also">SEE ALSO
</h2>
878 <div class=
"sectionbody">
879 <div class=
"paragraph"><p><a href=
"git-checkout.html">git-checkout(
1)
</a>,
880 <a href=
"git-commit.html">git-commit(
1)
</a>,
881 <a href=
"git-reflog.html">git-reflog(
1)
</a>,
882 <a href=
"git-reset.html">git-reset(
1)
</a></p></div>
884 <h2 id=
"_git">GIT
</h2>
885 <div class=
"sectionbody">
886 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
889 <div id=
"footnotes"><hr /></div>
891 <div id=
"footer-text">
892 Last updated
2011-
09-
21 23:
01:
14 PDT