forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgit-checkout.html
More file actions
754 lines (717 loc) · 20.6 KB
/
git-checkout.html
File metadata and controls
754 lines (717 loc) · 20.6 KB
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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
<!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-checkout(1)</title>
</head>
<body>
<div id="header">
<h1>
git-checkout(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-checkout -
Checkout a branch or paths to the working tree
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git checkout</em> [-q] [-f] [-m] [<branch>]
<em>git checkout</em> [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
<em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>…
<em>git checkout</em> --patch [<tree-ish>] [--] [<paths>…]</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>Updates files in the working tree to match the version in the index
or the specified tree. If no paths are given, <em>git checkout</em> will
also update <tt>HEAD</tt> to set the specified branch as the current
branch.</p></div>
<div class="vlist"><dl>
<dt>
<em>git checkout</em> [<branch>]
</dt>
<dt>
<em>git checkout</em> -b|-B <new_branch> [<start point>]
</dt>
<dd>
<p>
This form switches branches by updating the index, working
tree, and HEAD to reflect the specified branch.
</p>
<div class="para"><p>If <tt>-b</tt> is given, a new branch is created as if <a href="git-branch.html">git-branch(1)</a>
were called and then checked out; in this case you can
use the <tt>--track</tt> or <tt>--no-track</tt> options, which will be passed to
<em>git branch</em>. As a convenience, <tt>--track</tt> without <tt>-b</tt> implies branch
creation; see the description of <tt>--track</tt> below.</p></div>
<div class="para"><p>If <tt>-B</tt> is given, <new_branch> is created if it doesn't exist; otherwise, it
is reset. This is the transactional equivalent of</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git branch -f <branch> [<start point>]
$ git checkout <branch></tt></pre>
</div></div>
<div class="para"><p>that is to say, the branch is not reset/created unless "git checkout" is
successful.</p></div>
</dd>
<dt>
<em>git checkout</em> [--patch] [<tree-ish>] [--] <pathspec>…
</dt>
<dd>
<p>
When <paths> or <tt>--patch</tt> are given, <em>git checkout</em> does <strong>not</strong>
switch branches. It updates the named paths in the working tree
from the index file or from a named <tree-ish> (most often a
commit). In this case, the <tt>-b</tt> and <tt>--track</tt> options are
meaningless and giving either of them results in an error. The
<tree-ish> argument can be used to specify a specific tree-ish
(i.e. commit, tag or tree) to update the index for the given
paths before updating the working tree.
</p>
<div class="para"><p>The index may contain unmerged entries because of a previous failed merge.
By default, if you try to check out such an entry from the index, the
checkout operation will fail and nothing will be checked out.
Using <tt>-f</tt> will ignore these unmerged entries. The contents from a
specific side of the merge can be checked out of the index by
using <tt>--ours</tt> or <tt>--theirs</tt>. With <tt>-m</tt>, changes made to the working tree
file can be discarded to re-create the original conflicted merge result.</p></div>
</dd>
</dl></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
-q
</dt>
<dt>
--quiet
</dt>
<dd>
<p>
Quiet, suppress feedback messages.
</p>
</dd>
<dt>
-f
</dt>
<dt>
--force
</dt>
<dd>
<p>
When switching branches, proceed even if the index or the
working tree differs from HEAD. This is used to throw away
local changes.
</p>
<div class="para"><p>When checking out paths from the index, do not fail upon unmerged
entries; instead, unmerged entries are ignored.</p></div>
</dd>
<dt>
--ours
</dt>
<dt>
--theirs
</dt>
<dd>
<p>
When checking out paths from the index, check out stage #2
(<em>ours</em>) or #3 (<em>theirs</em>) for unmerged paths.
</p>
</dd>
<dt>
-b
</dt>
<dd>
<p>
Create a new branch named <new_branch> and start it at
<start_point>; see <a href="git-branch.html">git-branch(1)</a> for details.
</p>
</dd>
<dt>
-B
</dt>
<dd>
<p>
Creates the branch <new_branch> and start it at <start_point>;
if it already exists, then reset it to <start_point>. This is
equivalent to running "git branch" with "-f"; see
<a href="git-branch.html">git-branch(1)</a> for details.
</p>
</dd>
<dt>
-t
</dt>
<dt>
--track
</dt>
<dd>
<p>
When creating a new branch, set up "upstream" configuration. See
"--track" in <a href="git-branch.html">git-branch(1)</a> for details.
</p>
<div class="para"><p>If no <em>-b</em> option is given, the name of the new branch will be
derived from the remote branch. If "remotes/" or "refs/remotes/"
is prefixed it is stripped away, and then the part up to the
next slash (which would be the nickname of the remote) is removed.
This would tell us to use "hack" as the local branch when branching
off of "origin/hack" (or "remotes/origin/hack", or even
"refs/remotes/origin/hack"). If the given name has no slash, or the above
guessing results in an empty name, the guessing is aborted. You can
explicitly give a name with <em>-b</em> in such a case.</p></div>
</dd>
<dt>
--no-track
</dt>
<dd>
<p>
Do not set up "upstream" configuration, even if the
branch.autosetupmerge configuration variable is true.
</p>
</dd>
<dt>
-l
</dt>
<dd>
<p>
Create the new branch's reflog; see <a href="git-branch.html">git-branch(1)</a> for
details.
</p>
</dd>
<dt>
--orphan
</dt>
<dd>
<p>
Create a new <em>orphan</em> branch, named <new_branch>, started from
<start_point> and switch to it. The first commit made on this
new branch will have no parents and it will be the root of a new
history totally disconnected from all the other branches and
commits.
</p>
<div class="para"><p>The index and the working tree are adjusted as if you had previously run
"git checkout <start_point>". This allows you to start a new history
that records a set of paths similar to <start_point> by easily running
"git commit -a" to make the root commit.</p></div>
<div class="para"><p>This can be useful when you want to publish the tree from a commit
without exposing its full history. You might want to do this to publish
an open source branch of a project whose current tree is "clean", but
whose full history contains proprietary or otherwise encumbered bits of
code.</p></div>
<div class="para"><p>If you want to start a disconnected history that records a set of paths
that is totally different from the one of <start_point>, then you should
clear the index and the working tree right after creating the orphan
branch by running "git rm -rf ." from the top level of the working tree.
Afterwards you will be ready to prepare your new files, repopulating the
working tree, by copying them from elsewhere, extracting a tarball, etc.</p></div>
</dd>
<dt>
-m
</dt>
<dt>
--merge
</dt>
<dd>
<p>
When switching branches,
if you have local modifications to one or more files that
are different between the current branch and the branch to
which you are switching, the command refuses to switch
branches in order to preserve your modifications in context.
However, with this option, a three-way merge between the current
branch, your working tree contents, and the new branch
is done, and you will be on the new branch.
</p>
<div class="para"><p>When a merge conflict happens, the index entries for conflicting
paths are left unmerged, and you need to resolve the conflicts
and mark the resolved paths with <tt>git add</tt> (or <tt>git rm</tt> if the merge
should result in deletion of the path).</p></div>
<div class="para"><p>When checking out paths from the index, this option lets you recreate
the conflicted merge in the specified paths.</p></div>
</dd>
<dt>
--conflict=<style>
</dt>
<dd>
<p>
The same as --merge option above, but changes the way the
conflicting hunks are presented, overriding the
merge.conflictstyle configuration variable. Possible values are
"merge" (default) and "diff3" (in addition to what is shown by
"merge" style, shows the original contents).
</p>
</dd>
<dt>
-p
</dt>
<dt>
--patch
</dt>
<dd>
<p>
Interactively select hunks in the difference between the
<tree-ish> (or the index, if unspecified) and the working
tree. The chosen hunks are then applied in reverse to the
working tree (and if a <tree-ish> was specified, the index).
</p>
<div class="para"><p>This means that you can use <tt>git checkout -p</tt> to selectively discard
edits from your current working tree.</p></div>
</dd>
<dt>
<branch>
</dt>
<dd>
<p>
Branch to checkout; if it refers to a branch (i.e., a name that,
when prepended with "refs/heads/", is a valid ref), then that
branch is checked out. Otherwise, if it refers to a valid
commit, your HEAD becomes "detached" and you are no longer on
any branch (see below for details).
</p>
<div class="para"><p>As a special case, the <tt>"@{-N}"</tt> syntax for the N-th last branch
checks out the branch (instead of detaching). You may also specify
<tt>-</tt> which is synonymous with <tt>"@{-1}"</tt>.</p></div>
<div class="para"><p>As a further special case, you may use <tt>"A...B"</tt> as a shortcut for the
merge base of <tt>A</tt> and <tt>B</tt> if there is exactly one merge base. You can
leave out at most one of <tt>A</tt> and <tt>B</tt>, in which case it defaults to <tt>HEAD</tt>.</p></div>
</dd>
<dt>
<new_branch>
</dt>
<dd>
<p>
Name for the new branch.
</p>
</dd>
<dt>
<start_point>
</dt>
<dd>
<p>
The name of a commit at which to start the new branch; see
<a href="git-branch.html">git-branch(1)</a> for details. Defaults to HEAD.
</p>
</dd>
<dt>
<tree-ish>
</dt>
<dd>
<p>
Tree to checkout from (when paths are given). If not specified,
the index will be used.
</p>
</dd>
</dl></div>
</div>
<h2 id="_detached_head">Detached HEAD</h2>
<div class="sectionbody">
<div class="para"><p>It is sometimes useful to be able to <em>checkout</em> a commit that is
not at the tip of one of your branches. The most obvious
example is to check out the commit at a tagged official release
point, like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout v2.6.18</tt></pre>
</div></div>
<div class="para"><p>Earlier versions of git did not allow this and asked you to
create a temporary branch using the <tt>-b</tt> option, but starting from
version 1.5.0, the above command <em>detaches</em> your HEAD from the
current branch and directly points at the commit named by the tag
(<tt>v2.6.18</tt> in the example above).</p></div>
<div class="para"><p>You can use all git commands while in this state. You can use
<tt>git reset --hard $othercommit</tt> to further move around, for
example. You can make changes and create a new commit on top of
a detached HEAD. You can even create a merge by using <tt>git
merge $othercommit</tt>.</p></div>
<div class="para"><p>The state you are in while your HEAD is detached is not recorded
by any branch (which is natural --- you are not on any branch).
What this means is that you can discard your temporary commits
and merges by switching back to an existing branch (e.g. <tt>git
checkout master</tt>), and a later <tt>git prune</tt> or <tt>git gc</tt> would
garbage-collect them. If you did this by mistake, you can ask
the reflog for HEAD where you were, e.g.</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git log -g -2 HEAD</tt></pre>
</div></div>
</div>
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="olist"><ol>
<li>
<p>
The following sequence checks out the <tt>master</tt> branch, reverts
the <tt>Makefile</tt> to two revisions back, deletes hello.c by
mistake, and gets it back from the index.
</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout master <b>(1)</b>
$ git checkout master~2 Makefile <b>(2)</b>
$ rm -f hello.c
$ git checkout hello.c <b>(3)</b></tt></pre>
</div></div>
<div class="colist"><ol>
<li>
<p>
switch branch
</p>
</li>
<li>
<p>
take a file out of another commit
</p>
</li>
<li>
<p>
restore hello.c from the index
</p>
<div class="para"><p>If you have an unfortunate branch that is named <tt>hello.c</tt>, this
step would be confused as an instruction to switch to that branch.
You should instead write:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout -- hello.c</tt></pre>
</div></div>
</li>
</ol></div>
</li>
<li>
<p>
After working in the wrong branch, switching to the correct
branch would be done using:
</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout mytopic</tt></pre>
</div></div>
<div class="para"><p>However, your "wrong" branch and correct "mytopic" branch may
differ in files that you have modified locally, in which case
the above checkout would fail like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout mytopic
error: You have local changes to 'frotz'; not switching branches.</tt></pre>
</div></div>
<div class="para"><p>You can give the <tt>-m</tt> flag to the command, which would try a
three-way merge:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout -m mytopic
Auto-merging frotz</tt></pre>
</div></div>
<div class="para"><p>After this three-way merge, the local modifications are _not_
registered in your index file, so <tt>git diff</tt> would show you what
changes you made since the tip of the new branch.</p></div>
</li>
<li>
<p>
When a merge conflict happens during switching branches with
the <tt>-m</tt> option, you would see something like this:
</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ git checkout -m mytopic
Auto-merging frotz
ERROR: Merge conflict in frotz
fatal: merge program failed</tt></pre>
</div></div>
<div class="para"><p>At this point, <tt>git diff</tt> shows the changes cleanly merged as in
the previous example, as well as the changes in the conflicted
files. Edit and resolve the conflict and mark it resolved with
<tt>git add</tt> as usual:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ edit frotz
$ git add frotz</tt></pre>
</div></div>
</li>
</ol></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Linus Torvalds <[email protected]></p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by Junio C Hamano and the git-list <[email protected]>.</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 2010-09-28 05:49:36 UTC
</div>
</div>
</body>
</html>