git-update-index.txt 6.72 KB
Newer Older
Junio C Hamano's avatar
Junio C Hamano committed
1
git-update-index(1)
2 3 4 5
===================

NAME
----
Junio C Hamano's avatar
Junio C Hamano committed
6
git-update-index - Modifies the index or directory cache
7 8 9 10


SYNOPSIS
--------
Junio C Hamano's avatar
Junio C Hamano committed
11
'git-update-index'
12 13
	     [--add] [--remove | --force-remove] [--replace] 
	     [--refresh [-q] [--unmerged] [--ignore-missing]]
14
	     [--cacheinfo <mode> <object> <file>]\*
Junio C Hamano's avatar
Junio C Hamano committed
15
	     [--chmod=(+|-)x]
16 17 18
	     [--info-only] [--index-info]
	     [-z] [--stdin]
	     [--verbose]
19 20 21 22 23
	     [--] [<file>]\*

DESCRIPTION
-----------
Modifies the index or directory cache. Each file mentioned is updated
24
into the index and any 'unmerged' or 'needs updating' state is
25 26
cleared.

Junio C Hamano's avatar
Junio C Hamano committed
27
The way "git-update-index" handles files it is told about can be modified
28 29 30 31 32
using the various options:

OPTIONS
-------
--add::
33
	If a specified file isn't in the index already then it's
34 35 36 37
	added.
	Default behaviour is to ignore new files.

--remove::
38
	If a specified file is in the index but is missing then it's
39 40 41 42
	removed.
	Default behaviour is to ignore removed file.

--refresh::
43
	Looks at the current index and checks to see if merges or
44 45
	updates are needed by checking stat() information.

46
-q::
47
        Quiet.  If --refresh finds that the index needs an update, the
48 49 50 51
        default behavior is to error out.  This option makes
        git-update-index continue anyway.

--unmerged::
52
        If --refresh finds unmerged changes in the index, the default
53 54 55
        behavior is to error out.  This option makes git-update-index 
        continue anyway.

56 57 58 59
--ignore-missing::
	Ignores missing files during a --refresh

--cacheinfo <mode> <object> <path>::
60
	Directly insert the specified info into the index.
61
	
62
--index-info::
Nikolai Weibull's avatar
Nikolai Weibull committed
63
        Read index information from stdin.
64 65 66 67

--chmod=(+|-)x::
        Set the execute permissions on the updated files.        

68 69 70
--info-only::
	Do not create objects in the object database for all
	<file> arguments that follow this flag; just insert
71
	their object IDs into the index.
72

73 74
--force-remove::
	Remove the file from the index even when the working directory
75
	still has such a file. (Implies --remove.)
76 77 78

--replace::
	By default, when a file `path` exists in the index,
Junio C Hamano's avatar
Junio C Hamano committed
79
	git-update-index refuses an attempt to add `path/file`.
80 81 82 83 84
	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.

85 86 87 88 89
--stdin::
	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.

90 91 92
--verbose::
        Report what is being added and removed from index.

93 94 95 96
-z::
	Only meaningful with `--stdin`; paths are separated with
	NUL character instead of LF.

97 98 99 100 101
--::
	Do not interpret any more arguments as options.

<file>::
	Files to act on.
Junio C Hamano's avatar
Junio C Hamano committed
102
	Note that files beginning with '.' are discarded. This includes
103 104 105 106 107 108
	`./file` and `dir/./file`. If you don't want this, then use	
	cleaner names.
	The same applies to directories ending '/' and paths with '//'

Using --refresh
---------------
109
'--refresh' does not calculate a new sha1 file or bring the index
110
up-to-date for mode/content changes. But what it *does* do is to
111 112
"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
113 114 115
the stat entry is out of date.

For example, you'd want to do this after doing a "git-read-tree", to link
116
up the stat index details with the proper files.
117

118 119 120 121 122 123
Using --cacheinfo or --info-only
--------------------------------
'--cacheinfo' is used to register a file that is not in the
current working directory.  This is useful for minimum-checkout
merging.

124
To pretend you have a file with mode and sha1 at path, say:
125

126 127 128
----------------
$ git-update-index --cacheinfo mode sha1 path
----------------
129

130 131
'--info-only' is used to register files without placing them in the object
database.  This is useful for status-only repositories.
132

133 134 135 136 137 138
Both '--cacheinfo' and '--info-only' behave similarly: the index is updated
but the object database isn't.  '--cacheinfo' is useful when the object is
in the database but the file isn't available locally.  '--info-only' is
useful when the file is available, but you do not wish to update the
object database.

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

Using --index-info
------------------

`--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:

    . mode         SP sha1          TAB path
+
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.

    . mode SP type SP sha1          TAB path
+
The second format is to stuff git-ls-tree output
into the index file.

    . mode         SP sha1 SP stage TAB path
+
This format is to put higher order stages into the
index file and matches git-ls-files --stage output.

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.

For example, starting with this index:

------------
$ git ls-files -s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz
------------

you can feed the following input to `--index-info`:

------------
$ git update-index --index-info
0 0000000000000000000000000000000000000000	frotz
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1	frotz
100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2	frotz
------------

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:

------------
$ git ls-files -s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1	frotz
100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2	frotz
------------


196 197
Examples
--------
198 199
To update and refresh only the files already checked out:

200 201 202
----------------
$ git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh
----------------
203 204


Junio C Hamano's avatar
Junio C Hamano committed
205 206 207 208 209
Configuration
-------------

The command honors `core.filemode` configuration variable.  If
your repository is on an filesystem whose executable bits are
210 211 212
unreliable, this should be set to 'false' (see gitlink:git-repo-config[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
Junio C Hamano's avatar
Junio C Hamano committed
213 214 215
executable bit.   On such an unfortunate filesystem, you may
need to use `git-update-index --chmod=`.

216 217 218 219 220 221

See Also
--------
gitlink:git-repo-config[1]


222 223 224 225 226 227 228 229 230 231
Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
232
Part of the gitlink:git[7] suite
233