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