Google Git
Sign in
chromium / external / gitster / git-htmldocs / cae8627f672d77bd3e7a2edf5afa22aa3e5821ce / . / git-checkout.html
blob: 9a3729b479e2a0e3768cc1c9687144a71261bccc [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]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" />
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-checkout(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-checkout(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-checkout -
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]269 Checkout and switch to a branch
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]275<div class="verseblock">
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]276<div class="content"><em>git-checkout</em> [-q] [-f] [[--track | --no-track] -b &lt;new_branch&gt; [-l]] [-m] [&lt;branch&gt;]
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame]277<em>git-checkout</em> [&lt;tree-ish&gt;] &lt;paths&gt;&#8230;</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]278</div>
279<h2>DESCRIPTION</h2>
280<div class="sectionbody">
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]281<p>When &lt;paths&gt; are not given, this command switches branches by
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]282updating the index and working tree to reflect the specified
283branch, &lt;branch&gt;, and updating HEAD to be &lt;branch&gt; or, if
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]284specified, &lt;new_branch&gt;. Using -b will cause &lt;new_branch&gt; to
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]285be created; in this case you can use the --track or --no-track
286options, which will be passed to <tt>git branch</tt>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]287<p>When &lt;paths&gt; are given, this command does <strong>not</strong> switch
288branches. It updates the named paths in the working tree from
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]289the index file (i.e. it runs <tt>git-checkout-index -f -u</tt>), or
290from a named commit. In
291this case, the <tt>-f</tt> and <tt>-b</tt> options are meaningless and giving
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame]292either of them results in an error. &lt;tree-ish&gt; argument can be
293used to specify a specific tree-ish (i.e. commit, tag or tree)
294to update the index for the given paths before updating the
295working tree.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296</div>
297<h2>OPTIONS</h2>
298<div class="sectionbody">
299<dl>
300<dt>
Junio C Hamano39381a72007-02-02 07:35:15[diff] [blame]301-q
302</dt>
303<dd>
304<p>
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame^]305 Quiet, suppress feedback messages.
Junio C Hamano39381a72007-02-02 07:35:15[diff] [blame]306</p>
307</dd>
308<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]309-f
310</dt>
311<dd>
312<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]313 Proceed even if the index or the working tree differs
314 from HEAD. This is used to throw away local changes.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]315</p>
316</dd>
317<dt>
318-b
319</dt>
320<dd>
321<p>
Junio C Hamanob2f5edd2006-05-21 10:50:09[diff] [blame]322 Create a new branch named &lt;new_branch&gt; and start it at
323 &lt;branch&gt;. The new branch name must pass all checks defined
324 by <a href="git-check-ref-format.html">git-check-ref-format(1)</a>. Some of these checks
325 may restrict the characters allowed in a branch name.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]326</p>
327</dd>
328<dt>
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]329--track
330</dt>
331<dd>
332<p>
333 When -b is given and a branch is created off a remote branch,
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]334 set up configuration so that git-pull will automatically
335 retrieve data from the remote branch. Set the
336 branch.autosetupmerge configuration variable to true if you
Junio C Hamano9cb39172007-07-12 06:45:37[diff] [blame]337 want git-checkout and git-branch to always behave as if
338 <em>--track</em> were given.
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]339</p>
340</dd>
341<dt>
342--no-track
343</dt>
344<dd>
345<p>
346 When -b is given and a branch is created off a remote branch,
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]347 set up configuration so that git-pull will not retrieve data
348 from the remote branch, ignoring the branch.autosetupmerge
349 configuration variable.
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]350</p>
351</dd>
352<dt>
Junio C Hamano341071d2006-06-04 07:24:48[diff] [blame]353-l
354</dt>
355<dd>
356<p>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]357 Create the new branch's reflog. This activates recording of
358 all changes made to the branch ref, enabling use of date
359 based sha1 expressions such as "&lt;branchname&gt;@{yesterday}".
Junio C Hamano341071d2006-06-04 07:24:48[diff] [blame]360</p>
361</dd>
362<dt>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]363-m
364</dt>
365<dd>
366<p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]367 If you have local modifications to one or more files that
368 are different between the current branch and the branch to
369 which you are switching, the command refuses to switch
370 branches in order to preserve your modifications in context.
371 However, with this option, a three-way merge between the current
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]372 branch, your working tree contents, and the new branch
373 is done, and you will be on the new branch.
374</p>
375<p>When a merge conflict happens, the index entries for conflicting
376paths are left unmerged, and you need to resolve the conflicts
Junio C Hamano89d4e0f2007-02-18 00:34:59[diff] [blame]377and mark the resolved paths with <tt>git add</tt> (or <tt>git rm</tt> if the merge
378should result in deletion of the path).</p>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]379</dd>
380<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]381&lt;new_branch&gt;
382</dt>
383<dd>
384<p>
385 Name for the new branch.
386</p>
387</dd>
388<dt>
389&lt;branch&gt;
390</dt>
391<dd>
392<p>
393 Branch to checkout; may be any object ID that resolves to a
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]394 commit. Defaults to HEAD.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]395</p>
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]396<p>When this parameter names a non-branch (but still a valid commit object),
397your HEAD becomes <em>detached</em>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]398</dd>
399</dl>
400</div>
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]401<h2>Detached HEAD</h2>
402<div class="sectionbody">
403<p>It is sometimes useful to be able to <em>checkout</em> a commit that is
404not at the tip of one of your branches. The most obvious
405example is to check out the commit at a tagged official release
406point, like this:</p>
407<div class="listingblock">
408<div class="content">
409<pre><tt>$ git checkout v2.6.18</tt></pre>
410</div></div>
411<p>Earlier versions of git did not allow this and asked you to
412create a temporary branch using <tt>-b</tt> option, but starting from
413version 1.5.0, the above command <em>detaches</em> your HEAD from the
414current branch and directly point at the commit named by the tag
415(<tt>v2.6.18</tt> in the above example).</p>
416<p>You can use usual git commands while in this state. You can use
417<tt>git-reset --hard $othercommit</tt> to further move around, for
418example. You can make changes and create a new commit on top of
419a detached HEAD. You can even create a merge by using <tt>git
420merge $othercommit</tt>.</p>
421<p>The state you are in while your HEAD is detached is not recorded
422by any branch (which is natural --- you are not on any branch).
423What this means is that you can discard your temporary commits
424and merges by switching back to an existing branch (e.g. <tt>git
425checkout master</tt>), and a later <tt>git prune</tt> or <tt>git gc</tt> would
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]426garbage-collect them. If you did this by mistake, you can ask
427the reflog for HEAD where you were, e.g.</p>
428<div class="listingblock">
429<div class="content">
430<pre><tt>$ git log -g -2 HEAD</tt></pre>
431</div></div>
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]432</div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]433<h2>EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]434<div class="sectionbody">
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]435<ol>
436<li>
437<p>
438The following sequence checks out the <tt>master</tt> branch, reverts
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]439the <tt>Makefile</tt> to two revisions back, deletes hello.c by
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]440mistake, and gets it back from the index.
441</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]442<div class="listingblock">
443<div class="content">
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]444<pre><tt>$ git checkout master <b>(1)</b>
445$ git checkout master~2 Makefile <b>(2)</b>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]446$ rm -f hello.c
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]447$ git checkout hello.c <b>(3)</b></tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]448</div></div>
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]449<ol>
450<li>
451<p>
452switch branch
453</p>
454</li>
455<li>
456<p>
457take out a file out of other commit
458</p>
459</li>
460<li>
461<p>
462restore hello.c from HEAD of current branch
463</p>
464<p>If you have an unfortunate branch that is named <tt>hello.c</tt>, this
465step would be confused as an instruction to switch to that branch.
466You should instead write:</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]467<div class="listingblock">
468<div class="content">
469<pre><tt>$ git checkout -- hello.c</tt></pre>
470</div></div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]471</li>
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]472</ol>
473</li>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]474<li>
475<p>
476After working in a wrong branch, switching to the correct
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]477branch would be done using:
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]478</p>
479<div class="listingblock">
480<div class="content">
481<pre><tt>$ git checkout mytopic</tt></pre>
482</div></div>
483<p>However, your "wrong" branch and correct "mytopic" branch may
484differ in files that you have locally modified, in which case,
485the above checkout would fail like this:</p>
486<div class="listingblock">
487<div class="content">
488<pre><tt>$ git checkout mytopic
489fatal: Entry 'frotz' not uptodate. Cannot merge.</tt></pre>
490</div></div>
491<p>You can give the <tt>-m</tt> flag to the command, which would try a
492three-way merge:</p>
493<div class="listingblock">
494<div class="content">
495<pre><tt>$ git checkout -m mytopic
496Auto-merging frotz</tt></pre>
497</div></div>
498<p>After this three-way merge, the local modifications are _not_
499registered in your index file, so <tt>git diff</tt> would show you what
500changes you made since the tip of the new branch.</p>
501</li>
502<li>
503<p>
504When a merge conflict happens during switching branches with
505the <tt>-m</tt> option, you would see something like this:
506</p>
507<div class="listingblock">
508<div class="content">
509<pre><tt>$ git checkout -m mytopic
510Auto-merging frotz
511merge: warning: conflicts during merge
512ERROR: Merge conflict in frotz
513fatal: merge program failed</tt></pre>
514</div></div>
515<p>At this point, <tt>git diff</tt> shows the changes cleanly merged as in
516the previous example, as well as the changes in the conflicted
517files. Edit and resolve the conflict and mark it resolved with
Junio C Hamano89d4e0f2007-02-18 00:34:59[diff] [blame]518<tt>git add</tt> as usual:</p>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]519<div class="listingblock">
520<div class="content">
521<pre><tt>$ edit frotz
Junio C Hamano89d4e0f2007-02-18 00:34:59[diff] [blame]522$ git add frotz</tt></pre>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]523</div></div>
524</li>
525</ol>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]526</div>
527<h2>Author</h2>
528<div class="sectionbody">
529<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
530</div>
531<h2>Documentation</h2>
532<div class="sectionbody">
533<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
534</div>
535<h2>GIT</h2>
536<div class="sectionbody">
537<p>Part of the <a href="git.html">git(7)</a> suite</p>
538</div>
539<div id="footer">
540<div id="footer-text">
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame^]541Last updated 21-Aug-2007 02:20:17 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]542</div>
543</div>
544</body>
545</html>