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