difftool: Use eval to expand '--extcmd' expressions
[alt-git.git] / Documentation / git-update-index.txt
blob6052484ab9e28d5565067885b1c4ed5667e8e90f
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              [--ignore-submodules]
19              [--really-refresh] [--unresolve] [--again | -g]
20              [--info-only] [--index-info]
21              [-z] [--stdin]
22              [--verbose]
23              [--] [<file>]\*
25 DESCRIPTION
26 -----------
27 Modifies the index or directory cache. Each file mentioned is updated
28 into the index and any 'unmerged' or 'needs updating' state is
29 cleared.
31 See also linkgit:git-add[1] for a more user-friendly way to do some of
32 the most common operations on the index.
34 The way 'git-update-index' handles files it is told about can be modified
35 using the various options:
37 OPTIONS
38 -------
39 --add::
40         If a specified file isn't in the index already then it's
41         added.
42         Default behaviour is to ignore new files.
44 --remove::
45         If a specified file is in the index but is missing then it's
46         removed.
47         Default behavior is to ignore removed file.
49 --refresh::
50         Looks at the current index and checks to see if merges or
51         updates are needed by checking stat() information.
53 -q::
54         Quiet.  If --refresh finds that the index needs an update, the
55         default behavior is to error out.  This option makes
56         'git-update-index' continue anyway.
58 --ignore-submodules::
59         Do not try to update submodules.  This option is only respected
60         when passed before --refresh.
62 --unmerged::
63         If --refresh finds unmerged changes in the index, the default
64         behavior is to error out.  This option makes 'git-update-index'
65         continue anyway.
67 --ignore-missing::
68         Ignores missing files during a --refresh
70 --cacheinfo <mode> <object> <path>::
71         Directly insert the specified info into the index.
73 --index-info::
74         Read index information from stdin.
76 --chmod=(+|-)x::
77         Set the execute permissions on the updated files.
79 --assume-unchanged::
80 --no-assume-unchanged::
81         When these flags are specified, the object names recorded
82         for the paths are not updated.  Instead, these options
83         set and unset the "assume unchanged" bit for the
84         paths.  When the "assume unchanged" bit is on, git stops
85         checking the working tree files for possible
86         modifications, so you need to manually unset the bit to
87         tell git when you change the working tree file. This is
88         sometimes helpful when working with a big project on a
89         filesystem that has very slow lstat(2) system call
90         (e.g. cifs).
92 This option can be also used as a coarse file-level mechanism
93 to ignore uncommitted changes in tracked files (akin to what
94 `.gitignore` does for untracked files).
95 You should remember that an explicit 'git add' operation will
96 still cause the file to be refreshed from the working tree.
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 -g::
107 --again::
108         Runs 'git-update-index' itself on the paths whose index
109         entries are different from those from the `HEAD` commit.
111 --unresolve::
112         Restores the 'unmerged' or 'needs updating' state of a
113         file during a merge if it was cleared by accident.
115 --info-only::
116         Do not create objects in the object database for all
117         <file> arguments that follow this flag; just insert
118         their object IDs into the index.
120 --force-remove::
121         Remove the file from the index even when the working directory
122         still has such a file. (Implies --remove.)
124 --replace::
125         By default, when a file `path` exists in the index,
126         'git-update-index' refuses an attempt to add `path/file`.
127         Similarly if a file `path/file` exists, a file `path`
128         cannot be added.  With --replace flag, existing entries
129         that conflict with the entry being added are
130         automatically removed with warning messages.
132 --stdin::
133         Instead of taking list of paths from the command line,
134         read list of paths from the standard input.  Paths are
135         separated by LF (i.e. one path per line) by default.
137 --verbose::
138         Report what is being added and removed from index.
140 -z::
141         Only meaningful with `--stdin`; paths are separated with
142         NUL character instead of LF.
144 \--::
145         Do not interpret any more arguments as options.
147 <file>::
148         Files to act on.
149         Note that files beginning with '.' are discarded. This includes
150         `./file` and `dir/./file`. If you don't want this, then use
151         cleaner names.
152         The same applies to directories ending '/' and paths with '//'
154 Using --refresh
155 ---------------
156 '--refresh' does not calculate a new sha1 file or bring the index
157 up-to-date for mode/content changes. But what it *does* do is to
158 "re-match" the stat information of a file with the index, so that you
159 can refresh the index for a file that hasn't been changed but where
160 the stat entry is out of date.
162 For example, you'd want to do this after doing a 'git-read-tree', to link
163 up the stat index details with the proper files.
165 Using --cacheinfo or --info-only
166 --------------------------------
167 '--cacheinfo' is used to register a file that is not in the
168 current working directory.  This is useful for minimum-checkout
169 merging.
171 To pretend you have a file with mode and sha1 at path, say:
173 ----------------
174 $ git update-index --cacheinfo mode sha1 path
175 ----------------
177 '--info-only' is used to register files without placing them in the object
178 database.  This is useful for status-only repositories.
180 Both '--cacheinfo' and '--info-only' behave similarly: the index is updated
181 but the object database isn't.  '--cacheinfo' is useful when the object is
182 in the database but the file isn't available locally.  '--info-only' is
183 useful when the file is available, but you do not wish to update the
184 object database.
187 Using --index-info
188 ------------------
190 `--index-info` is a more powerful mechanism that lets you feed
191 multiple entry definitions from the standard input, and designed
192 specifically for scripts.  It can take inputs of three formats:
194     . mode         SP sha1          TAB path
196 The first format is what "git-apply --index-info"
197 reports, and used to reconstruct a partial tree
198 that is used for phony merge base tree when falling
199 back on 3-way merge.
201     . mode SP type SP sha1          TAB path
203 The second format is to stuff 'git-ls-tree' output
204 into the index file.
206     . mode         SP sha1 SP stage TAB path
208 This format is to put higher order stages into the
209 index file and matches 'git-ls-files --stage' output.
211 To place a higher stage entry to the index, the path should
212 first be removed by feeding a mode=0 entry for the path, and
213 then feeding necessary input lines in the third format.
215 For example, starting with this index:
217 ------------
218 $ git ls-files -s
219 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz
220 ------------
222 you can feed the following input to `--index-info`:
224 ------------
225 $ git update-index --index-info
226 0 0000000000000000000000000000000000000000      frotz
227 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
228 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
229 ------------
231 The first line of the input feeds 0 as the mode to remove the
232 path; the SHA1 does not matter as long as it is well formatted.
233 Then the second and third line feeds stage 1 and stage 2 entries
234 for that path.  After the above, we would end up with this:
236 ------------
237 $ git ls-files -s
238 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz
239 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz
240 ------------
243 Using ``assume unchanged'' bit
244 ------------------------------
246 Many operations in git depend on your filesystem to have an
247 efficient `lstat(2)` implementation, so that `st_mtime`
248 information for working tree files can be cheaply checked to see
249 if the file contents have changed from the version recorded in
250 the index file.  Unfortunately, some filesystems have
251 inefficient `lstat(2)`.  If your filesystem is one of them, you
252 can set "assume unchanged" bit to paths you have not changed to
253 cause git not to do this check.  Note that setting this bit on a
254 path does not mean git will check the contents of the file to
255 see if it has changed -- it makes git to omit any checking and
256 assume it has *not* changed.  When you make changes to working
257 tree files, you have to explicitly tell git about it by dropping
258 "assume unchanged" bit, either before or after you modify them.
260 In order to set "assume unchanged" bit, use `--assume-unchanged`
261 option.  To unset, use `--no-assume-unchanged`.
263 The command looks at `core.ignorestat` configuration variable.  When
264 this is true, paths updated with `git update-index paths...` and
265 paths updated with other git commands that update both index and
266 working tree (e.g. 'git-apply --index', 'git-checkout-index -u',
267 and 'git-read-tree -u') are automatically marked as "assume
268 unchanged".  Note that "assume unchanged" bit is *not* set if
269 `git update-index --refresh` finds the working tree file matches
270 the index (use `git update-index --really-refresh` if you want
271 to mark them as "assume unchanged").
274 Examples
275 --------
276 To update and refresh only the files already checked out:
278 ----------------
279 $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
280 ----------------
282 On an inefficient filesystem with `core.ignorestat` set::
284 ------------
285 $ git update-index --really-refresh              <1>
286 $ git update-index --no-assume-unchanged foo.c   <2>
287 $ git diff --name-only                           <3>
288 $ edit foo.c
289 $ git diff --name-only                           <4>
290 M foo.c
291 $ git update-index foo.c                         <5>
292 $ git diff --name-only                           <6>
293 $ edit foo.c
294 $ git diff --name-only                           <7>
295 $ git update-index --no-assume-unchanged foo.c   <8>
296 $ git diff --name-only                           <9>
297 M foo.c
298 ------------
300 <1> forces lstat(2) to set "assume unchanged" bits for paths that match index.
301 <2> mark the path to be edited.
302 <3> this does lstat(2) and finds index matches the path.
303 <4> this does lstat(2) and finds index does *not* match the path.
304 <5> registering the new version to index sets "assume unchanged" bit.
305 <6> and it is assumed unchanged.
306 <7> even after you edit it.
307 <8> you can tell about the change after the fact.
308 <9> now it checks with lstat(2) and finds it has been changed.
311 Configuration
312 -------------
314 The command honors `core.filemode` configuration variable.  If
315 your repository is on a filesystem whose executable bits are
316 unreliable, this should be set to 'false' (see linkgit:git-config[1]).
317 This causes the command to ignore differences in file modes recorded
318 in the index and the file mode on the filesystem if they differ only on
319 executable bit.   On such an unfortunate filesystem, you may
320 need to use 'git-update-index --chmod='.
322 Quite similarly, if `core.symlinks` configuration variable is set
323 to 'false' (see linkgit:git-config[1]), symbolic links are checked out
324 as plain files, and this command does not modify a recorded file mode
325 from symbolic link to regular file.
327 The command looks at `core.ignorestat` configuration variable.  See
328 'Using "assume unchanged" bit' section above.
330 The command also looks at `core.trustctime` configuration variable.
331 It can be useful when the inode change time is regularly modified by
332 something outside Git (file system crawlers and backup systems use
333 ctime for marking files processed) (see linkgit:git-config[1]).
336 SEE ALSO
337 --------
338 linkgit:git-config[1],
339 linkgit:git-add[1]
342 Author
343 ------
344 Written by Linus Torvalds <torvalds@osdl.org>
346 Documentation
347 --------------
348 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
352 Part of the linkgit:git[1] suite