Skip tests that fail due to incomplete implementations, missing tools...
[git/mingw/j6t.git] / Documentation / git-update-index.txt
blob1a296bc29a16fcf4ee6b581310033861c1ec82bc
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              [--[no-]assume-unchanged]
18              [--[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 --cacheinfo <mode> <object> <path>::
73         Directly insert the specified info into the index.  For
74         backward compatibility, you can also give these three
75         arguments as three separate parameters, but new users are
76         encouraged to use a single-parameter form.
78 --index-info::
79         Read index information from stdin.
81 --chmod=(+|-)x::
82         Set the execute permissions on the updated files.
84 --[no-]assume-unchanged::
85         When this flag is specified, the object names recorded
86         for the paths are not updated.  Instead, this option
87         sets/unsets the "assume unchanged" bit for the
88         paths.  When the "assume unchanged" bit is on, the user
89         promises not to change the file and allows Git to assume
90         that the working tree file matches what is recorded in
91         the index.  If you want to change the working tree file,
92         you need to unset the bit to tell Git.  This is
93         sometimes helpful when working with a big project on a
94         filesystem that has very slow lstat(2) system call
95         (e.g. cifs).
97 Git will fail (gracefully) in case it needs to modify this file
98 in the index e.g. when merging in a commit;
99 thus, in case the assumed-untracked file is changed upstream,
100 you will need to handle the situation manually.
102 --really-refresh::
103         Like '--refresh', but checks stat information unconditionally,
104         without regard to the "assume unchanged" setting.
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 --split-index::
163 --no-split-index::
164         Enable or disable split index mode. If enabled, the index is
165         split into two files, $GIT_DIR/index and $GIT_DIR/sharedindex.<SHA-1>.
166         Changes are accumulated in $GIT_DIR/index while the shared
167         index file contains all index entries stays unchanged. If
168         split-index mode is already enabled and `--split-index` is
169         given again, all changes in $GIT_DIR/index are pushed back to
170         the shared index file. This mode is designed for very large
171         indexes that take a significant amount of time to read or write.
173 --untracked-cache::
174 --no-untracked-cache::
175         Enable or disable untracked cache extension. This could speed
176         up for commands that involve determining untracked files such
177         as `git status`. The underlying operating system and file
178         system must change `st_mtime` field of a directory if files
179         are added or deleted in that directory.
181 --force-untracked-cache::
182         For safety, `--untracked-cache` performs tests on the working
183         directory to make sure untracked cache can be used. These
184         tests can take a few seconds. `--force-untracked-cache` can be
185         used to skip the tests.
187 \--::
188         Do not interpret any more arguments as options.
190 <file>::
191         Files to act on.
192         Note that files beginning with '.' are discarded. This includes
193         `./file` and `dir/./file`. If you don't want this, then use
194         cleaner names.
195         The same applies to directories ending '/' and paths with '//'
197 Using --refresh
198 ---------------
199 '--refresh' does not calculate a new sha1 file or bring the index
200 up-to-date for mode/content changes. But what it *does* do is to
201 "re-match" the stat information of a file with the index, so that you
202 can refresh the index for a file that hasn't been changed but where
203 the stat entry is out of date.
205 For example, you'd want to do this after doing a 'git read-tree', to link
206 up the stat index details with the proper files.
208 Using --cacheinfo or --info-only
209 --------------------------------
210 '--cacheinfo' is used to register a file that is not in the
211 current working directory.  This is useful for minimum-checkout
212 merging.
214 To pretend you have a file with mode and sha1 at path, say:
216 ----------------
217 $ git update-index --cacheinfo <mode>,<sha1>,<path>
218 ----------------
220 '--info-only' is used to register files without placing them in the object
221 database.  This is useful for status-only repositories.
223 Both '--cacheinfo' and '--info-only' behave similarly: the index is updated
224 but the object database isn't.  '--cacheinfo' is useful when the object is
225 in the database but the file isn't available locally.  '--info-only' is
226 useful when the file is available, but you do not wish to update the
227 object database.
230 Using --index-info
231 ------------------
233 `--index-info` is a more powerful mechanism that lets you feed
234 multiple entry definitions from the standard input, and designed
235 specifically for scripts.  It can take inputs of three formats:
237     . mode         SP sha1          TAB path
239 The first format is what "git-apply --index-info"
240 reports, and used to reconstruct a partial tree
241 that is used for phony merge base tree when falling
242 back on 3-way merge.
244     . mode SP type SP sha1          TAB path
246 The second format is to stuff 'git ls-tree' output
247 into the index file.
249     . mode         SP sha1 SP stage TAB path
251 This format is to put higher order stages into the
252 index file and matches 'git ls-files --stage' output.
254 To place a higher stage entry to the index, the path should
255 first be removed by feeding a mode=0 entry for the path, and
256 then feeding necessary input lines in the third format.
258 For example, starting with this index:
260 ------------
261 $ git ls-files -s
262 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz
263 ------------
265 you can feed the following input to `--index-info`:
267 ------------
268 $ git update-index --index-info
269 0 0000000000000000000000000000000000000000      frotz
270 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
271 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
272 ------------
274 The first line of the input feeds 0 as the mode to remove the
275 path; the SHA-1 does not matter as long as it is well formatted.
276 Then the second and third line feeds stage 1 and stage 2 entries
277 for that path.  After the above, we would end up with this:
279 ------------
280 $ git ls-files -s
281 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
282 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
283 ------------
286 Using ``assume unchanged'' bit
287 ------------------------------
289 Many operations in Git depend on your filesystem to have an
290 efficient `lstat(2)` implementation, so that `st_mtime`
291 information for working tree files can be cheaply checked to see
292 if the file contents have changed from the version recorded in
293 the index file.  Unfortunately, some filesystems have
294 inefficient `lstat(2)`.  If your filesystem is one of them, you
295 can set "assume unchanged" bit to paths you have not changed to
296 cause Git not to do this check.  Note that setting this bit on a
297 path does not mean Git will check the contents of the file to
298 see if it has changed -- it makes Git to omit any checking and
299 assume it has *not* changed.  When you make changes to working
300 tree files, you have to explicitly tell Git about it by dropping
301 "assume unchanged" bit, either before or after you modify them.
303 In order to set "assume unchanged" bit, use `--assume-unchanged`
304 option.  To unset, use `--no-assume-unchanged`. To see which files
305 have the "assume unchanged" bit set, use `git ls-files -v`
306 (see linkgit:git-ls-files[1]).
308 The command looks at `core.ignorestat` configuration variable.  When
309 this is true, paths updated with `git update-index paths...` and
310 paths updated with other Git commands that update both index and
311 working tree (e.g. 'git apply --index', 'git checkout-index -u',
312 and 'git read-tree -u') are automatically marked as "assume
313 unchanged".  Note that "assume unchanged" bit is *not* set if
314 `git update-index --refresh` finds the working tree file matches
315 the index (use `git update-index --really-refresh` if you want
316 to mark them as "assume unchanged").
319 Examples
320 --------
321 To update and refresh only the files already checked out:
323 ----------------
324 $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
325 ----------------
327 On an inefficient filesystem with `core.ignorestat` set::
329 ------------
330 $ git update-index --really-refresh              <1>
331 $ git update-index --no-assume-unchanged foo.c   <2>
332 $ git diff --name-only                           <3>
333 $ edit foo.c
334 $ git diff --name-only                           <4>
335 M foo.c
336 $ git update-index foo.c                         <5>
337 $ git diff --name-only                           <6>
338 $ edit foo.c
339 $ git diff --name-only                           <7>
340 $ git update-index --no-assume-unchanged foo.c   <8>
341 $ git diff --name-only                           <9>
342 M foo.c
343 ------------
345 <1> forces lstat(2) to set "assume unchanged" bits for paths that match index.
346 <2> mark the path to be edited.
347 <3> this does lstat(2) and finds index matches the path.
348 <4> this does lstat(2) and finds index does *not* match the path.
349 <5> registering the new version to index sets "assume unchanged" bit.
350 <6> and it is assumed unchanged.
351 <7> even after you edit it.
352 <8> you can tell about the change after the fact.
353 <9> now it checks with lstat(2) and finds it has been changed.
356 Skip-worktree bit
357 -----------------
359 Skip-worktree bit can be defined in one (long) sentence: When reading
360 an entry, if it is marked as skip-worktree, then Git pretends its
361 working directory version is up to date and read the index version
362 instead.
364 To elaborate, "reading" means checking for file existence, reading
365 file attributes or file content. The working directory version may be
366 present or absent. If present, its content may match against the index
367 version or not. Writing is not affected by this bit, content safety
368 is still first priority. Note that Git _can_ update working directory
369 file, that is marked skip-worktree, if it is safe to do so (i.e.
370 working directory version matches index version)
372 Although this bit looks similar to assume-unchanged bit, its goal is
373 different from assume-unchanged bit's. Skip-worktree also takes
374 precedence over assume-unchanged bit when both are set.
377 Configuration
378 -------------
380 The command honors `core.filemode` configuration variable.  If
381 your repository is on a filesystem whose executable bits are
382 unreliable, this should be set to 'false' (see linkgit:git-config[1]).
383 This causes the command to ignore differences in file modes recorded
384 in the index and the file mode on the filesystem if they differ only on
385 executable bit.   On such an unfortunate filesystem, you may
386 need to use 'git update-index --chmod='.
388 Quite similarly, if `core.symlinks` configuration variable is set
389 to 'false' (see linkgit:git-config[1]), symbolic links are checked out
390 as plain files, and this command does not modify a recorded file mode
391 from symbolic link to regular file.
393 The command looks at `core.ignorestat` configuration variable.  See
394 'Using "assume unchanged" bit' section above.
396 The command also looks at `core.trustctime` configuration variable.
397 It can be useful when the inode change time is regularly modified by
398 something outside Git (file system crawlers and backup systems use
399 ctime for marking files processed) (see linkgit:git-config[1]).
402 SEE ALSO
403 --------
404 linkgit:git-config[1],
405 linkgit:git-add[1],
406 linkgit:git-ls-files[1]
410 Part of the linkgit:git[1] suite