man1/git-checkout-index.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-CHECKOUT-INDEX" 1 "" "" ""
  21 .SH NAME
  22 git-checkout-index \- Copy files from the index to the working directory
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIgit\-checkout\-index\fR [\-u] [\-q] [\-a] [\-f] [\-n] [\-\-prefix=<string>]
  27                    [\-\-stage=<number>]
  28                    [\-z] [\-\-stdin]
  29                    [\-\-] [<file>]*
  30 .fi
  31
  32 .SH "DESCRIPTION"
  33
  34
  35 Will copy all files listed from the index to the working directory (not overwriting existing files)\&.
  36
  37 .SH "OPTIONS"
  38
  39 .TP
  40 \-u|\-\-index
  41 update stat information for the checked out entries in the index file\&.
  42
  43 .TP
  44 \-q|\-\-quiet
  45 be quiet if files exist or are not in the index
  46
  47 .TP
  48 \-f|\-\-force
  49 forces overwrite of existing files
  50
  51 .TP
  52 \-a|\-\-all
  53 checks out all files in the index\&. Cannot be used together with explicit filenames\&.
  54
  55 .TP
  56 \-n|\-\-no\-create
  57 Don't checkout new files, only refresh files already checked out\&.
  58
  59 .TP
  60 \-\-prefix=<string>
  61 When creating files, prepend <string> (usually a directory including a trailing /)
  62
  63 .TP
  64 \-\-stage=<number>
  65 Instead of checking out unmerged entries, copy out the files from named stage\&. <number> must be between 1 and 3\&.
  66
  67 .TP
  68 \-\-stdin
  69 Instead of taking list of paths from the command line, read list of paths from the standard input\&. Paths are separated by LF (i\&.e\&. one path per line) by default\&.
  70
  71 .TP
  72 \-z
  73 Only meaningful with \-\-stdin; paths are separated with NUL character instead of LF\&.
  74
  75 .TP
  76 --
  77 Do not interpret any more arguments as options\&.
  78
  79
  80 The order of the flags used to matter, but not anymore\&.
  81
  82
  83 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\&.
  84
  85
  86 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:
  87
  88 .IP
  89 $ find \&. \-name '*\&.h' \-print0 | xargs \-0 git\-checkout\-index \-f \-\-
  90
  91 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:
  92
  93 .IP
  94 $ find \&. \-name '*\&.h' \-print0 | git\-checkout\-index \-f \-z \-\-stdin
  95
  96 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\&.
  97
  98 .SH "EXAMPLES"
  99
 100 .TP
 101 To update and refresh only the files already checked out
 102
 103 .IP
 104 $ git\-checkout\-index \-n \-f \-a && git\-update\-index \-\-ignore\-missing \-\-refresh
 105 .TP
 106 Using git\-checkout\-index to "export an entire tree"
 107 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:
 108
 109
 110 .IP
 111 $ git\-checkout\-index \-\-prefix=git\-export\-dir/ \-agit\-checkout\-index will "export" the index into the specified directory\&.
 112
 113 The final "/" is important\&. The exported name is literally just prefixed with the specified string\&. Contrast this with the following example\&.
 114
 115 .TP
 116 Export files with a prefix
 117
 118 .IP
 119 $ git\-checkout\-index \-\-prefix=\&.merged\- MakefileThis will check out the currently cached copy of Makefile into the file \&.merged\-Makefile\&.
 120
 121 .SH "AUTHOR"
 122
 123
 124 Written by Linus Torvalds <torvalds@osdl\&.org>
 125
 126 .SH "DOCUMENTATION"
 127
 128
 129 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 130
 131 .SH "GIT"
 132
 133
 134 Part of the \fBgit\fR(7) suite
 135