]>
Commit | Line | Data |
---|---|---|
215a7ad1 | 1 | git-update-index(1) |
2cf565c5 | 2 | =================== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-update-index - Register file contents in the working tree to the index |
2cf565c5 DG |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
f9666adf | 11 | [verse] |
b1889c36 | 12 | 'git update-index' |
de5f2bf3 MK |
13 | [--add] [--remove | --force-remove] [--replace] |
14 | [--refresh] [-q] [--unmerged] [--ignore-missing] | |
ec160ae1 | 15 | [(--cacheinfo <mode>,<object>,<file>)...] |
5773c9f2 | 16 | [--chmod=(+|-)x] |
0460ed2c FC |
17 | [--[no-]assume-unchanged] |
18 | [--[no-]skip-worktree] | |
5fdeacb0 | 19 | [--ignore-submodules] |
bc497127 | 20 | [--[no-]split-index] |
eaab83d0 | 21 | [--[no-|test-|force-]untracked-cache] |
7099c9c7 | 22 | [--really-refresh] [--unresolve] [--again | -g] |
14470c0d | 23 | [--info-only] [--index-info] |
69dec66b | 24 | [-z] [--stdin] [--index-version <n>] |
14470c0d | 25 | [--verbose] |
0adda936 | 26 | [--] [<file>...] |
2cf565c5 DG |
27 | |
28 | DESCRIPTION | |
29 | ----------- | |
30 | Modifies the index or directory cache. Each file mentioned is updated | |
5f3aa197 | 31 | into the index and any 'unmerged' or 'needs updating' state is |
2cf565c5 DG |
32 | cleared. |
33 | ||
5162e697 | 34 | See also linkgit:git-add[1] for a more user-friendly way to do some of |
e701ccc3 MM |
35 | the most common operations on the index. |
36 | ||
0b444cdb | 37 | The way 'git update-index' handles files it is told about can be modified |
2cf565c5 DG |
38 | using the various options: |
39 | ||
40 | OPTIONS | |
41 | ------- | |
42 | --add:: | |
5f3aa197 | 43 | If a specified file isn't in the index already then it's |
2cf565c5 DG |
44 | added. |
45 | Default behaviour is to ignore new files. | |
46 | ||
47 | --remove:: | |
5f3aa197 | 48 | If a specified file is in the index but is missing then it's |
2cf565c5 | 49 | removed. |
abda1ef5 | 50 | Default behavior is to ignore removed file. |
2cf565c5 DG |
51 | |
52 | --refresh:: | |
5f3aa197 | 53 | Looks at the current index and checks to see if merges or |
2cf565c5 DG |
54 | updates are needed by checking stat() information. |
55 | ||
14470c0d | 56 | -q:: |
5f3aa197 | 57 | Quiet. If --refresh finds that the index needs an update, the |
14470c0d | 58 | default behavior is to error out. This option makes |
0b444cdb | 59 | 'git update-index' continue anyway. |
14470c0d | 60 | |
04c8ce9c | 61 | --ignore-submodules:: |
5fdeacb0 JS |
62 | Do not try to update submodules. This option is only respected |
63 | when passed before --refresh. | |
64 | ||
14470c0d | 65 | --unmerged:: |
5f3aa197 | 66 | If --refresh finds unmerged changes in the index, the default |
0b444cdb | 67 | behavior is to error out. This option makes 'git update-index' |
14470c0d CS |
68 | continue anyway. |
69 | ||
2cf565c5 DG |
70 | --ignore-missing:: |
71 | Ignores missing files during a --refresh | |
72 | ||
ec160ae1 | 73 | --cacheinfo <mode>,<object>,<path>:: |
2cf565c5 | 74 | --cacheinfo <mode> <object> <path>:: |
ec160ae1 JH |
75 | Directly insert the specified info into the index. For |
76 | backward compatibility, you can also give these three | |
77 | arguments as three separate parameters, but new users are | |
78 | encouraged to use a single-parameter form. | |
a6080a0a | 79 | |
14470c0d | 80 | --index-info:: |
7acab8f1 | 81 | Read index information from stdin. |
14470c0d CS |
82 | |
83 | --chmod=(+|-)x:: | |
a6080a0a | 84 | Set the execute permissions on the updated files. |
14470c0d | 85 | |
0460ed2c | 86 | --[no-]assume-unchanged:: |
ccadb25f PO |
87 | When this flag is specified, the object names recorded |
88 | for the paths are not updated. Instead, this option | |
89 | sets/unsets the "assume unchanged" bit for the | |
90 | paths. When the "assume unchanged" bit is on, the user | |
91 | promises not to change the file and allows Git to assume | |
92 | that the working tree file matches what is recorded in | |
93 | the index. If you want to change the working tree file, | |
94 | you need to unset the bit to tell Git. This is | |
f9666adf JH |
95 | sometimes helpful when working with a big project on a |
96 | filesystem that has very slow lstat(2) system call | |
97 | (e.g. cifs). | |
6259ac66 | 98 | + |
6259ac66 PB |
99 | Git will fail (gracefully) in case it needs to modify this file |
100 | in the index e.g. when merging in a commit; | |
101 | thus, in case the assumed-untracked file is changed upstream, | |
102 | you will need to handle the situation manually. | |
f9666adf | 103 | |
466d1f15 | 104 | --really-refresh:: |
bcf9626a | 105 | Like `--refresh`, but checks stat information unconditionally, |
466d1f15 ŠN |
106 | without regard to the "assume unchanged" setting. |
107 | ||
0460ed2c | 108 | --[no-]skip-worktree:: |
44a36913 NTND |
109 | When one of these flags is specified, the object name recorded |
110 | for the paths are not updated. Instead, these options | |
111 | set and unset the "skip-worktree" bit for the paths. See | |
112 | section "Skip-worktree bit" below for more information. | |
113 | ||
3240240f SB |
114 | -g:: |
115 | --again:: | |
0b444cdb | 116 | Runs 'git update-index' itself on the paths whose index |
83e77a25 JH |
117 | entries are different from those from the `HEAD` commit. |
118 | ||
060729dd MK |
119 | --unresolve:: |
120 | Restores the 'unmerged' or 'needs updating' state of a | |
121 | file during a merge if it was cleared by accident. | |
122 | ||
df6e1516 BL |
123 | --info-only:: |
124 | Do not create objects in the object database for all | |
125 | <file> arguments that follow this flag; just insert | |
5f3aa197 | 126 | their object IDs into the index. |
df6e1516 | 127 | |
2cf565c5 DG |
128 | --force-remove:: |
129 | Remove the file from the index even when the working directory | |
9b63f501 | 130 | still has such a file. (Implies --remove.) |
2cf565c5 DG |
131 | |
132 | --replace:: | |
133 | By default, when a file `path` exists in the index, | |
0b444cdb | 134 | 'git update-index' refuses an attempt to add `path/file`. |
2cf565c5 DG |
135 | Similarly if a file `path/file` exists, a file `path` |
136 | cannot be added. With --replace flag, existing entries | |
04c8ce9c | 137 | that conflict with the entry being added are |
2cf565c5 DG |
138 | automatically removed with warning messages. |
139 | ||
1f7f99de JH |
140 | --stdin:: |
141 | Instead of taking list of paths from the command line, | |
142 | read list of paths from the standard input. Paths are | |
143 | separated by LF (i.e. one path per line) by default. | |
144 | ||
14470c0d CS |
145 | --verbose:: |
146 | Report what is being added and removed from index. | |
147 | ||
69dec66b JH |
148 | --index-version <n>:: |
149 | Write the resulting index out in the named on-disk format version. | |
647d8794 NTND |
150 | Supported versions are 2, 3 and 4. The current default version is 2 |
151 | or 3, depending on whether extra features are used, such as | |
152 | `git add -N`. | |
153 | + | |
154 | Version 4 performs a simple pathname compression that reduces index | |
155 | size by 30%-50% on large repositories, which results in faster load | |
156 | time. Version 4 is relatively young (first released in in 1.8.0 in | |
157 | October 2012). Other Git implementations such as JGit and libgit2 | |
158 | may not support it yet. | |
69dec66b | 159 | |
1f7f99de | 160 | -z:: |
537497be BW |
161 | Only meaningful with `--stdin` or `--index-info`; paths are |
162 | separated with NUL character instead of LF. | |
1f7f99de | 163 | |
c18b80a0 NTND |
164 | --split-index:: |
165 | --no-split-index:: | |
166 | Enable or disable split index mode. If enabled, the index is | |
167 | split into two files, $GIT_DIR/index and $GIT_DIR/sharedindex.<SHA-1>. | |
168 | Changes are accumulated in $GIT_DIR/index while the shared | |
169 | index file contains all index entries stays unchanged. If | |
170 | split-index mode is already enabled and `--split-index` is | |
171 | given again, all changes in $GIT_DIR/index are pushed back to | |
172 | the shared index file. This mode is designed for very large | |
f745acb0 | 173 | indexes that take a significant amount of time to read or write. |
c18b80a0 | 174 | |
9e597241 NTND |
175 | --untracked-cache:: |
176 | --no-untracked-cache:: | |
435ec090 CC |
177 | Enable or disable untracked cache feature. Please use |
178 | `--test-untracked-cache` before enabling it. | |
179 | + | |
180 | These options take effect whatever the value of the `core.untrackedCache` | |
181 | configuration variable (see linkgit:git-config[1]). But a warning is | |
182 | emitted when the change goes against the configured value, as the | |
183 | configured value will take effect next time the index is read and this | |
184 | will remove the intended effect of the option. | |
9e597241 | 185 | |
eaab83d0 CC |
186 | --test-untracked-cache:: |
187 | Only perform tests on the working directory to make sure | |
188 | untracked cache can be used. You have to manually enable | |
435ec090 CC |
189 | untracked cache using `--untracked-cache` or |
190 | `--force-untracked-cache` or the `core.untrackedCache` | |
191 | configuration variable afterwards if you really want to use | |
192 | it. If a test fails the exit code is 1 and a message | |
193 | explains what is not working as needed, otherwise the exit | |
194 | code is 0 and OK is printed. | |
eaab83d0 | 195 | |
f64cb88d | 196 | --force-untracked-cache:: |
435ec090 CC |
197 | Same as `--untracked-cache`. Provided for backwards |
198 | compatibility with older versions of Git where | |
199 | `--untracked-cache` used to imply `--test-untracked-cache` but | |
200 | this option would enable the extension unconditionally. | |
f64cb88d | 201 | |
e994004f | 202 | \--:: |
2cf565c5 DG |
203 | Do not interpret any more arguments as options. |
204 | ||
205 | <file>:: | |
206 | Files to act on. | |
5773c9f2 | 207 | Note that files beginning with '.' are discarded. This includes |
a6080a0a | 208 | `./file` and `dir/./file`. If you don't want this, then use |
2cf565c5 DG |
209 | cleaner names. |
210 | The same applies to directories ending '/' and paths with '//' | |
211 | ||
212 | Using --refresh | |
213 | --------------- | |
bcf9626a | 214 | `--refresh` does not calculate a new sha1 file or bring the index |
2cf565c5 | 215 | up-to-date for mode/content changes. But what it *does* do is to |
5f3aa197 LS |
216 | "re-match" the stat information of a file with the index, so that you |
217 | can refresh the index for a file that hasn't been changed but where | |
2cf565c5 DG |
218 | the stat entry is out of date. |
219 | ||
0b444cdb | 220 | For example, you'd want to do this after doing a 'git read-tree', to link |
5f3aa197 | 221 | up the stat index details with the proper files. |
2cf565c5 | 222 | |
df6e1516 BL |
223 | Using --cacheinfo or --info-only |
224 | -------------------------------- | |
bcf9626a | 225 | `--cacheinfo` is used to register a file that is not in the |
df6e1516 BL |
226 | current working directory. This is useful for minimum-checkout |
227 | merging. | |
228 | ||
df8baa42 | 229 | To pretend you have a file with mode and sha1 at path, say: |
2cf565c5 | 230 | |
61f693bd | 231 | ---------------- |
7ac92f64 | 232 | $ git update-index --cacheinfo <mode>,<sha1>,<path> |
61f693bd | 233 | ---------------- |
2cf565c5 | 234 | |
bcf9626a | 235 | `--info-only` is used to register files without placing them in the object |
df6e1516 | 236 | database. This is useful for status-only repositories. |
2cf565c5 | 237 | |
bcf9626a MM |
238 | Both `--cacheinfo` and `--info-only` behave similarly: the index is updated |
239 | but the object database isn't. `--cacheinfo` is useful when the object is | |
240 | in the database but the file isn't available locally. `--info-only` is | |
df6e1516 BL |
241 | useful when the file is available, but you do not wish to update the |
242 | object database. | |
243 | ||
d23748a6 JH |
244 | |
245 | Using --index-info | |
246 | ------------------ | |
247 | ||
248 | `--index-info` is a more powerful mechanism that lets you feed | |
249 | multiple entry definitions from the standard input, and designed | |
250 | specifically for scripts. It can take inputs of three formats: | |
251 | ||
252 | . mode SP sha1 TAB path | |
253 | + | |
254 | The first format is what "git-apply --index-info" | |
255 | reports, and used to reconstruct a partial tree | |
256 | that is used for phony merge base tree when falling | |
257 | back on 3-way merge. | |
258 | ||
259 | . mode SP type SP sha1 TAB path | |
260 | + | |
0b444cdb | 261 | The second format is to stuff 'git ls-tree' output |
d23748a6 JH |
262 | into the index file. |
263 | ||
264 | . mode SP sha1 SP stage TAB path | |
265 | + | |
266 | This format is to put higher order stages into the | |
0b444cdb | 267 | index file and matches 'git ls-files --stage' output. |
d23748a6 JH |
268 | |
269 | To place a higher stage entry to the index, the path should | |
270 | first be removed by feeding a mode=0 entry for the path, and | |
271 | then feeding necessary input lines in the third format. | |
272 | ||
273 | For example, starting with this index: | |
274 | ||
275 | ------------ | |
276 | $ git ls-files -s | |
277 | 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0 frotz | |
278 | ------------ | |
279 | ||
280 | you can feed the following input to `--index-info`: | |
281 | ||
282 | ------------ | |
283 | $ git update-index --index-info | |
284 | 0 0000000000000000000000000000000000000000 frotz | |
285 | 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz | |
286 | 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz | |
287 | ------------ | |
288 | ||
289 | The first line of the input feeds 0 as the mode to remove the | |
d5fa1f1a | 290 | path; the SHA-1 does not matter as long as it is well formatted. |
d23748a6 JH |
291 | Then the second and third line feeds stage 1 and stage 2 entries |
292 | for that path. After the above, we would end up with this: | |
293 | ||
294 | ------------ | |
295 | $ git ls-files -s | |
296 | 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz | |
297 | 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz | |
298 | ------------ | |
299 | ||
300 | ||
bae777db JF |
301 | Using ``assume unchanged'' bit |
302 | ------------------------------ | |
f9666adf | 303 | |
2de9b711 | 304 | Many operations in Git depend on your filesystem to have an |
f9666adf JH |
305 | efficient `lstat(2)` implementation, so that `st_mtime` |
306 | information for working tree files can be cheaply checked to see | |
307 | if the file contents have changed from the version recorded in | |
308 | the index file. Unfortunately, some filesystems have | |
309 | inefficient `lstat(2)`. If your filesystem is one of them, you | |
310 | can set "assume unchanged" bit to paths you have not changed to | |
2de9b711 TA |
311 | cause Git not to do this check. Note that setting this bit on a |
312 | path does not mean Git will check the contents of the file to | |
313 | see if it has changed -- it makes Git to omit any checking and | |
f9666adf | 314 | assume it has *not* changed. When you make changes to working |
2de9b711 | 315 | tree files, you have to explicitly tell Git about it by dropping |
f9666adf JH |
316 | "assume unchanged" bit, either before or after you modify them. |
317 | ||
318 | In order to set "assume unchanged" bit, use `--assume-unchanged` | |
acd6d7e7 SN |
319 | option. To unset, use `--no-assume-unchanged`. To see which files |
320 | have the "assume unchanged" bit set, use `git ls-files -v` | |
321 | (see linkgit:git-ls-files[1]). | |
f9666adf JH |
322 | |
323 | The command looks at `core.ignorestat` configuration variable. When | |
b1889c36 | 324 | this is true, paths updated with `git update-index paths...` and |
2de9b711 | 325 | paths updated with other Git commands that update both index and |
0b444cdb TR |
326 | working tree (e.g. 'git apply --index', 'git checkout-index -u', |
327 | and 'git read-tree -u') are automatically marked as "assume | |
f9666adf | 328 | unchanged". Note that "assume unchanged" bit is *not* set if |
b1889c36 JN |
329 | `git update-index --refresh` finds the working tree file matches |
330 | the index (use `git update-index --really-refresh` if you want | |
f9666adf JH |
331 | to mark them as "assume unchanged"). |
332 | ||
333 | ||
df6e1516 BL |
334 | Examples |
335 | -------- | |
2cf565c5 DG |
336 | To update and refresh only the files already checked out: |
337 | ||
61f693bd | 338 | ---------------- |
b1889c36 | 339 | $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh |
61f693bd | 340 | ---------------- |
2cf565c5 | 341 | |
48aeecdc SE |
342 | On an inefficient filesystem with `core.ignorestat` set:: |
343 | + | |
f9666adf | 344 | ------------ |
48aeecdc SE |
345 | $ git update-index --really-refresh <1> |
346 | $ git update-index --no-assume-unchanged foo.c <2> | |
347 | $ git diff --name-only <3> | |
f9666adf | 348 | $ edit foo.c |
48aeecdc | 349 | $ git diff --name-only <4> |
f9666adf | 350 | M foo.c |
48aeecdc SE |
351 | $ git update-index foo.c <5> |
352 | $ git diff --name-only <6> | |
f9666adf | 353 | $ edit foo.c |
48aeecdc SE |
354 | $ git diff --name-only <7> |
355 | $ git update-index --no-assume-unchanged foo.c <8> | |
356 | $ git diff --name-only <9> | |
f9666adf | 357 | M foo.c |
48aeecdc SE |
358 | ------------ |
359 | + | |
360 | <1> forces lstat(2) to set "assume unchanged" bits for paths that match index. | |
f9666adf JH |
361 | <2> mark the path to be edited. |
362 | <3> this does lstat(2) and finds index matches the path. | |
48aeecdc | 363 | <4> this does lstat(2) and finds index does *not* match the path. |
f9666adf JH |
364 | <5> registering the new version to index sets "assume unchanged" bit. |
365 | <6> and it is assumed unchanged. | |
366 | <7> even after you edit it. | |
367 | <8> you can tell about the change after the fact. | |
368 | <9> now it checks with lstat(2) and finds it has been changed. | |
f9666adf | 369 | |
2cf565c5 | 370 | |
44a36913 NTND |
371 | Skip-worktree bit |
372 | ----------------- | |
373 | ||
374 | Skip-worktree bit can be defined in one (long) sentence: When reading | |
375 | an entry, if it is marked as skip-worktree, then Git pretends its | |
376 | working directory version is up to date and read the index version | |
377 | instead. | |
378 | ||
379 | To elaborate, "reading" means checking for file existence, reading | |
380 | file attributes or file content. The working directory version may be | |
381 | present or absent. If present, its content may match against the index | |
382 | version or not. Writing is not affected by this bit, content safety | |
383 | is still first priority. Note that Git _can_ update working directory | |
384 | file, that is marked skip-worktree, if it is safe to do so (i.e. | |
385 | working directory version matches index version) | |
386 | ||
387 | Although this bit looks similar to assume-unchanged bit, its goal is | |
388 | different from assume-unchanged bit's. Skip-worktree also takes | |
389 | precedence over assume-unchanged bit when both are set. | |
390 | ||
435ec090 CC |
391 | Untracked cache |
392 | --------------- | |
393 | ||
394 | This cache is meant to speed up commands that involve determining | |
395 | untracked files such as `git status`. | |
396 | ||
397 | This feature works by recording the mtime of the working tree | |
398 | directories and then omitting reading directories and stat calls | |
399 | against files in those directories whose mtime hasn't changed. For | |
400 | this to work the underlying operating system and file system must | |
401 | change the `st_mtime` field of directories if files in the directory | |
402 | are added, modified or deleted. | |
403 | ||
404 | You can test whether the filesystem supports that with the | |
405 | `--test-untracked-cache` option. The `--untracked-cache` option used | |
406 | to implicitly perform that test in older versions of Git, but that's | |
407 | no longer the case. | |
408 | ||
409 | If you want to enable (or disable) this feature, it is easier to use | |
410 | the `core.untrackedCache` configuration variable (see | |
411 | linkgit:git-config[1]) than using the `--untracked-cache` option to | |
412 | `git update-index` in each repository, especially if you want to do so | |
413 | across all repositories you use, because you can set the configuration | |
414 | variable to `true` (or `false`) in your `$HOME/.gitconfig` just once | |
415 | and have it affect all repositories you touch. | |
416 | ||
417 | When the `core.untrackedCache` configuration variable is changed, the | |
418 | untracked cache is added to or removed from the index the next time a | |
419 | command reads the index; while when `--[no-|force-]untracked-cache` | |
420 | are used, the untracked cache is immediately added to or removed from | |
421 | the index. | |
44a36913 | 422 | |
5773c9f2 JH |
423 | Configuration |
424 | ------------- | |
425 | ||
426 | The command honors `core.filemode` configuration variable. If | |
466d1f15 | 427 | your repository is on a filesystem whose executable bits are |
5162e697 | 428 | unreliable, this should be set to 'false' (see linkgit:git-config[1]). |
61f693bd JL |
429 | This causes the command to ignore differences in file modes recorded |
430 | in the index and the file mode on the filesystem if they differ only on | |
5773c9f2 | 431 | executable bit. On such an unfortunate filesystem, you may |
0b444cdb | 432 | need to use 'git update-index --chmod='. |
5773c9f2 | 433 | |
78a8d641 | 434 | Quite similarly, if `core.symlinks` configuration variable is set |
5162e697 | 435 | to 'false' (see linkgit:git-config[1]), symbolic links are checked out |
78a8d641 JS |
436 | as plain files, and this command does not modify a recorded file mode |
437 | from symbolic link to regular file. | |
438 | ||
f9666adf JH |
439 | The command looks at `core.ignorestat` configuration variable. See |
440 | 'Using "assume unchanged" bit' section above. | |
441 | ||
1ce4790b AR |
442 | The command also looks at `core.trustctime` configuration variable. |
443 | It can be useful when the inode change time is regularly modified by | |
444 | something outside Git (file system crawlers and backup systems use | |
445 | ctime for marking files processed) (see linkgit:git-config[1]). | |
446 | ||
435ec090 CC |
447 | The untracked cache extension can be enabled by the |
448 | `core.untrackedCache` configuration variable (see | |
449 | linkgit:git-config[1]). | |
61f693bd | 450 | |
56ae8df5 | 451 | SEE ALSO |
61f693bd | 452 | -------- |
5162e697 | 453 | linkgit:git-config[1], |
acd6d7e7 SN |
454 | linkgit:git-add[1], |
455 | linkgit:git-ls-files[1] | |
61f693bd | 456 | |
2cf565c5 DG |
457 | GIT |
458 | --- | |
9e1f0a85 | 459 | Part of the linkgit:git[1] suite |