git-update-index.txt 4.88 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 24 25 26
	     [--] [<file>]\*

DESCRIPTION
-----------
Modifies the index or directory cache. Each file mentioned is updated
into the cache and any 'unmerged' or 'needs updating' state is
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 33 34 35 36 37 38 39 40 41 42 43 44 45
using the various options:

OPTIONS
-------
--add::
	If a specified file isn't in the cache already then it's
	added.
	Default behaviour is to ignore new files.

--remove::
	If a specified file is in the cache but is missing then it's
	removed.
	Default behaviour is to ignore removed file.

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

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

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

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

--cacheinfo <mode> <object> <path>::
	Directly insert the specified info into the cache.
	
62 63 64 65 66 67
--index-info::
        Read index info from stdin.

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

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

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 109 110 111 112 113 114 115 116 117
	`./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
---------------
'--refresh' does not calculate a new sha1 file or bring the cache
up-to-date for mode/content changes. But what it *does* do is to
"re-match" the stat information of a file with the cache, so that you
can refresh the cache for a file that hasn't been changed but where
the stat entry is out of date.

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

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

Junio C Hamano's avatar
Junio C Hamano committed
126
   $ git-update-index --cacheinfo mode sha1 path
127

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

131 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.

Examples
--------
139 140
To update and refresh only the files already checked out:

Junio C Hamano's avatar
Junio C Hamano committed
141
   git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh
142 143


Junio C Hamano's avatar
Junio C Hamano committed
144 145 146 147 148 149 150 151 152 153 154
Configuration
-------------

The command honors `core.filemode` configuration variable.  If
your repository is on an filesystem whose executable bits are
unreliable, this should be set to 'false'.  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=`.

155 156 157 158 159 160 161 162 163 164
Author
------
Written by Linus Torvalds <[email protected]>

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

GIT
---
165
Part of the gitlink:git[7] suite
166