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.2.5" />
7 <style type=
"text/css">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-stash(
1)
</title>
312 git-stash(
1) Manual Page
315 <div class=
"sectionbody">
317 Stash the changes in a dirty working directory away
322 <div class=
"sectionbody">
323 <div class=
"verseblock">
324 <div class=
"content"><em>git stash
</em> list [
<options
>]
325 <em>git stash
</em> ( show | drop ) [
<stash
>]
326 <em>git stash
</em> ( pop | apply ) [--index] [
<stash
>]
327 <em>git stash
</em> branch
<branchname
> [
<stash
>]
328 <em>git stash
</em> [save [--keep-index] [
<message
>]]
329 <em>git stash
</em> clear
330 <em>git stash
</em> create
</div></div>
332 <h2 id=
"_description">DESCRIPTION
</h2>
333 <div class=
"sectionbody">
334 <div class=
"para"><p>Use
<em>git stash
</em> when you want to record the current state of the
335 working directory and the index, but want to go back to a clean
336 working directory. The command saves your local modifications away
337 and reverts the working directory to match the
<tt>HEAD
</tt> commit.
</p></div>
338 <div class=
"para"><p>The modifications stashed away by this command can be listed with
339 <tt>git stash list
</tt>, inspected with
<tt>git stash show
</tt>, and restored
340 (potentially on top of a different commit) with
<tt>git stash apply
</tt>.
341 Calling
<tt>git stash
</tt> without any arguments is equivalent to
<tt>git stash save
</tt>.
342 A stash is by default listed as
"WIP on <em>branchname</em> …", but
343 you can give a more descriptive message on the command line when
344 you create one.
</p></div>
345 <div class=
"para"><p>The latest stash you created is stored in
<tt>$GIT_DIR/refs/stash
</tt>; older
346 stashes are found in the reflog of this reference and can be named using
347 the usual reflog syntax (e.g.
<tt>stash@{
0}
</tt> is the most recently
348 created stash,
<tt>stash@{
1}
</tt> is the one before it,
<tt>stash@{
2.hours.ago}
</tt>
349 is also possible).
</p></div>
351 <h2 id=
"_options">OPTIONS
</h2>
352 <div class=
"sectionbody">
353 <div class=
"vlist"><dl>
355 save [--keep-index] [
<message
>]
359 Save your local modifications to a new
<em>stash
</em>, and run
<tt>git reset
360 --hard
</tt> to revert them. This is the default action when no
361 subcommand is given. The
<message
> part is optional and gives
362 the description along with the stashed state.
364 <div class=
"para"><p>If the
<tt>--keep-index
</tt> option is used, all changes already added to the
365 index are left intact.
</p></div>
368 list [
<options
>]
372 List the stashes that you currently have. Each
<em>stash
</em> is listed
373 with its name (e.g.
<tt>stash@{
0}
</tt> is the latest stash,
<tt>stash@{
1}
</tt> is
374 the one before, etc.), the name of the branch that was current when the
375 stash was made, and a short description of the commit the stash was
378 <div class=
"listingblock">
379 <div class=
"content">
380 <pre><tt>stash@{
0}: WIP on submit:
6ebd0e2... Update git-stash documentation
381 stash@{
1}: On master:
9cc0589... Add git-stash
</tt></pre>
383 <div class=
"para"><p>The command takes options applicable to the
<em>git-log
</em>
384 command to control what is shown and how. See
<a href=
"git-log.html">git-log(
1)
</a>.
</p></div>
391 Show the changes recorded in the stash as a diff between the
392 stashed state and its original parent. When no
<tt><stash
></tt> is given,
393 shows the latest one. By default, the command shows the diffstat, but
394 it will accept any format known to
<em>git-diff
</em> (e.g.,
<tt>git stash show
395 -p stash@{
1}
</tt> to view the second most recent stash in patch form).
403 Remove a single stashed state from the stash list and apply it
404 on top of the current working tree state, i.e., do the inverse
405 operation of
<tt>git stash save
</tt>. The working directory must
408 <div class=
"para"><p>Applying the state can fail with conflicts; in this case, it is not
409 removed from the stash list. You need to resolve the conflicts by hand
410 and call
<tt>git stash drop
</tt> manually afterwards.
</p></div>
411 <div class=
"para"><p>If the
<tt>--index
</tt> option is used, then tries to reinstate not only the working
412 tree's changes, but also the index's ones. However, this can fail, when you
413 have conflicts (which are stored in the index, where you therefore can no
414 longer apply the changes as they were originally).
</p></div>
415 <div class=
"para"><p>When no
<tt><stash
></tt> is given,
<tt>stash@{
0}
</tt> is assumed.
</p></div>
418 apply [--index] [
<stash
>]
422 Like
<tt>pop
</tt>, but do not remove the state from the stash list.
426 branch
<branchname
> [
<stash
>]
430 Creates and checks out a new branch named
<tt><branchname
></tt> starting from
431 the commit at which the
<tt><stash
></tt> was originally created, applies the
432 changes recorded in
<tt><stash
></tt> to the new working tree and index, then
433 drops the
<tt><stash
></tt> if that completes successfully. When no
<tt><stash
></tt>
434 is given, applies the latest one.
436 <div class=
"para"><p>This is useful if the branch on which you ran
<tt>git stash save
</tt> has
437 changed enough that
<tt>git stash apply
</tt> fails due to conflicts. Since
438 the stash is applied on top of the commit that was HEAD at the time
439 <tt>git stash
</tt> was run, it restores the originally stashed state with
440 no conflicts.
</p></div>
447 Remove all the stashed states. Note that those states will then
448 be subject to pruning, and may be difficult or impossible to recover.
456 Remove a single stashed state from the stash list. When no
<tt><stash
></tt>
457 is given, it removes the latest one. i.e.
<tt>stash@{
0}
</tt>
465 Create a stash (which is a regular commit object) and return its
466 object name, without storing it anywhere in the ref namespace.
471 <h2 id=
"_discussion">DISCUSSION
</h2>
472 <div class=
"sectionbody">
473 <div class=
"para"><p>A stash is represented as a commit whose tree records the state of the
474 working directory, and its first parent is the commit at
<tt>HEAD
</tt> when
475 the stash was created. The tree of the second parent records the
476 state of the index when the stash is made, and it is made a child of
477 the
<tt>HEAD
</tt> commit. The ancestry graph looks like this:
</p></div>
478 <div class=
"literalblock">
479 <div class=
"content">
482 -----H----I
</tt></pre>
484 <div class=
"para"><p>where
<tt>H
</tt> is the
<tt>HEAD
</tt> commit,
<tt>I
</tt> is a commit that records the state
485 of the index, and
<tt>W
</tt> is a commit that records the state of the working
488 <h2 id=
"_examples">EXAMPLES
</h2>
489 <div class=
"sectionbody">
490 <div class=
"vlist"><dl>
492 Pulling into a dirty tree
496 When you are in the middle of something, you learn that there are
497 upstream changes that are possibly relevant to what you are
498 doing. When your local changes do not conflict with the changes in
499 the upstream, a simple
<tt>git pull
</tt> will let you move forward.
501 <div class=
"para"><p>However, there are cases in which your local changes do conflict with
502 the upstream changes, and
<tt>git pull
</tt> refuses to overwrite your
503 changes. In such a case, you can stash your changes away,
504 perform a pull, and then unstash, like this:
</p></div>
505 <div class=
"listingblock">
506 <div class=
"content">
509 file foobar not up to date, cannot merge.
512 $ git stash pop
</tt></pre>
520 When you are in the middle of something, your boss comes in and
521 demands that you fix something immediately. Traditionally, you would
522 make a commit to a temporary branch to store your changes away, and
523 return to your original branch to make the emergency fix, like this:
525 <div class=
"listingblock">
526 <div class=
"content">
527 <pre><tt># ... hack hack hack ...
528 $ git checkout -b my_wip
529 $ git commit -a -m
"WIP"
530 $ git checkout master
532 $ git commit -a -m
"Fix in a hurry"
533 $ git checkout my_wip
534 $ git reset --soft HEAD^
535 # ... continue hacking ...
</tt></pre>
537 <div class=
"para"><p>You can use
<em>git-stash
</em> to simplify the above, like this:
</p></div>
538 <div class=
"listingblock">
539 <div class=
"content">
540 <pre><tt># ... hack hack hack ...
543 $ git commit -a -m
"Fix in a hurry"
545 # ... continue hacking ...
</tt></pre>
549 Testing partial commits
553 You can use
<tt>git stash save --keep-index
</tt> when you want to make two or
554 more commits out of the changes in the work tree, and you want to test
555 each change before committing:
557 <div class=
"listingblock">
558 <div class=
"content">
559 <pre><tt># ... hack hack hack ...
560 $ git add --patch foo # add just first part to the index
561 $ git stash save --keep-index # save all other changes to the stash
562 $ edit/build/test first part
563 $ git commit -m 'First part' # commit fully tested change
564 $ git stash pop # prepare to work on all other changes
565 # ... repeat above five steps until one commit remains ...
566 $ edit/build/test remaining parts
567 $ git commit foo -m 'Remaining parts'
</tt></pre>
572 <h2 id=
"_see_also">SEE ALSO
</h2>
573 <div class=
"sectionbody">
574 <div class=
"para"><p><a href=
"git-checkout.html">git-checkout(
1)
</a>,
575 <a href=
"git-commit.html">git-commit(
1)
</a>,
576 <a href=
"git-reflog.html">git-reflog(
1)
</a>,
577 <a href=
"git-reset.html">git-reset(
1)
</a></p></div>
579 <h2 id=
"_author">AUTHOR
</h2>
580 <div class=
"sectionbody">
581 <div class=
"para"><p>Written by Nanako Shiraishi
<nanako3@bluebottle.com
></p></div>
583 <h2 id=
"_git">GIT
</h2>
584 <div class=
"sectionbody">
585 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
588 <div id=
"footer-text">
589 Last updated
2009-
07-
01 02:
31:
04 UTC