Google Git
Sign in
chromium / external / gitster / git-htmldocs / 2b13527e6477916ed5cb6f1858d9d0e5381d236d / . / git-checkout.html
blob: d8ec4847db961ff510f36e54fe396cd93b3265b1 [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">
276<div class="content"><em>git-checkout</em> [-f] [-b &lt;new_branch&gt;] [-m] [&lt;branch&gt;]
277<em>git-checkout</em> [-m] [&lt;branch&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
288the index file (i.e. it runs <tt>git-checkout-index -f -u</tt>). In
289this case, <tt>-f</tt> and <tt>-b</tt> options are meaningless and giving
290either of them results in an error. &lt;branch&gt; argument can be
291used to specify a specific tree-ish to update the index for the
292given paths before updating the working tree.</p>
293</div>
294<h2>OPTIONS</h2>
295<div class="sectionbody">
296<dl>
297<dt>
298-f
299</dt>
300<dd>
301<p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame^]302 Force a re-read of everything.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]303</p>
304</dd>
305<dt>
306-b
307</dt>
308<dd>
309<p>
310 Create a new branch and start it at &lt;branch&gt;.
311</p>
312</dd>
313<dt>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]314-m
315</dt>
316<dd>
317<p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame^]318 If you have local modifications to one or more files that
319 are different between the current branch and the branch to
320 which you are switching, the command refuses to switch
321 branches in order to preserve your modifications in context.
322 However, with this option, a three-way merge between the current
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]323 branch, your working tree contents, and the new branch
324 is done, and you will be on the new branch.
325</p>
326<p>When a merge conflict happens, the index entries for conflicting
327paths are left unmerged, and you need to resolve the conflicts
328and mark the resolved paths with <tt>git update-index</tt>.</p>
329</dd>
330<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]331&lt;new_branch&gt;
332</dt>
333<dd>
334<p>
335 Name for the new branch.
336</p>
337</dd>
338<dt>
339&lt;branch&gt;
340</dt>
341<dd>
342<p>
343 Branch to checkout; may be any object ID that resolves to a
344 commit. Defaults to HEAD.
345</p>
346</dd>
347</dl>
348</div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]349<h2>EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]350<div class="sectionbody">
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]351<ol>
352<li>
353<p>
354The following sequence checks out the <tt>master</tt> branch, reverts
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]355the <tt>Makefile</tt> to two revisions back, deletes hello.c by
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]356mistake, and gets it back from the index.
357</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]358<div class="listingblock">
359<div class="content">
360<pre><tt>$ git checkout master <b>(1)</b>
361$ git checkout master~2 Makefile <b>(2)</b>
362$ rm -f hello.c
363$ git checkout hello.c <b>(3)</b>
364
365<b>(1)</b> switch branch
366<b>(2)</b> take out a file out of other commit
367<b>(3)</b> or "git checkout -- hello.c", as in the next example.</tt></pre>
368</div></div>
369<p>If you have an unfortunate branch that is named <tt>hello.c</tt>, the
370last step above would be confused as an instruction to switch to
371that branch. You should instead write:</p>
372<div class="listingblock">
373<div class="content">
374<pre><tt>$ git checkout -- hello.c</tt></pre>
375</div></div>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]376</li>
377<li>
378<p>
379After working in a wrong branch, switching to the correct
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame^]380branch would be done using:
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]381</p>
382<div class="listingblock">
383<div class="content">
384<pre><tt>$ git checkout mytopic</tt></pre>
385</div></div>
386<p>However, your "wrong" branch and correct "mytopic" branch may
387differ in files that you have locally modified, in which case,
388the above checkout would fail like this:</p>
389<div class="listingblock">
390<div class="content">
391<pre><tt>$ git checkout mytopic
392fatal: Entry 'frotz' not uptodate. Cannot merge.</tt></pre>
393</div></div>
394<p>You can give the <tt>-m</tt> flag to the command, which would try a
395three-way merge:</p>
396<div class="listingblock">
397<div class="content">
398<pre><tt>$ git checkout -m mytopic
399Auto-merging frotz</tt></pre>
400</div></div>
401<p>After this three-way merge, the local modifications are _not_
402registered in your index file, so <tt>git diff</tt> would show you what
403changes you made since the tip of the new branch.</p>
404</li>
405<li>
406<p>
407When a merge conflict happens during switching branches with
408the <tt>-m</tt> option, you would see something like this:
409</p>
410<div class="listingblock">
411<div class="content">
412<pre><tt>$ git checkout -m mytopic
413Auto-merging frotz
414merge: warning: conflicts during merge
415ERROR: Merge conflict in frotz
416fatal: merge program failed</tt></pre>
417</div></div>
418<p>At this point, <tt>git diff</tt> shows the changes cleanly merged as in
419the previous example, as well as the changes in the conflicted
420files. Edit and resolve the conflict and mark it resolved with
421<tt>git update-index</tt> as usual:</p>
422<div class="listingblock">
423<div class="content">
424<pre><tt>$ edit frotz
425$ git update-index frotz</tt></pre>
426</div></div>
427</li>
428</ol>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]429</div>
430<h2>Author</h2>
431<div class="sectionbody">
432<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
433</div>
434<h2>Documentation</h2>
435<div class="sectionbody">
436<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
437</div>
438<h2>GIT</h2>
439<div class="sectionbody">
440<p>Part of the <a href="git.html">git(7)</a> suite</p>
441</div>
442<div id="footer">
443<div id="footer-text">
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame^]444Last updated 18-Mar-2006 07:45:34 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]445</div>
446</div>
447</body>
448</html>