man1/git-update-index.1

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