Documentation/git-update-index.txt

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