add description parameter to OPT__QUIET
[git/git.git] / builtin / checkout-index.c
CommitLineData
33db5f4d
LT
1/*
2 * Check-out files from the "current cache directory"
3 *
4 * Copyright (C) 2005 Linus Torvalds
5 *
6 * Careful: order of argument flags does matter. For example,
7 *
05207a28 8 * git checkout-index -a -f file.c
33db5f4d
LT
9 *
10 * Will first check out all files listed in the cache (but not
11 * overwrite any old ones), and then force-checkout "file.c" a
12 * second time (ie that one _will_ overwrite any old contents
13 * with the same filename).
14 *
05207a28
HO
15 * Also, just doing "git checkout-index" does nothing. You probably
16 * meant "git checkout-index -a". And if you want to force it, you
17 * want "git checkout-index -f -a".
33db5f4d
LT
18 *
19 * Intuitiveness is not the goal here. Repeatability is. The
20 * reason for the "no arguments means no work" thing is that
21 * from scripts you are supposed to be able to do things like
22 *
05207a28 23 * find . -name '*.h' -print0 | xargs -0 git checkout-index -f --
33db5f4d 24 *
9debe63d
SP
25 * or:
26 *
05207a28 27 * find . -name '*.h' -print0 | git checkout-index -f -z --stdin
9debe63d 28 *
33db5f4d
LT
29 * which will force all existing *.h files to be replaced with
30 * their cached copies. If an empty command line implied "all",
31 * then this would force-refresh everything in the cache, which
32 * was not the point.
33 *
34 * Oh, and the "--" is just a good idea when you know the rest
35 * will be filenames. Just so that you wouldn't have a filename
36 * of "-a" causing problems (not possible in the above example,
37 * but get used to it in scripting!).
38 */
baffc0e7 39#include "builtin.h"
33db5f4d 40#include "cache.h"
9debe63d 41#include "quote.h"
bad68ec9 42#include "cache-tree.h"
a6c7db1b 43#include "parse-options.h"
33db5f4d 44
de84f99c 45#define CHECKOUT_ALL 4
de84f99c 46static int line_termination = '\n';
3bd348ae 47static int checkout_stage; /* default to checkout stage0 */
de84f99c 48static int to_tempfile;
095c424d 49static char topath[4][PATH_MAX + 1];
c3e9a653 50
344c52ae 51static struct checkout state;
33db5f4d 52
e414156a 53static void write_tempfile_record(const char *name, int prefix_length)
de84f99c
SP
54{
55 int i;
56
57 if (CHECKOUT_ALL == checkout_stage) {
58 for (i = 1; i < 4; i++) {
59 if (i > 1)
60 putchar(' ');
61 if (topath[i][0])
62 fputs(topath[i], stdout);
63 else
64 putchar('.');
65 }
66 } else
67 fputs(topath[checkout_stage], stdout);
68
69 putchar('\t');
663af342 70 write_name_quoted(name + prefix_length, stdout, line_termination);
de84f99c
SP
71
72 for (i = 0; i < 4; i++) {
73 topath[i][0] = 0;
74 }
75}
76
e414156a 77static int checkout_file(const char *name, int prefix_length)
33db5f4d 78{
3bd348ae
JH
79 int namelen = strlen(name);
80 int pos = cache_name_pos(name, namelen);
81 int has_same_name = 0;
de84f99c
SP
82 int did_checkout = 0;
83 int errs = 0;
3bd348ae
JH
84
85 if (pos < 0)
86 pos = -pos - 1;
87
88 while (pos < active_nr) {
89 struct cache_entry *ce = active_cache[pos];
f4f9adae 90 if (ce_namelen(ce) != namelen ||
3bd348ae
JH
91 memcmp(ce->name, name, namelen))
92 break;
93 has_same_name = 1;
3bd348ae 94 pos++;
de84f99c
SP
95 if (ce_stage(ce) != checkout_stage
96 && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
97 continue;
98 did_checkout = 1;
99 if (checkout_entry(ce, &state,
100 to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
101 errs++;
102 }
103
104 if (did_checkout) {
105 if (to_tempfile)
e414156a 106 write_tempfile_record(name, prefix_length);
de84f99c 107 return errs > 0 ? -1 : 0;
33db5f4d 108 }
3bd348ae
JH
109
110 if (!state.quiet) {
05207a28 111 fprintf(stderr, "git checkout-index: %s ", name);
3bd348ae
JH
112 if (!has_same_name)
113 fprintf(stderr, "is not in the cache");
114 else if (checkout_stage)
115 fprintf(stderr, "does not exist at stage %d",
116 checkout_stage);
117 else
118 fprintf(stderr, "is unmerged");
119 fputc('\n', stderr);
120 }
121 return -1;
33db5f4d
LT
122}
123
f7f0fbfc 124static void checkout_all(const char *prefix, int prefix_length)
33db5f4d 125{
4b12dae6 126 int i, errs = 0;
4b25d091 127 struct cache_entry *last_ce = NULL;
33db5f4d
LT
128
129 for (i = 0; i < active_nr ; i++) {
130 struct cache_entry *ce = active_cache[i];
de84f99c
SP
131 if (ce_stage(ce) != checkout_stage
132 && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
d9f98eeb 133 continue;
c3e9a653 134 if (prefix && *prefix &&
3bd348ae
JH
135 (ce_namelen(ce) <= prefix_length ||
136 memcmp(prefix, ce->name, prefix_length)))
c3e9a653 137 continue;
de84f99c
SP
138 if (last_ce && to_tempfile) {
139 if (ce_namelen(last_ce) != ce_namelen(ce)
140 || memcmp(last_ce->name, ce->name, ce_namelen(ce)))
e414156a 141 write_tempfile_record(last_ce->name, prefix_length);
de84f99c
SP
142 }
143 if (checkout_entry(ce, &state,
144 to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
4b12dae6 145 errs++;
de84f99c 146 last_ce = ce;
33db5f4d 147 }
de84f99c 148 if (last_ce && to_tempfile)
e414156a 149 write_tempfile_record(last_ce->name, prefix_length);
4b12dae6
JH
150 if (errs)
151 /* we have already done our error reporting.
152 * exit with the same code as die().
153 */
154 exit(128);
33db5f4d
LT
155}
156
a6c7db1b 157static const char * const builtin_checkout_index_usage[] = {
d0bb1366 158 "git checkout-index [options] [--] [<file>...]",
a6c7db1b
MV
159 NULL
160};
d46ad9c9 161
021b6e45 162static struct lock_file lock_file;
31f584c2 163
a6c7db1b
MV
164static int option_parse_u(const struct option *opt,
165 const char *arg, int unset)
166{
167 int *newfd = opt->value;
168
169 state.refresh_cache = 1;
170 if (*newfd < 0)
171 *newfd = hold_locked_index(&lock_file, 1);
172 return 0;
173}
174
175static int option_parse_z(const struct option *opt,
176 const char *arg, int unset)
177{
178 if (unset)
179 line_termination = '\n';
180 else
181 line_termination = 0;
182 return 0;
183}
184
185static int option_parse_prefix(const struct option *opt,
186 const char *arg, int unset)
187{
188 state.base_dir = arg;
189 state.base_dir_len = strlen(arg);
190 return 0;
191}
192
193static int option_parse_stage(const struct option *opt,
194 const char *arg, int unset)
195{
196 if (!strcmp(arg, "all")) {
197 to_tempfile = 1;
198 checkout_stage = CHECKOUT_ALL;
199 } else {
200 int ch = arg[0];
201 if ('1' <= ch && ch <= '3')
202 checkout_stage = arg[0] - '0';
203 else
204 die("stage should be between 1 and 3 or all");
205 }
206 return 0;
207}
208
e414156a 209int cmd_checkout_index(int argc, const char **argv, const char *prefix)
33db5f4d 210{
a65a686f 211 int i;
415e96c8 212 int newfd = -1;
a65a686f 213 int all = 0;
9debe63d 214 int read_from_stdin = 0;
e414156a 215 int prefix_length;
a6c7db1b
MV
216 int force = 0, quiet = 0, not_new = 0;
217 struct option builtin_checkout_index_options[] = {
218 OPT_BOOLEAN('a', "all", &all,
219 "checks out all files in the index"),
220 OPT_BOOLEAN('f', "force", &force,
221 "forces overwrite of existing files"),
d52ee6e6 222 OPT__QUIET(&quiet, "be quiet"),
a6c7db1b
MV
223 OPT_BOOLEAN('n', "no-create", &not_new,
224 "don't checkout new files"),
225 { OPTION_CALLBACK, 'u', "index", &newfd, NULL,
226 "update stat information in the index file",
227 PARSE_OPT_NOARG, option_parse_u },
228 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
229 "paths are separated with NUL character",
230 PARSE_OPT_NOARG, option_parse_z },
231 OPT_BOOLEAN(0, "stdin", &read_from_stdin,
232 "read list of paths from the standard input"),
233 OPT_BOOLEAN(0, "temp", &to_tempfile,
234 "write the content to temporary files"),
235 OPT_CALLBACK(0, "prefix", NULL, "string",
236 "when creating files, prepend <string>",
237 option_parse_prefix),
238 OPT_CALLBACK(0, "stage", NULL, NULL,
239 "copy out the files from named stage",
240 option_parse_stage),
241 OPT_END()
242 };
33db5f4d 243
ef90d6d4 244 git_config(git_default_config, NULL);
e414156a 245 state.base_dir = "";
c3e9a653
JH
246 prefix_length = prefix ? strlen(prefix) : 0;
247
33db5f4d 248 if (read_cache() < 0) {
2de381f9 249 die("invalid cache");
33db5f4d
LT
250 }
251
37782920 252 argc = parse_options(argc, argv, prefix, builtin_checkout_index_options,
a6c7db1b
MV
253 builtin_checkout_index_usage, 0);
254 state.force = force;
255 state.quiet = quiet;
256 state.not_new = not_new;
a65a686f 257
de84f99c 258 if (state.base_dir_len || to_tempfile) {
a65a686f
LT
259 /* when --prefix is specified we do not
260 * want to update cache.
261 */
262 if (state.refresh_cache) {
021b6e45 263 rollback_lock_file(&lock_file);
4ed7cd3a 264 newfd = -1;
a65a686f
LT
265 }
266 state.refresh_cache = 0;
267 }
268
269 /* Check out named files first */
a6c7db1b 270 for (i = 0; i < argc; i++) {
a65a686f 271 const char *arg = argv[i];
dc46da22 272 const char *p;
a65a686f
LT
273
274 if (all)
7e44c935 275 die("git checkout-index: don't mix '--all' and explicit filenames");
9debe63d 276 if (read_from_stdin)
7e44c935 277 die("git checkout-index: don't mix '--stdin' and explicit filenames");
dc46da22 278 p = prefix_path(prefix, prefix_length, arg);
e414156a 279 checkout_file(p, prefix_length);
be65e7d9 280 if (p < arg || p > arg + strlen(arg))
4b25d091 281 free((char *)p);
33db5f4d 282 }
415e96c8 283
9debe63d 284 if (read_from_stdin) {
f285a2d7 285 struct strbuf buf = STRBUF_INIT, nbuf = STRBUF_INIT;
7fb1011e 286
9debe63d 287 if (all)
7e44c935 288 die("git checkout-index: don't mix '--all' and '--stdin'");
7fb1011e 289
7fb1011e 290 while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
dc46da22 291 const char *p;
7fb1011e
PH
292 if (line_termination && buf.buf[0] == '"') {
293 strbuf_reset(&nbuf);
294 if (unquote_c_style(&nbuf, buf.buf, NULL))
295 die("line is badly quoted");
296 strbuf_swap(&buf, &nbuf);
297 }
298 p = prefix_path(prefix, prefix_length, buf.buf);
e414156a 299 checkout_file(p, prefix_length);
7fb1011e 300 if (p < buf.buf || p > buf.buf + buf.len)
dc46da22 301 free((char *)p);
9debe63d 302 }
7fb1011e 303 strbuf_release(&nbuf);
e6c019d0 304 strbuf_release(&buf);
9debe63d
SP
305 }
306
a65a686f 307 if (all)
e414156a 308 checkout_all(prefix, prefix_length);
a65a686f 309
415e96c8
JH
310 if (0 <= newfd &&
311 (write_cache(newfd, active_cache, active_nr) ||
4ed7cd3a 312 commit_locked_index(&lock_file)))
021b6e45 313 die("Unable to write new index file");
33db5f4d
LT
314 return 0;
315}