| blob | fc01ee4878541dbfc7c5c2565ec160ba9c28055a |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-update-index(1) Manual Page
407 </h1>
410 <p>git-update-index -
411 Register file contents in the working tree to the index
412 </p>
413 </div>
414 </div>
419 [--add] [--remove | --force-remove] [--replace]
420 [--refresh] [-q] [--unmerged] [--ignore-missing]
422 [--chmod=(+|-)x]
423 [--assume-unchanged | --no-assume-unchanged]
424 [--skip-worktree | --no-skip-worktree]
425 [--ignore-submodules]
426 [--really-refresh] [--unresolve] [--again | -g]
427 [--info-only] [--index-info]
428 [-z] [--stdin]
429 [--verbose]
432 </div></div>
433 </div>
438 cleared.</p></div>
439 <div class="paragraph"><p>See also <a href="git-add.html">git-add(1)</a> for a more user-friendly way to do some of
440 the most common operations on the index.</p></div>
441 <div class="paragraph"><p>The way <em>git update-index</em> handles files it is told about can be modified
442 using the various options:</p></div>
443 </div>
448 --add
449 </dt>
450 <dd>
451 <p>
453 added.
454 Default behaviour is to ignore new files.
455 </p>
456 </dd>
458 --remove
459 </dt>
460 <dd>
461 <p>
462 If a specified file is in the index but is missing then it’s
463 removed.
464 Default behavior is to ignore removed file.
465 </p>
466 </dd>
468 --refresh
469 </dt>
470 <dd>
471 <p>
472 Looks at the current index and checks to see if merges or
473 updates are needed by checking stat() information.
474 </p>
475 </dd>
477 -q
478 </dt>
479 <dd>
480 <p>
481 Quiet. If --refresh finds that the index needs an update, the
482 default behavior is to error out. This option makes
484 </p>
485 </dd>
487 --ignore-submodules
488 </dt>
489 <dd>
490 <p>
491 Do not try to update submodules. This option is only respected
492 when passed before --refresh.
493 </p>
494 </dd>
496 --unmerged
497 </dt>
498 <dd>
499 <p>
500 If --refresh finds unmerged changes in the index, the default
502 continue anyway.
503 </p>
504 </dd>
506 --ignore-missing
507 </dt>
508 <dd>
509 <p>
510 Ignores missing files during a --refresh
511 </p>
512 </dd>
515 </dt>
516 <dd>
517 <p>
518 Directly insert the specified info into the index.
519 </p>
520 </dd>
522 --index-info
523 </dt>
524 <dd>
525 <p>
526 Read index information from stdin.
527 </p>
528 </dd>
530 --chmod=(+|-)x
531 </dt>
532 <dd>
533 <p>
534 Set the execute permissions on the updated files.
535 </p>
536 </dd>
538 --assume-unchanged
539 </dt>
541 --no-assume-unchanged
542 </dt>
543 <dd>
544 <p>
545 When these flags are specified, the object names recorded
546 for the paths are not updated. Instead, these options
547 set and unset the "assume unchanged" bit for the
548 paths. When the "assume unchanged" bit is on, git stops
549 checking the working tree files for possible
550 modifications, so you need to manually unset the bit to
551 tell git when you change the working tree file. This is
552 sometimes helpful when working with a big project on a
553 filesystem that has very slow lstat(2) system call
554 (e.g. cifs).
555 </p>
557 to ignore uncommitted changes in tracked files (akin to what
559 Git will fail (gracefully) in case it needs to modify this file
560 in the index e.g. when merging in a commit;
561 thus, in case the assumed-untracked file is changed upstream,
562 you will need to handle the situation manually.</p></div>
563 </dd>
565 --really-refresh
566 </dt>
567 <dd>
568 <p>
570 without regard to the "assume unchanged" setting.
571 </p>
572 </dd>
574 --skip-worktree
575 </dt>
577 --no-skip-worktree
578 </dt>
579 <dd>
580 <p>
581 When one of these flags is specified, the object name recorded
582 for the paths are not updated. Instead, these options
583 set and unset the "skip-worktree" bit for the paths. See
584 section "Skip-worktree bit" below for more information.
585 </p>
586 </dd>
588 -g
589 </dt>
591 --again
592 </dt>
593 <dd>
594 <p>
597 </p>
598 </dd>
600 --unresolve
601 </dt>
602 <dd>
603 <p>
605 file during a merge if it was cleared by accident.
606 </p>
607 </dd>
609 --info-only
610 </dt>
611 <dd>
612 <p>
613 Do not create objects in the object database for all
615 their object IDs into the index.
616 </p>
617 </dd>
619 --force-remove
620 </dt>
621 <dd>
622 <p>
623 Remove the file from the index even when the working directory
624 still has such a file. (Implies --remove.)
625 </p>
626 </dd>
628 --replace
629 </dt>
630 <dd>
631 <p>
635 cannot be added. With --replace flag, existing entries
636 that conflict with the entry being added are
637 automatically removed with warning messages.
638 </p>
639 </dd>
641 --stdin
642 </dt>
643 <dd>
644 <p>
645 Instead of taking list of paths from the command line,
646 read list of paths from the standard input. Paths are
647 separated by LF (i.e. one path per line) by default.
648 </p>
649 </dd>
651 --verbose
652 </dt>
653 <dd>
654 <p>
655 Report what is being added and removed from index.
656 </p>
657 </dd>
659 -z
660 </dt>
661 <dd>
662 <p>
664 separated with NUL character instead of LF.
665 </p>
666 </dd>
668 --
669 </dt>
670 <dd>
671 <p>
672 Do not interpret any more arguments as options.
673 </p>
674 </dd>
677 </dt>
678 <dd>
679 <p>
680 Files to act on.
683 cleaner names.
685 </p>
686 </dd>
687 </dl></div>
688 </div>
691 <div class="paragraph"><p><em>--refresh</em> does not calculate a new sha1 file or bring the index
693 "re-match" the stat information of a file with the index, so that you
694 can refresh the index for a file that hasn’t been changed but where
695 the stat entry is out of date.</p></div>
696 <div class="paragraph"><p>For example, you’d want to do this after doing a <em>git read-tree</em>, to link
697 up the stat index details with the proper files.</p></div>
698 </div>
702 current working directory. This is useful for minimum-checkout
703 merging.</p></div>
708 </div></div>
709 <div class="paragraph"><p><em>--info-only</em> is used to register files without placing them in the object
710 database. This is useful for status-only repositories.</p></div>
711 <div class="paragraph"><p>Both <em>--cacheinfo</em> and <em>--info-only</em> behave similarly: the index is updated
714 useful when the file is available, but you do not wish to update the
715 object database.</p></div>
716 </div>
720 multiple entry definitions from the standard input, and designed
721 specifically for scripts. It can take inputs of three formats:</p></div>
723 <li>
724 <p>
725 mode SP sha1 TAB path
726 </p>
728 reports, and used to reconstruct a partial tree
729 that is used for phony merge base tree when falling
731 </li>
732 <li>
733 <p>
734 mode SP type SP sha1 TAB path
735 </p>
737 into the index file.</p></div>
738 </li>
739 <li>
740 <p>
741 mode SP sha1 SP stage TAB path
742 </p>
745 </li>
746 </ol></div>
748 first be removed by feeding a mode=0 entry for the path, and
749 then feeding necessary input lines in the third format.</p></div>
753 <pre><tt>$ git ls-files -s
755 </div></div>
759 <pre><tt>$ git update-index --index-info
760 0 0000000000000000000000000000000000000000 frotz
763 </div></div>
765 path; the SHA1 does not matter as long as it is well formatted.
767 for that path. After the above, we would end up with this:</p></div>
770 <pre><tt>$ git ls-files -s
773 </div></div>
774 </div>
779 information for working tree files can be cheaply checked to see
780 if the file contents have changed from the version recorded in
781 the index file. Unfortunately, some filesystems have
783 can set "assume unchanged" bit to paths you have not changed to
784 cause git not to do this check. Note that setting this bit on a
785 path does not mean git will check the contents of the file to
786 see if it has changed — it makes git to omit any checking and
788 tree files, you have to explicitly tell git about it by dropping
790 <div class="paragraph"><p>In order to set "assume unchanged" bit, use <tt>--assume-unchanged</tt>
792 <div class="paragraph"><p>The command looks at <tt>core.ignorestat</tt> configuration variable. When
794 paths updated with other git commands that update both index and
801 </div>
807 <pre><tt>$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh</tt></pre>
808 </div></div>
812 </dt>
813 <dd>
819 $ edit foo.c
821 M foo.c
824 $ edit foo.c
828 M foo.c</tt></pre>
829 </div></div>
831 <li>
832 <p>
834 </p>
835 </li>
836 <li>
837 <p>
838 mark the path to be edited.
839 </p>
840 </li>
841 <li>
842 <p>
843 this does lstat(2) and finds index matches the path.
844 </p>
845 </li>
846 <li>
847 <p>
849 </p>
850 </li>
851 <li>
852 <p>
853 registering the new version to index sets "assume unchanged" bit.
854 </p>
855 </li>
856 <li>
857 <p>
858 and it is assumed unchanged.
859 </p>
860 </li>
861 <li>
862 <p>
863 even after you edit it.
864 </p>
865 </li>
866 <li>
867 <p>
868 you can tell about the change after the fact.
869 </p>
870 </li>
871 <li>
872 <p>
873 now it checks with lstat(2) and finds it has been changed.
874 </p>
875 </li>
876 </ol></div>
877 </dd>
878 </dl></div>
879 </div>
883 an entry, if it is marked as skip-worktree, then Git pretends its
884 working directory version is up to date and read the index version
885 instead.</p></div>
887 file attributes or file content. The working directory version may be
888 present or absent. If present, its content may match against the index
889 version or not. Writing is not affected by this bit, content safety
891 file, that is marked skip-worktree, if it is safe to do so (i.e.
892 working directory version matches index version)</p></div>
894 different from assume-unchanged bit’s. Skip-worktree also takes
895 precedence over assume-unchanged bit when both are set.</p></div>
896 </div>
900 your repository is on a filesystem whose executable bits are
901 unreliable, this should be set to <em>false</em> (see <a href="git-config.html">git-config(1)</a>).
902 This causes the command to ignore differences in file modes recorded
903 in the index and the file mode on the filesystem if they differ only on
904 executable bit. On such an unfortunate filesystem, you may
906 <div class="paragraph"><p>Quite similarly, if <tt>core.symlinks</tt> configuration variable is set
907 to <em>false</em> (see <a href="git-config.html">git-config(1)</a>), symbolic links are checked out
908 as plain files, and this command does not modify a recorded file mode
909 from symbolic link to regular file.</p></div>
910 <div class="paragraph"><p>The command looks at <tt>core.ignorestat</tt> configuration variable. See
912 <div class="paragraph"><p>The command also looks at <tt>core.trustctime</tt> configuration variable.
913 It can be useful when the inode change time is regularly modified by
914 something outside Git (file system crawlers and backup systems use
916 </div>
921 </div>
925 </div>
929 </div>
930 </div>
931 </body>
932 </html>