update-index: list supported idx versions and their features
[git/jnareb-git.git] / Documentation / git-update-index.txt
blobdd36d1328554840d2f90739db11ad33b4a677a7e
1 git-update-index(1)
2 ===================
4 NAME
5 ----
6 git-update-index - Register file contents in the working tree to the index
9 SYNOPSIS
10 --------
11 [verse]
12 'git update-index'
13              [--add] [--remove | --force-remove] [--replace]
14              [--refresh] [-q] [--unmerged] [--ignore-missing]
15              [(--cacheinfo <mode> <object> <file>)...]
16              [--chmod=(+|-)x]
17              [--assume-unchanged | --no-assume-unchanged]
18              [--skip-worktree | --no-skip-worktree]
19              [--ignore-submodules]
20              [--really-refresh] [--unresolve] [--again | -g]
21              [--info-only] [--index-info]
22              [-z] [--stdin] [--index-version <n>]
23              [--verbose]
24              [--] [<file>...]
26 DESCRIPTION
27 -----------
28 Modifies the index or directory cache. Each file mentioned is updated
29 into the index and any 'unmerged' or 'needs updating' state is
30 cleared.
32 See also linkgit:git-add[1] for a more user-friendly way to do some of
33 the most common operations on the index.
35 The way 'git update-index' handles files it is told about can be modified
36 using the various options:
38 OPTIONS
39 -------
40 --add::
41         If a specified file isn't in the index already then it's
42         added.
43         Default behaviour is to ignore new files.
45 --remove::
46         If a specified file is in the index but is missing then it's
47         removed.
48         Default behavior is to ignore removed file.
50 --refresh::
51         Looks at the current index and checks to see if merges or
52         updates are needed by checking stat() information.
54 -q::
55         Quiet.  If --refresh finds that the index needs an update, the
56         default behavior is to error out.  This option makes
57         'git update-index' continue anyway.
59 --ignore-submodules::
60         Do not try to update submodules.  This option is only respected
61         when passed before --refresh.
63 --unmerged::
64         If --refresh finds unmerged changes in the index, the default
65         behavior is to error out.  This option makes 'git update-index'
66         continue anyway.
68 --ignore-missing::
69         Ignores missing files during a --refresh
71 --cacheinfo <mode> <object> <path>::
72         Directly insert the specified info into the index.
74 --index-info::
75         Read index information from stdin.
77 --chmod=(+|-)x::
78         Set the execute permissions on the updated files.
80 --assume-unchanged::
81 --no-assume-unchanged::
82         When these flags are specified, the object names recorded
83         for the paths are not updated.  Instead, these options
84         set and unset the "assume unchanged" bit for the
85         paths.  When the "assume unchanged" bit is on, git stops
86         checking the working tree files for possible
87         modifications, so you need to manually unset the bit to
88         tell git when you change the working tree file. This is
89         sometimes helpful when working with a big project on a
90         filesystem that has very slow lstat(2) system call
91         (e.g. cifs).
93 This option can be also used as a coarse file-level mechanism
94 to ignore uncommitted changes in tracked files (akin to what
95 `.gitignore` does for untracked files).
96 Git will fail (gracefully) in case it needs to modify this file
97 in the index e.g. when merging in a commit;
98 thus, in case the assumed-untracked file is changed upstream,
99 you will need to handle the situation manually.
101 --really-refresh::
102         Like '--refresh', but checks stat information unconditionally,
103         without regard to the "assume unchanged" setting.
105 --skip-worktree::
106 --no-skip-worktree::
107         When one of these flags is specified, the object name recorded
108         for the paths are not updated. Instead, these options
109         set and unset the "skip-worktree" bit for the paths. See
110         section "Skip-worktree bit" below for more information.
112 -g::
113 --again::
114         Runs 'git update-index' itself on the paths whose index
115         entries are different from those from the `HEAD` commit.
117 --unresolve::
118         Restores the 'unmerged' or 'needs updating' state of a
119         file during a merge if it was cleared by accident.
121 --info-only::
122         Do not create objects in the object database for all
123         <file> arguments that follow this flag; just insert
124         their object IDs into the index.
126 --force-remove::
127         Remove the file from the index even when the working directory
128         still has such a file. (Implies --remove.)
130 --replace::
131         By default, when a file `path` exists in the index,
132         'git update-index' refuses an attempt to add `path/file`.
133         Similarly if a file `path/file` exists, a file `path`
134         cannot be added.  With --replace flag, existing entries
135         that conflict with the entry being added are
136         automatically removed with warning messages.
138 --stdin::
139         Instead of taking list of paths from the command line,
140         read list of paths from the standard input.  Paths are
141         separated by LF (i.e. one path per line) by default.
143 --verbose::
144         Report what is being added and removed from index.
146 --index-version <n>::
147         Write the resulting index out in the named on-disk format version.
148         Supported versions are 2, 3 and 4. The current default version is 2
149         or 3, depending on whether extra features are used, such as
150         `git add -N`.
152 Version 4 performs a simple pathname compression that reduces index
153 size by 30%-50% on large repositories, which results in faster load
154 time. Version 4 is relatively young (first released in in 1.8.0 in
155 October 2012). Other Git implementations such as JGit and libgit2
156 may not support it yet.
158 -z::
159         Only meaningful with `--stdin` or `--index-info`; paths are
160         separated with NUL character instead of LF.
162 \--::
163         Do not interpret any more arguments as options.
165 <file>::
166         Files to act on.
167         Note that files beginning with '.' are discarded. This includes
168         `./file` and `dir/./file`. If you don't want this, then use
169         cleaner names.
170         The same applies to directories ending '/' and paths with '//'
172 Using --refresh
173 ---------------
174 '--refresh' does not calculate a new sha1 file or bring the index
175 up-to-date for mode/content changes. But what it *does* do is to
176 "re-match" the stat information of a file with the index, so that you
177 can refresh the index for a file that hasn't been changed but where
178 the stat entry is out of date.
180 For example, you'd want to do this after doing a 'git read-tree', to link
181 up the stat index details with the proper files.
183 Using --cacheinfo or --info-only
184 --------------------------------
185 '--cacheinfo' is used to register a file that is not in the
186 current working directory.  This is useful for minimum-checkout
187 merging.
189 To pretend you have a file with mode and sha1 at path, say:
191 ----------------
192 $ git update-index --cacheinfo mode sha1 path
193 ----------------
195 '--info-only' is used to register files without placing them in the object
196 database.  This is useful for status-only repositories.
198 Both '--cacheinfo' and '--info-only' behave similarly: the index is updated
199 but the object database isn't.  '--cacheinfo' is useful when the object is
200 in the database but the file isn't available locally.  '--info-only' is
201 useful when the file is available, but you do not wish to update the
202 object database.
205 Using --index-info
206 ------------------
208 `--index-info` is a more powerful mechanism that lets you feed
209 multiple entry definitions from the standard input, and designed
210 specifically for scripts.  It can take inputs of three formats:
212     . mode         SP sha1          TAB path
214 The first format is what "git-apply --index-info"
215 reports, and used to reconstruct a partial tree
216 that is used for phony merge base tree when falling
217 back on 3-way merge.
219     . mode SP type SP sha1          TAB path
221 The second format is to stuff 'git ls-tree' output
222 into the index file.
224     . mode         SP sha1 SP stage TAB path
226 This format is to put higher order stages into the
227 index file and matches 'git ls-files --stage' output.
229 To place a higher stage entry to the index, the path should
230 first be removed by feeding a mode=0 entry for the path, and
231 then feeding necessary input lines in the third format.
233 For example, starting with this index:
235 ------------
236 $ git ls-files -s
237 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz
238 ------------
240 you can feed the following input to `--index-info`:
242 ------------
243 $ git update-index --index-info
244 0 0000000000000000000000000000000000000000      frotz
245 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
246 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
247 ------------
249 The first line of the input feeds 0 as the mode to remove the
250 path; the SHA1 does not matter as long as it is well formatted.
251 Then the second and third line feeds stage 1 and stage 2 entries
252 for that path.  After the above, we would end up with this:
254 ------------
255 $ git ls-files -s
256 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
257 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
258 ------------
261 Using ``assume unchanged'' bit
262 ------------------------------
264 Many operations in git depend on your filesystem to have an
265 efficient `lstat(2)` implementation, so that `st_mtime`
266 information for working tree files can be cheaply checked to see
267 if the file contents have changed from the version recorded in
268 the index file.  Unfortunately, some filesystems have
269 inefficient `lstat(2)`.  If your filesystem is one of them, you
270 can set "assume unchanged" bit to paths you have not changed to
271 cause git not to do this check.  Note that setting this bit on a
272 path does not mean git will check the contents of the file to
273 see if it has changed -- it makes git to omit any checking and
274 assume it has *not* changed.  When you make changes to working
275 tree files, you have to explicitly tell git about it by dropping
276 "assume unchanged" bit, either before or after you modify them.
278 In order to set "assume unchanged" bit, use `--assume-unchanged`
279 option.  To unset, use `--no-assume-unchanged`. To see which files
280 have the "assume unchanged" bit set, use `git ls-files -v`
281 (see linkgit:git-ls-files[1]).
283 The command looks at `core.ignorestat` configuration variable.  When
284 this is true, paths updated with `git update-index paths...` and
285 paths updated with other git commands that update both index and
286 working tree (e.g. 'git apply --index', 'git checkout-index -u',
287 and 'git read-tree -u') are automatically marked as "assume
288 unchanged".  Note that "assume unchanged" bit is *not* set if
289 `git update-index --refresh` finds the working tree file matches
290 the index (use `git update-index --really-refresh` if you want
291 to mark them as "assume unchanged").
294 Examples
295 --------
296 To update and refresh only the files already checked out:
298 ----------------
299 $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
300 ----------------
302 On an inefficient filesystem with `core.ignorestat` set::
304 ------------
305 $ git update-index --really-refresh              <1>
306 $ git update-index --no-assume-unchanged foo.c   <2>
307 $ git diff --name-only                           <3>
308 $ edit foo.c
309 $ git diff --name-only                           <4>
310 M foo.c
311 $ git update-index foo.c                         <5>
312 $ git diff --name-only                           <6>
313 $ edit foo.c
314 $ git diff --name-only                           <7>
315 $ git update-index --no-assume-unchanged foo.c   <8>
316 $ git diff --name-only                           <9>
317 M foo.c
318 ------------
320 <1> forces lstat(2) to set "assume unchanged" bits for paths that match index.
321 <2> mark the path to be edited.
322 <3> this does lstat(2) and finds index matches the path.
323 <4> this does lstat(2) and finds index does *not* match the path.
324 <5> registering the new version to index sets "assume unchanged" bit.
325 <6> and it is assumed unchanged.
326 <7> even after you edit it.
327 <8> you can tell about the change after the fact.
328 <9> now it checks with lstat(2) and finds it has been changed.
331 Skip-worktree bit
332 -----------------
334 Skip-worktree bit can be defined in one (long) sentence: When reading
335 an entry, if it is marked as skip-worktree, then Git pretends its
336 working directory version is up to date and read the index version
337 instead.
339 To elaborate, "reading" means checking for file existence, reading
340 file attributes or file content. The working directory version may be
341 present or absent. If present, its content may match against the index
342 version or not. Writing is not affected by this bit, content safety
343 is still first priority. Note that Git _can_ update working directory
344 file, that is marked skip-worktree, if it is safe to do so (i.e.
345 working directory version matches index version)
347 Although this bit looks similar to assume-unchanged bit, its goal is
348 different from assume-unchanged bit's. Skip-worktree also takes
349 precedence over assume-unchanged bit when both are set.
352 Configuration
353 -------------
355 The command honors `core.filemode` configuration variable.  If
356 your repository is on a filesystem whose executable bits are
357 unreliable, this should be set to 'false' (see linkgit:git-config[1]).
358 This causes the command to ignore differences in file modes recorded
359 in the index and the file mode on the filesystem if they differ only on
360 executable bit.   On such an unfortunate filesystem, you may
361 need to use 'git update-index --chmod='.
363 Quite similarly, if `core.symlinks` configuration variable is set
364 to 'false' (see linkgit:git-config[1]), symbolic links are checked out
365 as plain files, and this command does not modify a recorded file mode
366 from symbolic link to regular file.
368 The command looks at `core.ignorestat` configuration variable.  See
369 'Using "assume unchanged" bit' section above.
371 The command also looks at `core.trustctime` configuration variable.
372 It can be useful when the inode change time is regularly modified by
373 something outside Git (file system crawlers and backup systems use
374 ctime for marking files processed) (see linkgit:git-config[1]).
377 SEE ALSO
378 --------
379 linkgit:git-config[1],
380 linkgit:git-add[1],
381 linkgit:git-ls-files[1]
385 Part of the linkgit:git[1] suite