Autogenerated HTML docs for v1.2.2-g858c
[git.git] / 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.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-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 <div class="verseblock">\r
276 <div class="content"><em>git-update-index</em>\r
277              [--add] [--remove | --force-remove] [--replace]\r
278              [--refresh [-q] [--unmerged] [--ignore-missing]]\r
279              [--cacheinfo &lt;mode&gt; &lt;object&gt; &lt;file&gt;]*\r
280              [--chmod=(+|-)x]\r
281              [--assume-unchanged | --no-assume-unchanged]\r
282              [--really-refresh]\r
283              [--info-only] [--index-info]\r
284              [-z] [--stdin]\r
285              [--verbose]\r
286              [--] [&lt;file&gt;]*</div></div>\r
287 </div>\r
288 <h2>DESCRIPTION</h2>\r
289 <div class="sectionbody">\r
290 <p>Modifies the index or directory cache. Each file mentioned is updated\r
291 into the index and any <em>unmerged</em> or <em>needs updating</em> state is\r
292 cleared.</p>\r
293 <p>The way "git-update-index" handles files it is told about can be modified\r
294 using the various options:</p>\r
295 </div>\r
296 <h2>OPTIONS</h2>\r
297 <div class="sectionbody">\r
298 <dl>\r
299 <dt>\r
300 --add\r
301 </dt>\r
302 <dd>\r
303 <p>\r
304         If a specified file isn't in the index already then it's\r
305         added.\r
306         Default behaviour is to ignore new files.\r
307 </p>\r
308 </dd>\r
309 <dt>\r
310 --remove\r
311 </dt>\r
312 <dd>\r
313 <p>\r
314         If a specified file is in the index but is missing then it's\r
315         removed.\r
316         Default behaviour is to ignore removed file.\r
317 </p>\r
318 </dd>\r
319 <dt>\r
320 --refresh\r
321 </dt>\r
322 <dd>\r
323 <p>\r
324         Looks at the current index and checks to see if merges or\r
325         updates are needed by checking stat() information.\r
326 </p>\r
327 </dd>\r
328 <dt>\r
329 -q\r
330 </dt>\r
331 <dd>\r
332 <p>\r
333         Quiet.  If --refresh finds that the index needs an update, the\r
334         default behavior is to error out.  This option makes\r
335         git-update-index continue anyway.\r
336 </p>\r
337 </dd>\r
338 <dt>\r
339 --unmerged\r
340 </dt>\r
341 <dd>\r
342 <p>\r
343         If --refresh finds unmerged changes in the index, the default\r
344         behavior is to error out.  This option makes git-update-index\r
345         continue anyway.\r
346 </p>\r
347 </dd>\r
348 <dt>\r
349 --ignore-missing\r
350 </dt>\r
351 <dd>\r
352 <p>\r
353         Ignores missing files during a --refresh\r
354 </p>\r
355 </dd>\r
356 <dt>\r
357 --cacheinfo &lt;mode&gt; &lt;object&gt; &lt;path&gt;\r
358 </dt>\r
359 <dd>\r
360 <p>\r
361         Directly insert the specified info into the index.\r
362 </p>\r
363 </dd>\r
364 <dt>\r
365 --index-info\r
366 </dt>\r
367 <dd>\r
368 <p>\r
369         Read index information from stdin.\r
370 </p>\r
371 </dd>\r
372 <dt>\r
373 --chmod=(+|-)x\r
374 </dt>\r
375 <dd>\r
376 <p>\r
377         Set the execute permissions on the updated files.\r
378 </p>\r
379 </dd>\r
380 <dt>\r
381 --assume-unchanged, --no-assume-unchanged\r
382 </dt>\r
383 <dd>\r
384 <p>\r
385         When these flags are specified, the object name recorded\r
386         for the paths are not updated.  Instead, these options\r
387         sets and unsets the "assume unchanged" bit for the\r
388         paths.  When the "assume unchanged" bit is on, git stops\r
389         checking the working tree files for possible\r
390         modifications, so you need to manually unset the bit to\r
391         tell git when you change the working tree file. This is\r
392         sometimes helpful when working with a big project on a\r
393         filesystem that has very slow lstat(2) system call\r
394         (e.g. cifs).\r
395 </p>\r
396 </dd>\r
397 <dt>\r
398 --info-only\r
399 </dt>\r
400 <dd>\r
401 <p>\r
402         Do not create objects in the object database for all\r
403         &lt;file&gt; arguments that follow this flag; just insert\r
404         their object IDs into the index.\r
405 </p>\r
406 </dd>\r
407 <dt>\r
408 --force-remove\r
409 </dt>\r
410 <dd>\r
411 <p>\r
412         Remove the file from the index even when the working directory\r
413         still has such a file. (Implies --remove.)\r
414 </p>\r
415 </dd>\r
416 <dt>\r
417 --replace\r
418 </dt>\r
419 <dd>\r
420 <p>\r
421         By default, when a file <tt>path</tt> exists in the index,\r
422         git-update-index refuses an attempt to add <tt>path/file</tt>.\r
423         Similarly if a file <tt>path/file</tt> exists, a file <tt>path</tt>\r
424         cannot be added.  With --replace flag, existing entries\r
425         that conflicts with the entry being added are\r
426         automatically removed with warning messages.\r
427 </p>\r
428 </dd>\r
429 <dt>\r
430 --stdin\r
431 </dt>\r
432 <dd>\r
433 <p>\r
434         Instead of taking list of paths from the command line,\r
435         read list of paths from the standard input.  Paths are\r
436         separated by LF (i.e. one path per line) by default.\r
437 </p>\r
438 </dd>\r
439 <dt>\r
440 --verbose\r
441 </dt>\r
442 <dd>\r
443 <p>\r
444         Report what is being added and removed from index.\r
445 </p>\r
446 </dd>\r
447 <dt>\r
448 -z\r
449 </dt>\r
450 <dd>\r
451 <p>\r
452         Only meaningful with <tt>--stdin</tt>; paths are separated with\r
453         NUL character instead of LF.\r
454 </p>\r
455 </dd>\r
456 <dt>\r
457 &#8212;\r
458 </dt>\r
459 <dd>\r
460 <p>\r
461         Do not interpret any more arguments as options.\r
462 </p>\r
463 </dd>\r
464 <dt>\r
465 &lt;file&gt;\r
466 </dt>\r
467 <dd>\r
468 <p>\r
469         Files to act on.\r
470         Note that files beginning with <em>.</em> are discarded. This includes\r
471         <tt>./file</tt> and <tt>dir/./file</tt>. If you don't want this, then use\r
472         cleaner names.\r
473         The same applies to directories ending <em>/</em> and paths with <em>//</em>\r
474 </p>\r
475 </dd>\r
476 </dl>\r
477 </div>\r
478 <h2>Using --refresh</h2>\r
479 <div class="sectionbody">\r
480 <p><em>--refresh</em> does not calculate a new sha1 file or bring the index\r
481 up-to-date for mode/content changes. But what it <strong>does</strong> do is to\r
482 "re-match" the stat information of a file with the index, so that you\r
483 can refresh the index for a file that hasn't been changed but where\r
484 the stat entry is out of date.</p>\r
485 <p>For example, you'd want to do this after doing a "git-read-tree", to link\r
486 up the stat index details with the proper files.</p>\r
487 </div>\r
488 <h2>Using --cacheinfo or --info-only</h2>\r
489 <div class="sectionbody">\r
490 <p><em>--cacheinfo</em> is used to register a file that is not in the\r
491 current working directory.  This is useful for minimum-checkout\r
492 merging.</p>\r
493 <p>To pretend you have a file with mode and sha1 at path, say:</p>\r
494 <div class="listingblock">\r
495 <div class="content">\r
496 <pre><tt>$ git-update-index --cacheinfo mode sha1 path</tt></pre>\r
497 </div></div>\r
498 <p><em>--info-only</em> is used to register files without placing them in the object\r
499 database.  This is useful for status-only repositories.</p>\r
500 <p>Both <em>--cacheinfo</em> and <em>--info-only</em> behave similarly: the index is updated\r
501 but the object database isn't.  <em>--cacheinfo</em> is useful when the object is\r
502 in the database but the file isn't available locally.  <em>--info-only</em> is\r
503 useful when the file is available, but you do not wish to update the\r
504 object database.</p>\r
505 </div>\r
506 <h2>Using --index-info</h2>\r
507 <div class="sectionbody">\r
508 <p><tt>--index-info</tt> is a more powerful mechanism that lets you feed\r
509 multiple entry definitions from the standard input, and designed\r
510 specifically for scripts.  It can take inputs of three formats:</p>\r
511 <ol>\r
512 <li>\r
513 <p>\r
514 mode         SP sha1          TAB path\r
515 </p>\r
516 <p>The first format is what "git-apply --index-info"\r
517 reports, and used to reconstruct a partial tree\r
518 that is used for phony merge base tree when falling\r
519 back on 3-way merge.</p>\r
520 </li>\r
521 <li>\r
522 <p>\r
523 mode SP type SP sha1          TAB path\r
524 </p>\r
525 <p>The second format is to stuff git-ls-tree output\r
526 into the index file.</p>\r
527 </li>\r
528 <li>\r
529 <p>\r
530 mode         SP sha1 SP stage TAB path\r
531 </p>\r
532 <p>This format is to put higher order stages into the\r
533 index file and matches git-ls-files --stage output.</p>\r
534 </li>\r
535 </ol>\r
536 <p>To place a higher stage entry to the index, the path should\r
537 first be removed by feeding a mode=0 entry for the path, and\r
538 then feeding necessary input lines in the third format.</p>\r
539 <p>For example, starting with this index:</p>\r
540 <div class="listingblock">\r
541 <div class="content">\r
542 <pre><tt>$ git ls-files -s\r
543 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz</tt></pre>\r
544 </div></div>\r
545 <p>you can feed the following input to <tt>--index-info</tt>:</p>\r
546 <div class="listingblock">\r
547 <div class="content">\r
548 <pre><tt>$ git update-index --index-info\r
549 0 0000000000000000000000000000000000000000      frotz\r
550 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
551 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</tt></pre>\r
552 </div></div>\r
553 <p>The first line of the input feeds 0 as the mode to remove the\r
554 path; the SHA1 does not matter as long as it is well formatted.\r
555 Then the second and third line feeds stage 1 and stage 2 entries\r
556 for that path.  After the above, we would end up with this:</p>\r
557 <div class="listingblock">\r
558 <div class="content">\r
559 <pre><tt>$ git ls-files -s\r
560 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
561 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</tt></pre>\r
562 </div></div>\r
563 </div>\r
564 <h2>Using "assume unchanged" bit</h2>\r
565 <div class="sectionbody">\r
566 <p>Many operations in git depend on your filesystem to have an\r
567 efficient <tt>lstat(2)</tt> implementation, so that <tt>st_mtime</tt>\r
568 information for working tree files can be cheaply checked to see\r
569 if the file contents have changed from the version recorded in\r
570 the index file.  Unfortunately, some filesystems have\r
571 inefficient <tt>lstat(2)</tt>.  If your filesystem is one of them, you\r
572 can set "assume unchanged" bit to paths you have not changed to\r
573 cause git not to do this check.  Note that setting this bit on a\r
574 path does not mean git will check the contents of the file to\r
575 see if it has changed &#8212; it makes git to omit any checking and\r
576 assume it has <strong>not</strong> changed.  When you make changes to working\r
577 tree files, you have to explicitly tell git about it by dropping\r
578 "assume unchanged" bit, either before or after you modify them.</p>\r
579 <p>In order to set "assume unchanged" bit, use <tt>--assume-unchanged</tt>\r
580 option.  To unset, use <tt>--no-assume-unchanged</tt>.</p>\r
581 <p>The command looks at <tt>core.ignorestat</tt> configuration variable.  When\r
582 this is true, paths updated with <tt>git-update-index paths&#8230;</tt> and\r
583 paths updated with other git commands that update both index and\r
584 working tree (e.g. <tt>git-apply --index</tt>, <tt>git-checkout-index -u</tt>,\r
585 and <tt>git-read-tree -u</tt>) are automatically marked as "assume\r
586 unchanged".  Note that "assume unchanged" bit is <strong>not</strong> set if\r
587 <tt>git-update-index --refresh</tt> finds the working tree file matches\r
588 the index (use <tt>git-update-index --really-refresh</tt> if you want\r
589 to mark them as "assume unchanged").</p>\r
590 </div>\r
591 <h2>Examples</h2>\r
592 <div class="sectionbody">\r
593 <p>To update and refresh only the files already checked out:</p>\r
594 <div class="listingblock">\r
595 <div class="content">\r
596 <pre><tt>$ git-checkout-index -n -f -a &amp;&amp; git-update-index --ignore-missing --refresh</tt></pre>\r
597 </div></div>\r
598 <p>On an inefficient filesystem with <tt>core.ignorestat</tt> set:</p>\r
599 <div class="listingblock">\r
600 <div class="content">\r
601 <pre><tt>$ git update-index --really-refresh <b>(1)</b>\r
602 $ git update-index --no-assume-unchanged foo.c <b>(2)</b>\r
603 $ git diff --name-only <b>(3)</b>\r
604 $ edit foo.c\r
605 $ git diff --name-only <b>(4)</b>\r
606 M foo.c\r
607 $ git update-index foo.c <b>(5)</b>\r
608 $ git diff --name-only <b>(6)</b>\r
609 $ edit foo.c\r
610 $ git diff --name-only <b>(7)</b>\r
611 $ git update-index --no-assume-unchanged foo.c <b>(8)</b>\r
612 $ git diff --name-only <b>(9)</b>\r
613 M foo.c\r
614 \r
615 <b>(1)</b> forces lstat(2) to set "assume unchanged" bits for paths\r
616     that match index.\r
617 <b>(2)</b> mark the path to be edited.\r
618 <b>(3)</b> this does lstat(2) and finds index matches the path.\r
619 <b>(4)</b> this does lstat(2) and finds index does not match the path.\r
620 <b>(5)</b> registering the new version to index sets "assume unchanged" bit.\r
621 <b>(6)</b> and it is assumed unchanged.\r
622 <b>(7)</b> even after you edit it.\r
623 <b>(8)</b> you can tell about the change after the fact.\r
624 <b>(9)</b> now it checks with lstat(2) and finds it has been changed.</tt></pre>\r
625 </div></div>\r
626 </div>\r
627 <h2>Configuration</h2>\r
628 <div class="sectionbody">\r
629 <p>The command honors <tt>core.filemode</tt> configuration variable.  If\r
630 your repository is on an filesystem whose executable bits are\r
631 unreliable, this should be set to <em>false</em> (see <a href="git-repo-config.html">git-repo-config(1)</a>).\r
632 This causes the command to ignore differences in file modes recorded\r
633 in the index and the file mode on the filesystem if they differ only on\r
634 executable bit.   On such an unfortunate filesystem, you may\r
635 need to use <tt>git-update-index --chmod=</tt>.</p>\r
636 <p>The command looks at <tt>core.ignorestat</tt> configuration variable.  See\r
637 <em>Using "assume unchanged" bit</em> section above.</p>\r
638 </div>\r
639 <h2>See Also</h2>\r
640 <div class="sectionbody">\r
641 <p><a href="git-repo-config.html">git-repo-config(1)</a></p>\r
642 </div>\r
643 <h2>Author</h2>\r
644 <div class="sectionbody">\r
645 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
646 </div>\r
647 <h2>Documentation</h2>\r
648 <div class="sectionbody">\r
649 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
650 </div>\r
651 <h2>GIT</h2>\r
652 <div class="sectionbody">\r
653 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
654 </div>\r
655 <div id="footer">\r
656 <div id="footer-text">\r
657 Last updated 22-Feb-2006 10:44:48 UTC\r
658 </div>\r
659 </div>\r
660 </body>\r
661 </html>\r