Autogenerated HTML docs for v1.6.4-rc1
[git/jnareb-git.git] / git-stash.html
blob240f088d3c678aa8a65ed2b3d6edf5b46c810680
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">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-stash(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-stash(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-stash -
317 Stash the changes in a dirty working directory away
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="verseblock">
324 <div class="content"><em>git stash</em> list [&lt;options&gt;]
325 <em>git stash</em> show [&lt;stash&gt;]
326 <em>git stash</em> drop [-q|--quiet] [&lt;stash&gt;]
327 <em>git stash</em> ( pop | apply ) [--index] [-q|--quiet] [&lt;stash&gt;]
328 <em>git stash</em> branch &lt;branchname&gt; [&lt;stash&gt;]
329 <em>git stash</em> [save [--keep-index] [-q|--quiet] [&lt;message&gt;]]
330 <em>git stash</em> clear
331 <em>git stash</em> create</div></div>
332 </div>
333 <h2 id="_description">DESCRIPTION</h2>
334 <div class="sectionbody">
335 <div class="para"><p>Use <em>git stash</em> when you want to record the current state of the
336 working directory and the index, but want to go back to a clean
337 working directory. The command saves your local modifications away
338 and reverts the working directory to match the <tt>HEAD</tt> commit.</p></div>
339 <div class="para"><p>The modifications stashed away by this command can be listed with
340 <tt>git stash list</tt>, inspected with <tt>git stash show</tt>, and restored
341 (potentially on top of a different commit) with <tt>git stash apply</tt>.
342 Calling <tt>git stash</tt> without any arguments is equivalent to <tt>git stash save</tt>.
343 A stash is by default listed as "WIP on <em>branchname</em> &#8230;", but
344 you can give a more descriptive message on the command line when
345 you create one.</p></div>
346 <div class="para"><p>The latest stash you created is stored in <tt>$GIT_DIR/refs/stash</tt>; older
347 stashes are found in the reflog of this reference and can be named using
348 the usual reflog syntax (e.g. <tt>stash@{0}</tt> is the most recently
349 created stash, <tt>stash@{1}</tt> is the one before it, <tt>stash@{2.hours.ago}</tt>
350 is also possible).</p></div>
351 </div>
352 <h2 id="_options">OPTIONS</h2>
353 <div class="sectionbody">
354 <div class="vlist"><dl>
355 <dt>
356 save [--keep-index] [-q|--quiet] [&lt;message&gt;]
357 </dt>
358 <dd>
360 Save your local modifications to a new <em>stash</em>, and run <tt>git reset
361 --hard</tt> to revert them. This is the default action when no
362 subcommand is given. The &lt;message&gt; part is optional and gives
363 the description along with the stashed state.
364 </p>
365 <div class="para"><p>If the <tt>--keep-index</tt> option is used, all changes already added to the
366 index are left intact.</p></div>
367 </dd>
368 <dt>
369 list [&lt;options&gt;]
370 </dt>
371 <dd>
373 List the stashes that you currently have. Each <em>stash</em> is listed
374 with its name (e.g. <tt>stash@{0}</tt> is the latest stash, <tt>stash@{1}</tt> is
375 the one before, etc.), the name of the branch that was current when the
376 stash was made, and a short description of the commit the stash was
377 based on.
378 </p>
379 <div class="listingblock">
380 <div class="content">
381 <pre><tt>stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
382 stash@{1}: On master: 9cc0589... Add git-stash</tt></pre>
383 </div></div>
384 <div class="para"><p>The command takes options applicable to the <em>git-log</em>
385 command to control what is shown and how. See <a href="git-log.html">git-log(1)</a>.</p></div>
386 </dd>
387 <dt>
388 show [&lt;stash&gt;]
389 </dt>
390 <dd>
392 Show the changes recorded in the stash as a diff between the
393 stashed state and its original parent. When no <tt>&lt;stash&gt;</tt> is given,
394 shows the latest one. By default, the command shows the diffstat, but
395 it will accept any format known to <em>git-diff</em> (e.g., <tt>git stash show
396 -p stash@{1}</tt> to view the second most recent stash in patch form).
397 </p>
398 </dd>
399 <dt>
400 pop [--index] [-q|--quiet] [&lt;stash&gt;]
401 </dt>
402 <dd>
404 Remove a single stashed state from the stash list and apply it
405 on top of the current working tree state, i.e., do the inverse
406 operation of <tt>git stash save</tt>. The working directory must
407 match the index.
408 </p>
409 <div class="para"><p>Applying the state can fail with conflicts; in this case, it is not
410 removed from the stash list. You need to resolve the conflicts by hand
411 and call <tt>git stash drop</tt> manually afterwards.</p></div>
412 <div class="para"><p>If the <tt>--index</tt> option is used, then tries to reinstate not only the working
413 tree's changes, but also the index's ones. However, this can fail, when you
414 have conflicts (which are stored in the index, where you therefore can no
415 longer apply the changes as they were originally).</p></div>
416 <div class="para"><p>When no <tt>&lt;stash&gt;</tt> is given, <tt>stash@{0}</tt> is assumed.</p></div>
417 </dd>
418 <dt>
419 apply [--index] [-q|--quiet] [&lt;stash&gt;]
420 </dt>
421 <dd>
423 Like <tt>pop</tt>, but do not remove the state from the stash list.
424 </p>
425 </dd>
426 <dt>
427 branch &lt;branchname&gt; [&lt;stash&gt;]
428 </dt>
429 <dd>
431 Creates and checks out a new branch named <tt>&lt;branchname&gt;</tt> starting from
432 the commit at which the <tt>&lt;stash&gt;</tt> was originally created, applies the
433 changes recorded in <tt>&lt;stash&gt;</tt> to the new working tree and index, then
434 drops the <tt>&lt;stash&gt;</tt> if that completes successfully. When no <tt>&lt;stash&gt;</tt>
435 is given, applies the latest one.
436 </p>
437 <div class="para"><p>This is useful if the branch on which you ran <tt>git stash save</tt> has
438 changed enough that <tt>git stash apply</tt> fails due to conflicts. Since
439 the stash is applied on top of the commit that was HEAD at the time
440 <tt>git stash</tt> was run, it restores the originally stashed state with
441 no conflicts.</p></div>
442 </dd>
443 <dt>
444 clear
445 </dt>
446 <dd>
448 Remove all the stashed states. Note that those states will then
449 be subject to pruning, and may be difficult or impossible to recover.
450 </p>
451 </dd>
452 <dt>
453 drop [-q|--quiet] [&lt;stash&gt;]
454 </dt>
455 <dd>
457 Remove a single stashed state from the stash list. When no <tt>&lt;stash&gt;</tt>
458 is given, it removes the latest one. i.e. <tt>stash@{0}</tt>
459 </p>
460 </dd>
461 <dt>
462 create
463 </dt>
464 <dd>
466 Create a stash (which is a regular commit object) and return its
467 object name, without storing it anywhere in the ref namespace.
468 </p>
469 </dd>
470 </dl></div>
471 </div>
472 <h2 id="_discussion">DISCUSSION</h2>
473 <div class="sectionbody">
474 <div class="para"><p>A stash is represented as a commit whose tree records the state of the
475 working directory, and its first parent is the commit at <tt>HEAD</tt> when
476 the stash was created. The tree of the second parent records the
477 state of the index when the stash is made, and it is made a child of
478 the <tt>HEAD</tt> commit. The ancestry graph looks like this:</p></div>
479 <div class="literalblock">
480 <div class="content">
481 <pre><tt> .----W
483 -----H----I</tt></pre>
484 </div></div>
485 <div class="para"><p>where <tt>H</tt> is the <tt>HEAD</tt> commit, <tt>I</tt> is a commit that records the state
486 of the index, and <tt>W</tt> is a commit that records the state of the working
487 tree.</p></div>
488 </div>
489 <h2 id="_examples">EXAMPLES</h2>
490 <div class="sectionbody">
491 <div class="vlist"><dl>
492 <dt>
493 Pulling into a dirty tree
494 </dt>
495 <dd>
497 When you are in the middle of something, you learn that there are
498 upstream changes that are possibly relevant to what you are
499 doing. When your local changes do not conflict with the changes in
500 the upstream, a simple <tt>git pull</tt> will let you move forward.
501 </p>
502 <div class="para"><p>However, there are cases in which your local changes do conflict with
503 the upstream changes, and <tt>git pull</tt> refuses to overwrite your
504 changes. In such a case, you can stash your changes away,
505 perform a pull, and then unstash, like this:</p></div>
506 <div class="listingblock">
507 <div class="content">
508 <pre><tt>$ git pull
510 file foobar not up to date, cannot merge.
511 $ git stash
512 $ git pull
513 $ git stash pop</tt></pre>
514 </div></div>
515 </dd>
516 <dt>
517 Interrupted workflow
518 </dt>
519 <dd>
521 When you are in the middle of something, your boss comes in and
522 demands that you fix something immediately. Traditionally, you would
523 make a commit to a temporary branch to store your changes away, and
524 return to your original branch to make the emergency fix, like this:
525 </p>
526 <div class="listingblock">
527 <div class="content">
528 <pre><tt># ... hack hack hack ...
529 $ git checkout -b my_wip
530 $ git commit -a -m "WIP"
531 $ git checkout master
532 $ edit emergency fix
533 $ git commit -a -m "Fix in a hurry"
534 $ git checkout my_wip
535 $ git reset --soft HEAD^
536 # ... continue hacking ...</tt></pre>
537 </div></div>
538 <div class="para"><p>You can use <em>git-stash</em> to simplify the above, like this:</p></div>
539 <div class="listingblock">
540 <div class="content">
541 <pre><tt># ... hack hack hack ...
542 $ git stash
543 $ edit emergency fix
544 $ git commit -a -m "Fix in a hurry"
545 $ git stash pop
546 # ... continue hacking ...</tt></pre>
547 </div></div>
548 </dd>
549 <dt>
550 Testing partial commits
551 </dt>
552 <dd>
554 You can use <tt>git stash save --keep-index</tt> when you want to make two or
555 more commits out of the changes in the work tree, and you want to test
556 each change before committing:
557 </p>
558 <div class="listingblock">
559 <div class="content">
560 <pre><tt># ... hack hack hack ...
561 $ git add --patch foo # add just first part to the index
562 $ git stash save --keep-index # save all other changes to the stash
563 $ edit/build/test first part
564 $ git commit -m 'First part' # commit fully tested change
565 $ git stash pop # prepare to work on all other changes
566 # ... repeat above five steps until one commit remains ...
567 $ edit/build/test remaining parts
568 $ git commit foo -m 'Remaining parts'</tt></pre>
569 </div></div>
570 </dd>
571 </dl></div>
572 </div>
573 <h2 id="_see_also">SEE ALSO</h2>
574 <div class="sectionbody">
575 <div class="para"><p><a href="git-checkout.html">git-checkout(1)</a>,
576 <a href="git-commit.html">git-commit(1)</a>,
577 <a href="git-reflog.html">git-reflog(1)</a>,
578 <a href="git-reset.html">git-reset(1)</a></p></div>
579 </div>
580 <h2 id="_author">AUTHOR</h2>
581 <div class="sectionbody">
582 <div class="para"><p>Written by Nanako Shiraishi &lt;nanako3@bluebottle.com&gt;</p></div>
583 </div>
584 <h2 id="_git">GIT</h2>
585 <div class="sectionbody">
586 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
587 </div>
588 <div id="footer">
589 <div id="footer-text">
590 Last updated 2009-07-02 03:16:40 UTC
591 </div>
592 </div>
593 </body>
594 </html>