]>
Commit | Line | Data |
---|---|---|
215a7ad1 | 1 | git-update-index(1) |
2cf565c5 | 2 | =================== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
215a7ad1 | 6 | git-update-index - Modifies the index or directory cache |
2cf565c5 DG |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
215a7ad1 | 11 | 'git-update-index' |
14470c0d CS |
12 | [--add] [--remove | --force-remove] [--replace] |
13 | [--refresh [-q] [--unmerged] [--ignore-missing]] | |
2cf565c5 | 14 | [--cacheinfo <mode> <object> <file>]\* |
5773c9f2 | 15 | [--chmod=(+|-)x] |
14470c0d CS |
16 | [--info-only] [--index-info] |
17 | [-z] [--stdin] | |
18 | [--verbose] | |
2cf565c5 DG |
19 | [--] [<file>]\* |
20 | ||
21 | DESCRIPTION | |
22 | ----------- | |
23 | Modifies the index or directory cache. Each file mentioned is updated | |
5f3aa197 | 24 | into the index and any 'unmerged' or 'needs updating' state is |
2cf565c5 DG |
25 | cleared. |
26 | ||
215a7ad1 | 27 | The way "git-update-index" handles files it is told about can be modified |
2cf565c5 DG |
28 | using the various options: |
29 | ||
30 | OPTIONS | |
31 | ------- | |
32 | --add:: | |
5f3aa197 | 33 | If a specified file isn't in the index already then it's |
2cf565c5 DG |
34 | added. |
35 | Default behaviour is to ignore new files. | |
36 | ||
37 | --remove:: | |
5f3aa197 | 38 | If a specified file is in the index but is missing then it's |
2cf565c5 DG |
39 | removed. |
40 | Default behaviour is to ignore removed file. | |
41 | ||
42 | --refresh:: | |
5f3aa197 | 43 | Looks at the current index and checks to see if merges or |
2cf565c5 DG |
44 | updates are needed by checking stat() information. |
45 | ||
14470c0d | 46 | -q:: |
5f3aa197 | 47 | Quiet. If --refresh finds that the index needs an update, the |
14470c0d CS |
48 | default behavior is to error out. This option makes |
49 | git-update-index continue anyway. | |
50 | ||
51 | --unmerged:: | |
5f3aa197 | 52 | If --refresh finds unmerged changes in the index, the default |
14470c0d CS |
53 | behavior is to error out. This option makes git-update-index |
54 | continue anyway. | |
55 | ||
2cf565c5 DG |
56 | --ignore-missing:: |
57 | Ignores missing files during a --refresh | |
58 | ||
59 | --cacheinfo <mode> <object> <path>:: | |
5f3aa197 | 60 | Directly insert the specified info into the index. |
2cf565c5 | 61 | |
14470c0d CS |
62 | --index-info:: |
63 | Read index info from stdin. | |
64 | ||
65 | --chmod=(+|-)x:: | |
66 | Set the execute permissions on the updated files. | |
67 | ||
df6e1516 BL |
68 | --info-only:: |
69 | Do not create objects in the object database for all | |
70 | <file> arguments that follow this flag; just insert | |
5f3aa197 | 71 | their object IDs into the index. |
df6e1516 | 72 | |
2cf565c5 DG |
73 | --force-remove:: |
74 | Remove the file from the index even when the working directory | |
9b63f501 | 75 | still has such a file. (Implies --remove.) |
2cf565c5 DG |
76 | |
77 | --replace:: | |
78 | By default, when a file `path` exists in the index, | |
215a7ad1 | 79 | git-update-index refuses an attempt to add `path/file`. |
2cf565c5 DG |
80 | Similarly if a file `path/file` exists, a file `path` |
81 | cannot be added. With --replace flag, existing entries | |
82 | that conflicts with the entry being added are | |
83 | automatically removed with warning messages. | |
84 | ||
1f7f99de JH |
85 | --stdin:: |
86 | Instead of taking list of paths from the command line, | |
87 | read list of paths from the standard input. Paths are | |
88 | separated by LF (i.e. one path per line) by default. | |
89 | ||
14470c0d CS |
90 | --verbose:: |
91 | Report what is being added and removed from index. | |
92 | ||
1f7f99de JH |
93 | -z:: |
94 | Only meaningful with `--stdin`; paths are separated with | |
95 | NUL character instead of LF. | |
96 | ||
2cf565c5 DG |
97 | --:: |
98 | Do not interpret any more arguments as options. | |
99 | ||
100 | <file>:: | |
101 | Files to act on. | |
5773c9f2 | 102 | Note that files beginning with '.' are discarded. This includes |
2cf565c5 DG |
103 | `./file` and `dir/./file`. If you don't want this, then use |
104 | cleaner names. | |
105 | The same applies to directories ending '/' and paths with '//' | |
106 | ||
107 | Using --refresh | |
108 | --------------- | |
5f3aa197 | 109 | '--refresh' does not calculate a new sha1 file or bring the index |
2cf565c5 | 110 | up-to-date for mode/content changes. But what it *does* do is to |
5f3aa197 LS |
111 | "re-match" the stat information of a file with the index, so that you |
112 | can refresh the index for a file that hasn't been changed but where | |
2cf565c5 DG |
113 | the stat entry is out of date. |
114 | ||
115 | For example, you'd want to do this after doing a "git-read-tree", to link | |
5f3aa197 | 116 | up the stat index details with the proper files. |
2cf565c5 | 117 | |
df6e1516 BL |
118 | Using --cacheinfo or --info-only |
119 | -------------------------------- | |
120 | '--cacheinfo' is used to register a file that is not in the | |
121 | current working directory. This is useful for minimum-checkout | |
122 | merging. | |
123 | ||
df8baa42 | 124 | To pretend you have a file with mode and sha1 at path, say: |
2cf565c5 | 125 | |
215a7ad1 | 126 | $ git-update-index --cacheinfo mode sha1 path |
2cf565c5 | 127 | |
df6e1516 BL |
128 | '--info-only' is used to register files without placing them in the object |
129 | database. This is useful for status-only repositories. | |
2cf565c5 | 130 | |
df6e1516 BL |
131 | Both '--cacheinfo' and '--info-only' behave similarly: the index is updated |
132 | but the object database isn't. '--cacheinfo' is useful when the object is | |
133 | in the database but the file isn't available locally. '--info-only' is | |
134 | useful when the file is available, but you do not wish to update the | |
135 | object database. | |
136 | ||
137 | Examples | |
138 | -------- | |
2cf565c5 DG |
139 | To update and refresh only the files already checked out: |
140 | ||
215a7ad1 | 141 | git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh |
2cf565c5 DG |
142 | |
143 | ||
5773c9f2 JH |
144 | Configuration |
145 | ------------- | |
146 | ||
147 | The command honors `core.filemode` configuration variable. If | |
148 | your repository is on an filesystem whose executable bits are | |
149 | unreliable, this should be set to 'false'. This causes the | |
150 | command to ignore differences in file modes recorded in the | |
151 | index and the file mode on the filesystem if they differ only on | |
152 | executable bit. On such an unfortunate filesystem, you may | |
153 | need to use `git-update-index --chmod=`. | |
154 | ||
2cf565c5 DG |
155 | Author |
156 | ------ | |
157 | Written by Linus Torvalds <torvalds@osdl.org> | |
158 | ||
159 | Documentation | |
160 | -------------- | |
161 | Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. | |
162 | ||
163 | GIT | |
164 | --- | |
a7154e91 | 165 | Part of the gitlink:git[7] suite |
2cf565c5 | 166 |