help: align the longest command in the command listing
[git.git] / builtin / checkout-index.c
blobeb74774cbc9d6bd6acf1b7fe2f31b8e80e461a12
1 /*
2 * Check-out files from the "current cache directory"
4 * Copyright (C) 2005 Linus Torvalds
6 */
7 #include "builtin.h"
8 #include "config.h"
9 #include "lockfile.h"
10 #include "quote.h"
11 #include "cache-tree.h"
12 #include "parse-options.h"
14 #define CHECKOUT_ALL 4
15 static int nul_term_line;
16 static int checkout_stage; /* default to checkout stage0 */
17 static int to_tempfile;
18 static char topath[4][TEMPORARY_FILENAME_LENGTH + 1];
20 static struct checkout state = CHECKOUT_INIT;
22 static void write_tempfile_record(const char *name, const char *prefix)
24 int i;
26 if (CHECKOUT_ALL == checkout_stage) {
27 for (i = 1; i < 4; i++) {
28 if (i > 1)
29 putchar(' ');
30 if (topath[i][0])
31 fputs(topath[i], stdout);
32 else
33 putchar('.');
35 } else
36 fputs(topath[checkout_stage], stdout);
38 putchar('\t');
39 write_name_quoted_relative(name, prefix, stdout,
40 nul_term_line ? '\0' : '\n');
42 for (i = 0; i < 4; i++) {
43 topath[i][0] = 0;
47 static int checkout_file(const char *name, const char *prefix)
49 int namelen = strlen(name);
50 int pos = cache_name_pos(name, namelen);
51 int has_same_name = 0;
52 int did_checkout = 0;
53 int errs = 0;
55 if (pos < 0)
56 pos = -pos - 1;
58 while (pos < active_nr) {
59 struct cache_entry *ce = active_cache[pos];
60 if (ce_namelen(ce) != namelen ||
61 memcmp(ce->name, name, namelen))
62 break;
63 has_same_name = 1;
64 pos++;
65 if (ce_stage(ce) != checkout_stage
66 && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
67 continue;
68 did_checkout = 1;
69 if (checkout_entry(ce, &state,
70 to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
71 errs++;
74 if (did_checkout) {
75 if (to_tempfile)
76 write_tempfile_record(name, prefix);
77 return errs > 0 ? -1 : 0;
80 if (!state.quiet) {
81 fprintf(stderr, "git checkout-index: %s ", name);
82 if (!has_same_name)
83 fprintf(stderr, "is not in the cache");
84 else if (checkout_stage)
85 fprintf(stderr, "does not exist at stage %d",
86 checkout_stage);
87 else
88 fprintf(stderr, "is unmerged");
89 fputc('\n', stderr);
91 return -1;
94 static void checkout_all(const char *prefix, int prefix_length)
96 int i, errs = 0;
97 struct cache_entry *last_ce = NULL;
99 for (i = 0; i < active_nr ; i++) {
100 struct cache_entry *ce = active_cache[i];
101 if (ce_stage(ce) != checkout_stage
102 && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
103 continue;
104 if (prefix && *prefix &&
105 (ce_namelen(ce) <= prefix_length ||
106 memcmp(prefix, ce->name, prefix_length)))
107 continue;
108 if (last_ce && to_tempfile) {
109 if (ce_namelen(last_ce) != ce_namelen(ce)
110 || memcmp(last_ce->name, ce->name, ce_namelen(ce)))
111 write_tempfile_record(last_ce->name, prefix);
113 if (checkout_entry(ce, &state,
114 to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
115 errs++;
116 last_ce = ce;
118 if (last_ce && to_tempfile)
119 write_tempfile_record(last_ce->name, prefix);
120 if (errs)
121 /* we have already done our error reporting.
122 * exit with the same code as die().
124 exit(128);
127 static const char * const builtin_checkout_index_usage[] = {
128 N_("git checkout-index [<options>] [--] [<file>...]"),
129 NULL
132 static int option_parse_stage(const struct option *opt,
133 const char *arg, int unset)
135 BUG_ON_OPT_NEG(unset);
137 if (!strcmp(arg, "all")) {
138 to_tempfile = 1;
139 checkout_stage = CHECKOUT_ALL;
140 } else {
141 int ch = arg[0];
142 if ('1' <= ch && ch <= '3')
143 checkout_stage = arg[0] - '0';
144 else
145 die(_("stage should be between 1 and 3 or all"));
147 return 0;
150 int cmd_checkout_index(int argc, const char **argv, const char *prefix)
152 int i;
153 struct lock_file lock_file = LOCK_INIT;
154 int all = 0;
155 int read_from_stdin = 0;
156 int prefix_length;
157 int force = 0, quiet = 0, not_new = 0;
158 int index_opt = 0;
159 struct option builtin_checkout_index_options[] = {
160 OPT_BOOL('a', "all", &all,
161 N_("check out all files in the index")),
162 OPT__FORCE(&force, N_("force overwrite of existing files"), 0),
163 OPT__QUIET(&quiet,
164 N_("no warning for existing files and files not in index")),
165 OPT_BOOL('n', "no-create", &not_new,
166 N_("don't checkout new files")),
167 OPT_BOOL('u', "index", &index_opt,
168 N_("update stat information in the index file")),
169 OPT_BOOL('z', NULL, &nul_term_line,
170 N_("paths are separated with NUL character")),
171 OPT_BOOL(0, "stdin", &read_from_stdin,
172 N_("read list of paths from the standard input")),
173 OPT_BOOL(0, "temp", &to_tempfile,
174 N_("write the content to temporary files")),
175 OPT_STRING(0, "prefix", &state.base_dir, N_("string"),
176 N_("when creating files, prepend <string>")),
177 { OPTION_CALLBACK, 0, "stage", NULL, "(1|2|3|all)",
178 N_("copy out the files from named stage"),
179 PARSE_OPT_NONEG, option_parse_stage },
180 OPT_END()
183 if (argc == 2 && !strcmp(argv[1], "-h"))
184 usage_with_options(builtin_checkout_index_usage,
185 builtin_checkout_index_options);
186 git_config(git_default_config, NULL);
187 prefix_length = prefix ? strlen(prefix) : 0;
189 if (read_cache() < 0) {
190 die("invalid cache");
193 argc = parse_options(argc, argv, prefix, builtin_checkout_index_options,
194 builtin_checkout_index_usage, 0);
195 state.istate = &the_index;
196 state.force = force;
197 state.quiet = quiet;
198 state.not_new = not_new;
200 if (!state.base_dir)
201 state.base_dir = "";
202 state.base_dir_len = strlen(state.base_dir);
205 * when --prefix is specified we do not want to update cache.
207 if (index_opt && !state.base_dir_len && !to_tempfile) {
208 state.refresh_cache = 1;
209 state.istate = &the_index;
210 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
213 /* Check out named files first */
214 for (i = 0; i < argc; i++) {
215 const char *arg = argv[i];
216 char *p;
218 if (all)
219 die("git checkout-index: don't mix '--all' and explicit filenames");
220 if (read_from_stdin)
221 die("git checkout-index: don't mix '--stdin' and explicit filenames");
222 p = prefix_path(prefix, prefix_length, arg);
223 checkout_file(p, prefix);
224 free(p);
227 if (read_from_stdin) {
228 struct strbuf buf = STRBUF_INIT;
229 struct strbuf unquoted = STRBUF_INIT;
230 strbuf_getline_fn getline_fn;
232 if (all)
233 die("git checkout-index: don't mix '--all' and '--stdin'");
235 getline_fn = nul_term_line ? strbuf_getline_nul : strbuf_getline_lf;
236 while (getline_fn(&buf, stdin) != EOF) {
237 char *p;
238 if (!nul_term_line && buf.buf[0] == '"') {
239 strbuf_reset(&unquoted);
240 if (unquote_c_style(&unquoted, buf.buf, NULL))
241 die("line is badly quoted");
242 strbuf_swap(&buf, &unquoted);
244 p = prefix_path(prefix, prefix_length, buf.buf);
245 checkout_file(p, prefix);
246 free(p);
248 strbuf_release(&unquoted);
249 strbuf_release(&buf);
252 if (all)
253 checkout_all(prefix, prefix_length);
255 if (is_lock_file_locked(&lock_file) &&
256 write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
257 die("Unable to write new index file");
258 return 0;