git-checkout-index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-checkout-index(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-checkout-index(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-checkout-index -\r
 269    Copy files from the index to the working directory\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]\r
 277                    [--stage=&lt;number&gt;|all]\r
 278                    [--temp]\r
 279                    [-z] [--stdin]\r
 280                    [--] [&lt;file&gt;]*</div></div>\r
 281 </div>\r
 282 <h2>DESCRIPTION</h2>\r
 283 <div class="sectionbody">\r
 284 <p>Will copy all files listed from the index to the working directory\r
 285 (not overwriting existing files).</p>\r
 286 </div>\r
 287 <h2>OPTIONS</h2>\r
 288 <div class="sectionbody">\r
 289 <dl>\r
 290 <dt>\r
 291 -u|--index\r
 292 </dt>\r
 293 <dd>\r
 294 <p>\r
 295         update stat information for the checked out entries in\r
 296         the index file.\r
 297 </p>\r
 298 </dd>\r
 299 <dt>\r
 300 -q|--quiet\r
 301 </dt>\r
 302 <dd>\r
 303 <p>\r
 304         be quiet if files exist or are not in the index\r
 305 </p>\r
 306 </dd>\r
 307 <dt>\r
 308 -f|--force\r
 309 </dt>\r
 310 <dd>\r
 311 <p>\r
 312         forces overwrite of existing files\r
 313 </p>\r
 314 </dd>\r
 315 <dt>\r
 316 -a|--all\r
 317 </dt>\r
 318 <dd>\r
 319 <p>\r
 320         checks out all files in the index.  Cannot be used\r
 321         together with explicit filenames.\r
 322 </p>\r
 323 </dd>\r
 324 <dt>\r
 325 -n|--no-create\r
 326 </dt>\r
 327 <dd>\r
 328 <p>\r
 329         Don't checkout new files, only refresh files already checked\r
 330         out.\r
 331 </p>\r
 332 </dd>\r
 333 <dt>\r
 334 --prefix=&lt;string&gt;\r
 335 </dt>\r
 336 <dd>\r
 337 <p>\r
 338         When creating files, prepend &lt;string&gt; (usually a directory\r
 339         including a trailing /)\r
 340 </p>\r
 341 </dd>\r
 342 <dt>\r
 343 --stage=&lt;number&gt;|all\r
 344 </dt>\r
 345 <dd>\r
 346 <p>\r
 347         Instead of checking out unmerged entries, copy out the\r
 348         files from named stage.  &lt;number&gt; must be between 1 and 3.\r
 349         Note: --stage=all automatically implies --temp.\r
 350 </p>\r
 351 </dd>\r
 352 <dt>\r
 353 --temp\r
 354 </dt>\r
 355 <dd>\r
 356 <p>\r
 357         Instead of copying the files to the working directory\r
 358         write the content to temporary files.  The temporary name\r
 359         associations will be written to stdout.\r
 360 </p>\r
 361 </dd>\r
 362 <dt>\r
 363 --stdin\r
 364 </dt>\r
 365 <dd>\r
 366 <p>\r
 367         Instead of taking list of paths from the command line,\r
 368         read list of paths from the standard input.  Paths are\r
 369         separated by LF (i.e. one path per line) by default.\r
 370 </p>\r
 371 </dd>\r
 372 <dt>\r
 373 -z\r
 374 </dt>\r
 375 <dd>\r
 376 <p>\r
 377         Only meaningful with <tt>--stdin</tt>; paths are separated with\r
 378         NUL character instead of LF.\r
 379 </p>\r
 380 </dd>\r
 381 <dt>\r
 382 &#8212;\r
 383 </dt>\r
 384 <dd>\r
 385 <p>\r
 386         Do not interpret any more arguments as options.\r
 387 </p>\r
 388 </dd>\r
 389 </dl>\r
 390 <p>The order of the flags used to matter, but not anymore.</p>\r
 391 <p>Just doing <tt>git-checkout-index</tt> does nothing. You probably meant\r
 392 <tt>git-checkout-index -a</tt>. And if you want to force it, you want\r
 393 <tt>git-checkout-index -f -a</tt>.</p>\r
 394 <p>Intuitiveness is not the goal here. Repeatability is. The reason for\r
 395 the "no arguments means no work" behavior is that from scripts you are\r
 396 supposed to be able to do:</p>\r
 397 <div class="listingblock">\r
 398 <div class="content">\r
 399 <pre><tt>$ find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --</tt></pre>\r
 400 </div></div>\r
 401 <p>which will force all existing <tt>*.h</tt> files to be replaced with their\r
 402 cached copies. If an empty command line implied "all", then this would\r
 403 force-refresh everything in the index, which was not the point.  But\r
 404 since git-checkout-index accepts --stdin it would be faster to use:</p>\r
 405 <div class="listingblock">\r
 406 <div class="content">\r
 407 <pre><tt>$ find . -name '*.h' -print0 | git-checkout-index -f -z --stdin</tt></pre>\r
 408 </div></div>\r
 409 <p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;\r
 410 it will prevent problems with a filename of, for example,  <tt>-a</tt>.\r
 411 Using <tt>--</tt> is probably a good policy in scripts.</p>\r
 412 </div>\r
 413 <h2>Using --temp or --stage=all</h2>\r
 414 <div class="sectionbody">\r
 415 <p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)\r
 416 <tt>git-checkout-index</tt> will create a temporary file for each index\r
 417 entry being checked out.  The index will not be updated with stat\r
 418 information.  These options can be useful if the caller needs all\r
 419 stages of all unmerged entries so that the unmerged files can be\r
 420 processed by an external merge tool.</p>\r
 421 <p>A listing will be written to stdout providing the association of\r
 422 temporary file names to tracked path names.  The listing format\r
 423 has two variations:</p>\r
 424 <ol>\r
 425 <li>\r
 426 <p>\r
 427 tempname TAB path RS\r
 428 </p>\r
 429 <p>The first format is what gets used when <tt>--stage</tt> is omitted or\r
 430 is not <tt>--stage=all</tt>. The field tempname is the temporary file\r
 431 name holding the file content and path is the tracked path name in\r
 432 the index.  Only the requested entries are output.</p>\r
 433 </li>\r
 434 <li>\r
 435 <p>\r
 436 stage1temp SP stage2temp SP stage3tmp TAB path RS\r
 437 </p>\r
 438 <p>The second format is what gets used when <tt>--stage=all</tt>.  The three\r
 439 stage temporary fields (stage1temp, stage2temp, stage3temp) list the\r
 440 name of the temporary file if there is a stage entry in the index\r
 441 or <tt>.</tt> if there is no stage entry.  Paths which only have a stage 0\r
 442 entry will always be omitted from the output.</p>\r
 443 </li>\r
 444 </ol>\r
 445 <p>In both formats RS (the record separator) is newline by default\r
 446 but will be the null byte if -z was passed on the command line.\r
 447 The temporary file names are always safe strings; they will never\r
 448 contain directory separators or whitespace characters.  The path\r
 449 field is always relative to the current directory and the temporary\r
 450 file names are always relative to the top level directory.</p>\r
 451 <p>If the object being copied out to a temporary file is a symbolic\r
 452 link the content of the link will be written to a normal file.  It is\r
 453 up to the end-user or the Porcelain to make use of this information.</p>\r
 454 </div>\r
 455 <h2>EXAMPLES</h2>\r
 456 <div class="sectionbody">\r
 457 <dl>\r
 458 <dt>\r
 459 To update and refresh only the files already checked out\r
 460 </dt>\r
 461 <dd>\r
 462 <div class="listingblock">\r
 463 <div class="content">\r
 464 <pre><tt>$ git-checkout-index -n -f -a &amp;&amp; git-update-index --ignore-missing --refresh</tt></pre>\r
 465 </div></div>\r
 466 </dd>\r
 467 <dt>\r
 468 Using <tt>git-checkout-index</tt> to "export an entire tree"\r
 469 </dt>\r
 470 <dd>\r
 471 <p>\r
 472         The prefix ability basically makes it trivial to use\r
 473         <tt>git-checkout-index</tt> as an "export as tree" function.\r
 474         Just read the desired tree into the index, and do:\r
 475 </p>\r
 476 <div class="listingblock">\r
 477 <div class="content">\r
 478 <pre><tt>$ git-checkout-index --prefix=git-export-dir/ -a</tt></pre>\r
 479 </div></div>\r
 480 <p><tt>git-checkout-index</tt> will "export" the index into the specified\r
 481 directory.</p>\r
 482 <p>The final "/" is important. The exported name is literally just\r
 483 prefixed with the specified string.  Contrast this with the\r
 484 following example.</p>\r
 485 </dd>\r
 486 <dt>\r
 487 Export files with a prefix\r
 488 </dt>\r
 489 <dd>\r
 490 <div class="listingblock">\r
 491 <div class="content">\r
 492 <pre><tt>$ git-checkout-index --prefix=.merged- Makefile</tt></pre>\r
 493 </div></div>\r
 494 <p>This will check out the currently cached copy of <tt>Makefile</tt>\r
 495 into the file <tt>.merged-Makefile</tt>.</p>\r
 496 </dd>\r
 497 </dl>\r
 498 </div>\r
 499 <h2>Author</h2>\r
 500 <div class="sectionbody">\r
 501 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 502 </div>\r
 503 <h2>Documentation</h2>\r
 504 <div class="sectionbody">\r
 505 <p>Documentation by David Greaves,\r
 506 Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 507 </div>\r
 508 <h2>GIT</h2>\r
 509 <div class="sectionbody">\r
 510 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 511 </div>\r
 512 <div id="footer">\r
 513 <div id="footer-text">\r
 514 Last updated 07-Mar-2006 05:16:20 UTC\r
 515 </div>\r
 516 </div>\r
 517 </body>\r
 518 </html>\r