blob: 1c4d146a41ce091755b2e4baef0fa79f45a4b515 [file] [log] [blame]
Junio C Hamano215a7ad2005-09-07 17:26:23 -07001git-update-index(1)
David Greaves2cf565c2005-05-10 22:32:30 +01002===================
David Greaves2cf565c2005-05-10 22:32:30 +01003
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -08006git-update-index - Register file contents in the working tree to the index
David Greaves2cf565c2005-05-10 22:32:30 +01007
8
9SYNOPSIS
10--------
Junio C Hamanof9666ad2006-02-12 01:48:47 -080011[verse]
Jonathan Niederb1889c32008-06-30 01:09:04 -050012'git update-index'
Matthias Kestenholzde5f2bf2006-05-03 12:51:40 +020013 [--add] [--remove | --force-remove] [--replace]
14 [--refresh] [-q] [--unmerged] [--ignore-missing]
Junio C Hamanoec160ae2014-03-23 16:57:28 -070015 [(--cacheinfo <mode>,<object>,<file>)...]
Junio C Hamano5773c9f2005-10-29 14:32:56 -070016 [--chmod=(+|-)x]
Felipe Contreras0460ed22013-05-08 20:16:55 -050017 [--[no-]assume-unchanged]
18 [--[no-]skip-worktree]
Ben Peart780494b2017-09-22 12:35:41 -040019 [--[no-]fsmonitor-valid]
Johannes Schindelin5fdeacb2008-05-14 18:03:45 +010020 [--ignore-submodules]
Christian Couderbc497122015-11-25 10:30:02 +010021 [--[no-]split-index]
Christian Coudereaab83d2016-01-24 16:28:16 +010022 [--[no-|test-|force-]untracked-cache]
Ben Peart780494b2017-09-22 12:35:41 -040023 [--[no-]fsmonitor]
Junio C Hamano7099c9c2006-08-23 21:24:47 -070024 [--really-refresh] [--unresolve] [--again | -g]
Chris Shoemaker14470c02005-10-29 17:46:41 -040025 [--info-only] [--index-info]
Junio C Hamano69dec662012-04-04 09:37:02 -070026 [-z] [--stdin] [--index-version <n>]
Chris Shoemaker14470c02005-10-29 17:46:41 -040027 [--verbose]
Štěpán Němec0adda932010-10-08 19:31:17 +020028 [--] [<file>...]
David Greaves2cf565c2005-05-10 22:32:30 +010029
30DESCRIPTION
31-----------
32Modifies the index or directory cache. Each file mentioned is updated
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010033into the index and any 'unmerged' or 'needs updating' state is
David Greaves2cf565c2005-05-10 22:32:30 +010034cleared.
35
Dan McGee5162e692007-12-29 00:20:38 -060036See also linkgit:git-add[1] for a more user-friendly way to do some of
Matthieu Moye701ccc2007-05-06 23:11:56 +020037the most common operations on the index.
38
Thomas Rast0b444cd2010-01-10 00:33:00 +010039The way 'git update-index' handles files it is told about can be modified
David Greaves2cf565c2005-05-10 22:32:30 +010040using the various options:
41
42OPTIONS
43-------
44--add::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010045 If a specified file isn't in the index already then it's
David Greaves2cf565c2005-05-10 22:32:30 +010046 added.
47 Default behaviour is to ignore new files.
48
49--remove::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010050 If a specified file is in the index but is missing then it's
David Greaves2cf565c2005-05-10 22:32:30 +010051 removed.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -040052 Default behavior is to ignore removed file.
David Greaves2cf565c2005-05-10 22:32:30 +010053
54--refresh::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010055 Looks at the current index and checks to see if merges or
David Greaves2cf565c2005-05-10 22:32:30 +010056 updates are needed by checking stat() information.
57
Chris Shoemaker14470c02005-10-29 17:46:41 -040058-q::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010059 Quiet. If --refresh finds that the index needs an update, the
Chris Shoemaker14470c02005-10-29 17:46:41 -040060 default behavior is to error out. This option makes
Thomas Rast0b444cd2010-01-10 00:33:00 +010061 'git update-index' continue anyway.
Chris Shoemaker14470c02005-10-29 17:46:41 -040062
Markus Heidelberg04c8ce92008-12-19 13:14:18 +010063--ignore-submodules::
Johannes Schindelin5fdeacb2008-05-14 18:03:45 +010064 Do not try to update submodules. This option is only respected
65 when passed before --refresh.
66
Chris Shoemaker14470c02005-10-29 17:46:41 -040067--unmerged::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +010068 If --refresh finds unmerged changes in the index, the default
Thomas Rast0b444cd2010-01-10 00:33:00 +010069 behavior is to error out. This option makes 'git update-index'
Chris Shoemaker14470c02005-10-29 17:46:41 -040070 continue anyway.
71
David Greaves2cf565c2005-05-10 22:32:30 +010072--ignore-missing::
73 Ignores missing files during a --refresh
74
Junio C Hamanoec160ae2014-03-23 16:57:28 -070075--cacheinfo <mode>,<object>,<path>::
David Greaves2cf565c2005-05-10 22:32:30 +010076--cacheinfo <mode> <object> <path>::
Junio C Hamanoec160ae2014-03-23 16:57:28 -070077 Directly insert the specified info into the index. For
78 backward compatibility, you can also give these three
79 arguments as three separate parameters, but new users are
80 encouraged to use a single-parameter form.
Junio C Hamanoa6080a02007-06-07 00:04:01 -070081
Chris Shoemaker14470c02005-10-29 17:46:41 -040082--index-info::
Nikolai Weibull7acab8f2005-11-15 00:20:01 +010083 Read index information from stdin.
Chris Shoemaker14470c02005-10-29 17:46:41 -040084
85--chmod=(+|-)x::
Junio C Hamanoa6080a02007-06-07 00:04:01 -070086 Set the execute permissions on the updated files.
Chris Shoemaker14470c02005-10-29 17:46:41 -040087
Felipe Contreras0460ed22013-05-08 20:16:55 -050088--[no-]assume-unchanged::
Philip Oakleyccadb252014-12-06 15:04:30 +000089 When this flag is specified, the object names recorded
90 for the paths are not updated. Instead, this option
91 sets/unsets the "assume unchanged" bit for the
92 paths. When the "assume unchanged" bit is on, the user
93 promises not to change the file and allows Git to assume
94 that the working tree file matches what is recorded in
95 the index. If you want to change the working tree file,
96 you need to unset the bit to tell Git. This is
Junio C Hamanof9666ad2006-02-12 01:48:47 -080097 sometimes helpful when working with a big project on a
98 filesystem that has very slow lstat(2) system call
99 (e.g. cifs).
Petr Baudis6259ac62008-07-18 16:11:07 +0200100+
Petr Baudis6259ac62008-07-18 16:11:07 +0200101Git will fail (gracefully) in case it needs to modify this file
102in the index e.g. when merging in a commit;
103thus, in case the assumed-untracked file is changed upstream,
104you will need to handle the situation manually.
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800105
Štěpán Němec466d1f12009-11-10 19:11:51 +0100106--really-refresh::
Matthieu Moybcf96262016-06-28 13:40:11 +0200107 Like `--refresh`, but checks stat information unconditionally,
Štěpán Němec466d1f12009-11-10 19:11:51 +0100108 without regard to the "assume unchanged" setting.
109
Felipe Contreras0460ed22013-05-08 20:16:55 -0500110--[no-]skip-worktree::
Nguyễn Thái Ngọc Duy44a36912009-08-20 20:46:57 +0700111 When one of these flags is specified, the object name recorded
112 for the paths are not updated. Instead, these options
113 set and unset the "skip-worktree" bit for the paths. See
114 section "Skip-worktree bit" below for more information.
115
Ben Peart780494b2017-09-22 12:35:41 -0400116--[no-]fsmonitor-valid::
117 When one of these flags is specified, the object name recorded
118 for the paths are not updated. Instead, these options
119 set and unset the "fsmonitor valid" bit for the paths. See
120 section "File System Monitor" below for more information.
121
Stephan Beyer32402402008-06-08 03:36:09 +0200122-g::
123--again::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100124 Runs 'git update-index' itself on the paths whose index
Junio C Hamano83e77a22006-05-05 17:40:47 -0700125 entries are different from those from the `HEAD` commit.
126
Matthias Kestenholz060729d2006-05-03 12:53:19 +0200127--unresolve::
128 Restores the 'unmerged' or 'needs updating' state of a
129 file during a merge if it was cleared by accident.
130
Bryan Larsendf6e1512005-07-08 16:52:12 -0700131--info-only::
132 Do not create objects in the object database for all
133 <file> arguments that follow this flag; just insert
Lukas_Sandström5f3aa192005-11-11 02:12:27 +0100134 their object IDs into the index.
Bryan Larsendf6e1512005-07-08 16:52:12 -0700135
David Greaves2cf565c2005-05-10 22:32:30 +0100136--force-remove::
137 Remove the file from the index even when the working directory
Petr Baudis9b63f502005-05-31 18:52:43 +0200138 still has such a file. (Implies --remove.)
David Greaves2cf565c2005-05-10 22:32:30 +0100139
140--replace::
141 By default, when a file `path` exists in the index,
Thomas Rast0b444cd2010-01-10 00:33:00 +0100142 'git update-index' refuses an attempt to add `path/file`.
David Greaves2cf565c2005-05-10 22:32:30 +0100143 Similarly if a file `path/file` exists, a file `path`
144 cannot be added. With --replace flag, existing entries
Markus Heidelberg04c8ce92008-12-19 13:14:18 +0100145 that conflict with the entry being added are
David Greaves2cf565c2005-05-10 22:32:30 +0100146 automatically removed with warning messages.
147
Junio C Hamano1f7f99d2005-09-26 18:13:32 -0700148--stdin::
149 Instead of taking list of paths from the command line,
150 read list of paths from the standard input. Paths are
151 separated by LF (i.e. one path per line) by default.
152
Chris Shoemaker14470c02005-10-29 17:46:41 -0400153--verbose::
154 Report what is being added and removed from index.
155
Junio C Hamano69dec662012-04-04 09:37:02 -0700156--index-version <n>::
157 Write the resulting index out in the named on-disk format version.
Nguyễn Thái Ngọc Duy647d8792013-02-23 09:29:31 +0700158 Supported versions are 2, 3 and 4. The current default version is 2
159 or 3, depending on whether extra features are used, such as
160 `git add -N`.
161+
162Version 4 performs a simple pathname compression that reduces index
163size by 30%-50% on large repositories, which results in faster load
Evan Zacksbe945682017-09-12 15:58:39 -0700164time. Version 4 is relatively young (first released in 1.8.0 in
Nguyễn Thái Ngọc Duy647d8792013-02-23 09:29:31 +0700165October 2012). Other Git implementations such as JGit and libgit2
166may not support it yet.
Junio C Hamano69dec662012-04-04 09:37:02 -0700167
Junio C Hamano1f7f99d2005-09-26 18:13:32 -0700168-z::
Bert Wesarg537497b2010-10-08 08:50:20 +0200169 Only meaningful with `--stdin` or `--index-info`; paths are
170 separated with NUL character instead of LF.
Junio C Hamano1f7f99d2005-09-26 18:13:32 -0700171
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 19:19:44 +0700172--split-index::
173--no-split-index::
Christian Couderb4601392017-03-06 10:42:03 +0100174 Enable or disable split index mode. If split-index mode is
175 already enabled and `--split-index` is given again, all
176 changes in $GIT_DIR/index are pushed back to the shared index
177 file.
Christian Couder13c0e4c2017-02-27 19:00:06 +0100178+
179These options take effect whatever the value of the `core.splitIndex`
180configuration variable (see linkgit:git-config[1]). But a warning is
181emitted when the change goes against the configured value, as the
182configured value will take effect next time the index is read and this
183will remove the intended effect of the option.
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 19:19:44 +0700184
Nguyễn Thái Ngọc Duy9e597242015-03-08 17:12:42 +0700185--untracked-cache::
186--no-untracked-cache::
Christian Couder435ec092016-01-27 07:58:05 +0100187 Enable or disable untracked cache feature. Please use
188 `--test-untracked-cache` before enabling it.
189+
190These options take effect whatever the value of the `core.untrackedCache`
191configuration variable (see linkgit:git-config[1]). But a warning is
192emitted when the change goes against the configured value, as the
193configured value will take effect next time the index is read and this
194will remove the intended effect of the option.
Nguyễn Thái Ngọc Duy9e597242015-03-08 17:12:42 +0700195
Christian Coudereaab83d2016-01-24 16:28:16 +0100196--test-untracked-cache::
197 Only perform tests on the working directory to make sure
198 untracked cache can be used. You have to manually enable
Christian Couder435ec092016-01-27 07:58:05 +0100199 untracked cache using `--untracked-cache` or
200 `--force-untracked-cache` or the `core.untrackedCache`
201 configuration variable afterwards if you really want to use
202 it. If a test fails the exit code is 1 and a message
203 explains what is not working as needed, otherwise the exit
204 code is 0 and OK is printed.
Christian Coudereaab83d2016-01-24 16:28:16 +0100205
Nguyễn Thái Ngọc Duyf64cb882015-03-08 17:12:43 +0700206--force-untracked-cache::
Christian Couder435ec092016-01-27 07:58:05 +0100207 Same as `--untracked-cache`. Provided for backwards
208 compatibility with older versions of Git where
209 `--untracked-cache` used to imply `--test-untracked-cache` but
210 this option would enable the extension unconditionally.
Nguyễn Thái Ngọc Duyf64cb882015-03-08 17:12:43 +0700211
Ben Peart780494b2017-09-22 12:35:41 -0400212--fsmonitor::
213--no-fsmonitor::
214 Enable or disable files system monitor feature. These options
215 take effect whatever the value of the `core.fsmonitor`
216 configuration variable (see linkgit:git-config[1]). But a warning
217 is emitted when the change goes against the configured value, as
218 the configured value will take effect next time the index is
219 read and this will remove the intended effect of the option.
220
seane9940042006-05-05 15:05:24 -0400221\--::
David Greaves2cf565c2005-05-10 22:32:30 +0100222 Do not interpret any more arguments as options.
223
224<file>::
225 Files to act on.
Junio C Hamano5773c9f2005-10-29 14:32:56 -0700226 Note that files beginning with '.' are discarded. This includes
Junio C Hamanoa6080a02007-06-07 00:04:01 -0700227 `./file` and `dir/./file`. If you don't want this, then use
David Greaves2cf565c2005-05-10 22:32:30 +0100228 cleaner names.
229 The same applies to directories ending '/' and paths with '//'
230
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200231USING --REFRESH
David Greaves2cf565c2005-05-10 22:32:30 +0100232---------------
Matthieu Moybcf96262016-06-28 13:40:11 +0200233`--refresh` does not calculate a new sha1 file or bring the index
Martin Ågren7560f542017-08-23 19:49:35 +0200234up to date for mode/content changes. But what it *does* do is to
Lukas_Sandström5f3aa192005-11-11 02:12:27 +0100235"re-match" the stat information of a file with the index, so that you
236can refresh the index for a file that hasn't been changed but where
David Greaves2cf565c2005-05-10 22:32:30 +0100237the stat entry is out of date.
238
Thomas Rast0b444cd2010-01-10 00:33:00 +0100239For example, you'd want to do this after doing a 'git read-tree', to link
Lukas_Sandström5f3aa192005-11-11 02:12:27 +0100240up the stat index details with the proper files.
David Greaves2cf565c2005-05-10 22:32:30 +0100241
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200242USING --CACHEINFO OR --INFO-ONLY
Bryan Larsendf6e1512005-07-08 16:52:12 -0700243--------------------------------
Matthieu Moybcf96262016-06-28 13:40:11 +0200244`--cacheinfo` is used to register a file that is not in the
Bryan Larsendf6e1512005-07-08 16:52:12 -0700245current working directory. This is useful for minimum-checkout
246merging.
David Greaves2cf565c2005-05-10 22:32:30 +0100247
Elijah Newren388d0ff2018-08-08 13:28:07 -0700248To pretend you have a file at path with mode and sha1, say:
David Greaves2cf565c2005-05-10 22:32:30 +0100249
Jon Loeliger61f693b2005-12-05 23:13:03 -0600250----------------
Elijah Newren388d0ff2018-08-08 13:28:07 -0700251$ git update-index --add --cacheinfo <mode>,<sha1>,<path>
Jon Loeliger61f693b2005-12-05 23:13:03 -0600252----------------
David Greaves2cf565c2005-05-10 22:32:30 +0100253
Matthieu Moybcf96262016-06-28 13:40:11 +0200254`--info-only` is used to register files without placing them in the object
Bryan Larsendf6e1512005-07-08 16:52:12 -0700255database. This is useful for status-only repositories.
256
Matthieu Moybcf96262016-06-28 13:40:11 +0200257Both `--cacheinfo` and `--info-only` behave similarly: the index is updated
258but the object database isn't. `--cacheinfo` is useful when the object is
259in the database but the file isn't available locally. `--info-only` is
Bryan Larsendf6e1512005-07-08 16:52:12 -0700260useful when the file is available, but you do not wish to update the
261object database.
262
Junio C Hamanod23748a2005-12-07 01:45:38 -0800263
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200264USING --INDEX-INFO
Junio C Hamanod23748a2005-12-07 01:45:38 -0800265------------------
266
267`--index-info` is a more powerful mechanism that lets you feed
268multiple entry definitions from the standard input, and designed
269specifically for scripts. It can take inputs of three formats:
270
Junio C Hamanod23748a2005-12-07 01:45:38 -0800271 . mode SP type SP sha1 TAB path
272+
Junio C Hamanoe05aa682018-08-08 14:35:18 -0700273This format is to stuff `git ls-tree` output into the index.
Junio C Hamanod23748a2005-12-07 01:45:38 -0800274
275 . mode SP sha1 SP stage TAB path
276+
277This format is to put higher order stages into the
Thomas Rast0b444cd2010-01-10 00:33:00 +0100278index file and matches 'git ls-files --stage' output.
Junio C Hamanod23748a2005-12-07 01:45:38 -0800279
Junio C Hamanoe05aa682018-08-08 14:35:18 -0700280 . mode SP sha1 TAB path
281+
282This format is no longer produced by any Git command, but is
283and will continue to be supported by `update-index --index-info`.
284
Junio C Hamanod23748a2005-12-07 01:45:38 -0800285To place a higher stage entry to the index, the path should
286first be removed by feeding a mode=0 entry for the path, and
287then feeding necessary input lines in the third format.
288
289For example, starting with this index:
290
291------------
292$ git ls-files -s
293100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0 frotz
294------------
295
296you can feed the following input to `--index-info`:
297
298------------
299$ git update-index --index-info
3000 0000000000000000000000000000000000000000 frotz
301100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz
302100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz
303------------
304
305The first line of the input feeds 0 as the mode to remove the
Thomas Ackermannd5fa1f12013-04-15 19:49:04 +0200306path; the SHA-1 does not matter as long as it is well formatted.
Junio C Hamanod23748a2005-12-07 01:45:38 -0800307Then the second and third line feeds stage 1 and stage 2 entries
308for that path. After the above, we would end up with this:
309
310------------
311$ git ls-files -s
312100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz
313100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz
314------------
315
316
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200317USING ``ASSUME UNCHANGED'' BIT
Jonas Fonsecabae777d2006-11-12 22:28:43 +0100318------------------------------
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800319
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100320Many operations in Git depend on your filesystem to have an
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800321efficient `lstat(2)` implementation, so that `st_mtime`
322information for working tree files can be cheaply checked to see
323if the file contents have changed from the version recorded in
324the index file. Unfortunately, some filesystems have
325inefficient `lstat(2)`. If your filesystem is one of them, you
326can set "assume unchanged" bit to paths you have not changed to
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100327cause Git not to do this check. Note that setting this bit on a
328path does not mean Git will check the contents of the file to
329see if it has changed -- it makes Git to omit any checking and
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800330assume it has *not* changed. When you make changes to working
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100331tree files, you have to explicitly tell Git about it by dropping
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800332"assume unchanged" bit, either before or after you modify them.
333
334In order to set "assume unchanged" bit, use `--assume-unchanged`
Stefan Naeweacd6d7e2011-09-21 08:21:50 +0200335option. To unset, use `--no-assume-unchanged`. To see which files
336have the "assume unchanged" bit set, use `git ls-files -v`
337(see linkgit:git-ls-files[1]).
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800338
339The command looks at `core.ignorestat` configuration variable. When
Jonathan Niederb1889c32008-06-30 01:09:04 -0500340this is true, paths updated with `git update-index paths...` and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100341paths updated with other Git commands that update both index and
Thomas Rast0b444cd2010-01-10 00:33:00 +0100342working tree (e.g. 'git apply --index', 'git checkout-index -u',
343and 'git read-tree -u') are automatically marked as "assume
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800344unchanged". Note that "assume unchanged" bit is *not* set if
Jonathan Niederb1889c32008-06-30 01:09:04 -0500345`git update-index --refresh` finds the working tree file matches
346the index (use `git update-index --really-refresh` if you want
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800347to mark them as "assume unchanged").
348
349
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200350EXAMPLES
Bryan Larsendf6e1512005-07-08 16:52:12 -0700351--------
David Greaves2cf565c2005-05-10 22:32:30 +0100352To update and refresh only the files already checked out:
353
Jon Loeliger61f693b2005-12-05 23:13:03 -0600354----------------
Jonathan Niederb1889c32008-06-30 01:09:04 -0500355$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
Jon Loeliger61f693b2005-12-05 23:13:03 -0600356----------------
David Greaves2cf565c2005-05-10 22:32:30 +0100357
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400358On an inefficient filesystem with `core.ignorestat` set::
359+
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800360------------
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400361$ git update-index --really-refresh <1>
362$ git update-index --no-assume-unchanged foo.c <2>
363$ git diff --name-only <3>
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800364$ edit foo.c
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400365$ git diff --name-only <4>
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800366M foo.c
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400367$ git update-index foo.c <5>
368$ git diff --name-only <6>
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800369$ edit foo.c
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400370$ git diff --name-only <7>
371$ git update-index --no-assume-unchanged foo.c <8>
372$ git diff --name-only <9>
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800373M foo.c
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400374------------
375+
376<1> forces lstat(2) to set "assume unchanged" bits for paths that match index.
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800377<2> mark the path to be edited.
378<3> this does lstat(2) and finds index matches the path.
Sean Estabrooks48aeecd2006-04-28 09:15:05 -0400379<4> this does lstat(2) and finds index does *not* match the path.
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800380<5> registering the new version to index sets "assume unchanged" bit.
381<6> and it is assumed unchanged.
382<7> even after you edit it.
383<8> you can tell about the change after the fact.
384<9> now it checks with lstat(2) and finds it has been changed.
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800385
David Greaves2cf565c2005-05-10 22:32:30 +0100386
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200387SKIP-WORKTREE BIT
Nguyễn Thái Ngọc Duy44a36912009-08-20 20:46:57 +0700388-----------------
389
390Skip-worktree bit can be defined in one (long) sentence: When reading
391an entry, if it is marked as skip-worktree, then Git pretends its
392working directory version is up to date and read the index version
393instead.
394
395To elaborate, "reading" means checking for file existence, reading
396file attributes or file content. The working directory version may be
397present or absent. If present, its content may match against the index
398version or not. Writing is not affected by this bit, content safety
399is still first priority. Note that Git _can_ update working directory
400file, that is marked skip-worktree, if it is safe to do so (i.e.
401working directory version matches index version)
402
403Although this bit looks similar to assume-unchanged bit, its goal is
404different from assume-unchanged bit's. Skip-worktree also takes
405precedence over assume-unchanged bit when both are set.
406
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200407SPLIT INDEX
Christian Couderb4601392017-03-06 10:42:03 +0100408-----------
409
410This mode is designed for repositories with very large indexes, and
411aims at reducing the time it takes to repeatedly write these indexes.
412
413In this mode, the index is split into two files, $GIT_DIR/index and
414$GIT_DIR/sharedindex.<SHA-1>. Changes are accumulated in
415$GIT_DIR/index, the split index, while the shared index file contains
416all index entries and stays unchanged.
417
418All changes in the split index are pushed back to the shared index
419file when the number of entries in the split index reaches a level
420specified by the splitIndex.maxPercentChange config variable (see
421linkgit:git-config[1]).
422
423Each time a new shared index file is created, the old shared index
424files are deleted if their modification time is older than what is
425specified by the splitIndex.sharedIndexExpire config variable (see
426linkgit:git-config[1]).
427
428To avoid deleting a shared index file that is still used, its
429modification time is updated to the current time everytime a new split
430index based on the shared index file is either created or read from.
431
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200432UNTRACKED CACHE
Christian Couder435ec092016-01-27 07:58:05 +0100433---------------
434
435This cache is meant to speed up commands that involve determining
436untracked files such as `git status`.
437
438This feature works by recording the mtime of the working tree
439directories and then omitting reading directories and stat calls
440against files in those directories whose mtime hasn't changed. For
441this to work the underlying operating system and file system must
442change the `st_mtime` field of directories if files in the directory
443are added, modified or deleted.
444
445You can test whether the filesystem supports that with the
446`--test-untracked-cache` option. The `--untracked-cache` option used
447to implicitly perform that test in older versions of Git, but that's
448no longer the case.
449
450If you want to enable (or disable) this feature, it is easier to use
451the `core.untrackedCache` configuration variable (see
452linkgit:git-config[1]) than using the `--untracked-cache` option to
453`git update-index` in each repository, especially if you want to do so
454across all repositories you use, because you can set the configuration
455variable to `true` (or `false`) in your `$HOME/.gitconfig` just once
456and have it affect all repositories you touch.
457
458When the `core.untrackedCache` configuration variable is changed, the
459untracked cache is added to or removed from the index the next time a
460command reads the index; while when `--[no-|force-]untracked-cache`
461are used, the untracked cache is immediately added to or removed from
462the index.
Nguyễn Thái Ngọc Duy44a36912009-08-20 20:46:57 +0700463
Ævar Arnfjörð Bjarmason9b978692018-02-09 21:04:30 +0000464Before 2.17, the untracked cache had a bug where replacing a directory
465with a symlink to another directory could cause it to incorrectly show
466files tracked by git as untracked. See the "status: add a failing test
467showing a core.untrackedCache bug" commit to git.git. A workaround for
468that is (and this might work for other undiscovered bugs in the
469future):
470
471----------------
472$ git -c core.untrackedCache=false status
473----------------
474
475This bug has also been shown to affect non-symlink cases of replacing
476a directory with a file when it comes to the internal structures of
477the untracked cache, but no case has been reported where this resulted in
478wrong "git status" output.
479
Ævar Arnfjörð Bjarmason7bf0be72018-02-09 21:04:31 +0000480There are also cases where existing indexes written by git versions
481before 2.17 will reference directories that don't exist anymore,
482potentially causing many "could not open directory" warnings to be
483printed on "git status". These are new warnings for existing issues
484that were previously silently discarded.
485
486As with the bug described above the solution is to one-off do a "git
487status" run with `core.untrackedCache=false` to flush out the leftover
488bad data.
489
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200490FILE SYSTEM MONITOR
Ben Peart780494b2017-09-22 12:35:41 -0400491-------------------
492
493This feature is intended to speed up git operations for repos that have
494large working directories.
495
496It enables git to work together with a file system monitor (see the
497"fsmonitor-watchman" section of linkgit:githooks[5]) that can
498inform it as to what files have been modified. This enables git to avoid
499having to lstat() every file to find modified files.
500
501When used in conjunction with the untracked cache, it can further improve
502performance by avoiding the cost of scanning the entire working directory
503looking for new files.
504
505If you want to enable (or disable) this feature, it is easier to use
506the `core.fsmonitor` configuration variable (see
507linkgit:git-config[1]) than using the `--fsmonitor` option to
508`git update-index` in each repository, especially if you want to do so
509across all repositories you use, because you can set the configuration
Ben Peart4ccf4612018-02-14 10:41:30 -0500510variable in your `$HOME/.gitconfig` just once and have it affect all
511repositories you touch.
Ben Peart780494b2017-09-22 12:35:41 -0400512
513When the `core.fsmonitor` configuration variable is changed, the
514file system monitor is added to or removed from the index the next time
515a command reads the index. When `--[no-]fsmonitor` are used, the file
516system monitor is immediately added to or removed from the index.
517
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200518CONFIGURATION
Junio C Hamano5773c9f2005-10-29 14:32:56 -0700519-------------
520
521The command honors `core.filemode` configuration variable. If
Štěpán Němec466d1f12009-11-10 19:11:51 +0100522your repository is on a filesystem whose executable bits are
Dan McGee5162e692007-12-29 00:20:38 -0600523unreliable, this should be set to 'false' (see linkgit:git-config[1]).
Jon Loeliger61f693b2005-12-05 23:13:03 -0600524This causes the command to ignore differences in file modes recorded
525in the index and the file mode on the filesystem if they differ only on
Junio C Hamano5773c9f2005-10-29 14:32:56 -0700526executable bit. On such an unfortunate filesystem, you may
Thomas Rast0b444cd2010-01-10 00:33:00 +0100527need to use 'git update-index --chmod='.
Junio C Hamano5773c9f2005-10-29 14:32:56 -0700528
Johannes Sixt78a8d642007-03-02 22:11:30 +0100529Quite similarly, if `core.symlinks` configuration variable is set
Dan McGee5162e692007-12-29 00:20:38 -0600530to 'false' (see linkgit:git-config[1]), symbolic links are checked out
Johannes Sixt78a8d642007-03-02 22:11:30 +0100531as plain files, and this command does not modify a recorded file mode
532from symbolic link to regular file.
533
Junio C Hamanof9666ad2006-02-12 01:48:47 -0800534The command looks at `core.ignorestat` configuration variable. See
535'Using "assume unchanged" bit' section above.
536
Alex Riesen1ce47902008-07-28 08:31:28 +0200537The command also looks at `core.trustctime` configuration variable.
538It can be useful when the inode change time is regularly modified by
539something outside Git (file system crawlers and backup systems use
540ctime for marking files processed) (see linkgit:git-config[1]).
541
Christian Couder435ec092016-01-27 07:58:05 +0100542The untracked cache extension can be enabled by the
543`core.untrackedCache` configuration variable (see
544linkgit:git-config[1]).
Jon Loeliger61f693b2005-12-05 23:13:03 -0600545
Junio C Hamano56ae8df2008-05-28 16:55:27 -0700546SEE ALSO
Jon Loeliger61f693b2005-12-05 23:13:03 -0600547--------
Dan McGee5162e692007-12-29 00:20:38 -0600548linkgit:git-config[1],
Stefan Naeweacd6d7e2011-09-21 08:21:50 +0200549linkgit:git-add[1],
550linkgit:git-ls-files[1]
Jon Loeliger61f693b2005-12-05 23:13:03 -0600551
David Greaves2cf565c2005-05-10 22:32:30 +0100552GIT
553---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200554Part of the linkgit:git[1] suite