3 #include "parse-options.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
11 #include "run-command.h"
12 #include "merge-recursive.h"
18 #include "xdiff-interface.h"
20 #include "resolve-undo.h"
22 static const char * const checkout_usage[] = {
23 "git checkout [options] <branch>",
24 "git checkout [options] [<branch>] -- <file>...",
28 struct checkout_opts {
35 const char *new_branch;
37 enum branch_track track;
40 static int post_checkout_hook(struct commit *old, struct commit *new,
43 return run_hook(NULL, "post-checkout",
44 sha1_to_hex(old ? old->object.sha1 : null_sha1),
45 sha1_to_hex(new ? new->object.sha1 : null_sha1),
46 changed ? "1" : "0", NULL);
47 /* "new" can be NULL when checking out from the index before
52 static int update_some(const unsigned char *sha1, const char *base, int baselen,
53 const char *pathname, unsigned mode, int stage, void *context)
56 struct cache_entry *ce;
59 return READ_TREE_RECURSIVE;
61 len = baselen + strlen(pathname);
62 ce = xcalloc(1, cache_entry_size(len));
63 hashcpy(ce->sha1, sha1);
64 memcpy(ce->name, base, baselen);
65 memcpy(ce->name + baselen, pathname, len - baselen);
66 ce->ce_flags = create_ce_flags(len, 0);
67 ce->ce_mode = create_ce_mode(mode);
68 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
72 static int read_tree_some(struct tree *tree, const char **pathspec)
74 read_tree_recursive(tree, "", 0, 0, pathspec, update_some, NULL);
76 /* update the index with the given tree's info
77 * for all args, expanding wildcards, and exit
78 * with any non-zero return code.
83 static int skip_same_name(struct cache_entry *ce, int pos)
85 while (++pos < active_nr &&
86 !strcmp(active_cache[pos]->name, ce->name))
91 static int check_stage(int stage, struct cache_entry *ce, int pos)
93 while (pos < active_nr &&
94 !strcmp(active_cache[pos]->name, ce->name)) {
95 if (ce_stage(active_cache[pos]) == stage)
99 return error("path '%s' does not have %s version",
101 (stage == 2) ? "our" : "their");
104 static int check_all_stages(struct cache_entry *ce, int pos)
106 if (ce_stage(ce) != 1 ||
107 active_nr <= pos + 2 ||
108 strcmp(active_cache[pos+1]->name, ce->name) ||
109 ce_stage(active_cache[pos+1]) != 2 ||
110 strcmp(active_cache[pos+2]->name, ce->name) ||
111 ce_stage(active_cache[pos+2]) != 3)
112 return error("path '%s' does not have all three versions",
117 static int checkout_stage(int stage, struct cache_entry *ce, int pos,
118 struct checkout *state)
120 while (pos < active_nr &&
121 !strcmp(active_cache[pos]->name, ce->name)) {
122 if (ce_stage(active_cache[pos]) == stage)
123 return checkout_entry(active_cache[pos], state, NULL);
126 return error("path '%s' does not have %s version",
128 (stage == 2) ? "our" : "their");
131 /* NEEDSWORK: share with merge-recursive */
132 static void fill_mm(const unsigned char *sha1, mmfile_t *mm)
135 enum object_type type;
137 if (!hashcmp(sha1, null_sha1)) {
138 mm->ptr = xstrdup("");
143 mm->ptr = read_sha1_file(sha1, &type, &size);
144 if (!mm->ptr || type != OBJ_BLOB)
145 die("unable to read blob object %s", sha1_to_hex(sha1));
149 static int checkout_merged(int pos, struct checkout *state)
151 struct cache_entry *ce = active_cache[pos];
152 const char *path = ce->name;
153 mmfile_t ancestor, ours, theirs;
155 unsigned char sha1[20];
156 mmbuffer_t result_buf;
158 if (ce_stage(ce) != 1 ||
159 active_nr <= pos + 2 ||
160 strcmp(active_cache[pos+1]->name, path) ||
161 ce_stage(active_cache[pos+1]) != 2 ||
162 strcmp(active_cache[pos+2]->name, path) ||
163 ce_stage(active_cache[pos+2]) != 3)
164 return error("path '%s' does not have all 3 versions", path);
166 fill_mm(active_cache[pos]->sha1, &ancestor);
167 fill_mm(active_cache[pos+1]->sha1, &ours);
168 fill_mm(active_cache[pos+2]->sha1, &theirs);
170 status = ll_merge(&result_buf, path, &ancestor,
171 &ours, "ours", &theirs, "theirs", 1);
175 if (status < 0 || !result_buf.ptr) {
176 free(result_buf.ptr);
177 return error("path '%s': cannot merge", path);
182 * There is absolutely no reason to write this as a blob object
183 * and create a phony cache entry just to leak. This hack is
184 * primarily to get to the write_entry() machinery that massages
185 * the contents to work-tree format and writes out which only
186 * allows it for a cache entry. The code in write_entry() needs
187 * to be refactored to allow us to feed a <buffer, size, mode>
188 * instead of a cache entry. Such a refactoring would help
189 * merge_recursive as well (it also writes the merge result to the
190 * object database even when it may contain conflicts).
192 if (write_sha1_file(result_buf.ptr, result_buf.size,
194 die("Unable to add merge result for '%s'", path);
195 ce = make_cache_entry(create_ce_mode(active_cache[pos+1]->ce_mode),
199 die("make_cache_entry failed for path '%s'", path);
200 status = checkout_entry(ce, state, NULL);
204 static int checkout_paths(struct tree *source_tree, const char **pathspec,
205 struct checkout_opts *opts)
208 struct checkout state;
209 static char *ps_matched;
210 unsigned char rev[20];
214 int stage = opts->writeout_stage;
215 int merge = opts->merge;
217 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
219 newfd = hold_locked_index(lock_file, 1);
220 if (read_cache_preload(pathspec) < 0)
221 return error("corrupt index file");
224 read_tree_some(source_tree, pathspec);
226 for (pos = 0; pathspec[pos]; pos++)
228 ps_matched = xcalloc(1, pos);
230 for (pos = 0; pos < active_nr; pos++) {
231 struct cache_entry *ce = active_cache[pos];
232 match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, ps_matched);
235 if (report_path_error(ps_matched, pathspec, 0))
238 /* Any unmerged paths? */
239 for (pos = 0; pos < active_nr; pos++) {
240 struct cache_entry *ce = active_cache[pos];
241 if (match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, NULL)) {
245 warning("path '%s' is unmerged", ce->name);
247 errs |= check_stage(stage, ce, pos);
248 } else if (opts->merge) {
249 errs |= check_all_stages(ce, pos);
252 error("path '%s' is unmerged", ce->name);
254 pos = skip_same_name(ce, pos) - 1;
260 /* Now we are committed to check them out */
261 memset(&state, 0, sizeof(state));
263 state.refresh_cache = 1;
264 for (pos = 0; pos < active_nr; pos++) {
265 struct cache_entry *ce = active_cache[pos];
266 if (match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, NULL)) {
268 errs |= checkout_entry(ce, &state, NULL);
272 errs |= checkout_stage(stage, ce, pos, &state);
274 errs |= checkout_merged(pos, &state);
275 pos = skip_same_name(ce, pos) - 1;
279 if (write_cache(newfd, active_cache, active_nr) ||
280 commit_locked_index(lock_file))
281 die("unable to write new index file");
283 resolve_ref("HEAD", rev, 0, &flag);
284 head = lookup_commit_reference_gently(rev, 1);
286 errs |= post_checkout_hook(head, head, 0);
290 static void show_local_changes(struct object *head)
293 /* I think we want full paths, even if we're in a subdirectory. */
294 init_revisions(&rev, NULL);
296 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
297 if (diff_setup_done(&rev.diffopt) < 0)
298 die("diff_setup_done failed");
299 add_pending_object(&rev, head, NULL);
300 run_diff_index(&rev, 0);
303 static void describe_detached_head(char *msg, struct commit *commit)
305 struct strbuf sb = STRBUF_INIT;
306 struct pretty_print_context ctx = {0};
307 parse_commit(commit);
308 pretty_print_commit(CMIT_FMT_ONELINE, commit, &sb, &ctx);
309 fprintf(stderr, "%s %s... %s\n", msg,
310 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV), sb.buf);
314 static int reset_tree(struct tree *tree, struct checkout_opts *o, int worktree)
316 struct unpack_trees_options opts;
317 struct tree_desc tree_desc;
319 memset(&opts, 0, sizeof(opts));
321 opts.update = worktree;
322 opts.skip_unmerged = !worktree;
325 opts.fn = oneway_merge;
326 opts.verbose_update = !o->quiet;
327 opts.src_index = &the_index;
328 opts.dst_index = &the_index;
330 init_tree_desc(&tree_desc, tree->buffer, tree->size);
331 switch (unpack_trees(1, &tree_desc, &opts)) {
333 o->writeout_error = 1;
335 * We return 0 nevertheless, as the index is all right
336 * and more importantly we have made best efforts to
337 * update paths in the work tree, and we cannot revert
348 const char *name; /* The short name used */
349 const char *path; /* The full name of a real branch */
350 struct commit *commit; /* The named commit */
353 static void setup_branch_path(struct branch_info *branch)
355 struct strbuf buf = STRBUF_INIT;
357 strbuf_branchname(&buf, branch->name);
358 if (strcmp(buf.buf, branch->name))
359 branch->name = xstrdup(buf.buf);
360 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
361 branch->path = strbuf_detach(&buf, NULL);
364 static int merge_working_tree(struct checkout_opts *opts,
365 struct branch_info *old, struct branch_info *new)
368 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
369 int newfd = hold_locked_index(lock_file, 1);
371 if (read_cache_preload(NULL) < 0)
372 return error("corrupt index file");
374 resolve_undo_clear();
376 ret = reset_tree(new->commit->tree, opts, 1);
380 struct tree_desc trees[2];
382 struct unpack_trees_options topts;
384 memset(&topts, 0, sizeof(topts));
386 topts.src_index = &the_index;
387 topts.dst_index = &the_index;
389 topts.msgs.not_uptodate_file = "You have local changes to '%s'; cannot switch branches.";
391 refresh_cache(REFRESH_QUIET);
393 if (unmerged_cache()) {
394 error("you need to resolve your current index first");
398 /* 2-way merge to the new branch */
399 topts.initial_checkout = is_cache_unborn();
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->flags |= DIR_SHOW_IGNORED;
407 topts.dir->exclude_per_dir = ".gitignore";
408 tree = parse_tree_indirect(old->commit ?
409 old->commit->object.sha1 :
410 (unsigned char *)EMPTY_TREE_SHA1_BIN);
411 init_tree_desc(&trees[0], tree->buffer, tree->size);
412 tree = parse_tree_indirect(new->commit->object.sha1);
413 init_tree_desc(&trees[1], tree->buffer, tree->size);
415 ret = unpack_trees(2, trees, &topts);
418 * Unpack couldn't do a trivial merge; either
419 * give up or do a real merge, depending on
420 * whether the merge flag was used.
424 struct merge_options o;
427 parse_commit(old->commit);
429 /* Do more real merge */
432 * We update the index fully, then write the
433 * tree from the index, then merge the new
434 * branch with the current tree, with the old
435 * branch as the base. Then we reset the index
436 * (but not the working tree) to the new
437 * branch, leaving the working tree as the
438 * merged version, but skipping unmerged
439 * entries in the index.
442 add_files_to_cache(NULL, NULL, 0);
443 init_merge_options(&o);
445 work = write_tree_from_memory(&o);
447 ret = reset_tree(new->commit->tree, opts, 1);
450 o.branch1 = new->name;
452 merge_trees(&o, new->commit->tree, work,
453 old->commit->tree, &result);
454 ret = reset_tree(new->commit->tree, opts, 0);
460 if (write_cache(newfd, active_cache, active_nr) ||
461 commit_locked_index(lock_file))
462 die("unable to write new index file");
464 if (!opts->force && !opts->quiet)
465 show_local_changes(&new->commit->object);
470 static void report_tracking(struct branch_info *new)
472 struct strbuf sb = STRBUF_INIT;
473 struct branch *branch = branch_get(new->name);
475 if (!format_tracking_info(branch, &sb))
477 fputs(sb.buf, stdout);
481 static void update_refs_for_switch(struct checkout_opts *opts,
482 struct branch_info *old,
483 struct branch_info *new)
485 struct strbuf msg = STRBUF_INIT;
486 const char *old_desc;
487 if (opts->new_branch) {
488 create_branch(old->name, opts->new_branch, new->name, 0,
489 opts->new_branch_log, opts->track);
490 new->name = opts->new_branch;
491 setup_branch_path(new);
494 old_desc = old->name;
495 if (!old_desc && old->commit)
496 old_desc = sha1_to_hex(old->commit->object.sha1);
497 strbuf_addf(&msg, "checkout: moving from %s to %s",
498 old_desc ? old_desc : "(invalid)", new->name);
501 create_symref("HEAD", new->path, msg.buf);
503 if (old->path && !strcmp(new->path, old->path))
504 fprintf(stderr, "Already on '%s'\n",
507 fprintf(stderr, "Switched to%s branch '%s'\n",
508 opts->new_branch ? " a new" : "",
511 } else if (strcmp(new->name, "HEAD")) {
512 update_ref(msg.buf, "HEAD", new->commit->object.sha1, NULL,
513 REF_NODEREF, DIE_ON_ERR);
516 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);
517 describe_detached_head("HEAD is now at", new->commit);
520 remove_branch_state();
521 strbuf_release(&msg);
522 if (!opts->quiet && (new->path || !strcmp(new->name, "HEAD")))
523 report_tracking(new);
526 static int switch_branches(struct checkout_opts *opts, struct branch_info *new)
529 struct branch_info old;
530 unsigned char rev[20];
532 memset(&old, 0, sizeof(old));
533 old.path = resolve_ref("HEAD", rev, 0, &flag);
534 old.commit = lookup_commit_reference_gently(rev, 1);
535 if (!(flag & REF_ISSYMREF))
538 if (old.path && !prefixcmp(old.path, "refs/heads/"))
539 old.name = old.path + strlen("refs/heads/");
543 new->commit = old.commit;
545 die("You are on a branch yet to be born");
546 parse_commit(new->commit);
549 ret = merge_working_tree(opts, &old, new);
554 * If we were on a detached HEAD, but have now moved to
555 * a new commit, we want to mention the old commit once more
556 * to remind the user that it might be lost.
558 if (!opts->quiet && !old.path && old.commit && new->commit != old.commit)
559 describe_detached_head("Previous HEAD position was", old.commit);
561 update_refs_for_switch(opts, &old, new);
563 ret = post_checkout_hook(old.commit, new->commit, 1);
564 return ret || opts->writeout_error;
567 static int git_checkout_config(const char *var, const char *value, void *cb)
569 return git_xmerge_config(var, value, cb);
572 static int interactive_checkout(const char *revision, const char **pathspec,
573 struct checkout_opts *opts)
575 return run_add_interactive(revision, "--patch=checkout", pathspec);
578 struct tracking_name_data {
584 static int check_tracking_name(const char *refname, const unsigned char *sha1,
585 int flags, void *cb_data)
587 struct tracking_name_data *cb = cb_data;
590 if (prefixcmp(refname, "refs/remotes/"))
592 slash = strchr(refname + 13, '/');
593 if (!slash || strcmp(slash + 1, cb->name))
599 cb->remote = xstrdup(refname);
603 static const char *unique_tracking_name(const char *name)
605 struct tracking_name_data cb_data = { name, NULL, 1 };
606 for_each_ref(check_tracking_name, &cb_data);
608 return cb_data.remote;
609 free(cb_data.remote);
613 int cmd_checkout(int argc, const char **argv, const char *prefix)
615 struct checkout_opts opts;
616 unsigned char rev[20];
618 struct branch_info new;
619 struct tree *source_tree = NULL;
620 char *conflict_style = NULL;
622 int dwim_new_local_branch = 1;
623 struct option options[] = {
624 OPT__QUIET(&opts.quiet),
625 OPT_STRING('b', NULL, &opts.new_branch, "new branch", "branch"),
626 OPT_BOOLEAN('l', NULL, &opts.new_branch_log, "log for new branch"),
627 OPT_SET_INT('t', "track", &opts.track, "track",
628 BRANCH_TRACK_EXPLICIT),
629 OPT_SET_INT('2', "ours", &opts.writeout_stage, "stage",
631 OPT_SET_INT('3', "theirs", &opts.writeout_stage, "stage",
633 OPT_BOOLEAN('f', "force", &opts.force, "force"),
634 OPT_BOOLEAN('m', "merge", &opts.merge, "merge"),
635 OPT_STRING(0, "conflict", &conflict_style, "style",
636 "conflict style (merge or diff3)"),
637 OPT_BOOLEAN('p', "patch", &patch_mode, "select hunks interactively"),
638 { OPTION_BOOLEAN, 0, "guess", &dwim_new_local_branch, NULL,
639 "second guess 'git checkout no-such-branch'",
640 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
645 memset(&opts, 0, sizeof(opts));
646 memset(&new, 0, sizeof(new));
648 git_config(git_checkout_config, NULL);
650 opts.track = BRANCH_TRACK_UNSPECIFIED;
652 argc = parse_options(argc, argv, prefix, options, checkout_usage,
653 PARSE_OPT_KEEP_DASHDASH);
655 if (patch_mode && (opts.track > 0 || opts.new_branch
656 || opts.new_branch_log || opts.merge || opts.force))
657 die ("--patch is incompatible with all other options");
659 /* --track without -b should DWIM */
660 if (0 < opts.track && !opts.new_branch) {
661 const char *argv0 = argv[0];
662 if (!argc || !strcmp(argv0, "--"))
663 die ("--track needs a branch name");
664 if (!prefixcmp(argv0, "refs/"))
666 if (!prefixcmp(argv0, "remotes/"))
668 argv0 = strchr(argv0, '/');
669 if (!argv0 || !argv0[1])
670 die ("Missing branch name; try -b");
671 opts.new_branch = argv0 + 1;
674 if (conflict_style) {
675 opts.merge = 1; /* implied */
676 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
679 if (opts.force && opts.merge)
680 die("git checkout: -f and -m are incompatible");
683 * case 1: git checkout <ref> -- [<paths>]
685 * <ref> must be a valid tree, everything after the '--' must be
688 * case 2: git checkout -- [<paths>]
690 * everything after the '--' must be paths.
692 * case 3: git checkout <something> [<paths>]
694 * With no paths, if <something> is a commit, that is to
695 * switch to the branch or detach HEAD at it.
697 * With no paths, if <something> is _not_ a commit, no -t nor -b
698 * was given, and there is a tracking branch whose name is
699 * <something> in one and only one remote, then this is a short-hand
700 * to fork local <something> from that remote tracking branch.
702 * Otherwise <something> shall not be ambiguous.
703 * - If it's *only* a reference, treat it like case (1).
704 * - If it's only a path, treat it like case (2).
709 if (!strcmp(argv[0], "--")) { /* case (2) */
716 has_dash_dash = (argc > 1) && !strcmp(argv[1], "--");
718 if (!strcmp(arg, "-"))
721 if (get_sha1(arg, rev)) {
722 if (has_dash_dash) /* case (1) */
723 die("invalid reference: %s", arg);
725 dwim_new_local_branch &&
726 opts.track == BRANCH_TRACK_UNSPECIFIED &&
728 !check_filename(NULL, arg) &&
730 const char *remote = unique_tracking_name(arg);
731 if (!remote || get_sha1(remote, rev))
733 opts.new_branch = arg;
735 /* DWIMmed to create local branch */
741 /* we can't end up being in (2) anymore, eat the argument */
746 if ((new.commit = lookup_commit_reference_gently(rev, 1))) {
747 setup_branch_path(&new);
748 if (resolve_ref(new.path, rev, 1, NULL))
749 new.commit = lookup_commit_reference(rev);
752 parse_commit(new.commit);
753 source_tree = new.commit->tree;
755 source_tree = parse_tree_indirect(rev);
757 if (!source_tree) /* case (1): want a tree */
758 die("reference is not a tree: %s", arg);
759 if (!has_dash_dash) {/* case (3 -> 1) */
761 * Do not complain the most common case
762 * git checkout branch
763 * even if there happen to be a file called 'branch';
764 * it would be extremely annoying.
767 verify_non_filename(NULL, arg);
777 if (opts.track == BRANCH_TRACK_UNSPECIFIED)
778 opts.track = git_branch_track;
781 const char **pathspec = get_pathspec(prefix, argv);
784 die("invalid path specification");
787 return interactive_checkout(new.name, pathspec, &opts);
790 if (opts.new_branch) {
792 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]);
794 die("git checkout: updating paths is incompatible with switching branches.");
798 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
799 die("git checkout: --ours/--theirs, --force and --merge are incompatible when\nchecking out of the index.");
801 return checkout_paths(source_tree, pathspec, &opts);
805 return interactive_checkout(new.name, NULL, &opts);
807 if (opts.new_branch) {
808 struct strbuf buf = STRBUF_INIT;
809 if (strbuf_check_branch_ref(&buf, opts.new_branch))
810 die("git checkout: we do not like '%s' as a branch name.",
812 if (!get_sha1(buf.buf, rev))
813 die("git checkout: branch %s already exists", opts.new_branch);
814 strbuf_release(&buf);
817 if (new.name && !new.commit) {
818 die("Cannot switch branch to a non-commit.");
820 if (opts.writeout_stage)
821 die("--ours/--theirs is incompatible with switching branches.");
823 return switch_branches(&opts, &new);