git-branch: Documentation fixes
[git/mingw/4msysgit/kblees.git] / checkout-index.c
blob53dd8cba6f0c56125545acd46f1091366949f89b
1 /*
2 * Check-out files from the "current cache directory"
4 * Copyright (C) 2005 Linus Torvalds
6 * Careful: order of argument flags does matter. For example,
8 * git-checkout-index -a -f file.c
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).
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".
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
23 * find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --
25 * which will force all existing *.h files to be replaced with
26 * their cached copies. If an empty command line implied "all",
27 * then this would force-refresh everything in the cache, which
28 * was not the point.
30 * Oh, and the "--" is just a good idea when you know the rest
31 * will be filenames. Just so that you wouldn't have a filename
32 * of "-a" causing problems (not possible in the above example,
33 * but get used to it in scripting!).
35 #include "cache.h"
37 static const char *prefix;
38 static int prefix_length;
39 static int checkout_stage; /* default to checkout stage0 */
41 static struct checkout state = {
42 .base_dir = "",
43 .base_dir_len = 0,
44 .force = 0,
45 .quiet = 0,
46 .not_new = 0,
47 .refresh_cache = 0,
50 static int checkout_file(const char *name)
52 int namelen = strlen(name);
53 int pos = cache_name_pos(name, namelen);
54 int has_same_name = 0;
56 if (pos < 0)
57 pos = -pos - 1;
59 while (pos < active_nr) {
60 struct cache_entry *ce = active_cache[pos];
61 if (ce_namelen(ce) != namelen ||
62 memcmp(ce->name, name, namelen))
63 break;
64 has_same_name = 1;
65 if (checkout_stage == ce_stage(ce))
66 return checkout_entry(ce, &state);
67 pos++;
70 if (!state.quiet) {
71 fprintf(stderr, "git-checkout-index: %s ", name);
72 if (!has_same_name)
73 fprintf(stderr, "is not in the cache");
74 else if (checkout_stage)
75 fprintf(stderr, "does not exist at stage %d",
76 checkout_stage);
77 else
78 fprintf(stderr, "is unmerged");
79 fputc('\n', stderr);
81 return -1;
84 static int checkout_all(void)
86 int i, errs = 0;
88 for (i = 0; i < active_nr ; i++) {
89 struct cache_entry *ce = active_cache[i];
90 if (ce_stage(ce) != checkout_stage)
91 continue;
92 if (prefix && *prefix &&
93 (ce_namelen(ce) <= prefix_length ||
94 memcmp(prefix, ce->name, prefix_length)))
95 continue;
96 if (checkout_entry(ce, &state) < 0)
97 errs++;
99 if (errs)
100 /* we have already done our error reporting.
101 * exit with the same code as die().
103 exit(128);
104 return 0;
107 static const char checkout_cache_usage[] =
108 "git-checkout-index [-u] [-q] [-a] [-f] [-n] [--stage=[123]] [--prefix=<string>] [--] <file>...";
110 static struct cache_file cache_file;
112 int main(int argc, char **argv)
114 int i;
115 int newfd = -1;
116 int all = 0;
118 prefix = setup_git_directory();
119 prefix_length = prefix ? strlen(prefix) : 0;
121 if (read_cache() < 0) {
122 die("invalid cache");
125 for (i = 1; i < argc; i++) {
126 const char *arg = argv[i];
128 if (!strcmp(arg, "--")) {
129 i++;
130 break;
132 if (!strcmp(arg, "-a") || !strcmp(arg, "--all")) {
133 all = 1;
134 continue;
136 if (!strcmp(arg, "-f") || !strcmp(arg, "--force")) {
137 state.force = 1;
138 continue;
140 if (!strcmp(arg, "-q") || !strcmp(arg, "--quiet")) {
141 state.quiet = 1;
142 continue;
144 if (!strcmp(arg, "-n") || !strcmp(arg, "--no-create")) {
145 state.not_new = 1;
146 continue;
148 if (!strcmp(arg, "-u") || !strcmp(arg, "--index")) {
149 state.refresh_cache = 1;
150 if (newfd < 0)
151 newfd = hold_index_file_for_update
152 (&cache_file,
153 get_index_file());
154 if (newfd < 0)
155 die("cannot open index.lock file.");
156 continue;
158 if (!strncmp(arg, "--prefix=", 9)) {
159 state.base_dir = arg+9;
160 state.base_dir_len = strlen(state.base_dir);
161 continue;
163 if (!strncmp(arg, "--stage=", 8)) {
164 int ch = arg[8];
165 if ('1' <= ch && ch <= '3')
166 checkout_stage = arg[8] - '0';
167 else
168 die("stage should be between 1 and 3");
169 continue;
171 if (arg[0] == '-')
172 usage(checkout_cache_usage);
173 break;
176 if (state.base_dir_len) {
177 /* when --prefix is specified we do not
178 * want to update cache.
180 if (state.refresh_cache) {
181 close(newfd); newfd = -1;
182 rollback_index_file(&cache_file);
184 state.refresh_cache = 0;
187 /* Check out named files first */
188 for ( ; i < argc; i++) {
189 const char *arg = argv[i];
191 if (all)
192 die("git-checkout-index: don't mix '--all' and explicit filenames");
193 checkout_file(prefix_path(prefix, prefix_length, arg));
196 if (all)
197 checkout_all();
199 if (0 <= newfd &&
200 (write_cache(newfd, active_cache, active_nr) ||
201 commit_index_file(&cache_file)))
202 die("Unable to write new cachefile");
203 return 0;