X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-checkout-index.txt;h=9f32c65aaba057d684c349c6ab3f3fde45a36f13;hb=ed24928e122bad83e62d161087f806fa21c46a59;hp=1ba6fb2d9cce2cd7f39f5c9831690551f376cc5a;hpb=0493a3fd5204a36bc961a8611770ddb9ec1ed8ed;p=git.git diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 1ba6fb2d..9f32c65a 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -1,39 +1,38 @@ git-checkout-index(1) ===================== -v0.1, May 2005 NAME ---- -git-checkout-index - Copy files from the cache to the working directory +git-checkout-index - Copy files from the index to the working directory SYNOPSIS -------- 'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=] - [--] ... + [--stage=] [--] ... DESCRIPTION ----------- -Will copy all files listed from the cache to the working directory +Will copy all files listed from the index to the working directory (not overwriting existing files). OPTIONS ------- --u:: +-u|--index:: update stat information for the checked out entries in - the cache file. + the index file. --q:: - be quiet if files exist or are not in the cache +-q|--quiet:: + be quiet if files exist or are not in the index --f:: +-f|--force:: forces overwrite of existing files --a:: - checks out all files in the cache (will then continue to - process listed files). +-a|--all:: + checks out all files in the index. Cannot be used + together with explicit filenames. --n:: +-n|--no-create:: Don't checkout new files, only refresh files already checked out. @@ -41,64 +40,80 @@ OPTIONS When creating files, prepend (usually a directory including a trailing /) +--stage=:: + Instead of checking out unmerged entries, copy out the + files from named stage. must be between 1 and 3. + --:: Do not interpret any more arguments as options. -Note that the order of the flags matters: - - git-checkout-index -a -f file.c +The order of the flags used to matter, but not anymore. -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 -f -a". +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: +the "no arguments means no work" behavior is that from scripts you are +supposed to be able to do: - find . -name '*.h' -print0 | xargs -0 git-checkout-index -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 -force-refresh everything in the cache, which was not the point. - -To update and refresh only the files already checked out: +force-refresh everything in the index, which was not the point. - git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh +The `--` is just a good idea when you know the rest will be filenames; +it will prevent problems with a filename of, for example, `-a`. +Using `--` is probably a good policy in scripts. -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 -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-index as an "export as tree" function. Just read the -desired tree into the index, and do a - - git-checkout-index --prefix=git-export-dir/ -a - -and git-checkout-index will "export" the cache into the specified +EXAMPLES +-------- +To update and refresh only the files already checked out:: ++ +---------------- +$ git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh +---------------- + +Using `git-checkout-index` to "export an entire tree":: + The prefix ability basically makes it trivial to use + `git-checkout-index` as an "export as tree" function. + Just read the desired tree into the index, and do: ++ +---------------- +$ git-checkout-index --prefix=git-export-dir/ -a +---------------- ++ +`git-checkout-index` will "export" the index 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 ++ +The final "/" is important. The exported name is literally just +prefixed with the specified string. Contrast this with the +following example. - git-checkout-index --prefix=.merged- Makefile +Export files with a prefix:: ++ +---------------- +$ git-checkout-index --prefix=.merged- Makefile +---------------- ++ +This will check out the currently cached copy of `Makefile` +into the file `.merged-Makefile`. -to check out the currently cached copy of `Makefile` into the file -`.merged-Makefile` Author ------ Written by Linus Torvalds + Documentation -------------- -Documentation by David Greaves, Junio C Hamano and the git-list . +Documentation by David Greaves, +Junio C Hamano and the git-list . + GIT ---