git-update-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-update-index(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-update-index(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-update-index -\r
 269    Modifies the index or directory cache\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-update-index</em>\r
 276              [--add] [--remove | --force-remove] [--replace]\r
 277              [--refresh [-q] [--unmerged] [--ignore-missing]]\r
 278              [--cacheinfo &lt;mode&gt; &lt;object&gt; &lt;file&gt;]*\r
 279              [--chmod=(+|-)x]\r
 280              [--info-only] [--index-info]\r
 281              [-z] [--stdin]\r
 282              [--verbose]\r
 283              [--] [&lt;file&gt;]*</p>\r
 284 </div>\r
 285 <h2>DESCRIPTION</h2>\r
 286 <div class="sectionbody">\r
 287 <p>Modifies the index or directory cache. Each file mentioned is updated\r
 288 into the index and any <em>unmerged</em> or <em>needs updating</em> state is\r
 289 cleared.</p>\r
 290 <p>The way "git-update-index" handles files it is told about can be modified\r
 291 using the various options:</p>\r
 292 </div>\r
 293 <h2>OPTIONS</h2>\r
 294 <div class="sectionbody">\r
 295 <dl>\r
 296 <dt>\r
 297 --add\r
 298 </dt>\r
 299 <dd>\r
 300 <p>\r
 301         If a specified file isn't in the index already then it's\r
 302         added.\r
 303         Default behaviour is to ignore new files.\r
 304 </p>\r
 305 </dd>\r
 306 <dt>\r
 307 --remove\r
 308 </dt>\r
 309 <dd>\r
 310 <p>\r
 311         If a specified file is in the index but is missing then it's\r
 312         removed.\r
 313         Default behaviour is to ignore removed file.\r
 314 </p>\r
 315 </dd>\r
 316 <dt>\r
 317 --refresh\r
 318 </dt>\r
 319 <dd>\r
 320 <p>\r
 321         Looks at the current index and checks to see if merges or\r
 322         updates are needed by checking stat() information.\r
 323 </p>\r
 324 </dd>\r
 325 <dt>\r
 326 -q\r
 327 </dt>\r
 328 <dd>\r
 329 <p>\r
 330         Quiet.  If --refresh finds that the index needs an update, the\r
 331         default behavior is to error out.  This option makes\r
 332         git-update-index continue anyway.\r
 333 </p>\r
 334 </dd>\r
 335 <dt>\r
 336 --unmerged\r
 337 </dt>\r
 338 <dd>\r
 339 <p>\r
 340         If --refresh finds unmerged changes in the index, the default\r
 341         behavior is to error out.  This option makes git-update-index\r
 342         continue anyway.\r
 343 </p>\r
 344 </dd>\r
 345 <dt>\r
 346 --ignore-missing\r
 347 </dt>\r
 348 <dd>\r
 349 <p>\r
 350         Ignores missing files during a --refresh\r
 351 </p>\r
 352 </dd>\r
 353 <dt>\r
 354 --cacheinfo &lt;mode&gt; &lt;object&gt; &lt;path&gt;\r
 355 </dt>\r
 356 <dd>\r
 357 <p>\r
 358         Directly insert the specified info into the index.\r
 359 </p>\r
 360 </dd>\r
 361 <dt>\r
 362 --index-info\r
 363 </dt>\r
 364 <dd>\r
 365 <p>\r
 366         Read index information from stdin.\r
 367 </p>\r
 368 </dd>\r
 369 <dt>\r
 370 --chmod=(+|-)x\r
 371 </dt>\r
 372 <dd>\r
 373 <p>\r
 374         Set the execute permissions on the updated files.\r
 375 </p>\r
 376 </dd>\r
 377 <dt>\r
 378 --info-only\r
 379 </dt>\r
 380 <dd>\r
 381 <p>\r
 382         Do not create objects in the object database for all\r
 383         &lt;file&gt; arguments that follow this flag; just insert\r
 384         their object IDs into the index.\r
 385 </p>\r
 386 </dd>\r
 387 <dt>\r
 388 --force-remove\r
 389 </dt>\r
 390 <dd>\r
 391 <p>\r
 392         Remove the file from the index even when the working directory\r
 393         still has such a file. (Implies --remove.)\r
 394 </p>\r
 395 </dd>\r
 396 <dt>\r
 397 --replace\r
 398 </dt>\r
 399 <dd>\r
 400 <p>\r
 401         By default, when a file <tt>path</tt> exists in the index,\r
 402         git-update-index refuses an attempt to add <tt>path/file</tt>.\r
 403         Similarly if a file <tt>path/file</tt> exists, a file <tt>path</tt>\r
 404         cannot be added.  With --replace flag, existing entries\r
 405         that conflicts with the entry being added are\r
 406         automatically removed with warning messages.\r
 407 </p>\r
 408 </dd>\r
 409 <dt>\r
 410 --stdin\r
 411 </dt>\r
 412 <dd>\r
 413 <p>\r
 414         Instead of taking list of paths from the command line,\r
 415         read list of paths from the standard input.  Paths are\r
 416         separated by LF (i.e. one path per line) by default.\r
 417 </p>\r
 418 </dd>\r
 419 <dt>\r
 420 --verbose\r
 421 </dt>\r
 422 <dd>\r
 423 <p>\r
 424         Report what is being added and removed from index.\r
 425 </p>\r
 426 </dd>\r
 427 <dt>\r
 428 -z\r
 429 </dt>\r
 430 <dd>\r
 431 <p>\r
 432         Only meaningful with <tt>--stdin</tt>; paths are separated with\r
 433         NUL character instead of LF.\r
 434 </p>\r
 435 </dd>\r
 436 <dt>\r
 437 &#8212;\r
 438 </dt>\r
 439 <dd>\r
 440 <p>\r
 441         Do not interpret any more arguments as options.\r
 442 </p>\r
 443 </dd>\r
 444 <dt>\r
 445 &lt;file&gt;\r
 446 </dt>\r
 447 <dd>\r
 448 <p>\r
 449         Files to act on.\r
 450         Note that files beginning with <em>.</em> are discarded. This includes\r
 451         <tt>./file</tt> and <tt>dir/./file</tt>. If you don't want this, then use\r
 452         cleaner names.\r
 453         The same applies to directories ending <em>/</em> and paths with <em>//</em>\r
 454 </p>\r
 455 </dd>\r
 456 </dl>\r
 457 </div>\r
 458 <h2>Using --refresh</h2>\r
 459 <div class="sectionbody">\r
 460 <p><em>--refresh</em> does not calculate a new sha1 file or bring the index\r
 461 up-to-date for mode/content changes. But what it <strong>does</strong> do is to\r
 462 "re-match" the stat information of a file with the index, so that you\r
 463 can refresh the index for a file that hasn't been changed but where\r
 464 the stat entry is out of date.</p>\r
 465 <p>For example, you'd want to do this after doing a "git-read-tree", to link\r
 466 up the stat index details with the proper files.</p>\r
 467 </div>\r
 468 <h2>Using --cacheinfo or --info-only</h2>\r
 469 <div class="sectionbody">\r
 470 <p><em>--cacheinfo</em> is used to register a file that is not in the\r
 471 current working directory.  This is useful for minimum-checkout\r
 472 merging.</p>\r
 473 <p>To pretend you have a file with mode and sha1 at path, say:</p>\r
 474 <div class="listingblock">\r
 475 <div class="content">\r
 476 <pre><tt>$ git-update-index --cacheinfo mode sha1 path</tt></pre>\r
 477 </div></div>\r
 478 <p><em>--info-only</em> is used to register files without placing them in the object\r
 479 database.  This is useful for status-only repositories.</p>\r
 480 <p>Both <em>--cacheinfo</em> and <em>--info-only</em> behave similarly: the index is updated\r
 481 but the object database isn't.  <em>--cacheinfo</em> is useful when the object is\r
 482 in the database but the file isn't available locally.  <em>--info-only</em> is\r
 483 useful when the file is available, but you do not wish to update the\r
 484 object database.</p>\r
 485 </div>\r
 486 <h2>Using --index-info</h2>\r
 487 <div class="sectionbody">\r
 488 <p><tt>--index-info</tt> is a more powerful mechanism that lets you feed\r
 489 multiple entry definitions from the standard input, and designed\r
 490 specifically for scripts.  It can take inputs of three formats:</p>\r
 491 <ol>\r
 492 <li>\r
 493 <p>\r
 494 mode         SP sha1          TAB path\r
 495 </p>\r
 496 <p>The first format is what "git-apply --index-info"\r
 497 reports, and used to reconstruct a partial tree\r
 498 that is used for phony merge base tree when falling\r
 499 back on 3-way merge.</p>\r
 500 </li>\r
 501 <li>\r
 502 <p>\r
 503 mode SP type SP sha1          TAB path\r
 504 </p>\r
 505 <p>The second format is to stuff git-ls-tree output\r
 506 into the index file.</p>\r
 507 </li>\r
 508 <li>\r
 509 <p>\r
 510 mode         SP sha1 SP stage TAB path\r
 511 </p>\r
 512 <p>This format is to put higher order stages into the\r
 513 index file and matches git-ls-files --stage output.</p>\r
 514 </li>\r
 515 </ol>\r
 516 <p>To place a higher stage entry to the index, the path should\r
 517 first be removed by feeding a mode=0 entry for the path, and\r
 518 then feeding necessary input lines in the third format.</p>\r
 519 <p>For example, starting with this index:</p>\r
 520 <div class="listingblock">\r
 521 <div class="content">\r
 522 <pre><tt>$ git ls-files -s\r
 523 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz</tt></pre>\r
 524 </div></div>\r
 525 <p>you can feed the following input to <tt>--index-info</tt>:</p>\r
 526 <div class="listingblock">\r
 527 <div class="content">\r
 528 <pre><tt>$ git update-index --index-info\r
 529 0 0000000000000000000000000000000000000000      frotz\r
 530 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
 531 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</tt></pre>\r
 532 </div></div>\r
 533 <p>The first line of the input feeds 0 as the mode to remove the\r
 534 path; the SHA1 does not matter as long as it is well formatted.\r
 535 Then the second and third line feeds stage 1 and stage 2 entries\r
 536 for that path.  After the above, we would end up with this:</p>\r
 537 <div class="listingblock">\r
 538 <div class="content">\r
 539 <pre><tt>$ git ls-files -s\r
 540 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
 541 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</tt></pre>\r
 542 </div></div>\r
 543 </div>\r
 544 <h2>Examples</h2>\r
 545 <div class="sectionbody">\r
 546 <p>To update and refresh only the files already checked out:</p>\r
 547 <div class="listingblock">\r
 548 <div class="content">\r
 549 <pre><tt>$ git-checkout-index -n -f -a &amp;&amp; git-update-index --ignore-missing --refresh</tt></pre>\r
 550 </div></div>\r
 551 </div>\r
 552 <h2>Configuration</h2>\r
 553 <div class="sectionbody">\r
 554 <p>The command honors <tt>core.filemode</tt> configuration variable.  If\r
 555 your repository is on an filesystem whose executable bits are\r
 556 unreliable, this should be set to <em>false</em> (see <a href="git-repo-config.html">git-repo-config(1)</a>).\r
 557 This causes the command to ignore differences in file modes recorded\r
 558 in the index and the file mode on the filesystem if they differ only on\r
 559 executable bit.   On such an unfortunate filesystem, you may\r
 560 need to use <tt>git-update-index --chmod=</tt>.</p>\r
 561 </div>\r
 562 <h2>See Also</h2>\r
 563 <div class="sectionbody">\r
 564 <p><a href="git-repo-config.html">git-repo-config(1)</a></p>\r
 565 </div>\r
 566 <h2>Author</h2>\r
 567 <div class="sectionbody">\r
 568 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 569 </div>\r
 570 <h2>Documentation</h2>\r
 571 <div class="sectionbody">\r
 572 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 573 </div>\r
 574 <h2>GIT</h2>\r
 575 <div class="sectionbody">\r
 576 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 577 </div>\r
 578 <div id="footer">\r
 579 <div id="footer-text">\r
 580 Last updated 27-Dec-2005 00:16:52 PDT\r
 581 </div>\r
 582 </div>\r
 583 </body>\r
 584 </html>\r