From 3f9cd51ab3e3f844c30524631bdef718e8503af9 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 7 Mar 2006 05:16:34 +0000 Subject: [PATCH] Autogenerated man pages for v1.2.4-g2dcd --- man1/git-checkout-index.1 | 61 ++++++++++++++++++++++++++++++++------- 1 file changed, 51 insertions(+), 10 deletions(-) diff --git a/man1/git-checkout-index.1 b/man1/git-checkout-index.1 index 20c04a9c4..1a2160017 100755 --- a/man1/git-checkout-index.1 +++ b/man1/git-checkout-index.1 @@ -24,7 +24,8 @@ git-checkout-index \- Copy files from the index to the working directory .nf \fIgit\-checkout\-index\fR [\-u] [\-q] [\-a] [\-f] [\-n] [\-\-prefix=] - [\-\-stage=] + [\-\-stage=|all] + [\-\-temp] [\-z] [\-\-stdin] [\-\-] []* .fi @@ -61,8 +62,12 @@ Don't checkout new files, only refresh files already checked out\&. When creating files, prepend (usually a directory including a trailing /) .TP -\-\-stage= -Instead of checking out unmerged entries, copy out the files from named stage\&. must be between 1 and 3\&. +\-\-stage=|all +Instead of checking out unmerged entries, copy out the files from named stage\&. must be between 1 and 3\&. Note: \-\-stage=all automatically implies \-\-temp\&. + +.TP +\-\-temp +Instead of copying the files to the working directory write the content to temporary files\&. The temporary name associations will be written to stdout\&. .TP \-\-stdin @@ -85,38 +90,74 @@ Just doing git\-checkout\-index does nothing\&. You probably meant git\-checkout Intuitiveness is not the goal here\&. Repeatability is\&. The reason for the "no arguments means no work" behavior is that from scripts you are supposed to be able to do: -.IP +.nf $ find \&. \-name '*\&.h' \-print0 | xargs \-0 git\-checkout\-index \-f \-\- +.fi + 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 index, which was not the point\&. But since git\-checkout\-index accepts \-\-stdin it would be faster to use: -.IP +.nf $ find \&. \-name '*\&.h' \-print0 | git\-checkout\-index \-f \-z \-\-stdin +.fi + 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\&. +.SH "USING --TEMP OR --STAGE=ALL" + + +When \-\-temp is used (or implied by \-\-stage=all) git\-checkout\-index will create a temporary file for each index entry being checked out\&. The index will not be updated with stat information\&. These options can be useful if the caller needs all stages of all unmerged entries so that the unmerged files can be processed by an external merge tool\&. + + +A listing will be written to stdout providing the association of temporary file names to tracked path names\&. The listing format has two variations: + +.TP 3 +1. +tempname TAB path RS + +The first format is what gets used when \-\-stage is omitted or is not \-\-stage=all\&. The field tempname is the temporary file name holding the file content and path is the tracked path name in the index\&. Only the requested entries are output\&. +.TP +2. +stage1temp SP stage2temp SP stage3tmp TAB path RS + +The second format is what gets used when \-\-stage=all\&. The three stage temporary fields (stage1temp, stage2temp, stage3temp) list the name of the temporary file if there is a stage entry in the index or \&. if there is no stage entry\&. Paths which only have a stage 0 entry will always be omitted from the output\&. +.LP + + +In both formats RS (the record separator) is newline by default but will be the null byte if \-z was passed on the command line\&. The temporary file names are always safe strings; they will never contain directory separators or whitespace characters\&. The path field is always relative to the current directory and the temporary file names are always relative to the top level directory\&. + + +If the object being copied out to a temporary file is a symbolic link the content of the link will be written to a normal file\&. It is up to the end\-user or the Porcelain to make use of this information\&. + .SH "EXAMPLES" .TP To update and refresh only the files already checked out -.IP +.nf $ git\-checkout\-index \-n \-f \-a && git\-update\-index \-\-ignore\-missing \-\-refresh +.fi + .TP 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: -.IP -$ git\-checkout\-index \-\-prefix=git\-export\-dir/ \-agit\-checkout\-index will "export" the index into the specified directory\&. +.nf +$ git\-checkout\-index \-\-prefix=git\-export\-dir/ \-a +.fi +git\-checkout\-index will "export" the index into the specified directory\&. The final "/" is important\&. The exported name is literally just prefixed with the specified string\&. Contrast this with the following example\&. .TP Export files with a prefix -.IP -$ git\-checkout\-index \-\-prefix=\&.merged\- MakefileThis will check out the currently cached copy of Makefile into the file \&.merged\-Makefile\&. +.nf +$ git\-checkout\-index \-\-prefix=\&.merged\- Makefile +.fi +This will check out the currently cached copy of Makefile into the file \&.merged\-Makefile\&. .SH "AUTHOR" -- 2.26.2