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