blob: cd74976d85cc2fe9b6d5e5f589f4747c6dd8f224 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!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 Hamanoba4b9282008-07-06 05:20:316<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:237<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
Junio C Hamanoba4b9282008-07-06 05:20:3119a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:2326
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:3147h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2348 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2351 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:3153h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:2359
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:3183 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:2384}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23306</style>
307<title>git-checkout-index(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-checkout-index(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-checkout-index -
Junio C Hamano7c73c662007-01-19 00:37:50317 Copy files from the index to the working tree
Junio C Hamano1a4e8412005-12-27 08:17:23318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamano235a91e2006-01-07 01:13:58323<div class="verseblock">
Junio C Hamanofce7c7e2008-07-02 03:06:38324<div class="content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]
Junio C Hamanof84a2b12006-03-07 05:16:28325 [--stage=&lt;number&gt;|all]
326 [--temp]
Junio C Hamanodecf50e2006-03-05 10:51:14327 [-z] [--stdin]
328 [--] [&lt;file&gt;]*</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23329</div>
Junio C Hamanoba4b9282008-07-06 05:20:31330<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23331<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31332<div class="para"><p>Will copy all files listed from the index to the working directory
333(not overwriting existing files).</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23334</div>
Junio C Hamanoba4b9282008-07-06 05:20:31335<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23336<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31337<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23338<dt>
Junio C Hamanoeb415992008-06-08 22:49:47339-u
340</dt>
341<dt>
342--index
Junio C Hamano1a4e8412005-12-27 08:17:23343</dt>
344<dd>
345<p>
346 update stat information for the checked out entries in
347 the index file.
348</p>
349</dd>
350<dt>
Junio C Hamanoeb415992008-06-08 22:49:47351-q
352</dt>
353<dt>
354--quiet
Junio C Hamano1a4e8412005-12-27 08:17:23355</dt>
356<dd>
357<p>
358 be quiet if files exist or are not in the index
359</p>
360</dd>
361<dt>
Junio C Hamanoeb415992008-06-08 22:49:47362-f
363</dt>
364<dt>
365--force
Junio C Hamano1a4e8412005-12-27 08:17:23366</dt>
367<dd>
368<p>
369 forces overwrite of existing files
370</p>
371</dd>
372<dt>
Junio C Hamanoeb415992008-06-08 22:49:47373-a
374</dt>
375<dt>
376--all
Junio C Hamano1a4e8412005-12-27 08:17:23377</dt>
378<dd>
379<p>
380 checks out all files in the index. Cannot be used
381 together with explicit filenames.
382</p>
383</dd>
384<dt>
Junio C Hamanoeb415992008-06-08 22:49:47385-n
386</dt>
387<dt>
388--no-create
Junio C Hamano1a4e8412005-12-27 08:17:23389</dt>
390<dd>
391<p>
392 Don't checkout new files, only refresh files already checked
393 out.
394</p>
395</dd>
396<dt>
397--prefix=&lt;string&gt;
398</dt>
399<dd>
400<p>
401 When creating files, prepend &lt;string&gt; (usually a directory
402 including a trailing /)
403</p>
404</dd>
405<dt>
Junio C Hamanof84a2b12006-03-07 05:16:28406--stage=&lt;number&gt;|all
Junio C Hamano1a4e8412005-12-27 08:17:23407</dt>
408<dd>
409<p>
410 Instead of checking out unmerged entries, copy out the
411 files from named stage. &lt;number&gt; must be between 1 and 3.
Junio C Hamanof84a2b12006-03-07 05:16:28412 Note: --stage=all automatically implies --temp.
413</p>
414</dd>
415<dt>
416--temp
417</dt>
418<dd>
419<p>
420 Instead of copying the files to the working directory
421 write the content to temporary files. The temporary name
422 associations will be written to stdout.
Junio C Hamano1a4e8412005-12-27 08:17:23423</p>
424</dd>
425<dt>
Junio C Hamanodecf50e2006-03-05 10:51:14426--stdin
427</dt>
428<dd>
429<p>
430 Instead of taking list of paths from the command line,
431 read list of paths from the standard input. Paths are
432 separated by LF (i.e. one path per line) by default.
433</p>
434</dd>
435<dt>
436-z
437</dt>
438<dd>
439<p>
440 Only meaningful with <tt>--stdin</tt>; paths are separated with
441 NUL character instead of LF.
442</p>
443</dd>
444<dt>
Junio C Hamano1bb569e2006-05-05 23:14:25445--
Junio C Hamano1a4e8412005-12-27 08:17:23446</dt>
447<dd>
448<p>
449 Do not interpret any more arguments as options.
450</p>
451</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31452</dl></div>
453<div class="para"><p>The order of the flags used to matter, but not anymore.</p></div>
454<div class="para"><p>Just doing <tt>git checkout-index</tt> does nothing. You probably meant
Junio C Hamanofce7c7e2008-07-02 03:06:38455<tt>git checkout-index -a</tt>. And if you want to force it, you want
Junio C Hamanoba4b9282008-07-06 05:20:31456<tt>git checkout-index -f -a</tt>.</p></div>
457<div class="para"><p>Intuitiveness is not the goal here. Repeatability is. The reason for
Junio C Hamano1a4e8412005-12-27 08:17:23458the "no arguments means no work" behavior is that from scripts you are
Junio C Hamanoba4b9282008-07-06 05:20:31459supposed to be able to do:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23460<div class="listingblock">
461<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38462<pre><tt>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23463</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31464<div class="para"><p>which will force all existing <tt>*.h</tt> files to be replaced with their
Junio C Hamano1a4e8412005-12-27 08:17:23465cached copies. If an empty command line implied "all", then this would
Junio C Hamanodecf50e2006-03-05 10:51:14466force-refresh everything in the index, which was not the point. But
Junio C Hamanoba4b9282008-07-06 05:20:31467since <em>git-checkout-index</em> accepts --stdin it would be faster to use:</p></div>
Junio C Hamanodecf50e2006-03-05 10:51:14468<div class="listingblock">
469<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38470<pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</tt></pre>
Junio C Hamanodecf50e2006-03-05 10:51:14471</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31472<div class="para"><p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;
Junio C Hamano1a4e8412005-12-27 08:17:23473it will prevent problems with a filename of, for example, <tt>-a</tt>.
Junio C Hamanoba4b9282008-07-06 05:20:31474Using <tt>--</tt> is probably a good policy in scripts.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23475</div>
Junio C Hamanoba4b9282008-07-06 05:20:31476<h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2>
Junio C Hamanof84a2b12006-03-07 05:16:28477<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31478<div class="para"><p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)
479<em>git-checkout-index</em> will create a temporary file for each index
Junio C Hamanof84a2b12006-03-07 05:16:28480entry being checked out. The index will not be updated with stat
481information. These options can be useful if the caller needs all
482stages of all unmerged entries so that the unmerged files can be
Junio C Hamanoba4b9282008-07-06 05:20:31483processed by an external merge tool.</p></div>
484<div class="para"><p>A listing will be written to stdout providing the association of
Junio C Hamanof84a2b12006-03-07 05:16:28485temporary file names to tracked path names. The listing format
Junio C Hamanoba4b9282008-07-06 05:20:31486has two variations:</p></div>
487<div class="olist"><ol>
Junio C Hamanof84a2b12006-03-07 05:16:28488<li>
489<p>
490tempname TAB path RS
491</p>
Junio C Hamanoba4b9282008-07-06 05:20:31492<div class="para"><p>The first format is what gets used when <tt>--stage</tt> is omitted or
Junio C Hamanof84a2b12006-03-07 05:16:28493is not <tt>--stage=all</tt>. The field tempname is the temporary file
494name holding the file content and path is the tracked path name in
Junio C Hamanoba4b9282008-07-06 05:20:31495the index. Only the requested entries are output.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28496</li>
497<li>
498<p>
499stage1temp SP stage2temp SP stage3tmp TAB path RS
500</p>
Junio C Hamanoba4b9282008-07-06 05:20:31501<div class="para"><p>The second format is what gets used when <tt>--stage=all</tt>. The three
Junio C Hamanof84a2b12006-03-07 05:16:28502stage temporary fields (stage1temp, stage2temp, stage3temp) list the
503name of the temporary file if there is a stage entry in the index
504or <tt>.</tt> if there is no stage entry. Paths which only have a stage 0
Junio C Hamanoba4b9282008-07-06 05:20:31505entry will always be omitted from the output.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28506</li>
Junio C Hamanoba4b9282008-07-06 05:20:31507</ol></div>
508<div class="para"><p>In both formats RS (the record separator) is newline by default
Junio C Hamanof84a2b12006-03-07 05:16:28509but will be the null byte if -z was passed on the command line.
510The temporary file names are always safe strings; they will never
511contain directory separators or whitespace characters. The path
512field is always relative to the current directory and the temporary
Junio C Hamanoba4b9282008-07-06 05:20:31513file names are always relative to the top level directory.</p></div>
514<div class="para"><p>If the object being copied out to a temporary file is a symbolic
Junio C Hamanof84a2b12006-03-07 05:16:28515link the content of the link will be written to a normal file. It is
Junio C Hamanoba4b9282008-07-06 05:20:31516up to the end-user or the Porcelain to make use of this information.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28517</div>
Junio C Hamanoba4b9282008-07-06 05:20:31518<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23519<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31520<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23521<dt>
522To update and refresh only the files already checked out
523</dt>
524<dd>
525<div class="listingblock">
526<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38527<pre><tt>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23528</div></div>
529</dd>
530<dt>
Junio C Hamanoba4b9282008-07-06 05:20:31531Using <em>git-checkout-index</em> to "export an entire tree"
Junio C Hamano1a4e8412005-12-27 08:17:23532</dt>
533<dd>
534<p>
535 The prefix ability basically makes it trivial to use
Junio C Hamanoba4b9282008-07-06 05:20:31536 <em>git-checkout-index</em> as an "export as tree" function.
Junio C Hamano1a4e8412005-12-27 08:17:23537 Just read the desired tree into the index, and do:
538</p>
539<div class="listingblock">
540<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38541<pre><tt>$ git checkout-index --prefix=git-export-dir/ -a</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23542</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31543<div class="para"><p><tt>git checkout-index</tt> will "export" the index into the specified
544directory.</p></div>
545<div class="para"><p>The final "/" is important. The exported name is literally just
Junio C Hamano1a4e8412005-12-27 08:17:23546prefixed with the specified string. Contrast this with the
Junio C Hamanoba4b9282008-07-06 05:20:31547following example.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23548</dd>
549<dt>
550Export files with a prefix
551</dt>
552<dd>
553<div class="listingblock">
554<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38555<pre><tt>$ git checkout-index --prefix=.merged- Makefile</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23556</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31557<div class="para"><p>This will check out the currently cached copy of <tt>Makefile</tt>
558into the file <tt>.merged-Makefile</tt>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23559</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31560</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23561</div>
Junio C Hamanoba4b9282008-07-06 05:20:31562<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23563<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31564<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23565</div>
Junio C Hamanoba4b9282008-07-06 05:20:31566<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23567<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31568<div class="para"><p>Documentation by David Greaves,
569Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23570</div>
Junio C Hamanoba4b9282008-07-06 05:20:31571<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23572<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31573<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23574</div>
575<div id="footer">
576<div id="footer-text">
Junio C Hamanoba4b9282008-07-06 05:20:31577Last updated 2008-07-06 05:16:37 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23578</div>
579</div>
580</body>
581</html>