Code

checkout --conflict=<style>: recreate merge in a non-default style
[git.git] / builtin-checkout.c
1 #include "cache.h"
2 #include "builtin.h"
3 #include "parse-options.h"
4 #include "refs.h"
5 #include "commit.h"
6 #include "tree.h"
7 #include "tree-walk.h"
8 #include "unpack-trees.h"
9 #include "dir.h"
10 #include "run-command.h"
11 #include "merge-recursive.h"
12 #include "branch.h"
13 #include "diff.h"
14 #include "revision.h"
15 #include "remote.h"
16 #include "blob.h"
17 #include "xdiff-interface.h"
18 #include "ll-merge.h"
20 static const char * const checkout_usage[] = {
21         "git checkout [options] <branch>",
22         "git checkout [options] [<branch>] -- <file>...",
23         NULL,
24 };
26 struct checkout_opts {
27         int quiet;
28         int merge;
29         int force;
30         int writeout_stage;
31         int writeout_error;
33         const char *new_branch;
34         int new_branch_log;
35         enum branch_track track;
36 };
38 static int post_checkout_hook(struct commit *old, struct commit *new,
39                               int changed)
40 {
41         struct child_process proc;
42         const char *name = git_path("hooks/post-checkout");
43         const char *argv[5];
45         if (access(name, X_OK) < 0)
46                 return 0;
48         memset(&proc, 0, sizeof(proc));
49         argv[0] = name;
50         argv[1] = xstrdup(sha1_to_hex(old->object.sha1));
51         argv[2] = xstrdup(sha1_to_hex(new->object.sha1));
52         argv[3] = changed ? "1" : "0";
53         argv[4] = NULL;
54         proc.argv = argv;
55         proc.no_stdin = 1;
56         proc.stdout_to_stderr = 1;
57         return run_command(&proc);
58 }
60 static int update_some(const unsigned char *sha1, const char *base, int baselen,
61                 const char *pathname, unsigned mode, int stage, void *context)
62 {
63         int len;
64         struct cache_entry *ce;
66         if (S_ISGITLINK(mode))
67                 return 0;
69         if (S_ISDIR(mode))
70                 return READ_TREE_RECURSIVE;
72         len = baselen + strlen(pathname);
73         ce = xcalloc(1, cache_entry_size(len));
74         hashcpy(ce->sha1, sha1);
75         memcpy(ce->name, base, baselen);
76         memcpy(ce->name + baselen, pathname, len - baselen);
77         ce->ce_flags = create_ce_flags(len, 0);
78         ce->ce_mode = create_ce_mode(mode);
79         add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
80         return 0;
81 }
83 static int read_tree_some(struct tree *tree, const char **pathspec)
84 {
85         read_tree_recursive(tree, "", 0, 0, pathspec, update_some, NULL);
87         /* update the index with the given tree's info
88          * for all args, expanding wildcards, and exit
89          * with any non-zero return code.
90          */
91         return 0;
92 }
94 static int skip_same_name(struct cache_entry *ce, int pos)
95 {
96         while (++pos < active_nr &&
97                !strcmp(active_cache[pos]->name, ce->name))
98                 ; /* skip */
99         return pos;
102 static int check_stage(int stage, struct cache_entry *ce, int pos)
104         while (pos < active_nr &&
105                !strcmp(active_cache[pos]->name, ce->name)) {
106                 if (ce_stage(active_cache[pos]) == stage)
107                         return 0;
108                 pos++;
109         }
110         return error("path '%s' does not have %s version",
111                      ce->name,
112                      (stage == 2) ? "our" : "their");
115 static int check_all_stages(struct cache_entry *ce, int pos)
117         if (ce_stage(ce) != 1 ||
118             active_nr <= pos + 2 ||
119             strcmp(active_cache[pos+1]->name, ce->name) ||
120             ce_stage(active_cache[pos+1]) != 2 ||
121             strcmp(active_cache[pos+2]->name, ce->name) ||
122             ce_stage(active_cache[pos+2]) != 3)
123                 return error("path '%s' does not have all three versions",
124                              ce->name);
125         return 0;
128 static int checkout_stage(int stage, struct cache_entry *ce, int pos,
129                           struct checkout *state)
131         while (pos < active_nr &&
132                !strcmp(active_cache[pos]->name, ce->name)) {
133                 if (ce_stage(active_cache[pos]) == stage)
134                         return checkout_entry(active_cache[pos], state, NULL);
135                 pos++;
136         }
137         return error("path '%s' does not have %s version",
138                      ce->name,
139                      (stage == 2) ? "our" : "their");
142 /* NEEDSWORK: share with merge-recursive */
143 static void fill_mm(const unsigned char *sha1, mmfile_t *mm)
145         unsigned long size;
146         enum object_type type;
148         if (!hashcmp(sha1, null_sha1)) {
149                 mm->ptr = xstrdup("");
150                 mm->size = 0;
151                 return;
152         }
154         mm->ptr = read_sha1_file(sha1, &type, &size);
155         if (!mm->ptr || type != OBJ_BLOB)
156                 die("unable to read blob object %s", sha1_to_hex(sha1));
157         mm->size = size;
160 static int checkout_merged(int pos, struct checkout *state)
162         struct cache_entry *ce = active_cache[pos];
163         const char *path = ce->name;
164         mmfile_t ancestor, ours, theirs;
165         int status;
166         unsigned char sha1[20];
167         mmbuffer_t result_buf;
169         if (ce_stage(ce) != 1 ||
170             active_nr <= pos + 2 ||
171             strcmp(active_cache[pos+1]->name, path) ||
172             ce_stage(active_cache[pos+1]) != 2 ||
173             strcmp(active_cache[pos+2]->name, path) ||
174             ce_stage(active_cache[pos+2]) != 3)
175                 return error("path '%s' does not have all 3 versions", path);
177         fill_mm(active_cache[pos]->sha1, &ancestor);
178         fill_mm(active_cache[pos+1]->sha1, &ours);
179         fill_mm(active_cache[pos+2]->sha1, &theirs);
181         status = ll_merge(&result_buf, path, &ancestor,
182                           &ours, "ours", &theirs, "theirs", 1);
183         free(ancestor.ptr);
184         free(ours.ptr);
185         free(theirs.ptr);
186         if (status < 0 || !result_buf.ptr) {
187                 free(result_buf.ptr);
188                 return error("path '%s': cannot merge", path);
189         }
191         /*
192          * NEEDSWORK:
193          * There is absolutely no reason to write this as a blob object
194          * and create a phoney cache entry just to leak.  This hack is
195          * primarily to get to the write_entry() machinery that massages
196          * the contents to work-tree format and writes out which only
197          * allows it for a cache entry.  The code in write_entry() needs
198          * to be refactored to allow us to feed a <buffer, size, mode>
199          * instead of a cache entry.  Such a refactoring would help
200          * merge_recursive as well (it also writes the merge result to the
201          * object database even when it may contain conflicts).
202          */
203         if (write_sha1_file(result_buf.ptr, result_buf.size,
204                             blob_type, sha1))
205                 die("Unable to add merge result for '%s'", path);
206         ce = make_cache_entry(create_ce_mode(active_cache[pos+1]->ce_mode),
207                               sha1,
208                               path, 2, 0);
209         status = checkout_entry(ce, state, NULL);
210         return status;
213 static int checkout_paths(struct tree *source_tree, const char **pathspec,
214                           struct checkout_opts *opts)
216         int pos;
217         struct checkout state;
218         static char *ps_matched;
219         unsigned char rev[20];
220         int flag;
221         struct commit *head;
222         int errs = 0;
223         int stage = opts->writeout_stage;
224         int merge = opts->merge;
225         int newfd;
226         struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
228         newfd = hold_locked_index(lock_file, 1);
229         read_cache();
231         if (source_tree)
232                 read_tree_some(source_tree, pathspec);
234         for (pos = 0; pathspec[pos]; pos++)
235                 ;
236         ps_matched = xcalloc(1, pos);
238         for (pos = 0; pos < active_nr; pos++) {
239                 struct cache_entry *ce = active_cache[pos];
240                 pathspec_match(pathspec, ps_matched, ce->name, 0);
241         }
243         if (report_path_error(ps_matched, pathspec, 0))
244                 return 1;
246         /* Any unmerged paths? */
247         for (pos = 0; pos < active_nr; pos++) {
248                 struct cache_entry *ce = active_cache[pos];
249                 if (pathspec_match(pathspec, NULL, ce->name, 0)) {
250                         if (!ce_stage(ce))
251                                 continue;
252                         if (opts->force) {
253                                 warning("path '%s' is unmerged", ce->name);
254                         } else if (stage) {
255                                 errs |= check_stage(stage, ce, pos);
256                         } else if (opts->merge) {
257                                 errs |= check_all_stages(ce, pos);
258                         } else {
259                                 errs = 1;
260                                 error("path '%s' is unmerged", ce->name);
261                         }
262                         pos = skip_same_name(ce, pos) - 1;
263                 }
264         }
265         if (errs)
266                 return 1;
268         /* Now we are committed to check them out */
269         memset(&state, 0, sizeof(state));
270         state.force = 1;
271         state.refresh_cache = 1;
272         for (pos = 0; pos < active_nr; pos++) {
273                 struct cache_entry *ce = active_cache[pos];
274                 if (pathspec_match(pathspec, NULL, ce->name, 0)) {
275                         if (!ce_stage(ce)) {
276                                 errs |= checkout_entry(ce, &state, NULL);
277                                 continue;
278                         }
279                         if (stage)
280                                 errs |= checkout_stage(stage, ce, pos, &state);
281                         else if (merge)
282                                 errs |= checkout_merged(pos, &state);
283                         pos = skip_same_name(ce, pos) - 1;
284                 }
285         }
287         if (write_cache(newfd, active_cache, active_nr) ||
288             commit_locked_index(lock_file))
289                 die("unable to write new index file");
291         resolve_ref("HEAD", rev, 0, &flag);
292         head = lookup_commit_reference_gently(rev, 1);
294         errs |= post_checkout_hook(head, head, 0);
295         return errs;
298 static void show_local_changes(struct object *head)
300         struct rev_info rev;
301         /* I think we want full paths, even if we're in a subdirectory. */
302         init_revisions(&rev, NULL);
303         rev.abbrev = 0;
304         rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
305         add_pending_object(&rev, head, NULL);
306         run_diff_index(&rev, 0);
309 static void describe_detached_head(char *msg, struct commit *commit)
311         struct strbuf sb;
312         strbuf_init(&sb, 0);
313         parse_commit(commit);
314         pretty_print_commit(CMIT_FMT_ONELINE, commit, &sb, 0, NULL, NULL, 0, 0);
315         fprintf(stderr, "%s %s... %s\n", msg,
316                 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV), sb.buf);
317         strbuf_release(&sb);
320 static int reset_tree(struct tree *tree, struct checkout_opts *o, int worktree)
322         struct unpack_trees_options opts;
323         struct tree_desc tree_desc;
325         memset(&opts, 0, sizeof(opts));
326         opts.head_idx = -1;
327         opts.update = worktree;
328         opts.skip_unmerged = !worktree;
329         opts.reset = 1;
330         opts.merge = 1;
331         opts.fn = oneway_merge;
332         opts.verbose_update = !o->quiet;
333         opts.src_index = &the_index;
334         opts.dst_index = &the_index;
335         parse_tree(tree);
336         init_tree_desc(&tree_desc, tree->buffer, tree->size);
337         switch (unpack_trees(1, &tree_desc, &opts)) {
338         case -2:
339                 o->writeout_error = 1;
340                 /*
341                  * We return 0 nevertheless, as the index is all right
342                  * and more importantly we have made best efforts to
343                  * update paths in the work tree, and we cannot revert
344                  * them.
345                  */
346         case 0:
347                 return 0;
348         default:
349                 return 128;
350         }
353 struct branch_info {
354         const char *name; /* The short name used */
355         const char *path; /* The full name of a real branch */
356         struct commit *commit; /* The named commit */
357 };
359 static void setup_branch_path(struct branch_info *branch)
361         struct strbuf buf;
362         strbuf_init(&buf, 0);
363         strbuf_addstr(&buf, "refs/heads/");
364         strbuf_addstr(&buf, branch->name);
365         branch->path = strbuf_detach(&buf, NULL);
368 static int merge_working_tree(struct checkout_opts *opts,
369                               struct branch_info *old, struct branch_info *new)
371         int ret;
372         struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
373         int newfd = hold_locked_index(lock_file, 1);
374         read_cache();
376         if (opts->force) {
377                 ret = reset_tree(new->commit->tree, opts, 1);
378                 if (ret)
379                         return ret;
380         } else {
381                 struct tree_desc trees[2];
382                 struct tree *tree;
383                 struct unpack_trees_options topts;
385                 memset(&topts, 0, sizeof(topts));
386                 topts.head_idx = -1;
387                 topts.src_index = &the_index;
388                 topts.dst_index = &the_index;
390                 topts.msgs.not_uptodate_file = "You have local changes to '%s'; cannot switch branches.";
392                 refresh_cache(REFRESH_QUIET);
394                 if (unmerged_cache()) {
395                         error("you need to resolve your current index first");
396                         return 1;
397                 }
399                 /* 2-way merge to the new branch */
400                 topts.update = 1;
401                 topts.merge = 1;
402                 topts.gently = opts->merge;
403                 topts.verbose_update = !opts->quiet;
404                 topts.fn = twoway_merge;
405                 topts.dir = xcalloc(1, sizeof(*topts.dir));
406                 topts.dir->show_ignored = 1;
407                 topts.dir->exclude_per_dir = ".gitignore";
408                 tree = parse_tree_indirect(old->commit->object.sha1);
409                 init_tree_desc(&trees[0], tree->buffer, tree->size);
410                 tree = parse_tree_indirect(new->commit->object.sha1);
411                 init_tree_desc(&trees[1], tree->buffer, tree->size);
413                 ret = unpack_trees(2, trees, &topts);
414                 if (ret == -1) {
415                         /*
416                          * Unpack couldn't do a trivial merge; either
417                          * give up or do a real merge, depending on
418                          * whether the merge flag was used.
419                          */
420                         struct tree *result;
421                         struct tree *work;
422                         if (!opts->merge)
423                                 return 1;
424                         parse_commit(old->commit);
426                         /* Do more real merge */
428                         /*
429                          * We update the index fully, then write the
430                          * tree from the index, then merge the new
431                          * branch with the current tree, with the old
432                          * branch as the base. Then we reset the index
433                          * (but not the working tree) to the new
434                          * branch, leaving the working tree as the
435                          * merged version, but skipping unmerged
436                          * entries in the index.
437                          */
439                         add_files_to_cache(NULL, NULL, 0);
440                         work = write_tree_from_memory();
442                         ret = reset_tree(new->commit->tree, opts, 1);
443                         if (ret)
444                                 return ret;
445                         merge_trees(new->commit->tree, work, old->commit->tree,
446                                     new->name, "local", &result);
447                         ret = reset_tree(new->commit->tree, opts, 0);
448                         if (ret)
449                                 return ret;
450                 }
451         }
453         if (write_cache(newfd, active_cache, active_nr) ||
454             commit_locked_index(lock_file))
455                 die("unable to write new index file");
457         if (!opts->force)
458                 show_local_changes(&new->commit->object);
460         return 0;
463 static void report_tracking(struct branch_info *new)
465         struct strbuf sb = STRBUF_INIT;
466         struct branch *branch = branch_get(new->name);
468         if (!format_tracking_info(branch, &sb))
469                 return;
470         fputs(sb.buf, stdout);
471         strbuf_release(&sb);
474 static void update_refs_for_switch(struct checkout_opts *opts,
475                                    struct branch_info *old,
476                                    struct branch_info *new)
478         struct strbuf msg;
479         const char *old_desc;
480         if (opts->new_branch) {
481                 create_branch(old->name, opts->new_branch, new->name, 0,
482                               opts->new_branch_log, opts->track);
483                 new->name = opts->new_branch;
484                 setup_branch_path(new);
485         }
487         strbuf_init(&msg, 0);
488         old_desc = old->name;
489         if (!old_desc)
490                 old_desc = sha1_to_hex(old->commit->object.sha1);
491         strbuf_addf(&msg, "checkout: moving from %s to %s",
492                     old_desc, new->name);
494         if (new->path) {
495                 create_symref("HEAD", new->path, msg.buf);
496                 if (!opts->quiet) {
497                         if (old->path && !strcmp(new->path, old->path))
498                                 fprintf(stderr, "Already on \"%s\"\n",
499                                         new->name);
500                         else
501                                 fprintf(stderr, "Switched to%s branch \"%s\"\n",
502                                         opts->new_branch ? " a new" : "",
503                                         new->name);
504                 }
505         } else if (strcmp(new->name, "HEAD")) {
506                 update_ref(msg.buf, "HEAD", new->commit->object.sha1, NULL,
507                            REF_NODEREF, DIE_ON_ERR);
508                 if (!opts->quiet) {
509                         if (old->path)
510                                 fprintf(stderr, "Note: moving to \"%s\" which isn't a local branch\nIf you want to create a new branch from this checkout, you may do so\n(now or later) by using -b with the checkout command again. Example:\n  git checkout -b <new_branch_name>\n", new->name);
511                         describe_detached_head("HEAD is now at", new->commit);
512                 }
513         }
514         remove_branch_state();
515         strbuf_release(&msg);
516         if (!opts->quiet && (new->path || !strcmp(new->name, "HEAD")))
517                 report_tracking(new);
520 static int switch_branches(struct checkout_opts *opts, struct branch_info *new)
522         int ret = 0;
523         struct branch_info old;
524         unsigned char rev[20];
525         int flag;
526         memset(&old, 0, sizeof(old));
527         old.path = resolve_ref("HEAD", rev, 0, &flag);
528         old.commit = lookup_commit_reference_gently(rev, 1);
529         if (!(flag & REF_ISSYMREF))
530                 old.path = NULL;
532         if (old.path && !prefixcmp(old.path, "refs/heads/"))
533                 old.name = old.path + strlen("refs/heads/");
535         if (!new->name) {
536                 new->name = "HEAD";
537                 new->commit = old.commit;
538                 if (!new->commit)
539                         die("You are on a branch yet to be born");
540                 parse_commit(new->commit);
541         }
543         /*
544          * If the new thing isn't a branch and isn't HEAD and we're
545          * not starting a new branch, and we want messages, and we
546          * weren't on a branch, and we're moving to a new commit,
547          * describe the old commit.
548          */
549         if (!new->path && strcmp(new->name, "HEAD") && !opts->new_branch &&
550             !opts->quiet && !old.path && new->commit != old.commit)
551                 describe_detached_head("Previous HEAD position was", old.commit);
553         if (!old.commit) {
554                 if (!opts->quiet) {
555                         fprintf(stderr, "warning: You appear to be on a branch yet to be born.\n");
556                         fprintf(stderr, "warning: Forcing checkout of %s.\n", new->name);
557                 }
558                 opts->force = 1;
559         }
561         ret = merge_working_tree(opts, &old, new);
562         if (ret)
563                 return ret;
565         update_refs_for_switch(opts, &old, new);
567         ret = post_checkout_hook(old.commit, new->commit, 1);
568         return ret || opts->writeout_error;
571 static int git_checkout_config(const char *var, const char *value, void *cb)
573         return git_xmerge_config(var, value, cb);
576 int cmd_checkout(int argc, const char **argv, const char *prefix)
578         struct checkout_opts opts;
579         unsigned char rev[20];
580         const char *arg;
581         struct branch_info new;
582         struct tree *source_tree = NULL;
583         char *conflict_style = NULL;
584         struct option options[] = {
585                 OPT__QUIET(&opts.quiet),
586                 OPT_STRING('b', NULL, &opts.new_branch, "new branch", "branch"),
587                 OPT_BOOLEAN('l', NULL, &opts.new_branch_log, "log for new branch"),
588                 OPT_SET_INT('t', "track",  &opts.track, "track",
589                         BRANCH_TRACK_EXPLICIT),
590                 OPT_SET_INT('2', "ours", &opts.writeout_stage, "stage",
591                             2),
592                 OPT_SET_INT('3', "theirs", &opts.writeout_stage, "stage",
593                             3),
594                 OPT_BOOLEAN('f', NULL, &opts.force, "force"),
595                 OPT_BOOLEAN('m', "merge", &opts.merge, "merge"),
596                 OPT_STRING(0, "conflict", &conflict_style, "style",
597                            "conflict style (merge or diff3)"),
598                 OPT_END(),
599         };
600         int has_dash_dash;
602         memset(&opts, 0, sizeof(opts));
603         memset(&new, 0, sizeof(new));
605         git_config(git_checkout_config, NULL);
607         opts.track = git_branch_track;
609         argc = parse_options(argc, argv, options, checkout_usage,
610                              PARSE_OPT_KEEP_DASHDASH);
612         if (conflict_style) {
613                 opts.merge = 1; /* implied */
614                 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
615         }
617         if (!opts.new_branch && (opts.track != git_branch_track))
618                 die("git checkout: --track and --no-track require -b");
620         if (opts.force && opts.merge)
621                 die("git checkout: -f and -m are incompatible");
623         /*
624          * case 1: git checkout <ref> -- [<paths>]
625          *
626          *   <ref> must be a valid tree, everything after the '--' must be
627          *   a path.
628          *
629          * case 2: git checkout -- [<paths>]
630          *
631          *   everything after the '--' must be paths.
632          *
633          * case 3: git checkout <something> [<paths>]
634          *
635          *   With no paths, if <something> is a commit, that is to
636          *   switch to the branch or detach HEAD at it.
637          *
638          *   Otherwise <something> shall not be ambiguous.
639          *   - If it's *only* a reference, treat it like case (1).
640          *   - If it's only a path, treat it like case (2).
641          *   - else: fail.
642          *
643          */
644         if (argc) {
645                 if (!strcmp(argv[0], "--")) {       /* case (2) */
646                         argv++;
647                         argc--;
648                         goto no_reference;
649                 }
651                 arg = argv[0];
652                 has_dash_dash = (argc > 1) && !strcmp(argv[1], "--");
654                 if (get_sha1(arg, rev)) {
655                         if (has_dash_dash)          /* case (1) */
656                                 die("invalid reference: %s", arg);
657                         goto no_reference;          /* case (3 -> 2) */
658                 }
660                 /* we can't end up being in (2) anymore, eat the argument */
661                 argv++;
662                 argc--;
664                 if ((new.commit = lookup_commit_reference_gently(rev, 1))) {
665                         new.name = arg;
666                         setup_branch_path(&new);
667                         if (resolve_ref(new.path, rev, 1, NULL))
668                                 new.commit = lookup_commit_reference(rev);
669                         else
670                                 new.path = NULL;
671                         parse_commit(new.commit);
672                         source_tree = new.commit->tree;
673                 } else
674                         source_tree = parse_tree_indirect(rev);
676                 if (!source_tree)                   /* case (1): want a tree */
677                         die("reference is not a tree: %s", arg);
678                 if (!has_dash_dash) {/* case (3 -> 1) */
679                         /*
680                          * Do not complain the most common case
681                          *      git checkout branch
682                          * even if there happen to be a file called 'branch';
683                          * it would be extremely annoying.
684                          */
685                         if (argc)
686                                 verify_non_filename(NULL, arg);
687                 }
688                 else {
689                         argv++;
690                         argc--;
691                 }
692         }
694 no_reference:
695         if (argc) {
696                 const char **pathspec = get_pathspec(prefix, argv);
698                 if (!pathspec)
699                         die("invalid path specification");
701                 /* Checkout paths */
702                 if (opts.new_branch) {
703                         if (argc == 1) {
704                                 die("git checkout: updating paths is incompatible with switching branches.\nDid you intend to checkout '%s' which can not be resolved as commit?", argv[0]);
705                         } else {
706                                 die("git checkout: updating paths is incompatible with switching branches.");
707                         }
708                 }
710                 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
711                         die("git checkout: --ours/--theirs, --force and --merge are incompatible when\nchecking out of the index.");
713                 return checkout_paths(source_tree, pathspec, &opts);
714         }
716         if (new.name && !new.commit) {
717                 die("Cannot switch branch to a non-commit.");
718         }
719         if (opts.writeout_stage)
720                 die("--ours/--theirs is incompatible with switching branches.");
722         return switch_branches(&opts, &new);