undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-checkout-index: documentation updates.

Browse Source 
Now the behaviour of '-a' has been straightened out, document it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Junio C Hamano 2005-10-17 17:38:09 -07:00
parent a65a686f49
commit fd25c82a80
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/git-checkout-index.txt
View File

@ -30,8 +30,8 @@ OPTIONS
forces overwrite of existing files forces overwrite of existing files
-a:: -a::
checks out all files in the cache (will then continue to checks out all files in the cache. Cannot be used
process listed files). together with explicit filenames.
-n:: -n::
Don't checkout new files, only refresh files already checked Don't checkout new files, only refresh files already checked
@ -44,15 +44,9 @@ OPTIONS
--:: --::
Do not interpret any more arguments as options. Do not interpret any more arguments as options.
Note that the order of the flags matters: The order of the flags used to matter, but not anymore.
git-checkout-index -a -f file.c Just doing "git-checkout-index" does nothing. You probably meant
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-index" does nothing. You probably meant
"git-checkout-index -a". And if you want to force it, you want "git-checkout-index -a". And if you want to force it, you want
"git-checkout-index -f -a". "git-checkout-index -f -a".
@ -78,12 +72,12 @@ scripting!).
The prefix ability basically makes it trivial to use The prefix ability basically makes it trivial to use
git-checkout-index 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 desired tree into the index, and do a
git-checkout-index --prefix=git-export-dir/ -a git-checkout-index --prefix=git-export-dir/ -a
and git-checkout-index will "export" the cache into the specified and git-checkout-index will "export" the cache into the specified
directory. directory.
NOTE The final "/" is important. The exported name is literally just NOTE The final "/" is important. The exported name is literally just
prefixed with the specified string, so you can also do something like prefixed with the specified string, so you can also do something like