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