Documentation: point git-prune users to git-gc
[git] / builtin-checkout-index.c
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  *
8  *      git-checkout-index -a -f file.c
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  *
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".
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  *
23  *      find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --
24  *
25  * or:
26  *
27  *      find . -name '*.h' -print0 | git-checkout-index -f -z --stdin
28  *
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  */
39 #include "builtin.h"
40 #include "cache.h"
41 #include "quote.h"
42 #include "cache-tree.h"
43
44 #define CHECKOUT_ALL 4
45 static int line_termination = '\n';
46 static int checkout_stage; /* default to checkout stage0 */
47 static int to_tempfile;
48 static char topath[4][PATH_MAX + 1];
49
50 static struct checkout state;
51
52 static void write_tempfile_record(const char *name, int prefix_length)
53 {
54         int i;
55
56         if (CHECKOUT_ALL == checkout_stage) {
57                 for (i = 1; i < 4; i++) {
58                         if (i > 1)
59                                 putchar(' ');
60                         if (topath[i][0])
61                                 fputs(topath[i], stdout);
62                         else
63                                 putchar('.');
64                 }
65         } else
66                 fputs(topath[checkout_stage], stdout);
67
68         putchar('\t');
69         write_name_quoted(name + prefix_length, stdout, line_termination);
70
71         for (i = 0; i < 4; i++) {
72                 topath[i][0] = 0;
73         }
74 }
75
76 static int checkout_file(const char *name, int prefix_length)
77 {
78         int namelen = strlen(name);
79         int pos = cache_name_pos(name, namelen);
80         int has_same_name = 0;
81         int did_checkout = 0;
82         int errs = 0;
83
84         if (pos < 0)
85                 pos = -pos - 1;
86
87         while (pos < active_nr) {
88                 struct cache_entry *ce = active_cache[pos];
89                 if (ce_namelen(ce) != namelen ||
90                     memcmp(ce->name, name, namelen))
91                         break;
92                 has_same_name = 1;
93                 pos++;
94                 if (ce_stage(ce) != checkout_stage
95                     && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
96                         continue;
97                 did_checkout = 1;
98                 if (checkout_entry(ce, &state,
99                     to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
100                         errs++;
101         }
102
103         if (did_checkout) {
104                 if (to_tempfile)
105                         write_tempfile_record(name, prefix_length);
106                 return errs > 0 ? -1 : 0;
107         }
108
109         if (!state.quiet) {
110                 fprintf(stderr, "git-checkout-index: %s ", name);
111                 if (!has_same_name)
112                         fprintf(stderr, "is not in the cache");
113                 else if (checkout_stage)
114                         fprintf(stderr, "does not exist at stage %d",
115                                 checkout_stage);
116                 else
117                         fprintf(stderr, "is unmerged");
118                 fputc('\n', stderr);
119         }
120         return -1;
121 }
122
123 static void checkout_all(const char *prefix, int prefix_length)
124 {
125         int i, errs = 0;
126         struct cache_entry* last_ce = NULL;
127
128         for (i = 0; i < active_nr ; i++) {
129                 struct cache_entry *ce = active_cache[i];
130                 if (ce_stage(ce) != checkout_stage
131                     && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
132                         continue;
133                 if (prefix && *prefix &&
134                     (ce_namelen(ce) <= prefix_length ||
135                      memcmp(prefix, ce->name, prefix_length)))
136                         continue;
137                 if (last_ce && to_tempfile) {
138                         if (ce_namelen(last_ce) != ce_namelen(ce)
139                             || memcmp(last_ce->name, ce->name, ce_namelen(ce)))
140                                 write_tempfile_record(last_ce->name, prefix_length);
141                 }
142                 if (checkout_entry(ce, &state,
143                     to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
144                         errs++;
145                 last_ce = ce;
146         }
147         if (last_ce && to_tempfile)
148                 write_tempfile_record(last_ce->name, prefix_length);
149         if (errs)
150                 /* we have already done our error reporting.
151                  * exit with the same code as die().
152                  */
153                 exit(128);
154 }
155
156 static const char checkout_cache_usage[] =
157 "git-checkout-index [-u] [-q] [-a] [-f] [-n] [--stage=[123]|all] [--prefix=<string>] [--temp] [--] <file>...";
158
159 static struct lock_file lock_file;
160
161 int cmd_checkout_index(int argc, const char **argv, const char *prefix)
162 {
163         int i;
164         int newfd = -1;
165         int all = 0;
166         int read_from_stdin = 0;
167         int prefix_length;
168
169         git_config(git_default_config);
170         state.base_dir = "";
171         prefix_length = prefix ? strlen(prefix) : 0;
172
173         if (read_cache() < 0) {
174                 die("invalid cache");
175         }
176
177         for (i = 1; i < argc; i++) {
178                 const char *arg = argv[i];
179
180                 if (!strcmp(arg, "--")) {
181                         i++;
182                         break;
183                 }
184                 if (!strcmp(arg, "-a") || !strcmp(arg, "--all")) {
185                         all = 1;
186                         continue;
187                 }
188                 if (!strcmp(arg, "-f") || !strcmp(arg, "--force")) {
189                         state.force = 1;
190                         continue;
191                 }
192                 if (!strcmp(arg, "-q") || !strcmp(arg, "--quiet")) {
193                         state.quiet = 1;
194                         continue;
195                 }
196                 if (!strcmp(arg, "-n") || !strcmp(arg, "--no-create")) {
197                         state.not_new = 1;
198                         continue;
199                 }
200                 if (!strcmp(arg, "-u") || !strcmp(arg, "--index")) {
201                         state.refresh_cache = 1;
202                         if (newfd < 0)
203                                 newfd = hold_locked_index(&lock_file, 1);
204                         continue;
205                 }
206                 if (!strcmp(arg, "-z")) {
207                         line_termination = 0;
208                         continue;
209                 }
210                 if (!strcmp(arg, "--stdin")) {
211                         if (i != argc - 1)
212                                 die("--stdin must be at the end");
213                         read_from_stdin = 1;
214                         i++; /* do not consider arg as a file name */
215                         break;
216                 }
217                 if (!strcmp(arg, "--temp")) {
218                         to_tempfile = 1;
219                         continue;
220                 }
221                 if (!prefixcmp(arg, "--prefix=")) {
222                         state.base_dir = arg+9;
223                         state.base_dir_len = strlen(state.base_dir);
224                         continue;
225                 }
226                 if (!prefixcmp(arg, "--stage=")) {
227                         if (!strcmp(arg + 8, "all")) {
228                                 to_tempfile = 1;
229                                 checkout_stage = CHECKOUT_ALL;
230                         } else {
231                                 int ch = arg[8];
232                                 if ('1' <= ch && ch <= '3')
233                                         checkout_stage = arg[8] - '0';
234                                 else
235                                         die("stage should be between 1 and 3 or all");
236                         }
237                         continue;
238                 }
239                 if (arg[0] == '-')
240                         usage(checkout_cache_usage);
241                 break;
242         }
243
244         if (state.base_dir_len || to_tempfile) {
245                 /* when --prefix is specified we do not
246                  * want to update cache.
247                  */
248                 if (state.refresh_cache) {
249                         rollback_lock_file(&lock_file);
250                         newfd = -1;
251                 }
252                 state.refresh_cache = 0;
253         }
254
255         /* Check out named files first */
256         for ( ; i < argc; i++) {
257                 const char *arg = argv[i];
258                 const char *p;
259
260                 if (all)
261                         die("git-checkout-index: don't mix '--all' and explicit filenames");
262                 if (read_from_stdin)
263                         die("git-checkout-index: don't mix '--stdin' and explicit filenames");
264                 p = prefix_path(prefix, prefix_length, arg);
265                 checkout_file(p, prefix_length);
266                 if (p < arg || p > arg + strlen(arg))
267                         free((char*)p);
268         }
269
270         if (read_from_stdin) {
271                 struct strbuf buf, nbuf;
272
273                 if (all)
274                         die("git-checkout-index: don't mix '--all' and '--stdin'");
275
276                 strbuf_init(&buf, 0);
277                 strbuf_init(&nbuf, 0);
278                 while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
279                         const char *p;
280                         if (line_termination && buf.buf[0] == '"') {
281                                 strbuf_reset(&nbuf);
282                                 if (unquote_c_style(&nbuf, buf.buf, NULL))
283                                         die("line is badly quoted");
284                                 strbuf_swap(&buf, &nbuf);
285                         }
286                         p = prefix_path(prefix, prefix_length, buf.buf);
287                         checkout_file(p, prefix_length);
288                         if (p < buf.buf || p > buf.buf + buf.len)
289                                 free((char *)p);
290                 }
291                 strbuf_release(&nbuf);
292                 strbuf_release(&buf);
293         }
294
295         if (all)
296                 checkout_all(prefix, prefix_length);
297
298         if (0 <= newfd &&
299             (write_cache(newfd, active_cache, active_nr) ||
300              commit_locked_index(&lock_file)))
301                 die("Unable to write new index file");
302         return 0;
303 }