Change 'cache' to 'index' in the docs
This patch makes the documentation refer to the index as index instead of cache, but some references still remain. (e.g. git-update-index.txt) Signed-off-by: Lukas Sandström <lukass@etek.chalmers.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
Lukas_Sandström committed
Nov 11, 2005 at 02:12 UTC
5f3aa197ac03eabbc45046cd3b9dbcfbda0426d9
17 files changed
+71
-71
Documentation/diff-format.txt
+4
-4
@@ -8,13 +8,13 @@ git-diff-index <tree-ish>::
8
compares the <tree-ish> and the files on the filesystem.
9
10
git-diff-index --cached <tree-ish>::
11
- compares the <tree-ish> and the cache.
11
+ compares the <tree-ish> and the index.
12
13
git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
14
compares the trees named by the two arguments.
15
16
git-diff-files [<pattern>...]::
17
- compares the cache and the files on the filesystem.
17
+ compares the index and the files on the filesystem.
18
19
20
An output line is formatted this way:
@@ -47,7 +47,7 @@ That is, from the left to the right:
47
. an LF or a NUL when '-z' option is used, to terminate the record.
48
49
<sha1> is shown as all 0's if a file is new on the filesystem
50
-and it is out of sync with the cache.
50
+and it is out of sync with the index.
51
52
Example:
53
@@ -104,7 +104,7 @@ where:
104
The file parameters can point at the user's working file
105
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
106
when a new file is added), or a temporary file (e.g. `old-file` in the
107
-cache). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
107
+index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
108
temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
109
110
For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
Documentation/diff-options.txt
+1
-1
@@ -50,7 +50,7 @@
50
<orderfile>, which has one shell glob pattern per line.
51
52
-R::
53
- Swap two inputs; that is, show differences from cache or
53
+ Swap two inputs; that is, show differences from index or
54
on-disk file to tree contents.
55
56
For more detailed explanation on these common options, see also
Documentation/git-checkout-index.txt
+7
-7
@@ -3,7 +3,7 @@ git-checkout-index(1)
3
4
NAME
5
----
6
-git-checkout-index - Copy files from the cache to the working directory
6
+git-checkout-index - Copy files from the index to the working directory
7
8
9
SYNOPSIS
@@ -13,23 +13,23 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Will copy all files listed from the cache to the working directory
16
+Will copy all files listed from the index to the working directory
17
(not overwriting existing files).
18
19
OPTIONS
20
-------
21
-u::
22
update stat information for the checked out entries in
23
- the cache file.
23
+ the index file.
24
25
-q::
26
- be quiet if files exist or are not in the cache
26
+ be quiet if files exist or are not in the index
27
28
-f::
29
forces overwrite of existing files
30
31
-a::
32
- checks out all files in the cache. Cannot be used
32
+ checks out all files in the index. Cannot be used
33
together with explicit filenames.
34
35
-n::
@@ -57,7 +57,7 @@ supposed to be able to do things like:
57
58
which will force all existing `*.h` files to be replaced with their
59
cached copies. If an empty command line implied "all", then this would
60
-force-refresh everything in the cache, which was not the point.
60
+force-refresh everything in the index, which was not the point.
61
62
To update and refresh only the files already checked out:
63
@@ -74,7 +74,7 @@ desired tree into the index, and do a
74
75
git-checkout-index --prefix=git-export-dir/ -a
76
77
-and git-checkout-index will "export" the cache into the specified
77
+and git-checkout-index will "export" the index into the specified
78
directory.
79
80
NOTE The final "/" is important. The exported name is literally just
Documentation/git-cvsimport.txt
+1
-1
@@ -35,7 +35,7 @@ OPTIONS
35
36
-i::
37
Import-only: don't perform a checkout after importing. This option
38
- ensures the working directory and cache remain untouched and will
38
+ ensures the working directory and index remain untouched and will
39
not create them if they do not exist.
40
41
-k::
Documentation/git-diff-files.txt
+3
-3
@@ -3,7 +3,7 @@ git-diff-files(1)
3
4
NAME
5
----
6
-git-diff-files - Compares files in the working tree and the cache
6
+git-diff-files - Compares files in the working tree and the index
7
8
9
SYNOPSIS
@@ -12,9 +12,9 @@ SYNOPSIS
12
13
DESCRIPTION
14
-----------
15
-Compares the files in the working tree and the cache. When paths
15
+Compares the files in the working tree and the index. When paths
16
are specified, compares only those named paths. Otherwise all
17
-entries in the cache are compared. The output format is the
17
+entries in the index are compared. The output format is the
18
same as "git-diff-index" and "git-diff-tree".
19
20
OPTIONS
Documentation/git-diff-index.txt
+7
-7
@@ -3,7 +3,7 @@ git-diff-index(1)
3
4
NAME
5
----
6
-git-diff-index - Compares content and mode of blobs between the cache and repository
6
+git-diff-index - Compares content and mode of blobs between the index and repository
7
8
9
SYNOPSIS
@@ -13,10 +13,10 @@ SYNOPSIS
13
DESCRIPTION
14
-----------
15
Compares the content and mode of the blobs found via a tree
16
-object with the content of the current cache and, optionally
16
+object with the content of the current index and, optionally
17
ignoring the stat state of the file on disk. When paths are
18
specified, compares only those named paths. Otherwise all
19
-entries in the cache are compared.
19
+entries in the index are compared.
20
21
OPTIONS
22
-------
@@ -49,11 +49,11 @@ Cached Mode
49
-----------
50
If '--cached' is specified, it allows you to ask:
51
52
- show me the differences between HEAD and the current cache
52
+ show me the differences between HEAD and the current index
53
contents (the ones I'd write with a "git-write-tree")
54
55
For example, let's say that you have worked on your working directory, updated
56
-some files in the cache and are ready to commit. You want to see eactly
56
+some files in the index and are ready to commit. You want to see eactly
57
*what* you are going to commit is without having to write a new tree
58
object and compare it that way, and to do that, you just do
59
@@ -92,7 +92,7 @@ which is obviously a very useful question too, since that tells you what
92
you *could* commit. Again, the output matches the "git-diff-tree -r"
93
output to a tee, but with a twist.
94
95
-The twist is that if some file doesn't match the cache, we don't have
95
+The twist is that if some file doesn't match the index, we don't have
96
a backing store thing for it, and we use the magic "all-zero" sha1 to
97
show that. So let's say that you have edited `kernel/sched.c`, but
98
have not actually done a "git-update-index" on it yet - there is no
@@ -110,7 +110,7 @@ NOTE: As with other commands of this type, "git-diff-index" does not
110
actually look at the contents of the file at all. So maybe
111
`kernel/sched.c` hasn't actually changed, and it's just that you
112
touched it. In either case, it's a note that you need to
113
-"git-upate-cache" it to make the cache be in sync.
113
+"git-upate-index" it to make the index be in sync.
114
115
NOTE: You can have a mixture of files show up as "has been updated"
116
and "is still dirty in the working directory" together. You can always
Documentation/git-fsck-objects.txt
+2
-2
@@ -33,7 +33,7 @@ index file and all SHA1 references in .git/refs/* as heads.
33
Report tags.
34
35
--cache::
36
- Consider any object recorded in the cache also as a head node for
36
+ Consider any object recorded in the index also as a head node for
37
an unreachability trace.
38
39
--standalone::
@@ -125,7 +125,7 @@ GIT_OBJECT_DIRECTORY::
125
used to specify the object database root (usually $GIT_DIR/objects)
126
127
GIT_INDEX_FILE::
128
- used to specify the index file of the cache
128
+ used to specify the index file of the index
129
130
GIT_ALTERNATE_OBJECT_DIRECTORIES::
131
used to specify additional object database roots (usually unset)
Documentation/git-hash-object.txt
+1
-1
@@ -16,7 +16,7 @@ Computes the object ID value for an object with specified type
16
with the contents of the named file (which can be outside of the
17
work tree), and optionally writes the resulting object into the
18
object database. Reports its object ID to its standard output.
19
-This is used by "git-cvsimport" to update the cache
19
+This is used by "git-cvsimport" to update the index
20
without modifying files in the work tree. When <type> is not
21
specified, it defaults to "blob".
22
Documentation/git-ls-files.txt
+1
-1
@@ -3,7 +3,7 @@ git-ls-files(1)
3
4
NAME
5
----
6
-git-ls-files - Information about files in the cache/working directory
6
+git-ls-files - Information about files in the index/working directory
7
8
9
SYNOPSIS
Documentation/git-merge-index.txt
+2
-2
@@ -12,7 +12,7 @@ SYNOPSIS
12
13
DESCRIPTION
14
-----------
15
-This looks up the <file>(s) in the cache and, if there are any merge
15
+This looks up the <file>(s) in the index and, if there are any merge
16
entries, passes the SHA1 hash for those files as arguments 1, 2, 3 (empty
17
argument if no file), and <file> as argument 4. File modes for the three
18
files are passed as arguments 5, 6 and 7.
@@ -23,7 +23,7 @@ OPTIONS
23
Interpret all following arguments as filenames.
24
25
-a::
26
- Run merge against all files in the cache that need merging.
26
+ Run merge against all files in the index that need merging.
27
28
-o::
29
Instead of stopping at the first failed merge, do all of them
Documentation/git-read-tree.txt
+10
-10
@@ -3,7 +3,7 @@ git-read-tree(1)
3
4
NAME
5
----
6
-git-read-tree - Reads tree information into the directory cache
6
+git-read-tree - Reads tree information into the index
7
8
9
SYNOPSIS
@@ -13,11 +13,11 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Reads the tree information given by <tree-ish> into the directory cache,
16
+Reads the tree information given by <tree-ish> into the index,
17
but does not actually *update* any of the files it "caches". (see:
18
git-checkout-index)
19
20
-Optionally, it can merge a tree into the cache, perform a
20
+Optionally, it can merge a tree into the index, perform a
21
fast-forward (i.e. 2-way) merge, or a 3-way merge, with the -m
22
flag. When used with -m, the -u flag causes it to also update
23
the files in the work tree with the result of the merge.
@@ -59,10 +59,10 @@ provided.
59
Single Tree Merge
60
~~~~~~~~~~~~~~~~~
61
If only 1 tree is specified, git-read-tree operates as if the user did not
62
-specify '-m', except that if the original cache has an entry for a
62
+specify '-m', except that if the original index has an entry for a
63
given pathname, and the contents of the path matches with the tree
64
-being read, the stat info from the cache is used. (In other words, the
65
-cache's stat()s take precedence over the merged tree's).
64
+being read, the stat info from the index is used. (In other words, the
65
+index's stat()s take precedence over the merged tree's).
66
67
That means that if you do a "git-read-tree -m <newtree>" followed by a
68
"git-checkout-index -f -u -a", the "git-checkout-index" only checks out
@@ -96,7 +96,7 @@ Here are the "carry forward" rules:
96
-------------------------------------------------------
97
0 nothing nothing nothing (does not happen)
98
1 nothing nothing exists use M
99
- 2 nothing exists nothing remove path from cache
99
+ 2 nothing exists nothing remove path from index
100
3 nothing exists exists use M
101
102
clean I==H I==M
@@ -109,7 +109,7 @@ Here are the "carry forward" rules:
109
8 yes N/A no nothing exists fail
110
9 no N/A no nothing exists fail
111
112
- 10 yes yes N/A exists nothing remove path from cache
112
+ 10 yes yes N/A exists nothing remove path from index
113
11 no yes N/A exists nothing fail
114
12 yes no N/A exists nothing fail
115
13 no no N/A exists nothing fail
@@ -128,7 +128,7 @@ Here are the "carry forward" rules:
128
20 yes yes no exists exists use M
129
21 no yes no exists exists fail
130
131
-In all "keep index" cases, the cache entry stays as in the
131
+In all "keep index" cases, the index entry stays as in the
132
original index file. If the entry were not up to date,
133
git-read-tree keeps the copy in the work tree intact when
134
operating under the -u flag.
@@ -245,7 +245,7 @@ since you pulled from him:
245
246
Your work tree is still based on your HEAD ($JC), but you have
247
some edits since. Three-way merge makes sure that you have not
248
-added or modified cache entries since $JC, and if you haven't,
248
+added or modified index entries since $JC, and if you haven't,
249
then does the right thing. So with the following sequence:
250
251
$ git-read-tree -m -u `git-merge-base $JC $LT` $JC $LT
Documentation/git-svnimport.txt
+1
-1
@@ -44,7 +44,7 @@ When importing incementally, you might need to edit the .git/svn2git file.
44
45
-i::
46
Import-only: don't perform a checkout after importing. This option
47
- ensures the working directory and cache remain untouched and will
47
+ ensures the working directory and index remain untouched and will
48
not create them if they do not exist.
49
50
-t <trunk_subdir>::
Documentation/git-update-index.txt
+12
-12
@@ -21,7 +21,7 @@ SYNOPSIS
21
DESCRIPTION
22
-----------
23
Modifies the index or directory cache. Each file mentioned is updated
24
-into the cache and any 'unmerged' or 'needs updating' state is
24
+into the index and any 'unmerged' or 'needs updating' state is
25
cleared.
26
27
The way "git-update-index" handles files it is told about can be modified
@@ -30,26 +30,26 @@ using the various options:
30
OPTIONS
31
-------
32
--add::
33
- If a specified file isn't in the cache already then it's
33
+ If a specified file isn't in the index already then it's
34
added.
35
Default behaviour is to ignore new files.
36
37
--remove::
38
- If a specified file is in the cache but is missing then it's
38
+ If a specified file is in the index but is missing then it's
39
removed.
40
Default behaviour is to ignore removed file.
41
42
--refresh::
43
- Looks at the current cache and checks to see if merges or
43
+ Looks at the current index and checks to see if merges or
44
updates are needed by checking stat() information.
45
46
-q::
47
- Quiet. If --refresh finds that the cache needs an update, the
47
+ Quiet. If --refresh finds that the index needs an update, the
48
default behavior is to error out. This option makes
49
git-update-index continue anyway.
50
51
--unmerged::
52
- If --refresh finds unmerged changes in the cache, the default
52
+ If --refresh finds unmerged changes in the index, the default
53
behavior is to error out. This option makes git-update-index
54
continue anyway.
55
@@ -57,7 +57,7 @@ OPTIONS
57
Ignores missing files during a --refresh
58
59
--cacheinfo <mode> <object> <path>::
60
- Directly insert the specified info into the cache.
60
+ Directly insert the specified info into the index.
61
62
--index-info::
63
Read index info from stdin.
@@ -68,7 +68,7 @@ OPTIONS
68
--info-only::
69
Do not create objects in the object database for all
70
<file> arguments that follow this flag; just insert
71
- their object IDs into the cache.
71
+ their object IDs into the index.
72
73
--force-remove::
74
Remove the file from the index even when the working directory
@@ -106,14 +106,14 @@ OPTIONS
106
107
Using --refresh
108
---------------
109
-'--refresh' does not calculate a new sha1 file or bring the cache
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
-"re-match" the stat information of a file with the cache, so that you
112
-can refresh the cache for a file that hasn't been changed but where
111
+"re-match" the stat information of a file with the index, so that you
112
+can refresh the index for a file that hasn't been changed but where
113
the stat entry is out of date.
114
115
For example, you'd want to do this after doing a "git-read-tree", to link
116
-up the stat cache details with the proper files.
116
+up the stat index details with the proper files.
117
118
Using --cacheinfo or --info-only
119
--------------------------------
Documentation/git-write-tree.txt
+4
-4
@@ -3,7 +3,7 @@ git-write-tree(1)
3
4
NAME
5
----
6
-git-write-tree - Creates a tree object from the current cache
6
+git-write-tree - Creates a tree object from the current index
7
8
9
SYNOPSIS
@@ -12,11 +12,11 @@ SYNOPSIS
12
13
DESCRIPTION
14
-----------
15
-Creates a tree object using the current cache.
15
+Creates a tree object using the current index.
16
17
-The cache must be merged.
17
+The index must be merged.
18
19
-Conceptually, "git-write-tree" sync()s the current directory cache contents
19
+Conceptually, "git-write-tree" sync()s the current index contents
20
into a set of tree files.
21
In order to have that match what is actually in your directory right
22
now, you need to have done a "git-update-index" phase before you did the
Documentation/git.txt
+9
-9
@@ -40,7 +40,7 @@ reflect recent changes.
40
Commands Overview
41
-----------------
42
The git commands can helpfully be split into those that manipulate
43
-the repository, the cache and the working fileset, those that
43
+the repository, the index and the working fileset, those that
44
interrogate and compare them, and those that moves objects and
45
references between repositories.
46
@@ -59,7 +59,7 @@ gitlink:git-apply[1]::
59
applies it to the working tree.
60
61
gitlink:git-checkout-index[1]::
62
- Copy files from the cache to the working directory
62
+ Copy files from the index to the working directory
63
64
gitlink:git-commit-tree[1]::
65
Creates a new commit object
@@ -86,7 +86,7 @@ gitlink:git-prune-packed[1]::
86
Remove extra objects that are already in pack files.
87
88
gitlink:git-read-tree[1]::
89
- Reads tree information into the directory cache
89
+ Reads tree information into the directory index
90
91
gitlink:git-unpack-objects[1]::
92
Unpacks objects out of a packed archive.
@@ -95,7 +95,7 @@ gitlink:git-update-index[1]::
95
Modifies the index or directory cache
96
97
gitlink:git-write-tree[1]::
98
- Creates a tree from the current cache
98
+ Creates a tree from the current index
99
100
101
Interrogation commands
@@ -105,10 +105,10 @@ gitlink:git-cat-file[1]::
105
Provide content or type information for repository objects
106
107
gitlink:git-diff-index[1]::
108
- Compares content and mode of blobs between the cache and repository
108
+ Compares content and mode of blobs between the index and repository
109
110
gitlink:git-diff-files[1]::
111
- Compares files in the working tree and the cache
111
+ Compares files in the working tree and the index
112
113
gitlink:git-diff-stages[1]::
114
Compares two "merge stages" in the index file.
@@ -120,7 +120,7 @@ gitlink:git-fsck-objects[1]::
120
Verifies the connectivity and validity of the objects in the database
121
122
gitlink:git-ls-files[1]::
123
- Information about files in the cache/working directory
123
+ Information about files in the index/working directory
124
125
gitlink:git-ls-tree[1]::
126
Displays a tree object in human readable form
@@ -490,8 +490,8 @@ git so take care if using Cogito etc
490
491
'GIT_INDEX_FILE'::
492
This environment allows the specification of an alternate
493
- cache/index file. If not specified, the default of
494
- `$GIT_DIR/index` is used.
493
+ index file. If not specified, the default of `$GIT_DIR/index`
494
+ is used.
495
496
'GIT_OBJECT_DIRECTORY'::
497
If the object storage directory is specified via this
Documentation/glossary.txt
+3
-3
@@ -43,14 +43,14 @@ DAG::
43
44
index::
45
A collection of files with stat information, whose contents are
46
- stored as objects. The cache is a stored version of your working
46
+ stored as objects. The index is a stored version of your working
47
tree. Truth be told, it can also contain a second, and even a third
48
version of a working tree, which are used when merging.
49
50
index entry::
51
The information regarding a particular file, stored in the index.
52
An index entry can be unmerged, if a merge was started, but not
53
- yet finished (i.e. if the cache contains multiple versions of
53
+ yet finished (i.e. if the index contains multiple versions of
54
that file).
55
56
unmerged index:
@@ -75,7 +75,7 @@ checkout::
75
stored in the object database.
76
77
commit::
78
- As a verb: The action of storing the current state of the cache in the
78
+ As a verb: The action of storing the current state of the index in the
79
object database. The result is a revision.
80
As a noun: Short hand for commit object.
81
Documentation/tutorial.txt
+3
-3
@@ -131,7 +131,7 @@ actually check in your hard work, you will have to go through two steps:
131
The first step is trivial: when you want to tell git about any changes
132
to your working tree, you use the `git-update-index` program. That
133
program normally just takes a list of filenames you want to update, but
134
-to avoid trivial mistakes, it refuses to add new entries to the cache
134
+to avoid trivial mistakes, it refuses to add new entries to the index
135
(or remove existing ones) unless you explicitly tell it that you're
136
adding a new entry with the `\--add` flag (or removing an entry with the
137
`\--remove`) flag.
@@ -199,7 +199,7 @@ was just to show that `git-update-index` did something magical, and
199
actually saved away the contents of your files into the git object
200
database.
201
202
-Updating the cache did something else too: it created a `.git/index`
202
+Updating the index did something else too: it created a `.git/index`
203
file. This is the index that describes your current working tree, and
204
something you should be very aware of. Again, you normally never worry
205
about the index file itself, but you should be aware of the fact that
@@ -440,7 +440,7 @@ a bit about what you have done.
440
Write whatever message you want, and all the lines that start with '#'
441
will be pruned out, and the rest will be used as the commit message for
442
the change. If you decide you don't want to commit anything after all at
443
-this point (you can continue to edit things and update the cache), you
443
+this point (you can continue to edit things and update the index), you
444
can just leave an empty message. Otherwise `git commit` will commit
445
the change for you.
446