Fix some documentation typoes
[git.git] / update-index.c
blob956b6b34f99a447f55fe48ef3ce1eb652524c985
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "strbuf.h"
8 #include "quote.h"
9 #include "cache-tree.h"
10 #include "tree-walk.h"
13 * Default to not allowing changes to the list of files. The
14 * tool doesn't actually care, but this makes it harder to add
15 * files to the revision control by mistake by doing something
16 * like "git-update-index *" and suddenly having all the object
17 * files be revision controlled.
19 static int allow_add;
20 static int allow_remove;
21 static int allow_replace;
22 static int info_only;
23 static int force_remove;
24 static int verbose;
25 static int mark_valid_only = 0;
26 #define MARK_VALID 1
27 #define UNMARK_VALID 2
29 static void report(const char *fmt, ...)
31 va_list vp;
33 if (!verbose)
34 return;
36 va_start(vp, fmt);
37 vprintf(fmt, vp);
38 putchar('\n');
39 va_end(vp);
42 static int mark_valid(const char *path)
44 int namelen = strlen(path);
45 int pos = cache_name_pos(path, namelen);
46 if (0 <= pos) {
47 switch (mark_valid_only) {
48 case MARK_VALID:
49 active_cache[pos]->ce_flags |= htons(CE_VALID);
50 break;
51 case UNMARK_VALID:
52 active_cache[pos]->ce_flags &= ~htons(CE_VALID);
53 break;
55 cache_tree_invalidate_path(active_cache_tree, path);
56 active_cache_changed = 1;
57 return 0;
59 return -1;
62 static int add_file_to_cache(const char *path)
64 int size, namelen, option, status;
65 struct cache_entry *ce;
66 struct stat st;
68 status = lstat(path, &st);
70 /* We probably want to do this in remove_file_from_cache() and
71 * add_cache_entry() instead...
73 cache_tree_invalidate_path(active_cache_tree, path);
75 if (status < 0 || S_ISDIR(st.st_mode)) {
76 /* When we used to have "path" and now we want to add
77 * "path/file", we need a way to remove "path" before
78 * being able to add "path/file". However,
79 * "git-update-index --remove path" would not work.
80 * --force-remove can be used but this is more user
81 * friendly, especially since we can do the opposite
82 * case just fine without --force-remove.
84 if (status == 0 || (errno == ENOENT || errno == ENOTDIR)) {
85 if (allow_remove) {
86 if (remove_file_from_cache(path))
87 return error("%s: cannot remove from the index",
88 path);
89 else
90 return 0;
91 } else if (status < 0) {
92 return error("%s: does not exist and --remove not passed",
93 path);
96 if (0 == status)
97 return error("%s: is a directory - add files inside instead",
98 path);
99 else
100 return error("lstat(\"%s\"): %s", path,
101 strerror(errno));
104 namelen = strlen(path);
105 size = cache_entry_size(namelen);
106 ce = xcalloc(1, size);
107 memcpy(ce->name, path, namelen);
108 ce->ce_flags = htons(namelen);
109 fill_stat_cache_info(ce, &st);
111 ce->ce_mode = create_ce_mode(st.st_mode);
112 if (!trust_executable_bit) {
113 /* If there is an existing entry, pick the mode bits
114 * from it.
116 int pos = cache_name_pos(path, namelen);
117 if (0 <= pos)
118 ce->ce_mode = active_cache[pos]->ce_mode;
121 if (index_path(ce->sha1, path, &st, !info_only))
122 return -1;
123 option = allow_add ? ADD_CACHE_OK_TO_ADD : 0;
124 option |= allow_replace ? ADD_CACHE_OK_TO_REPLACE : 0;
125 if (add_cache_entry(ce, option))
126 return error("%s: cannot add to the index - missing --add option?",
127 path);
128 return 0;
131 static int add_cacheinfo(unsigned int mode, const unsigned char *sha1,
132 const char *path, int stage)
134 int size, len, option;
135 struct cache_entry *ce;
137 if (!verify_path(path))
138 return -1;
140 len = strlen(path);
141 size = cache_entry_size(len);
142 ce = xcalloc(1, size);
144 memcpy(ce->sha1, sha1, 20);
145 memcpy(ce->name, path, len);
146 ce->ce_flags = create_ce_flags(len, stage);
147 ce->ce_mode = create_ce_mode(mode);
148 if (assume_unchanged)
149 ce->ce_flags |= htons(CE_VALID);
150 option = allow_add ? ADD_CACHE_OK_TO_ADD : 0;
151 option |= allow_replace ? ADD_CACHE_OK_TO_REPLACE : 0;
152 if (add_cache_entry(ce, option))
153 return error("%s: cannot add to the index - missing --add option?",
154 path);
155 report("add '%s'", path);
156 cache_tree_invalidate_path(active_cache_tree, path);
157 return 0;
160 static void chmod_path(int flip, const char *path)
162 int pos;
163 struct cache_entry *ce;
164 unsigned int mode;
166 pos = cache_name_pos(path, strlen(path));
167 if (pos < 0)
168 goto fail;
169 ce = active_cache[pos];
170 mode = ntohl(ce->ce_mode);
171 if (!S_ISREG(mode))
172 goto fail;
173 switch (flip) {
174 case '+':
175 ce->ce_mode |= htonl(0111); break;
176 case '-':
177 ce->ce_mode &= htonl(~0111); break;
178 default:
179 goto fail;
181 cache_tree_invalidate_path(active_cache_tree, path);
182 active_cache_changed = 1;
183 report("chmod %cx '%s'", flip, path);
184 return;
185 fail:
186 die("git-update-index: cannot chmod %cx '%s'", flip, path);
189 static struct cache_file cache_file;
191 static void update_one(const char *path, const char *prefix, int prefix_length)
193 const char *p = prefix_path(prefix, prefix_length, path);
194 if (!verify_path(p)) {
195 fprintf(stderr, "Ignoring path %s\n", path);
196 goto free_return;
198 if (mark_valid_only) {
199 if (mark_valid(p))
200 die("Unable to mark file %s", path);
201 goto free_return;
203 cache_tree_invalidate_path(active_cache_tree, path);
205 if (force_remove) {
206 if (remove_file_from_cache(p))
207 die("git-update-index: unable to remove %s", path);
208 report("remove '%s'", path);
209 goto free_return;
211 if (add_file_to_cache(p))
212 die("Unable to process file %s", path);
213 report("add '%s'", path);
214 free_return:
215 if (p < path || p > path + strlen(path))
216 free((char*)p);
219 static void read_index_info(int line_termination)
221 struct strbuf buf;
222 strbuf_init(&buf);
223 while (1) {
224 char *ptr, *tab;
225 char *path_name;
226 unsigned char sha1[20];
227 unsigned int mode;
228 int stage;
230 /* This reads lines formatted in one of three formats:
232 * (1) mode SP sha1 TAB path
233 * The first format is what "git-apply --index-info"
234 * reports, and used to reconstruct a partial tree
235 * that is used for phony merge base tree when falling
236 * back on 3-way merge.
238 * (2) mode SP type SP sha1 TAB path
239 * The second format is to stuff git-ls-tree output
240 * into the index file.
242 * (3) mode SP sha1 SP stage TAB path
243 * This format is to put higher order stages into the
244 * index file and matches git-ls-files --stage output.
246 read_line(&buf, stdin, line_termination);
247 if (buf.eof)
248 break;
250 mode = strtoul(buf.buf, &ptr, 8);
251 if (ptr == buf.buf || *ptr != ' ')
252 goto bad_line;
254 tab = strchr(ptr, '\t');
255 if (!tab || tab - ptr < 41)
256 goto bad_line;
258 if (tab[-2] == ' ' && '0' <= tab[-1] && tab[-1] <= '3') {
259 stage = tab[-1] - '0';
260 ptr = tab + 1; /* point at the head of path */
261 tab = tab - 2; /* point at tail of sha1 */
263 else {
264 stage = 0;
265 ptr = tab + 1; /* point at the head of path */
268 if (get_sha1_hex(tab - 40, sha1) || tab[-41] != ' ')
269 goto bad_line;
271 if (line_termination && ptr[0] == '"')
272 path_name = unquote_c_style(ptr, NULL);
273 else
274 path_name = ptr;
276 if (!verify_path(path_name)) {
277 fprintf(stderr, "Ignoring path %s\n", path_name);
278 if (path_name != ptr)
279 free(path_name);
280 continue;
282 cache_tree_invalidate_path(active_cache_tree, path_name);
284 if (!mode) {
285 /* mode == 0 means there is no such path -- remove */
286 if (remove_file_from_cache(path_name))
287 die("git-update-index: unable to remove %s",
288 ptr);
290 else {
291 /* mode ' ' sha1 '\t' name
292 * ptr[-1] points at tab,
293 * ptr[-41] is at the beginning of sha1
295 ptr[-42] = ptr[-1] = 0;
296 if (add_cacheinfo(mode, sha1, path_name, stage))
297 die("git-update-index: unable to update %s",
298 path_name);
300 if (path_name != ptr)
301 free(path_name);
302 continue;
304 bad_line:
305 die("malformed index info %s", buf.buf);
309 static const char update_index_usage[] =
310 "git-update-index [-q] [--add] [--replace] [--remove] [--unmerged] [--refresh] [--really-refresh] [--cacheinfo] [--chmod=(+|-)x] [--assume-unchanged] [--info-only] [--force-remove] [--stdin] [--index-info] [--unresolve] [--again] [--ignore-missing] [-z] [--verbose] [--] <file>...";
312 static unsigned char head_sha1[20];
313 static unsigned char merge_head_sha1[20];
315 static struct cache_entry *read_one_ent(const char *which,
316 unsigned char *ent, const char *path,
317 int namelen, int stage)
319 unsigned mode;
320 unsigned char sha1[20];
321 int size;
322 struct cache_entry *ce;
324 if (get_tree_entry(ent, path, sha1, &mode)) {
325 if (which)
326 error("%s: not in %s branch.", path, which);
327 return NULL;
329 if (mode == S_IFDIR) {
330 if (which)
331 error("%s: not a blob in %s branch.", path, which);
332 return NULL;
334 size = cache_entry_size(namelen);
335 ce = xcalloc(1, size);
337 memcpy(ce->sha1, sha1, 20);
338 memcpy(ce->name, path, namelen);
339 ce->ce_flags = create_ce_flags(namelen, stage);
340 ce->ce_mode = create_ce_mode(mode);
341 return ce;
344 static int unresolve_one(const char *path)
346 int namelen = strlen(path);
347 int pos;
348 int ret = 0;
349 struct cache_entry *ce_2 = NULL, *ce_3 = NULL;
351 /* See if there is such entry in the index. */
352 pos = cache_name_pos(path, namelen);
353 if (pos < 0) {
354 /* If there isn't, either it is unmerged, or
355 * resolved as "removed" by mistake. We do not
356 * want to do anything in the former case.
358 pos = -pos-1;
359 if (pos < active_nr) {
360 struct cache_entry *ce = active_cache[pos];
361 if (ce_namelen(ce) == namelen &&
362 !memcmp(ce->name, path, namelen)) {
363 fprintf(stderr,
364 "%s: skipping still unmerged path.\n",
365 path);
366 goto free_return;
371 /* Grab blobs from given path from HEAD and MERGE_HEAD,
372 * stuff HEAD version in stage #2,
373 * stuff MERGE_HEAD version in stage #3.
375 ce_2 = read_one_ent("our", head_sha1, path, namelen, 2);
376 ce_3 = read_one_ent("their", merge_head_sha1, path, namelen, 3);
378 if (!ce_2 || !ce_3) {
379 ret = -1;
380 goto free_return;
382 if (!memcmp(ce_2->sha1, ce_3->sha1, 20) &&
383 ce_2->ce_mode == ce_3->ce_mode) {
384 fprintf(stderr, "%s: identical in both, skipping.\n",
385 path);
386 goto free_return;
389 cache_tree_invalidate_path(active_cache_tree, path);
390 remove_file_from_cache(path);
391 if (add_cache_entry(ce_2, ADD_CACHE_OK_TO_ADD)) {
392 error("%s: cannot add our version to the index.", path);
393 ret = -1;
394 goto free_return;
396 if (!add_cache_entry(ce_3, ADD_CACHE_OK_TO_ADD))
397 return 0;
398 error("%s: cannot add their version to the index.", path);
399 ret = -1;
400 free_return:
401 free(ce_2);
402 free(ce_3);
403 return ret;
406 static void read_head_pointers(void)
408 if (read_ref(git_path("HEAD"), head_sha1))
409 die("No HEAD -- no initial commit yet?\n");
410 if (read_ref(git_path("MERGE_HEAD"), merge_head_sha1)) {
411 fprintf(stderr, "Not in the middle of a merge.\n");
412 exit(0);
416 static int do_unresolve(int ac, const char **av,
417 const char *prefix, int prefix_length)
419 int i;
420 int err = 0;
422 /* Read HEAD and MERGE_HEAD; if MERGE_HEAD does not exist, we
423 * are not doing a merge, so exit with success status.
425 read_head_pointers();
427 for (i = 1; i < ac; i++) {
428 const char *arg = av[i];
429 const char *p = prefix_path(prefix, prefix_length, arg);
430 err |= unresolve_one(p);
431 if (p < arg || p > arg + strlen(arg))
432 free((char*)p);
434 return err;
437 static int do_reupdate(int ac, const char **av,
438 const char *prefix, int prefix_length)
440 /* Read HEAD and run update-index on paths that are
441 * merged and already different between index and HEAD.
443 int pos;
444 int has_head = 1;
445 const char **pathspec = get_pathspec(prefix, av + 1);
447 if (read_ref(git_path("HEAD"), head_sha1))
448 /* If there is no HEAD, that means it is an initial
449 * commit. Update everything in the index.
451 has_head = 0;
452 redo:
453 for (pos = 0; pos < active_nr; pos++) {
454 struct cache_entry *ce = active_cache[pos];
455 struct cache_entry *old = NULL;
456 int save_nr;
458 if (ce_stage(ce) || !ce_path_match(ce, pathspec))
459 continue;
460 if (has_head)
461 old = read_one_ent(NULL, head_sha1,
462 ce->name, ce_namelen(ce), 0);
463 if (old && ce->ce_mode == old->ce_mode &&
464 !memcmp(ce->sha1, old->sha1, 20)) {
465 free(old);
466 continue; /* unchanged */
468 /* Be careful. The working tree may not have the
469 * path anymore, in which case, under 'allow_remove',
470 * or worse yet 'allow_replace', active_nr may decrease.
472 save_nr = active_nr;
473 update_one(ce->name + prefix_length, prefix, prefix_length);
474 if (save_nr != active_nr)
475 goto redo;
477 return 0;
480 int main(int argc, const char **argv)
482 int i, newfd, entries, has_errors = 0, line_termination = '\n';
483 int allow_options = 1;
484 int read_from_stdin = 0;
485 const char *prefix = setup_git_directory();
486 int prefix_length = prefix ? strlen(prefix) : 0;
487 char set_executable_bit = 0;
488 unsigned int refresh_flags = 0;
490 git_config(git_default_config);
492 newfd = hold_index_file_for_update(&cache_file, get_index_file());
493 if (newfd < 0)
494 die("unable to create new cachefile");
496 entries = read_cache();
497 if (entries < 0)
498 die("cache corrupted");
500 for (i = 1 ; i < argc; i++) {
501 const char *path = argv[i];
503 if (allow_options && *path == '-') {
504 if (!strcmp(path, "--")) {
505 allow_options = 0;
506 continue;
508 if (!strcmp(path, "-q")) {
509 refresh_flags |= REFRESH_QUIET;
510 continue;
512 if (!strcmp(path, "--add")) {
513 allow_add = 1;
514 continue;
516 if (!strcmp(path, "--replace")) {
517 allow_replace = 1;
518 continue;
520 if (!strcmp(path, "--remove")) {
521 allow_remove = 1;
522 continue;
524 if (!strcmp(path, "--unmerged")) {
525 refresh_flags |= REFRESH_UNMERGED;
526 continue;
528 if (!strcmp(path, "--refresh")) {
529 has_errors |= refresh_cache(refresh_flags);
530 continue;
532 if (!strcmp(path, "--really-refresh")) {
533 has_errors |= refresh_cache(REFRESH_REALLY | refresh_flags);
534 continue;
536 if (!strcmp(path, "--cacheinfo")) {
537 unsigned char sha1[20];
538 unsigned int mode;
540 if (i+3 >= argc)
541 die("git-update-index: --cacheinfo <mode> <sha1> <path>");
543 if ((sscanf(argv[i+1], "%o", &mode) != 1) ||
544 get_sha1_hex(argv[i+2], sha1) ||
545 add_cacheinfo(mode, sha1, argv[i+3], 0))
546 die("git-update-index: --cacheinfo"
547 " cannot add %s", argv[i+3]);
548 i += 3;
549 continue;
551 if (!strcmp(path, "--chmod=-x") ||
552 !strcmp(path, "--chmod=+x")) {
553 if (argc <= i+1)
554 die("git-update-index: %s <path>", path);
555 set_executable_bit = path[8];
556 continue;
558 if (!strcmp(path, "--assume-unchanged")) {
559 mark_valid_only = MARK_VALID;
560 continue;
562 if (!strcmp(path, "--no-assume-unchanged")) {
563 mark_valid_only = UNMARK_VALID;
564 continue;
566 if (!strcmp(path, "--info-only")) {
567 info_only = 1;
568 continue;
570 if (!strcmp(path, "--force-remove")) {
571 force_remove = 1;
572 continue;
574 if (!strcmp(path, "-z")) {
575 line_termination = 0;
576 continue;
578 if (!strcmp(path, "--stdin")) {
579 if (i != argc - 1)
580 die("--stdin must be at the end");
581 read_from_stdin = 1;
582 break;
584 if (!strcmp(path, "--index-info")) {
585 if (i != argc - 1)
586 die("--index-info must be at the end");
587 allow_add = allow_replace = allow_remove = 1;
588 read_index_info(line_termination);
589 break;
591 if (!strcmp(path, "--unresolve")) {
592 has_errors = do_unresolve(argc - i, argv + i,
593 prefix, prefix_length);
594 if (has_errors)
595 active_cache_changed = 0;
596 goto finish;
598 if (!strcmp(path, "--again")) {
599 has_errors = do_reupdate(argc - i, argv + i,
600 prefix, prefix_length);
601 if (has_errors)
602 active_cache_changed = 0;
603 goto finish;
605 if (!strcmp(path, "--ignore-missing")) {
606 refresh_flags |= REFRESH_IGNORE_MISSING;
607 continue;
609 if (!strcmp(path, "--verbose")) {
610 verbose = 1;
611 continue;
613 if (!strcmp(path, "-h") || !strcmp(path, "--help"))
614 usage(update_index_usage);
615 die("unknown option %s", path);
617 update_one(path, prefix, prefix_length);
618 if (set_executable_bit)
619 chmod_path(set_executable_bit, path);
621 if (read_from_stdin) {
622 struct strbuf buf;
623 strbuf_init(&buf);
624 while (1) {
625 char *path_name;
626 const char *p;
627 read_line(&buf, stdin, line_termination);
628 if (buf.eof)
629 break;
630 if (line_termination && buf.buf[0] == '"')
631 path_name = unquote_c_style(buf.buf, NULL);
632 else
633 path_name = buf.buf;
634 p = prefix_path(prefix, prefix_length, path_name);
635 update_one(p, NULL, 0);
636 if (set_executable_bit)
637 chmod_path(set_executable_bit, p);
638 if (p < path_name || p > path_name + strlen(path_name))
639 free((char*) p);
640 if (path_name != buf.buf)
641 free(path_name);
645 finish:
646 if (active_cache_changed) {
647 if (write_cache(newfd, active_cache, active_nr) ||
648 commit_index_file(&cache_file))
649 die("Unable to write new cachefile");
652 return has_errors ? 1 : 0;