Big tool rename.

[thirdparty/git.git] / Documentation / git-checkout-index.txt

diff --git a/Documentation/git-checkout-cache.txt b/Documentation/git-checkout-index.txt
similarity index 76%
rename from Documentation/git-checkout-cache.txt
rename to Documentation/git-checkout-index.txt
index 321a00c251f8eb13a9d9ed9f58322e4111dc6249..bb15214c989b73f37c79fef027900393aed419fd 100644 (file)
--- a/Documentation/git-checkout-cache.txt
+++ b/Documentation/git-checkout-index.txt
@@ -1,15 +1,15 @@
-git-checkout-cache(1)
+git-checkout-index(1)
 =====================
 v0.1, May 2005
 
 NAME
 ----
-git-checkout-cache - Copy files from the cache to the working directory
+git-checkout-index - Copy files from the cache to the working directory
 
 
 SYNOPSIS
 --------
-'git-checkout-cache' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
+'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
                   [--] <file>...
 
 DESCRIPTION
@@ -46,21 +46,21 @@ OPTIONS
 
 Note that the order of the flags matters:
 
-     git-checkout-cache -a -f file.c
+     git-checkout-index -a -f file.c
 
 will first check out all files listed in the cache (but not overwrite
 any old ones), and then force-checkout `file.c` a second time (ie that
 one *will* overwrite any old contents with the same filename).
 
-Also, just doing "git-checkout-cache" does nothing. You probably meant
-"git-checkout-cache -a". And if you want to force it, you want
-"git-checkout-cache -f -a".
+Also, just doing "git-checkout-index" does nothing. You probably meant
+"git-checkout-index -a". And if you want to force it, you want
+"git-checkout-index -f -a".
 
 Intuitiveness is not the goal here. Repeatability is. The reason for
 the "no arguments means no work" thing is that from scripts you are
 supposed to be able to do things like:
 
-       find . -name '*.h' -print0 | xargs -0 git-checkout-cache -f --
+       find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --
 
 which will force all existing `*.h` files to be replaced with their
 cached copies. If an empty command line implied "all", then this would
@@ -68,7 +68,7 @@ force-refresh everything in the cache, which was not the point.
 
 To update and refresh only the files already checked out:
 
-        git-checkout-cache -n -f -a && git-update-cache --ignore-missing --refresh
+        git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh
 
 Oh, and the "--" is just a good idea when you know the rest will be
 filenames. Just so that you wouldn't have a filename of "-a" causing
@@ -76,18 +76,18 @@ problems (not possible in the above example, but get used to it in
 scripting!).
 
 The prefix ability basically makes it trivial to use
-git-checkout-cache as an "export as tree" function. Just read the
+git-checkout-index as an "export as tree" function. Just read the
 desired tree into the index, and do a
   
-        git-checkout-cache --prefix=git-export-dir/ -a
+        git-checkout-index --prefix=git-export-dir/ -a
   
-and git-checkout-cache will "export" the cache into the specified
+and git-checkout-index will "export" the cache into the specified
 directory.
   
 NOTE The final "/" is important. The exported name is literally just
 prefixed with the specified string, so you can also do something like
 
-    git-checkout-cache --prefix=.merged- Makefile
+    git-checkout-index --prefix=.merged- Makefile
 
 to check out the currently cached copy of `Makefile` into the file
 `.merged-Makefile`