Google Git
Sign in
chromium / external / gitster / git-htmldocs / 8f62db9398f1b5c51907cea20d4b51cb0cd391d3 / . / git-checkout.html
blob: 7b7053008b8a547b00d4a7a0a300aca7a1d847f2 [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 Hamano341071d2006-06-04 07:24:48[diff] [blame]276<div class="content"><em>git-checkout</em> [-f] [-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
285be created.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]286<p>When &lt;paths&gt; are given, this command does <strong>not</strong> switch
287branches. It updates the named paths in the working tree from
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame^]288the index file (i.e. it runs <tt>git-checkout-index -f -u</tt>), or a
289named commit. In
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290this case, <tt>-f</tt> and <tt>-b</tt> options are meaningless and giving
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame^]291either of them results in an error. &lt;tree-ish&gt; argument can be
292used to specify a specific tree-ish (i.e. commit, tag or tree)
293to update the index for the given paths before updating the
294working tree.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]295</div>
296<h2>OPTIONS</h2>
297<div class="sectionbody">
298<dl>
299<dt>
300-f
301</dt>
302<dd>
303<p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]304 Force a re-read of everything.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]305</p>
306</dd>
307<dt>
308-b
309</dt>
310<dd>
311<p>
Junio C Hamanob2f5edd2006-05-21 10:50:09[diff] [blame]312 Create a new branch named &lt;new_branch&gt; and start it at
313 &lt;branch&gt;. The new branch name must pass all checks defined
314 by <a href="git-check-ref-format.html">git-check-ref-format(1)</a>. Some of these checks
315 may restrict the characters allowed in a branch name.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]316</p>
317</dd>
318<dt>
Junio C Hamano341071d2006-06-04 07:24:48[diff] [blame]319-l
320</dt>
321<dd>
322<p>
323 Create the new branch's ref log. This activates recording of
324 all changes to made the branch ref, enabling use of date
325</p>
326</dd>
327<dt>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]328-m
329</dt>
330<dd>
331<p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]332 If you have local modifications to one or more files that
333 are different between the current branch and the branch to
334 which you are switching, the command refuses to switch
335 branches in order to preserve your modifications in context.
336 However, with this option, a three-way merge between the current
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]337 branch, your working tree contents, and the new branch
338 is done, and you will be on the new branch.
339</p>
340<p>When a merge conflict happens, the index entries for conflicting
341paths are left unmerged, and you need to resolve the conflicts
342and mark the resolved paths with <tt>git update-index</tt>.</p>
343</dd>
344<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]345&lt;new_branch&gt;
346</dt>
347<dd>
348<p>
349 Name for the new branch.
350</p>
351</dd>
352<dt>
353&lt;branch&gt;
354</dt>
355<dd>
356<p>
357 Branch to checkout; may be any object ID that resolves to a
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]358 commit. Defaults to HEAD.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]359</p>
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]360<p>When this parameter names a non-branch (but still a valid commit object),
361your HEAD becomes <em>detached</em>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]362</dd>
363</dl>
364</div>
Junio C Hamano4f9a6052007-01-17 20:25:16[diff] [blame]365<h2>Detached HEAD</h2>
366<div class="sectionbody">
367<p>It is sometimes useful to be able to <em>checkout</em> a commit that is
368not at the tip of one of your branches. The most obvious
369example is to check out the commit at a tagged official release
370point, like this:</p>
371<div class="listingblock">
372<div class="content">
373<pre><tt>$ git checkout v2.6.18</tt></pre>
374</div></div>
375<p>Earlier versions of git did not allow this and asked you to
376create a temporary branch using <tt>-b</tt> option, but starting from
377version 1.5.0, the above command <em>detaches</em> your HEAD from the
378current branch and directly point at the commit named by the tag
379(<tt>v2.6.18</tt> in the above example).</p>
380<p>You can use usual git commands while in this state. You can use
381<tt>git-reset --hard $othercommit</tt> to further move around, for
382example. You can make changes and create a new commit on top of
383a detached HEAD. You can even create a merge by using <tt>git
384merge $othercommit</tt>.</p>
385<p>The state you are in while your HEAD is detached is not recorded
386by any branch (which is natural --- you are not on any branch).
387What this means is that you can discard your temporary commits
388and merges by switching back to an existing branch (e.g. <tt>git
389checkout master</tt>), and a later <tt>git prune</tt> or <tt>git gc</tt> would
390garbage-collect them.</p>
391<p>The command would refuse to switch back to make sure that you do
392not discard your temporary state by mistake when your detached
393HEAD is not pointed at by any existing ref. If you did want to
394save your state (e.g. "I was interested in the fifth commit from
395the top of <em>master</em> branch", or "I made two commits to fix minor
396bugs while on a detached HEAD" &#8212; and if you do not want to lose
397these facts), you can create a new branch and switch to it with
398<tt>git checkout -b newbranch</tt> so that you can keep building on
399that state, or tag it first so that you can come back to it
400later and switch to the branch you wanted to switch to with <tt>git
401tag that_state; git checkout master</tt>. On the other hand, if you
402did want to discard the temporary state, you can give <tt>-f</tt>
403option (e.g. <tt>git checkout -f master</tt>) to override this
404behaviour.</p>
405</div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]406<h2>EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]407<div class="sectionbody">
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]408<ol>
409<li>
410<p>
411The following sequence checks out the <tt>master</tt> branch, reverts
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]412the <tt>Makefile</tt> to two revisions back, deletes hello.c by
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]413mistake, and gets it back from the index.
414</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]415<div class="listingblock">
416<div class="content">
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]417<pre><tt>$ git checkout master <b>(1)</b>
418$ git checkout master~2 Makefile <b>(2)</b>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]419$ rm -f hello.c
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]420$ git checkout hello.c <b>(3)</b></tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]421</div></div>
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]422<ol>
423<li>
424<p>
425switch branch
426</p>
427</li>
428<li>
429<p>
430take out a file out of other commit
431</p>
432</li>
433<li>
434<p>
435restore hello.c from HEAD of current branch
436</p>
437<p>If you have an unfortunate branch that is named <tt>hello.c</tt>, this
438step would be confused as an instruction to switch to that branch.
439You should instead write:</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]440<div class="listingblock">
441<div class="content">
442<pre><tt>$ git checkout -- hello.c</tt></pre>
443</div></div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]444</li>
Junio C Hamanoc8d88c22006-04-29 07:02:01[diff] [blame]445</ol>
446</li>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]447<li>
448<p>
449After working in a wrong branch, switching to the correct
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]450branch would be done using:
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]451</p>
452<div class="listingblock">
453<div class="content">
454<pre><tt>$ git checkout mytopic</tt></pre>
455</div></div>
456<p>However, your "wrong" branch and correct "mytopic" branch may
457differ in files that you have locally modified, in which case,
458the above checkout would fail like this:</p>
459<div class="listingblock">
460<div class="content">
461<pre><tt>$ git checkout mytopic
462fatal: Entry 'frotz' not uptodate. Cannot merge.</tt></pre>
463</div></div>
464<p>You can give the <tt>-m</tt> flag to the command, which would try a
465three-way merge:</p>
466<div class="listingblock">
467<div class="content">
468<pre><tt>$ git checkout -m mytopic
469Auto-merging frotz</tt></pre>
470</div></div>
471<p>After this three-way merge, the local modifications are _not_
472registered in your index file, so <tt>git diff</tt> would show you what
473changes you made since the tip of the new branch.</p>
474</li>
475<li>
476<p>
477When a merge conflict happens during switching branches with
478the <tt>-m</tt> option, you would see something like this:
479</p>
480<div class="listingblock">
481<div class="content">
482<pre><tt>$ git checkout -m mytopic
483Auto-merging frotz
484merge: warning: conflicts during merge
485ERROR: Merge conflict in frotz
486fatal: merge program failed</tt></pre>
487</div></div>
488<p>At this point, <tt>git diff</tt> shows the changes cleanly merged as in
489the previous example, as well as the changes in the conflicted
490files. Edit and resolve the conflict and mark it resolved with
491<tt>git update-index</tt> as usual:</p>
492<div class="listingblock">
493<div class="content">
494<pre><tt>$ edit frotz
495$ git update-index frotz</tt></pre>
496</div></div>
497</li>
498</ol>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]499</div>
500<h2>Author</h2>
501<div class="sectionbody">
502<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
503</div>
504<h2>Documentation</h2>
505<div class="sectionbody">
506<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
507</div>
508<h2>GIT</h2>
509<div class="sectionbody">
510<p>Part of the <a href="git.html">git(7)</a> suite</p>
511</div>
512<div id="footer">
513<div id="footer-text">
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame^]514Last updated 01-Feb-2007 00:22:05 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]515</div>
516</div>
517</body>
518</html>