Fix silly typo in new builtin grep
[git/git.git] / Documentation / git-update-index.txt
1 git-update-index(1)
2 ===================
3
4 NAME
5 ----
6 git-update-index - Modifies the index or directory cache
7
8
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 [--really-refresh]
19 [--info-only] [--index-info]
20 [-z] [--stdin]
21 [--verbose]
22 [--] [<file>]\*
23
24 DESCRIPTION
25 -----------
26 Modifies the index or directory cache. Each file mentioned is updated
27 into the index and any 'unmerged' or 'needs updating' state is
28 cleared.
29
30 The way "git-update-index" handles files it is told about can be modified
31 using the various options:
32
33 OPTIONS
34 -------
35 --add::
36 If a specified file isn't in the index already then it's
37 added.
38 Default behaviour is to ignore new files.
39
40 --remove::
41 If a specified file is in the index but is missing then it's
42 removed.
43 Default behaviour is to ignore removed file.
44
45 --refresh::
46 Looks at the current index and checks to see if merges or
47 updates are needed by checking stat() information.
48
49 -q::
50 Quiet. If --refresh finds that the index needs an update, the
51 default behavior is to error out. This option makes
52 git-update-index continue anyway.
53
54 --unmerged::
55 If --refresh finds unmerged changes in the index, the default
56 behavior is to error out. This option makes git-update-index
57 continue anyway.
58
59 --ignore-missing::
60 Ignores missing files during a --refresh
61
62 --cacheinfo <mode> <object> <path>::
63 Directly insert the specified info into the index.
64
65 --index-info::
66 Read index information from stdin.
67
68 --chmod=(+|-)x::
69 Set the execute permissions on the updated files.
70
71 --assume-unchanged, --no-assume-unchanged::
72 When these flags are specified, the object name recorded
73 for the paths are not updated. Instead, these options
74 sets and unsets the "assume unchanged" bit for the
75 paths. When the "assume unchanged" bit is on, git stops
76 checking the working tree files for possible
77 modifications, so you need to manually unset the bit to
78 tell git when you change the working tree file. This is
79 sometimes helpful when working with a big project on a
80 filesystem that has very slow lstat(2) system call
81 (e.g. cifs).
82
83 --info-only::
84 Do not create objects in the object database for all
85 <file> arguments that follow this flag; just insert
86 their object IDs into the index.
87
88 --force-remove::
89 Remove the file from the index even when the working directory
90 still has such a file. (Implies --remove.)
91
92 --replace::
93 By default, when a file `path` exists in the index,
94 git-update-index refuses an attempt to add `path/file`.
95 Similarly if a file `path/file` exists, a file `path`
96 cannot be added. With --replace flag, existing entries
97 that conflicts with the entry being added are
98 automatically removed with warning messages.
99
100 --stdin::
101 Instead of taking list of paths from the command line,
102 read list of paths from the standard input. Paths are
103 separated by LF (i.e. one path per line) by default.
104
105 --verbose::
106 Report what is being added and removed from index.
107
108 -z::
109 Only meaningful with `--stdin`; paths are separated with
110 NUL character instead of LF.
111
112 --::
113 Do not interpret any more arguments as options.
114
115 <file>::
116 Files to act on.
117 Note that files beginning with '.' are discarded. This includes
118 `./file` and `dir/./file`. If you don't want this, then use
119 cleaner names.
120 The same applies to directories ending '/' and paths with '//'
121
122 Using --refresh
123 ---------------
124 '--refresh' does not calculate a new sha1 file or bring the index
125 up-to-date for mode/content changes. But what it *does* do is to
126 "re-match" the stat information of a file with the index, so that you
127 can refresh the index for a file that hasn't been changed but where
128 the stat entry is out of date.
129
130 For example, you'd want to do this after doing a "git-read-tree", to link
131 up the stat index details with the proper files.
132
133 Using --cacheinfo or --info-only
134 --------------------------------
135 '--cacheinfo' is used to register a file that is not in the
136 current working directory. This is useful for minimum-checkout
137 merging.
138
139 To pretend you have a file with mode and sha1 at path, say:
140
141 ----------------
142 $ git-update-index --cacheinfo mode sha1 path
143 ----------------
144
145 '--info-only' is used to register files without placing them in the object
146 database. This is useful for status-only repositories.
147
148 Both '--cacheinfo' and '--info-only' behave similarly: the index is updated
149 but the object database isn't. '--cacheinfo' is useful when the object is
150 in the database but the file isn't available locally. '--info-only' is
151 useful when the file is available, but you do not wish to update the
152 object database.
153
154
155 Using --index-info
156 ------------------
157
158 `--index-info` is a more powerful mechanism that lets you feed
159 multiple entry definitions from the standard input, and designed
160 specifically for scripts. It can take inputs of three formats:
161
162 . mode SP sha1 TAB path
163 +
164 The first format is what "git-apply --index-info"
165 reports, and used to reconstruct a partial tree
166 that is used for phony merge base tree when falling
167 back on 3-way merge.
168
169 . mode SP type SP sha1 TAB path
170 +
171 The second format is to stuff git-ls-tree output
172 into the index file.
173
174 . mode SP sha1 SP stage TAB path
175 +
176 This format is to put higher order stages into the
177 index file and matches git-ls-files --stage output.
178
179 To place a higher stage entry to the index, the path should
180 first be removed by feeding a mode=0 entry for the path, and
181 then feeding necessary input lines in the third format.
182
183 For example, starting with this index:
184
185 ------------
186 $ git ls-files -s
187 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0 frotz
188 ------------
189
190 you can feed the following input to `--index-info`:
191
192 ------------
193 $ git update-index --index-info
194 0 0000000000000000000000000000000000000000 frotz
195 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz
196 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz
197 ------------
198
199 The first line of the input feeds 0 as the mode to remove the
200 path; the SHA1 does not matter as long as it is well formatted.
201 Then the second and third line feeds stage 1 and stage 2 entries
202 for that path. After the above, we would end up with this:
203
204 ------------
205 $ git ls-files -s
206 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz
207 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz
208 ------------
209
210
211 Using "assume unchanged" bit
212 ----------------------------
213
214 Many operations in git depend on your filesystem to have an
215 efficient `lstat(2)` implementation, so that `st_mtime`
216 information for working tree files can be cheaply checked to see
217 if the file contents have changed from the version recorded in
218 the index file. Unfortunately, some filesystems have
219 inefficient `lstat(2)`. If your filesystem is one of them, you
220 can set "assume unchanged" bit to paths you have not changed to
221 cause git not to do this check. Note that setting this bit on a
222 path does not mean git will check the contents of the file to
223 see if it has changed -- it makes git to omit any checking and
224 assume it has *not* changed. When you make changes to working
225 tree files, you have to explicitly tell git about it by dropping
226 "assume unchanged" bit, either before or after you modify them.
227
228 In order to set "assume unchanged" bit, use `--assume-unchanged`
229 option. To unset, use `--no-assume-unchanged`.
230
231 The command looks at `core.ignorestat` configuration variable. When
232 this is true, paths updated with `git-update-index paths...` and
233 paths updated with other git commands that update both index and
234 working tree (e.g. `git-apply --index`, `git-checkout-index -u`,
235 and `git-read-tree -u`) are automatically marked as "assume
236 unchanged". Note that "assume unchanged" bit is *not* set if
237 `git-update-index --refresh` finds the working tree file matches
238 the index (use `git-update-index --really-refresh` if you want
239 to mark them as "assume unchanged").
240
241
242 Examples
243 --------
244 To update and refresh only the files already checked out:
245
246 ----------------
247 $ git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh
248 ----------------
249
250 On an inefficient filesystem with `core.ignorestat` set::
251 +
252 ------------
253 $ git update-index --really-refresh <1>
254 $ git update-index --no-assume-unchanged foo.c <2>
255 $ git diff --name-only <3>
256 $ edit foo.c
257 $ git diff --name-only <4>
258 M foo.c
259 $ git update-index foo.c <5>
260 $ git diff --name-only <6>
261 $ edit foo.c
262 $ git diff --name-only <7>
263 $ git update-index --no-assume-unchanged foo.c <8>
264 $ git diff --name-only <9>
265 M foo.c
266 ------------
267 +
268 <1> forces lstat(2) to set "assume unchanged" bits for paths that match index.
269 <2> mark the path to be edited.
270 <3> this does lstat(2) and finds index matches the path.
271 <4> this does lstat(2) and finds index does *not* match the path.
272 <5> registering the new version to index sets "assume unchanged" bit.
273 <6> and it is assumed unchanged.
274 <7> even after you edit it.
275 <8> you can tell about the change after the fact.
276 <9> now it checks with lstat(2) and finds it has been changed.
277
278
279 Configuration
280 -------------
281
282 The command honors `core.filemode` configuration variable. If
283 your repository is on an filesystem whose executable bits are
284 unreliable, this should be set to 'false' (see gitlink:git-repo-config[1]).
285 This causes the command to ignore differences in file modes recorded
286 in the index and the file mode on the filesystem if they differ only on
287 executable bit. On such an unfortunate filesystem, you may
288 need to use `git-update-index --chmod=`.
289
290 The command looks at `core.ignorestat` configuration variable. See
291 'Using "assume unchanged" bit' section above.
292
293
294 See Also
295 --------
296 gitlink:git-repo-config[1]
297
298
299 Author
300 ------
301 Written by Linus Torvalds <torvalds@osdl.org>
302
303 Documentation
304 --------------
305 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
306
307 GIT
308 ---
309 Part of the gitlink:git[7] suite
310