Document git-blame triple -C option
[git/mjg.git] / builtin-update-index.c
bloba6b7f2d6361fc1e8ea9713082affc72362f08d76
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "quote.h"
8 #include "cache-tree.h"
9 #include "tree-walk.h"
10 #include "builtin.h"
11 #include "refs.h"
14 * Default to not allowing changes to the list of files. The
15 * tool doesn't actually care, but this makes it harder to add
16 * files to the revision control by mistake by doing something
17 * like "git update-index *" and suddenly having all the object
18 * files be revision controlled.
20 static int allow_add;
21 static int allow_remove;
22 static int allow_replace;
23 static int info_only;
24 static int force_remove;
25 static int verbose;
26 static int mark_valid_only;
27 #define MARK_VALID 1
28 #define UNMARK_VALID 2
30 __attribute__((format (printf, 1, 2)))
31 static void report(const char *fmt, ...)
33 va_list vp;
35 if (!verbose)
36 return;
38 va_start(vp, fmt);
39 vprintf(fmt, vp);
40 putchar('\n');
41 va_end(vp);
44 static int mark_valid(const char *path)
46 int namelen = strlen(path);
47 int pos = cache_name_pos(path, namelen);
48 if (0 <= pos) {
49 switch (mark_valid_only) {
50 case MARK_VALID:
51 active_cache[pos]->ce_flags |= CE_VALID;
52 break;
53 case UNMARK_VALID:
54 active_cache[pos]->ce_flags &= ~CE_VALID;
55 break;
57 cache_tree_invalidate_path(active_cache_tree, path);
58 active_cache_changed = 1;
59 return 0;
61 return -1;
64 static int remove_one_path(const char *path)
66 if (!allow_remove)
67 return error("%s: does not exist and --remove not passed", path);
68 if (remove_file_from_cache(path))
69 return error("%s: cannot remove from the index", path);
70 return 0;
74 * Handle a path that couldn't be lstat'ed. It's either:
75 * - missing file (ENOENT or ENOTDIR). That's ok if we're
76 * supposed to be removing it and the removal actually
77 * succeeds.
78 * - permission error. That's never ok.
80 static int process_lstat_error(const char *path, int err)
82 if (err == ENOENT || err == ENOTDIR)
83 return remove_one_path(path);
84 return error("lstat(\"%s\"): %s", path, strerror(errno));
87 static int add_one_path(struct cache_entry *old, const char *path, int len, struct stat *st)
89 int option, size;
90 struct cache_entry *ce;
92 /* Was the old index entry already up-to-date? */
93 if (old && !ce_stage(old) && !ce_match_stat(old, st, 0))
94 return 0;
96 size = cache_entry_size(len);
97 ce = xcalloc(1, size);
98 memcpy(ce->name, path, len);
99 ce->ce_flags = len;
100 fill_stat_cache_info(ce, st);
101 ce->ce_mode = ce_mode_from_stat(old, st->st_mode);
103 if (index_path(ce->sha1, path, st, !info_only))
104 return -1;
105 option = allow_add ? ADD_CACHE_OK_TO_ADD : 0;
106 option |= allow_replace ? ADD_CACHE_OK_TO_REPLACE : 0;
107 if (add_cache_entry(ce, option))
108 return error("%s: cannot add to the index - missing --add option?", path);
109 return 0;
113 * Handle a path that was a directory. Four cases:
115 * - it's already a gitlink in the index, and we keep it that
116 * way, and update it if we can (if we cannot find the HEAD,
117 * we're going to keep it unchanged in the index!)
119 * - it's a *file* in the index, in which case it should be
120 * removed as a file if removal is allowed, since it doesn't
121 * exist as such any more. If removal isn't allowed, it's
122 * an error.
124 * (NOTE! This is old and arguably fairly strange behaviour.
125 * We might want to make this an error unconditionally, and
126 * use "--force-remove" if you actually want to force removal).
128 * - it used to exist as a subdirectory (ie multiple files with
129 * this particular prefix) in the index, in which case it's wrong
130 * to try to update it as a directory.
132 * - it doesn't exist at all in the index, but it is a valid
133 * git directory, and it should be *added* as a gitlink.
135 static int process_directory(const char *path, int len, struct stat *st)
137 unsigned char sha1[20];
138 int pos = cache_name_pos(path, len);
140 /* Exact match: file or existing gitlink */
141 if (pos >= 0) {
142 struct cache_entry *ce = active_cache[pos];
143 if (S_ISGITLINK(ce->ce_mode)) {
145 /* Do nothing to the index if there is no HEAD! */
146 if (resolve_gitlink_ref(path, "HEAD", sha1) < 0)
147 return 0;
149 return add_one_path(ce, path, len, st);
151 /* Should this be an unconditional error? */
152 return remove_one_path(path);
155 /* Inexact match: is there perhaps a subdirectory match? */
156 pos = -pos-1;
157 while (pos < active_nr) {
158 struct cache_entry *ce = active_cache[pos++];
160 if (strncmp(ce->name, path, len))
161 break;
162 if (ce->name[len] > '/')
163 break;
164 if (ce->name[len] < '/')
165 continue;
167 /* Subdirectory match - error out */
168 return error("%s: is a directory - add individual files instead", path);
171 /* No match - should we add it as a gitlink? */
172 if (!resolve_gitlink_ref(path, "HEAD", sha1))
173 return add_one_path(NULL, path, len, st);
175 /* Error out. */
176 return error("%s: is a directory - add files inside instead", path);
180 * Process a regular file
182 static int process_file(const char *path, int len, struct stat *st)
184 int pos = cache_name_pos(path, len);
185 struct cache_entry *ce = pos < 0 ? NULL : active_cache[pos];
187 if (ce && S_ISGITLINK(ce->ce_mode))
188 return error("%s is already a gitlink, not replacing", path);
190 return add_one_path(ce, path, len, st);
193 static int process_path(const char *path)
195 int len;
196 struct stat st;
198 len = strlen(path);
199 if (has_symlink_leading_path(path, len))
200 return error("'%s' is beyond a symbolic link", path);
203 * First things first: get the stat information, to decide
204 * what to do about the pathname!
206 if (lstat(path, &st) < 0)
207 return process_lstat_error(path, errno);
209 if (S_ISDIR(st.st_mode))
210 return process_directory(path, len, &st);
212 return process_file(path, len, &st);
215 static int add_cacheinfo(unsigned int mode, const unsigned char *sha1,
216 const char *path, int stage)
218 int size, len, option;
219 struct cache_entry *ce;
221 if (!verify_path(path))
222 return error("Invalid path '%s'", path);
224 len = strlen(path);
225 size = cache_entry_size(len);
226 ce = xcalloc(1, size);
228 hashcpy(ce->sha1, sha1);
229 memcpy(ce->name, path, len);
230 ce->ce_flags = create_ce_flags(len, stage);
231 ce->ce_mode = create_ce_mode(mode);
232 if (assume_unchanged)
233 ce->ce_flags |= CE_VALID;
234 option = allow_add ? ADD_CACHE_OK_TO_ADD : 0;
235 option |= allow_replace ? ADD_CACHE_OK_TO_REPLACE : 0;
236 if (add_cache_entry(ce, option))
237 return error("%s: cannot add to the index - missing --add option?",
238 path);
239 report("add '%s'", path);
240 return 0;
243 static void chmod_path(int flip, const char *path)
245 int pos;
246 struct cache_entry *ce;
247 unsigned int mode;
249 pos = cache_name_pos(path, strlen(path));
250 if (pos < 0)
251 goto fail;
252 ce = active_cache[pos];
253 mode = ce->ce_mode;
254 if (!S_ISREG(mode))
255 goto fail;
256 switch (flip) {
257 case '+':
258 ce->ce_mode |= 0111; break;
259 case '-':
260 ce->ce_mode &= ~0111; break;
261 default:
262 goto fail;
264 cache_tree_invalidate_path(active_cache_tree, path);
265 active_cache_changed = 1;
266 report("chmod %cx '%s'", flip, path);
267 return;
268 fail:
269 die("git update-index: cannot chmod %cx '%s'", flip, path);
272 static void update_one(const char *path, const char *prefix, int prefix_length)
274 const char *p = prefix_path(prefix, prefix_length, path);
275 if (!verify_path(p)) {
276 fprintf(stderr, "Ignoring path %s\n", path);
277 goto free_return;
279 if (mark_valid_only) {
280 if (mark_valid(p))
281 die("Unable to mark file %s", path);
282 goto free_return;
285 if (force_remove) {
286 if (remove_file_from_cache(p))
287 die("git update-index: unable to remove %s", path);
288 report("remove '%s'", path);
289 goto free_return;
291 if (process_path(p))
292 die("Unable to process path %s", path);
293 report("add '%s'", path);
294 free_return:
295 if (p < path || p > path + strlen(path))
296 free((char *)p);
299 static void read_index_info(int line_termination)
301 struct strbuf buf = STRBUF_INIT;
302 struct strbuf uq = STRBUF_INIT;
304 while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
305 char *ptr, *tab;
306 char *path_name;
307 unsigned char sha1[20];
308 unsigned int mode;
309 unsigned long ul;
310 int stage;
312 /* This reads lines formatted in one of three formats:
314 * (1) mode SP sha1 TAB path
315 * The first format is what "git apply --index-info"
316 * reports, and used to reconstruct a partial tree
317 * that is used for phony merge base tree when falling
318 * back on 3-way merge.
320 * (2) mode SP type SP sha1 TAB path
321 * The second format is to stuff "git ls-tree" output
322 * into the index file.
324 * (3) mode SP sha1 SP stage TAB path
325 * This format is to put higher order stages into the
326 * index file and matches "git ls-files --stage" output.
328 errno = 0;
329 ul = strtoul(buf.buf, &ptr, 8);
330 if (ptr == buf.buf || *ptr != ' '
331 || errno || (unsigned int) ul != ul)
332 goto bad_line;
333 mode = ul;
335 tab = strchr(ptr, '\t');
336 if (!tab || tab - ptr < 41)
337 goto bad_line;
339 if (tab[-2] == ' ' && '0' <= tab[-1] && tab[-1] <= '3') {
340 stage = tab[-1] - '0';
341 ptr = tab + 1; /* point at the head of path */
342 tab = tab - 2; /* point at tail of sha1 */
344 else {
345 stage = 0;
346 ptr = tab + 1; /* point at the head of path */
349 if (get_sha1_hex(tab - 40, sha1) || tab[-41] != ' ')
350 goto bad_line;
352 path_name = ptr;
353 if (line_termination && path_name[0] == '"') {
354 strbuf_reset(&uq);
355 if (unquote_c_style(&uq, path_name, NULL)) {
356 die("git update-index: bad quoting of path name");
358 path_name = uq.buf;
361 if (!verify_path(path_name)) {
362 fprintf(stderr, "Ignoring path %s\n", path_name);
363 continue;
366 if (!mode) {
367 /* mode == 0 means there is no such path -- remove */
368 if (remove_file_from_cache(path_name))
369 die("git update-index: unable to remove %s",
370 ptr);
372 else {
373 /* mode ' ' sha1 '\t' name
374 * ptr[-1] points at tab,
375 * ptr[-41] is at the beginning of sha1
377 ptr[-42] = ptr[-1] = 0;
378 if (add_cacheinfo(mode, sha1, path_name, stage))
379 die("git update-index: unable to update %s",
380 path_name);
382 continue;
384 bad_line:
385 die("malformed index info %s", buf.buf);
387 strbuf_release(&buf);
388 strbuf_release(&uq);
391 static const char update_index_usage[] =
392 "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 | -g] [--ignore-missing] [-z] [--verbose] [--] <file>...";
394 static unsigned char head_sha1[20];
395 static unsigned char merge_head_sha1[20];
397 static struct cache_entry *read_one_ent(const char *which,
398 unsigned char *ent, const char *path,
399 int namelen, int stage)
401 unsigned mode;
402 unsigned char sha1[20];
403 int size;
404 struct cache_entry *ce;
406 if (get_tree_entry(ent, path, sha1, &mode)) {
407 if (which)
408 error("%s: not in %s branch.", path, which);
409 return NULL;
411 if (mode == S_IFDIR) {
412 if (which)
413 error("%s: not a blob in %s branch.", path, which);
414 return NULL;
416 size = cache_entry_size(namelen);
417 ce = xcalloc(1, size);
419 hashcpy(ce->sha1, sha1);
420 memcpy(ce->name, path, namelen);
421 ce->ce_flags = create_ce_flags(namelen, stage);
422 ce->ce_mode = create_ce_mode(mode);
423 return ce;
426 static int unresolve_one(const char *path)
428 int namelen = strlen(path);
429 int pos;
430 int ret = 0;
431 struct cache_entry *ce_2 = NULL, *ce_3 = NULL;
433 /* See if there is such entry in the index. */
434 pos = cache_name_pos(path, namelen);
435 if (pos < 0) {
436 /* If there isn't, either it is unmerged, or
437 * resolved as "removed" by mistake. We do not
438 * want to do anything in the former case.
440 pos = -pos-1;
441 if (pos < active_nr) {
442 struct cache_entry *ce = active_cache[pos];
443 if (ce_namelen(ce) == namelen &&
444 !memcmp(ce->name, path, namelen)) {
445 fprintf(stderr,
446 "%s: skipping still unmerged path.\n",
447 path);
448 goto free_return;
453 /* Grab blobs from given path from HEAD and MERGE_HEAD,
454 * stuff HEAD version in stage #2,
455 * stuff MERGE_HEAD version in stage #3.
457 ce_2 = read_one_ent("our", head_sha1, path, namelen, 2);
458 ce_3 = read_one_ent("their", merge_head_sha1, path, namelen, 3);
460 if (!ce_2 || !ce_3) {
461 ret = -1;
462 goto free_return;
464 if (!hashcmp(ce_2->sha1, ce_3->sha1) &&
465 ce_2->ce_mode == ce_3->ce_mode) {
466 fprintf(stderr, "%s: identical in both, skipping.\n",
467 path);
468 goto free_return;
471 remove_file_from_cache(path);
472 if (add_cache_entry(ce_2, ADD_CACHE_OK_TO_ADD)) {
473 error("%s: cannot add our version to the index.", path);
474 ret = -1;
475 goto free_return;
477 if (!add_cache_entry(ce_3, ADD_CACHE_OK_TO_ADD))
478 return 0;
479 error("%s: cannot add their version to the index.", path);
480 ret = -1;
481 free_return:
482 free(ce_2);
483 free(ce_3);
484 return ret;
487 static void read_head_pointers(void)
489 if (read_ref("HEAD", head_sha1))
490 die("No HEAD -- no initial commit yet?");
491 if (read_ref("MERGE_HEAD", merge_head_sha1)) {
492 fprintf(stderr, "Not in the middle of a merge.\n");
493 exit(0);
497 static int do_unresolve(int ac, const char **av,
498 const char *prefix, int prefix_length)
500 int i;
501 int err = 0;
503 /* Read HEAD and MERGE_HEAD; if MERGE_HEAD does not exist, we
504 * are not doing a merge, so exit with success status.
506 read_head_pointers();
508 for (i = 1; i < ac; i++) {
509 const char *arg = av[i];
510 const char *p = prefix_path(prefix, prefix_length, arg);
511 err |= unresolve_one(p);
512 if (p < arg || p > arg + strlen(arg))
513 free((char *)p);
515 return err;
518 static int do_reupdate(int ac, const char **av,
519 const char *prefix, int prefix_length)
521 /* Read HEAD and run update-index on paths that are
522 * merged and already different between index and HEAD.
524 int pos;
525 int has_head = 1;
526 const char **pathspec = get_pathspec(prefix, av + 1);
528 if (read_ref("HEAD", head_sha1))
529 /* If there is no HEAD, that means it is an initial
530 * commit. Update everything in the index.
532 has_head = 0;
533 redo:
534 for (pos = 0; pos < active_nr; pos++) {
535 struct cache_entry *ce = active_cache[pos];
536 struct cache_entry *old = NULL;
537 int save_nr;
539 if (ce_stage(ce) || !ce_path_match(ce, pathspec))
540 continue;
541 if (has_head)
542 old = read_one_ent(NULL, head_sha1,
543 ce->name, ce_namelen(ce), 0);
544 if (old && ce->ce_mode == old->ce_mode &&
545 !hashcmp(ce->sha1, old->sha1)) {
546 free(old);
547 continue; /* unchanged */
549 /* Be careful. The working tree may not have the
550 * path anymore, in which case, under 'allow_remove',
551 * or worse yet 'allow_replace', active_nr may decrease.
553 save_nr = active_nr;
554 update_one(ce->name + prefix_length, prefix, prefix_length);
555 if (save_nr != active_nr)
556 goto redo;
558 return 0;
561 int cmd_update_index(int argc, const char **argv, const char *prefix)
563 int i, newfd, entries, has_errors = 0, line_termination = '\n';
564 int allow_options = 1;
565 int read_from_stdin = 0;
566 int prefix_length = prefix ? strlen(prefix) : 0;
567 char set_executable_bit = 0;
568 unsigned int refresh_flags = 0;
569 int lock_error = 0;
570 struct lock_file *lock_file;
572 git_config(git_default_config, NULL);
574 /* We can't free this memory, it becomes part of a linked list parsed atexit() */
575 lock_file = xcalloc(1, sizeof(struct lock_file));
577 newfd = hold_locked_index(lock_file, 0);
578 if (newfd < 0)
579 lock_error = errno;
581 entries = read_cache();
582 if (entries < 0)
583 die("cache corrupted");
585 for (i = 1 ; i < argc; i++) {
586 const char *path = argv[i];
587 const char *p;
589 if (allow_options && *path == '-') {
590 if (!strcmp(path, "--")) {
591 allow_options = 0;
592 continue;
594 if (!strcmp(path, "-q")) {
595 refresh_flags |= REFRESH_QUIET;
596 continue;
598 if (!strcmp(path, "--ignore-submodules")) {
599 refresh_flags |= REFRESH_IGNORE_SUBMODULES;
600 continue;
602 if (!strcmp(path, "--add")) {
603 allow_add = 1;
604 continue;
606 if (!strcmp(path, "--replace")) {
607 allow_replace = 1;
608 continue;
610 if (!strcmp(path, "--remove")) {
611 allow_remove = 1;
612 continue;
614 if (!strcmp(path, "--unmerged")) {
615 refresh_flags |= REFRESH_UNMERGED;
616 continue;
618 if (!strcmp(path, "--refresh")) {
619 setup_work_tree();
620 has_errors |= refresh_cache(refresh_flags);
621 continue;
623 if (!strcmp(path, "--really-refresh")) {
624 setup_work_tree();
625 has_errors |= refresh_cache(REFRESH_REALLY | refresh_flags);
626 continue;
628 if (!strcmp(path, "--cacheinfo")) {
629 unsigned char sha1[20];
630 unsigned int mode;
632 if (i+3 >= argc)
633 die("git update-index: --cacheinfo <mode> <sha1> <path>");
635 if (strtoul_ui(argv[i+1], 8, &mode) ||
636 get_sha1_hex(argv[i+2], sha1) ||
637 add_cacheinfo(mode, sha1, argv[i+3], 0))
638 die("git update-index: --cacheinfo"
639 " cannot add %s", argv[i+3]);
640 i += 3;
641 continue;
643 if (!strcmp(path, "--chmod=-x") ||
644 !strcmp(path, "--chmod=+x")) {
645 if (argc <= i+1)
646 die("git update-index: %s <path>", path);
647 set_executable_bit = path[8];
648 continue;
650 if (!strcmp(path, "--assume-unchanged")) {
651 mark_valid_only = MARK_VALID;
652 continue;
654 if (!strcmp(path, "--no-assume-unchanged")) {
655 mark_valid_only = UNMARK_VALID;
656 continue;
658 if (!strcmp(path, "--info-only")) {
659 info_only = 1;
660 continue;
662 if (!strcmp(path, "--force-remove")) {
663 force_remove = 1;
664 continue;
666 if (!strcmp(path, "-z")) {
667 line_termination = 0;
668 continue;
670 if (!strcmp(path, "--stdin")) {
671 if (i != argc - 1)
672 die("--stdin must be at the end");
673 read_from_stdin = 1;
674 break;
676 if (!strcmp(path, "--index-info")) {
677 if (i != argc - 1)
678 die("--index-info must be at the end");
679 allow_add = allow_replace = allow_remove = 1;
680 read_index_info(line_termination);
681 break;
683 if (!strcmp(path, "--unresolve")) {
684 has_errors = do_unresolve(argc - i, argv + i,
685 prefix, prefix_length);
686 if (has_errors)
687 active_cache_changed = 0;
688 goto finish;
690 if (!strcmp(path, "--again") || !strcmp(path, "-g")) {
691 setup_work_tree();
692 has_errors = do_reupdate(argc - i, argv + i,
693 prefix, prefix_length);
694 if (has_errors)
695 active_cache_changed = 0;
696 goto finish;
698 if (!strcmp(path, "--ignore-missing")) {
699 refresh_flags |= REFRESH_IGNORE_MISSING;
700 continue;
702 if (!strcmp(path, "--verbose")) {
703 verbose = 1;
704 continue;
706 if (!strcmp(path, "-h") || !strcmp(path, "--help"))
707 usage(update_index_usage);
708 die("unknown option %s", path);
710 setup_work_tree();
711 p = prefix_path(prefix, prefix_length, path);
712 update_one(p, NULL, 0);
713 if (set_executable_bit)
714 chmod_path(set_executable_bit, p);
715 if (p < path || p > path + strlen(path))
716 free((char *)p);
718 if (read_from_stdin) {
719 struct strbuf buf = STRBUF_INIT, nbuf = STRBUF_INIT;
721 setup_work_tree();
722 while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
723 const char *p;
724 if (line_termination && buf.buf[0] == '"') {
725 strbuf_reset(&nbuf);
726 if (unquote_c_style(&nbuf, buf.buf, NULL))
727 die("line is badly quoted");
728 strbuf_swap(&buf, &nbuf);
730 p = prefix_path(prefix, prefix_length, buf.buf);
731 update_one(p, NULL, 0);
732 if (set_executable_bit)
733 chmod_path(set_executable_bit, p);
734 if (p < buf.buf || p > buf.buf + buf.len)
735 free((char *)p);
737 strbuf_release(&nbuf);
738 strbuf_release(&buf);
741 finish:
742 if (active_cache_changed) {
743 if (newfd < 0) {
744 if (refresh_flags & REFRESH_QUIET)
745 exit(128);
746 unable_to_lock_index_die(get_index_file(), lock_error);
748 if (write_cache(newfd, active_cache, active_nr) ||
749 commit_locked_index(lock_file))
750 die("Unable to write new index file");
753 rollback_lock_file(lock_file);
755 return has_errors ? 1 : 0;