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.1" />\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;] [--] &lt;file&gt;&#8230;</div></div>\r
 278 </div>\r
 279 <h2>DESCRIPTION</h2>\r
 280 <div class="sectionbody">\r
 281 <p>Will copy all files listed from the index to the working directory\r
 282 (not overwriting existing files).</p>\r
 283 </div>\r
 284 <h2>OPTIONS</h2>\r
 285 <div class="sectionbody">\r
 286 <dl>\r
 287 <dt>\r
 288 -u|--index\r
 289 </dt>\r
 290 <dd>\r
 291 <p>\r
 292         update stat information for the checked out entries in\r
 293         the index file.\r
 294 </p>\r
 295 </dd>\r
 296 <dt>\r
 297 -q|--quiet\r
 298 </dt>\r
 299 <dd>\r
 300 <p>\r
 301         be quiet if files exist or are not in the index\r
 302 </p>\r
 303 </dd>\r
 304 <dt>\r
 305 -f|--force\r
 306 </dt>\r
 307 <dd>\r
 308 <p>\r
 309         forces overwrite of existing files\r
 310 </p>\r
 311 </dd>\r
 312 <dt>\r
 313 -a|--all\r
 314 </dt>\r
 315 <dd>\r
 316 <p>\r
 317         checks out all files in the index.  Cannot be used\r
 318         together with explicit filenames.\r
 319 </p>\r
 320 </dd>\r
 321 <dt>\r
 322 -n|--no-create\r
 323 </dt>\r
 324 <dd>\r
 325 <p>\r
 326         Don't checkout new files, only refresh files already checked\r
 327         out.\r
 328 </p>\r
 329 </dd>\r
 330 <dt>\r
 331 --prefix=&lt;string&gt;\r
 332 </dt>\r
 333 <dd>\r
 334 <p>\r
 335         When creating files, prepend &lt;string&gt; (usually a directory\r
 336         including a trailing /)\r
 337 </p>\r
 338 </dd>\r
 339 <dt>\r
 340 --stage=&lt;number&gt;\r
 341 </dt>\r
 342 <dd>\r
 343 <p>\r
 344         Instead of checking out unmerged entries, copy out the\r
 345         files from named stage.  &lt;number&gt; must be between 1 and 3.\r
 346 </p>\r
 347 </dd>\r
 348 <dt>\r
 349 &#8212;\r
 350 </dt>\r
 351 <dd>\r
 352 <p>\r
 353         Do not interpret any more arguments as options.\r
 354 </p>\r
 355 </dd>\r
 356 </dl>\r
 357 <p>The order of the flags used to matter, but not anymore.</p>\r
 358 <p>Just doing <tt>git-checkout-index</tt> does nothing. You probably meant\r
 359 <tt>git-checkout-index -a</tt>. And if you want to force it, you want\r
 360 <tt>git-checkout-index -f -a</tt>.</p>\r
 361 <p>Intuitiveness is not the goal here. Repeatability is. The reason for\r
 362 the "no arguments means no work" behavior is that from scripts you are\r
 363 supposed to be able to do:</p>\r
 364 <div class="listingblock">\r
 365 <div class="content">\r
 366 <pre><tt>$ find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --</tt></pre>\r
 367 </div></div>\r
 368 <p>which will force all existing <tt>*.h</tt> files to be replaced with their\r
 369 cached copies. If an empty command line implied "all", then this would\r
 370 force-refresh everything in the index, which was not the point.</p>\r
 371 <p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;\r
 372 it will prevent problems with a filename of, for example,  <tt>-a</tt>.\r
 373 Using <tt>--</tt> is probably a good policy in scripts.</p>\r
 374 </div>\r
 375 <h2>EXAMPLES</h2>\r
 376 <div class="sectionbody">\r
 377 <dl>\r
 378 <dt>\r
 379 To update and refresh only the files already checked out\r
 380 </dt>\r
 381 <dd>\r
 382 <div class="listingblock">\r
 383 <div class="content">\r
 384 <pre><tt>$ git-checkout-index -n -f -a &amp;&amp; git-update-index --ignore-missing --refresh</tt></pre>\r
 385 </div></div>\r
 386 </dd>\r
 387 <dt>\r
 388 Using <tt>git-checkout-index</tt> to "export an entire tree"\r
 389 </dt>\r
 390 <dd>\r
 391 <p>\r
 392         The prefix ability basically makes it trivial to use\r
 393         <tt>git-checkout-index</tt> as an "export as tree" function.\r
 394         Just read the desired tree into the index, and do:\r
 395 </p>\r
 396 <div class="listingblock">\r
 397 <div class="content">\r
 398 <pre><tt>$ git-checkout-index --prefix=git-export-dir/ -a</tt></pre>\r
 399 </div></div>\r
 400 <p><tt>git-checkout-index</tt> will "export" the index into the specified\r
 401 directory.</p>\r
 402 <p>The final "/" is important. The exported name is literally just\r
 403 prefixed with the specified string.  Contrast this with the\r
 404 following example.</p>\r
 405 </dd>\r
 406 <dt>\r
 407 Export files with a prefix\r
 408 </dt>\r
 409 <dd>\r
 410 <div class="listingblock">\r
 411 <div class="content">\r
 412 <pre><tt>$ git-checkout-index --prefix=.merged- Makefile</tt></pre>\r
 413 </div></div>\r
 414 <p>This will check out the currently cached copy of <tt>Makefile</tt>\r
 415 into the file <tt>.merged-Makefile</tt>.</p>\r
 416 </dd>\r
 417 </dl>\r
 418 </div>\r
 419 <h2>Author</h2>\r
 420 <div class="sectionbody">\r
 421 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 422 </div>\r
 423 <h2>Documentation</h2>\r
 424 <div class="sectionbody">\r
 425 <p>Documentation by David Greaves,\r
 426 Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 427 </div>\r
 428 <h2>GIT</h2>\r
 429 <div class="sectionbody">\r
 430 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 431 </div>\r
 432 <div id="footer">\r
 433 <div id="footer-text">\r
 434 Last updated 06-Jan-2006 17:12:07 PDT\r
 435 </div>\r
 436 </div>\r
 437 </body>\r
 438 </html>\r