summaryrefslogtreecommitdiff
path: root/Documentation/git-checkout-index.txt
blob: b0b65889ac5e91661e9a68161dda1bb9660c0bb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
git-checkout-index(1)
=====================
 
NAME
----
git-checkout-index - Copy files from the index to the working directory
 
 
SYNOPSIS
--------
[verse]
'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
		   [--stage=<number>]
		   [-z] [--stdin]
		   [--] [<file>]\*
 
DESCRIPTION
-----------
Will copy all files listed from the index to the working directory
(not overwriting existing files).
 
OPTIONS
-------
-u|--index::
	update stat information for the checked out entries in
	the index file.
 
-q|--quiet::
	be quiet if files exist or are not in the index
 
-f|--force::
	forces overwrite of existing files
 
-a|--all::
	checks out all files in the index.  Cannot be used
	together with explicit filenames.
 
-n|--no-create::
	Don't checkout new files, only refresh files already checked
	out.
 
--prefix=<string>::
	When creating files, prepend <string> (usually a directory
	including a trailing /)
 
--stage=<number>::
	Instead of checking out unmerged entries, copy out the
	files from named stage.  <number> must be between 1 and 3.
 
--stdin::
	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.
 
-z::
	Only meaningful with `--stdin`; paths are separated with
	NUL character instead of LF.
 
--::
	Do not interpret any more arguments as options.
 
The order of the flags used to matter, but not anymore.
 
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" behavior is that from scripts you are
supposed to be able to do:
 
----------------
$ 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 index, which was not the point.  But
since git-checkout-index accepts --stdin it would be faster to use:
 
----------------
$ find . -name '*.h' -print0 | git-checkout-index -f -z --stdin
----------------
 
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.
 
 
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.
+
The final "/" is important. The exported name is literally just
prefixed with the specified string.  Contrast this with the
following example.
 
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`.
 
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
 
 
Documentation
--------------
Documentation by David Greaves,
Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 
GIT
---
Part of the gitlink:git[7] suite