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">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.2.5" />
7 <style type=
"text/css">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-checkout-index(
1)
</title>
312 git-checkout-index(
1) Manual Page
315 <div class=
"sectionbody">
316 <p>git-checkout-index -
317 Copy files from the index to the working tree
322 <div class=
"sectionbody">
323 <div class=
"verseblock">
324 <div class=
"content"><em>git checkout-index
</em> [-u] [-q] [-a] [-f] [-n] [--prefix=
<string
>]
325 [--stage=
<number
>|all]
328 [--] [
<file
>]*
</div></div>
330 <h2 id=
"_description">DESCRIPTION
</h2>
331 <div class=
"sectionbody">
332 <div class=
"para"><p>Will copy all files listed from the index to the working directory
333 (not overwriting existing files).
</p></div>
335 <h2 id=
"_options">OPTIONS
</h2>
336 <div class=
"sectionbody">
337 <div class=
"vlist"><dl>
346 update stat information for the checked out entries in
358 be quiet if files exist or are not in the index
369 forces overwrite of existing files
380 checks out all files in the index. Cannot be used
381 together with explicit filenames.
392 Don't checkout new files, only refresh files already checked
397 --prefix=
<string
>
401 When creating files, prepend
<string
> (usually a directory
402 including a trailing /)
406 --stage=
<number
>|all
410 Instead of checking out unmerged entries, copy out the
411 files from named stage.
<number
> must be between
1 and
3.
412 Note: --stage=all automatically implies --temp.
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.
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.
440 Only meaningful with
<tt>--stdin
</tt>; paths are separated with
441 NUL character instead of LF.
449 Do not interpret any more arguments as options.
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
455 <tt>git checkout-index -a
</tt>. And if you want to force it, you want
456 <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
458 the
"no arguments means no work" behavior is that from scripts you are
459 supposed to be able to do:
</p></div>
460 <div class=
"listingblock">
461 <div class=
"content">
462 <pre><tt>$ find . -name '*.h' -print0 | xargs -
0 git checkout-index -f --
</tt></pre>
464 <div class=
"para"><p>which will force all existing
<tt>*.h
</tt> files to be replaced with their
465 cached copies. If an empty command line implied
"all", then this would
466 force-refresh everything in the index, which was not the point. But
467 since
<em>git-checkout-index
</em> accepts --stdin it would be faster to use:
</p></div>
468 <div class=
"listingblock">
469 <div class=
"content">
470 <pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin
</tt></pre>
472 <div class=
"para"><p>The
<tt>--
</tt> is just a good idea when you know the rest will be filenames;
473 it will prevent problems with a filename of, for example,
<tt>-a
</tt>.
474 Using
<tt>--
</tt> is probably a good policy in scripts.
</p></div>
476 <h2 id=
"_using_temp_or_stage_all">Using --temp or --stage=all
</h2>
477 <div class=
"sectionbody">
478 <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
480 entry being checked out. The index will not be updated with stat
481 information. These options can be useful if the caller needs all
482 stages of all unmerged entries so that the unmerged files can be
483 processed by an external merge tool.
</p></div>
484 <div class=
"para"><p>A listing will be written to stdout providing the association of
485 temporary file names to tracked path names. The listing format
486 has two variations:
</p></div>
487 <div class=
"olist"><ol>
492 <div class=
"para"><p>The first format is what gets used when
<tt>--stage
</tt> is omitted or
493 is not
<tt>--stage=all
</tt>. The field tempname is the temporary file
494 name holding the file content and path is the tracked path name in
495 the index. Only the requested entries are output.
</p></div>
499 stage1temp SP stage2temp SP stage3tmp TAB path RS
501 <div class=
"para"><p>The second format is what gets used when
<tt>--stage=all
</tt>. The three
502 stage temporary fields (stage1temp, stage2temp, stage3temp) list the
503 name of the temporary file if there is a stage entry in the index
504 or
<tt>.
</tt> if there is no stage entry. Paths which only have a stage
0
505 entry will always be omitted from the output.
</p></div>
508 <div class=
"para"><p>In both formats RS (the record separator) is newline by default
509 but will be the null byte if -z was passed on the command line.
510 The temporary file names are always safe strings; they will never
511 contain directory separators or whitespace characters. The path
512 field is always relative to the current directory and the temporary
513 file 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
515 link the content of the link will be written to a normal file. It is
516 up to the end-user or the Porcelain to make use of this information.
</p></div>
518 <h2 id=
"_examples">EXAMPLES
</h2>
519 <div class=
"sectionbody">
520 <div class=
"vlist"><dl>
522 To update and refresh only the files already checked out
525 <div class=
"listingblock">
526 <div class=
"content">
527 <pre><tt>$ git checkout-index -n -f -a
&& git update-index --ignore-missing --refresh
</tt></pre>
531 Using
<em>git-checkout-index
</em> to
"export an entire tree"
535 The prefix ability basically makes it trivial to use
536 <em>git-checkout-index
</em> as an
"export as tree" function.
537 Just read the desired tree into the index, and do:
539 <div class=
"listingblock">
540 <div class=
"content">
541 <pre><tt>$ git checkout-index --prefix=git-export-dir/ -a
</tt></pre>
543 <div class=
"para"><p><tt>git checkout-index
</tt> will
"export" the index into the specified
545 <div class=
"para"><p>The final
"/" is important. The exported name is literally just
546 prefixed with the specified string. Contrast this with the
547 following example.
</p></div>
550 Export files with a prefix
553 <div class=
"listingblock">
554 <div class=
"content">
555 <pre><tt>$ git checkout-index --prefix=.merged- Makefile
</tt></pre>
557 <div class=
"para"><p>This will check out the currently cached copy of
<tt>Makefile
</tt>
558 into the file
<tt>.merged-Makefile
</tt>.
</p></div>
562 <h2 id=
"_author">Author
</h2>
563 <div class=
"sectionbody">
564 <div class=
"para"><p>Written by Linus Torvalds
<torvalds@osdl.org
></p></div>
566 <h2 id=
"_documentation">Documentation
</h2>
567 <div class=
"sectionbody">
568 <div class=
"para"><p>Documentation by David Greaves,
569 Junio C Hamano and the git-list
<git@vger.kernel.org
>.
</p></div>
571 <h2 id=
"_git">GIT
</h2>
572 <div class=
"sectionbody">
573 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
576 <div id=
"footer-text">
577 Last updated
2009-
07-
01 02:
30:
44 UTC