OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-update-index.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-update-index(1)">\r
5 <articleinfo>\r
6     <title>git-update-index(1)</title>\r
7         <indexterm>\r
8                 <primary>git-update-index(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-update-index - Register file contents in the working tree to the index</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git update-index</emphasis>\r
19              [--add] [--remove | --force-remove] [--replace]\r
20              [--refresh] [-q] [--unmerged] [--ignore-missing]\r
21              [--cacheinfo &lt;mode&gt; &lt;object&gt; &lt;file&gt;]*\r
22              [--chmod=(+|-)x]\r
23              [--assume-unchanged | --no-assume-unchanged]\r
24              [--ignore-submodules]\r
25              [--really-refresh] [--unresolve] [--again | -g]\r
26              [--info-only] [--index-info]\r
27              [-z] [--stdin]\r
28              [--verbose]\r
29              [--] [&lt;file&gt;]\*</literallayout>\r
30 </blockquote>\r
31 </simplesect>\r
32 <simplesect id="_description">\r
33 <title>DESCRIPTION</title>\r
34 <simpara>Modifies the index or directory cache. Each file mentioned is updated\r
35 into the index and any <emphasis>unmerged</emphasis> or <emphasis>needs updating</emphasis> state is\r
36 cleared.</simpara>\r
37 <simpara>See also <xref linkend="git-add(1)"/> for a more user-friendly way to do some of\r
38 the most common operations on the index.</simpara>\r
39 <simpara>The way <emphasis>git-update-index</emphasis> handles files it is told about can be modified\r
40 using the various options:</simpara>\r
41 </simplesect>\r
42 <simplesect id="_options">\r
43 <title>OPTIONS</title>\r
44 <variablelist>\r
45 <varlistentry>\r
46 <term>\r
47 --add\r
48 </term>\r
49 <listitem>\r
50 <simpara>\r
51         If a specified file isn&#8217;t in the index already then it&#8217;s\r
52         added.\r
53         Default behaviour is to ignore new files.\r
54 </simpara>\r
55 </listitem>\r
56 </varlistentry>\r
57 <varlistentry>\r
58 <term>\r
59 --remove\r
60 </term>\r
61 <listitem>\r
62 <simpara>\r
63         If a specified file is in the index but is missing then it&#8217;s\r
64         removed.\r
65         Default behavior is to ignore removed file.\r
66 </simpara>\r
67 </listitem>\r
68 </varlistentry>\r
69 <varlistentry>\r
70 <term>\r
71 --refresh\r
72 </term>\r
73 <listitem>\r
74 <simpara>\r
75         Looks at the current index and checks to see if merges or\r
76         updates are needed by checking stat() information.\r
77 </simpara>\r
78 </listitem>\r
79 </varlistentry>\r
80 <varlistentry>\r
81 <term>\r
82 -q\r
83 </term>\r
84 <listitem>\r
85 <simpara>\r
86         Quiet.  If --refresh finds that the index needs an update, the\r
87         default behavior is to error out.  This option makes\r
88         <emphasis>git-update-index</emphasis> continue anyway.\r
89 </simpara>\r
90 </listitem>\r
91 </varlistentry>\r
92 <varlistentry>\r
93 <term>\r
94 --ignore-submodules\r
95 </term>\r
96 <listitem>\r
97 <simpara>\r
98         Do not try to update submodules.  This option is only respected\r
99         when passed before --refresh.\r
100 </simpara>\r
101 </listitem>\r
102 </varlistentry>\r
103 <varlistentry>\r
104 <term>\r
105 --unmerged\r
106 </term>\r
107 <listitem>\r
108 <simpara>\r
109         If --refresh finds unmerged changes in the index, the default\r
110         behavior is to error out.  This option makes <emphasis>git-update-index</emphasis>\r
111         continue anyway.\r
112 </simpara>\r
113 </listitem>\r
114 </varlistentry>\r
115 <varlistentry>\r
116 <term>\r
117 --ignore-missing\r
118 </term>\r
119 <listitem>\r
120 <simpara>\r
121         Ignores missing files during a --refresh\r
122 </simpara>\r
123 </listitem>\r
124 </varlistentry>\r
125 <varlistentry>\r
126 <term>\r
127 --cacheinfo &lt;mode&gt; &lt;object&gt; &lt;path&gt;\r
128 </term>\r
129 <listitem>\r
130 <simpara>\r
131         Directly insert the specified info into the index.\r
132 </simpara>\r
133 </listitem>\r
134 </varlistentry>\r
135 <varlistentry>\r
136 <term>\r
137 --index-info\r
138 </term>\r
139 <listitem>\r
140 <simpara>\r
141         Read index information from stdin.\r
142 </simpara>\r
143 </listitem>\r
144 </varlistentry>\r
145 <varlistentry>\r
146 <term>\r
147 --chmod=(+|-)x\r
148 </term>\r
149 <listitem>\r
150 <simpara>\r
151         Set the execute permissions on the updated files.\r
152 </simpara>\r
153 </listitem>\r
154 </varlistentry>\r
155 <varlistentry>\r
156 <term>\r
157 --assume-unchanged\r
158 </term>\r
159 <term>\r
160 --no-assume-unchanged\r
161 </term>\r
162 <listitem>\r
163 <simpara>\r
164         When these flags are specified, the object names recorded\r
165         for the paths are not updated.  Instead, these options\r
166         set and unset the "assume unchanged" bit for the\r
167         paths.  When the "assume unchanged" bit is on, git stops\r
168         checking the working tree files for possible\r
169         modifications, so you need to manually unset the bit to\r
170         tell git when you change the working tree file. This is\r
171         sometimes helpful when working with a big project on a\r
172         filesystem that has very slow lstat(2) system call\r
173         (e.g. cifs).\r
174 </simpara>\r
175 <simpara>This option can be also used as a coarse file-level mechanism\r
176 to ignore uncommitted changes in tracked files (akin to what\r
177 <literal>.gitignore</literal> does for untracked files).\r
178 You should remember that an explicit <emphasis>git add</emphasis> operation will\r
179 still cause the file to be refreshed from the working tree.\r
180 Git will fail (gracefully) in case it needs to modify this file\r
181 in the index e.g. when merging in a commit;\r
182 thus, in case the assumed-untracked file is changed upstream,\r
183 you will need to handle the situation manually.</simpara>\r
184 </listitem>\r
185 </varlistentry>\r
186 <varlistentry>\r
187 <term>\r
188 -g\r
189 </term>\r
190 <term>\r
191 --again\r
192 </term>\r
193 <listitem>\r
194 <simpara>\r
195         Runs <emphasis>git-update-index</emphasis> itself on the paths whose index\r
196         entries are different from those from the <literal>HEAD</literal> commit.\r
197 </simpara>\r
198 </listitem>\r
199 </varlistentry>\r
200 <varlistentry>\r
201 <term>\r
202 --unresolve\r
203 </term>\r
204 <listitem>\r
205 <simpara>\r
206         Restores the <emphasis>unmerged</emphasis> or <emphasis>needs updating</emphasis> state of a\r
207         file during a merge if it was cleared by accident.\r
208 </simpara>\r
209 </listitem>\r
210 </varlistentry>\r
211 <varlistentry>\r
212 <term>\r
213 --info-only\r
214 </term>\r
215 <listitem>\r
216 <simpara>\r
217         Do not create objects in the object database for all\r
218         &lt;file&gt; arguments that follow this flag; just insert\r
219         their object IDs into the index.\r
220 </simpara>\r
221 </listitem>\r
222 </varlistentry>\r
223 <varlistentry>\r
224 <term>\r
225 --force-remove\r
226 </term>\r
227 <listitem>\r
228 <simpara>\r
229         Remove the file from the index even when the working directory\r
230         still has such a file. (Implies --remove.)\r
231 </simpara>\r
232 </listitem>\r
233 </varlistentry>\r
234 <varlistentry>\r
235 <term>\r
236 --replace\r
237 </term>\r
238 <listitem>\r
239 <simpara>\r
240         By default, when a file <literal>path</literal> exists in the index,\r
241         <emphasis>git-update-index</emphasis> refuses an attempt to add <literal>path/file</literal>.\r
242         Similarly if a file <literal>path/file</literal> exists, a file <literal>path</literal>\r
243         cannot be added.  With --replace flag, existing entries\r
244         that conflict with the entry being added are\r
245         automatically removed with warning messages.\r
246 </simpara>\r
247 </listitem>\r
248 </varlistentry>\r
249 <varlistentry>\r
250 <term>\r
251 --stdin\r
252 </term>\r
253 <listitem>\r
254 <simpara>\r
255         Instead of taking list of paths from the command line,\r
256         read list of paths from the standard input.  Paths are\r
257         separated by LF (i.e. one path per line) by default.\r
258 </simpara>\r
259 </listitem>\r
260 </varlistentry>\r
261 <varlistentry>\r
262 <term>\r
263 --verbose\r
264 </term>\r
265 <listitem>\r
266 <simpara>\r
267         Report what is being added and removed from index.\r
268 </simpara>\r
269 </listitem>\r
270 </varlistentry>\r
271 <varlistentry>\r
272 <term>\r
273 -z\r
274 </term>\r
275 <listitem>\r
276 <simpara>\r
277         Only meaningful with <literal>--stdin</literal>; paths are separated with\r
278         NUL character instead of LF.\r
279 </simpara>\r
280 </listitem>\r
281 </varlistentry>\r
282 <varlistentry>\r
283 <term>\r
284 --\r
285 </term>\r
286 <listitem>\r
287 <simpara>\r
288         Do not interpret any more arguments as options.\r
289 </simpara>\r
290 </listitem>\r
291 </varlistentry>\r
292 <varlistentry>\r
293 <term>\r
294 &lt;file&gt;\r
295 </term>\r
296 <listitem>\r
297 <simpara>\r
298         Files to act on.\r
299         Note that files beginning with <emphasis>.</emphasis> are discarded. This includes\r
300         <literal>./file</literal> and <literal>dir/./file</literal>. If you don&#8217;t want this, then use\r
301         cleaner names.\r
302         The same applies to directories ending <emphasis>/</emphasis> and paths with <emphasis>//</emphasis>\r
303 </simpara>\r
304 </listitem>\r
305 </varlistentry>\r
306 </variablelist>\r
307 </simplesect>\r
308 <simplesect id="_using_refresh">\r
309 <title>Using --refresh</title>\r
310 <simpara><emphasis>--refresh</emphasis> does not calculate a new sha1 file or bring the index\r
311 up-to-date for mode/content changes. But what it <emphasis role="strong">does</emphasis> do is to\r
312 "re-match" the stat information of a file with the index, so that you\r
313 can refresh the index for a file that hasn&#8217;t been changed but where\r
314 the stat entry is out of date.</simpara>\r
315 <simpara>For example, you&#8217;d want to do this after doing a <emphasis>git-read-tree</emphasis>, to link\r
316 up the stat index details with the proper files.</simpara>\r
317 </simplesect>\r
318 <simplesect id="_using_cacheinfo_or_info_only">\r
319 <title>Using --cacheinfo or --info-only</title>\r
320 <simpara><emphasis>--cacheinfo</emphasis> is used to register a file that is not in the\r
321 current working directory.  This is useful for minimum-checkout\r
322 merging.</simpara>\r
323 <simpara>To pretend you have a file with mode and sha1 at path, say:</simpara>\r
324 <literallayout>$ git update-index --cacheinfo mode sha1 path</literallayout>\r
325 <simpara><emphasis>--info-only</emphasis> is used to register files without placing them in the object\r
326 database.  This is useful for status-only repositories.</simpara>\r
327 <simpara>Both <emphasis>--cacheinfo</emphasis> and <emphasis>--info-only</emphasis> behave similarly: the index is updated\r
328 but the object database isn&#8217;t.  <emphasis>--cacheinfo</emphasis> is useful when the object is\r
329 in the database but the file isn&#8217;t available locally.  <emphasis>--info-only</emphasis> is\r
330 useful when the file is available, but you do not wish to update the\r
331 object database.</simpara>\r
332 </simplesect>\r
333 <simplesect id="_using_index_info">\r
334 <title>Using --index-info</title>\r
335 <simpara><literal>--index-info</literal> is a more powerful mechanism that lets you feed\r
336 multiple entry definitions from the standard input, and designed\r
337 specifically for scripts.  It can take inputs of three formats:</simpara>\r
338 <orderedlist numeration="arabic">\r
339 <listitem>\r
340 <simpara>\r
341 mode         SP sha1          TAB path\r
342 </simpara>\r
343 <simpara>The first format is what "git-apply --index-info"\r
344 reports, and used to reconstruct a partial tree\r
345 that is used for phony merge base tree when falling\r
346 back on 3-way merge.</simpara>\r
347 </listitem>\r
348 <listitem>\r
349 <simpara>\r
350 mode SP type SP sha1          TAB path\r
351 </simpara>\r
352 <simpara>The second format is to stuff <emphasis>git-ls-tree</emphasis> output\r
353 into the index file.</simpara>\r
354 </listitem>\r
355 <listitem>\r
356 <simpara>\r
357 mode         SP sha1 SP stage TAB path\r
358 </simpara>\r
359 <simpara>This format is to put higher order stages into the\r
360 index file and matches <emphasis>git-ls-files --stage</emphasis> output.</simpara>\r
361 </listitem>\r
362 </orderedlist>\r
363 <simpara>To place a higher stage entry to the index, the path should\r
364 first be removed by feeding a mode=0 entry for the path, and\r
365 then feeding necessary input lines in the third format.</simpara>\r
366 <simpara>For example, starting with this index:</simpara>\r
367 <literallayout>$ git ls-files -s\r
368 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz</literallayout>\r
369 <simpara>you can feed the following input to <literal>--index-info</literal>:</simpara>\r
370 <literallayout>$ git update-index --index-info\r
371 0 0000000000000000000000000000000000000000      frotz\r
372 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
373 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</literallayout>\r
374 <simpara>The first line of the input feeds 0 as the mode to remove the\r
375 path; the SHA1 does not matter as long as it is well formatted.\r
376 Then the second and third line feeds stage 1 and stage 2 entries\r
377 for that path.  After the above, we would end up with this:</simpara>\r
378 <literallayout>$ git ls-files -s\r
379 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1       frotz\r
380 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2       frotz</literallayout>\r
381 </simplesect>\r
382 <simplesect id="_using_8220_assume_unchanged_8221_bit">\r
383 <title>Using &#8220;assume unchanged&#8221; bit</title>\r
384 <simpara>Many operations in git depend on your filesystem to have an\r
385 efficient <literal>lstat(2)</literal> implementation, so that <literal>st_mtime</literal>\r
386 information for working tree files can be cheaply checked to see\r
387 if the file contents have changed from the version recorded in\r
388 the index file.  Unfortunately, some filesystems have\r
389 inefficient <literal>lstat(2)</literal>.  If your filesystem is one of them, you\r
390 can set "assume unchanged" bit to paths you have not changed to\r
391 cause git not to do this check.  Note that setting this bit on a\r
392 path does not mean git will check the contents of the file to\r
393 see if it has changed&#8201;&#8212;&#8201;it makes git to omit any checking and\r
394 assume it has <emphasis role="strong">not</emphasis> changed.  When you make changes to working\r
395 tree files, you have to explicitly tell git about it by dropping\r
396 "assume unchanged" bit, either before or after you modify them.</simpara>\r
397 <simpara>In order to set "assume unchanged" bit, use <literal>--assume-unchanged</literal>\r
398 option.  To unset, use <literal>--no-assume-unchanged</literal>.</simpara>\r
399 <simpara>The command looks at <literal>core.ignorestat</literal> configuration variable.  When\r
400 this is true, paths updated with <literal>git update-index paths&#8230;</literal> and\r
401 paths updated with other git commands that update both index and\r
402 working tree (e.g. <emphasis>git-apply --index</emphasis>, <emphasis>git-checkout-index -u</emphasis>,\r
403 and <emphasis>git-read-tree -u</emphasis>) are automatically marked as "assume\r
404 unchanged".  Note that "assume unchanged" bit is <emphasis role="strong">not</emphasis> set if\r
405 <literal>git update-index --refresh</literal> finds the working tree file matches\r
406 the index (use <literal>git update-index --really-refresh</literal> if you want\r
407 to mark them as "assume unchanged").</simpara>\r
408 </simplesect>\r
409 <simplesect id="_examples">\r
410 <title>Examples</title>\r
411 <simpara>To update and refresh only the files already checked out:</simpara>\r
412 <literallayout>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</literallayout>\r
413 <variablelist>\r
414 <varlistentry>\r
415 <term>\r
416 On an inefficient filesystem with <literal>core.ignorestat</literal> set\r
417 </term>\r
418 <listitem>\r
419 <literallayout>$ git update-index --really-refresh              <co id="CO1-1"/>\r
420 $ git update-index --no-assume-unchanged foo.c   <co id="CO1-2"/>\r
421 $ git diff --name-only                           <co id="CO1-3"/>\r
422 $ edit foo.c\r
423 $ git diff --name-only                           <co id="CO1-4"/>\r
424 M foo.c\r
425 $ git update-index foo.c                         <co id="CO1-5"/>\r
426 $ git diff --name-only                           <co id="CO1-6"/>\r
427 $ edit foo.c\r
428 $ git diff --name-only                           <co id="CO1-7"/>\r
429 $ git update-index --no-assume-unchanged foo.c   <co id="CO1-8"/>\r
430 $ git diff --name-only                           <co id="CO1-9"/>\r
431 M foo.c</literallayout>\r
432 <calloutlist>\r
433 <callout arearefs="CO1-1">\r
434 <simpara>\r
435 forces lstat(2) to set "assume unchanged" bits for paths that match index.\r
436 </simpara>\r
437 </callout>\r
438 <callout arearefs="CO1-2">\r
439 <simpara>\r
440 mark the path to be edited.\r
441 </simpara>\r
442 </callout>\r
443 <callout arearefs="CO1-3">\r
444 <simpara>\r
445 this does lstat(2) and finds index matches the path.\r
446 </simpara>\r
447 </callout>\r
448 <callout arearefs="CO1-4">\r
449 <simpara>\r
450 this does lstat(2) and finds index does <emphasis role="strong">not</emphasis> match the path.\r
451 </simpara>\r
452 </callout>\r
453 <callout arearefs="CO1-5">\r
454 <simpara>\r
455 registering the new version to index sets "assume unchanged" bit.\r
456 </simpara>\r
457 </callout>\r
458 <callout arearefs="CO1-6">\r
459 <simpara>\r
460 and it is assumed unchanged.\r
461 </simpara>\r
462 </callout>\r
463 <callout arearefs="CO1-7">\r
464 <simpara>\r
465 even after you edit it.\r
466 </simpara>\r
467 </callout>\r
468 <callout arearefs="CO1-8">\r
469 <simpara>\r
470 you can tell about the change after the fact.\r
471 </simpara>\r
472 </callout>\r
473 <callout arearefs="CO1-9">\r
474 <simpara>\r
475 now it checks with lstat(2) and finds it has been changed.\r
476 </simpara>\r
477 </callout>\r
478 </calloutlist>\r
479 </listitem>\r
480 </varlistentry>\r
481 </variablelist>\r
482 </simplesect>\r
483 <simplesect id="_configuration">\r
484 <title>Configuration</title>\r
485 <simpara>The command honors <literal>core.filemode</literal> configuration variable.  If\r
486 your repository is on an filesystem whose executable bits are\r
487 unreliable, this should be set to <emphasis>false</emphasis> (see <xref linkend="git-config(1)"/>).\r
488 This causes the command to ignore differences in file modes recorded\r
489 in the index and the file mode on the filesystem if they differ only on\r
490 executable bit.   On such an unfortunate filesystem, you may\r
491 need to use <emphasis>git-update-index --chmod=</emphasis>.</simpara>\r
492 <simpara>Quite similarly, if <literal>core.symlinks</literal> configuration variable is set\r
493 to <emphasis>false</emphasis> (see <xref linkend="git-config(1)"/>), symbolic links are checked out\r
494 as plain files, and this command does not modify a recorded file mode\r
495 from symbolic link to regular file.</simpara>\r
496 <simpara>The command looks at <literal>core.ignorestat</literal> configuration variable.  See\r
497 <emphasis>Using "assume unchanged" bit</emphasis> section above.</simpara>\r
498 <simpara>The command also looks at <literal>core.trustctime</literal> configuration variable.\r
499 It can be useful when the inode change time is regularly modified by\r
500 something outside Git (file system crawlers and backup systems use\r
501 ctime for marking files processed) (see <xref linkend="git-config(1)"/>).</simpara>\r
502 </simplesect>\r
503 <simplesect id="_see_also">\r
504 <title>SEE ALSO</title>\r
505 <simpara><xref linkend="git-config(1)"/>,\r
506 <xref linkend="git-add(1)"/></simpara>\r
507 </simplesect>\r
508 <simplesect id="_author">\r
509 <title>Author</title>\r
510 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
511 </simplesect>\r
512 <simplesect id="_documentation">\r
513 <title>Documentation</title>\r
514 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
515 </simplesect>\r
516 <simplesect id="_git">\r
517 <title>GIT</title>\r
518 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
519 </simplesect>\r
520 </article>\r