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"
21 #include "submodule-config.h"
22 #include "submodule.h"
24 static int recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
26 static const char * const checkout_usage[] = {
27 N_("git checkout [<options>] <branch>"),
28 N_("git checkout [<options>] [<branch>] -- <file>..."),
32 static int option_parse_recurse_submodules(const struct option *opt,
33 const char *arg, int unset)
36 recurse_submodules = RECURSE_SUBMODULES_OFF;
41 parse_update_recurse_submodules_arg(opt->long_name,
44 recurse_submodules = RECURSE_SUBMODULES_ON;
49 struct checkout_opts {
57 int ignore_skipworktree;
58 int ignore_other_worktrees;
61 const char *new_branch;
62 const char *new_branch_force;
63 const char *new_orphan_branch;
65 enum branch_track track;
66 struct diff_options diff_options;
70 struct pathspec pathspec;
71 struct tree *source_tree;
74 static int post_checkout_hook(struct commit *old, struct commit *new,
77 return run_hook_le(NULL, "post-checkout",
78 oid_to_hex(old ? &old->object.oid : &null_oid),
79 oid_to_hex(new ? &new->object.oid : &null_oid),
80 changed ? "1" : "0", NULL);
81 /* "new" can be NULL when checking out from the index before
86 static int update_some(const unsigned char *sha1, struct strbuf *base,
87 const char *pathname, unsigned mode, int stage, void *context)
90 struct cache_entry *ce;
94 return READ_TREE_RECURSIVE;
96 len = base->len + strlen(pathname);
97 ce = xcalloc(1, cache_entry_size(len));
98 hashcpy(ce->oid.hash, sha1);
99 memcpy(ce->name, base->buf, base->len);
100 memcpy(ce->name + base->len, pathname, len - base->len);
101 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
102 ce->ce_namelen = len;
103 ce->ce_mode = create_ce_mode(mode);
106 * If the entry is the same as the current index, we can leave the old
107 * entry in place. Whether it is UPTODATE or not, checkout_entry will
108 * do the right thing.
110 pos = cache_name_pos(ce->name, ce->ce_namelen);
112 struct cache_entry *old = active_cache[pos];
113 if (ce->ce_mode == old->ce_mode &&
114 !oidcmp(&ce->oid, &old->oid)) {
115 old->ce_flags |= CE_UPDATE;
121 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
125 static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
127 read_tree_recursive(tree, "", 0, 0, pathspec, update_some, NULL);
129 /* update the index with the given tree's info
130 * for all args, expanding wildcards, and exit
131 * with any non-zero return code.
136 static int skip_same_name(const struct cache_entry *ce, int pos)
138 while (++pos < active_nr &&
139 !strcmp(active_cache[pos]->name, ce->name))
144 static int check_stage(int stage, const struct cache_entry *ce, int pos)
146 while (pos < active_nr &&
147 !strcmp(active_cache[pos]->name, ce->name)) {
148 if (ce_stage(active_cache[pos]) == stage)
153 return error(_("path '%s' does not have our version"), ce->name);
155 return error(_("path '%s' does not have their version"), ce->name);
158 static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
161 const char *name = ce->name;
163 while (pos < active_nr) {
164 ce = active_cache[pos];
165 if (strcmp(name, ce->name))
167 seen |= (1 << ce_stage(ce));
170 if ((stages & seen) != stages)
171 return error(_("path '%s' does not have all necessary versions"),
176 static int checkout_stage(int stage, const struct cache_entry *ce, int pos,
177 const struct checkout *state)
179 while (pos < active_nr &&
180 !strcmp(active_cache[pos]->name, ce->name)) {
181 if (ce_stage(active_cache[pos]) == stage)
182 return checkout_entry(active_cache[pos], state, NULL);
186 return error(_("path '%s' does not have our version"), ce->name);
188 return error(_("path '%s' does not have their version"), ce->name);
191 static int checkout_merged(int pos, const struct checkout *state)
193 struct cache_entry *ce = active_cache[pos];
194 const char *path = ce->name;
195 mmfile_t ancestor, ours, theirs;
197 struct object_id oid;
198 mmbuffer_t result_buf;
199 struct object_id threeway[3];
202 memset(threeway, 0, sizeof(threeway));
203 while (pos < active_nr) {
205 stage = ce_stage(ce);
206 if (!stage || strcmp(path, ce->name))
208 oidcpy(&threeway[stage - 1], &ce->oid);
210 mode = create_ce_mode(ce->ce_mode);
212 ce = active_cache[pos];
214 if (is_null_oid(&threeway[1]) || is_null_oid(&threeway[2]))
215 return error(_("path '%s' does not have necessary versions"), path);
217 read_mmblob(&ancestor, &threeway[0]);
218 read_mmblob(&ours, &threeway[1]);
219 read_mmblob(&theirs, &threeway[2]);
222 * NEEDSWORK: re-create conflicts from merges with
223 * merge.renormalize set, too
225 status = ll_merge(&result_buf, path, &ancestor, "base",
226 &ours, "ours", &theirs, "theirs", NULL);
230 if (status < 0 || !result_buf.ptr) {
231 free(result_buf.ptr);
232 return error(_("path '%s': cannot merge"), path);
237 * There is absolutely no reason to write this as a blob object
238 * and create a phony cache entry just to leak. This hack is
239 * primarily to get to the write_entry() machinery that massages
240 * the contents to work-tree format and writes out which only
241 * allows it for a cache entry. The code in write_entry() needs
242 * to be refactored to allow us to feed a <buffer, size, mode>
243 * instead of a cache entry. Such a refactoring would help
244 * merge_recursive as well (it also writes the merge result to the
245 * object database even when it may contain conflicts).
247 if (write_sha1_file(result_buf.ptr, result_buf.size,
248 blob_type, oid.hash))
249 die(_("Unable to add merge result for '%s'"), path);
250 ce = make_cache_entry(mode, oid.hash, path, 2, 0);
252 die(_("make_cache_entry failed for path '%s'"), path);
253 status = checkout_entry(ce, state, NULL);
257 static int checkout_paths(const struct checkout_opts *opts,
258 const char *revision)
261 struct checkout state = CHECKOUT_INIT;
262 static char *ps_matched;
263 struct object_id rev;
266 struct lock_file *lock_file;
268 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
269 die(_("'%s' cannot be used with updating paths"), "--track");
271 if (opts->new_branch_log)
272 die(_("'%s' cannot be used with updating paths"), "-l");
274 if (opts->force && opts->patch_mode)
275 die(_("'%s' cannot be used with updating paths"), "-f");
277 if (opts->force_detach)
278 die(_("'%s' cannot be used with updating paths"), "--detach");
280 if (opts->merge && opts->patch_mode)
281 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
283 if (opts->force && opts->merge)
284 die(_("'%s' cannot be used with %s"), "-f", "-m");
286 if (opts->new_branch)
287 die(_("Cannot update paths and switch to branch '%s' at the same time."),
290 if (opts->patch_mode)
291 return run_add_interactive(revision, "--patch=checkout",
294 lock_file = xcalloc(1, sizeof(struct lock_file));
296 hold_locked_index(lock_file, LOCK_DIE_ON_ERROR);
297 if (read_cache_preload(&opts->pathspec) < 0)
298 return error(_("index file corrupt"));
300 if (opts->source_tree)
301 read_tree_some(opts->source_tree, &opts->pathspec);
303 ps_matched = xcalloc(opts->pathspec.nr, 1);
306 * Make sure all pathspecs participated in locating the paths
309 for (pos = 0; pos < active_nr; pos++) {
310 struct cache_entry *ce = active_cache[pos];
311 ce->ce_flags &= ~CE_MATCHED;
312 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
314 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
316 * "git checkout tree-ish -- path", but this entry
317 * is in the original index; it will not be checked
318 * out to the working tree and it does not matter
319 * if pathspec matched this entry. We will not do
320 * anything to this entry at all.
324 * Either this entry came from the tree-ish we are
325 * checking the paths out of, or we are checking out
328 * If it comes from the tree-ish, we already know it
329 * matches the pathspec and could just stamp
330 * CE_MATCHED to it from update_some(). But we still
331 * need ps_matched and read_tree_recursive (and
332 * eventually tree_entry_interesting) cannot fill
333 * ps_matched yet. Once it can, we can avoid calling
334 * match_pathspec() for _all_ entries when
335 * opts->source_tree != NULL.
337 if (ce_path_match(ce, &opts->pathspec, ps_matched))
338 ce->ce_flags |= CE_MATCHED;
341 if (report_path_error(ps_matched, &opts->pathspec, opts->prefix)) {
347 /* "checkout -m path" to recreate conflicted state */
349 unmerge_marked_index(&the_index);
351 /* Any unmerged paths? */
352 for (pos = 0; pos < active_nr; pos++) {
353 const struct cache_entry *ce = active_cache[pos];
354 if (ce->ce_flags & CE_MATCHED) {
358 warning(_("path '%s' is unmerged"), ce->name);
359 } else if (opts->writeout_stage) {
360 errs |= check_stage(opts->writeout_stage, ce, pos);
361 } else if (opts->merge) {
362 errs |= check_stages((1<<2) | (1<<3), ce, pos);
365 error(_("path '%s' is unmerged"), ce->name);
367 pos = skip_same_name(ce, pos) - 1;
373 /* Now we are committed to check them out */
375 state.refresh_cache = 1;
376 state.istate = &the_index;
377 for (pos = 0; pos < active_nr; pos++) {
378 struct cache_entry *ce = active_cache[pos];
379 if (ce->ce_flags & CE_MATCHED) {
381 errs |= checkout_entry(ce, &state, NULL);
384 if (opts->writeout_stage)
385 errs |= checkout_stage(opts->writeout_stage, ce, pos, &state);
386 else if (opts->merge)
387 errs |= checkout_merged(pos, &state);
388 pos = skip_same_name(ce, pos) - 1;
392 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
393 die(_("unable to write new index file"));
395 read_ref_full("HEAD", 0, rev.hash, NULL);
396 head = lookup_commit_reference_gently(rev.hash, 1);
398 errs |= post_checkout_hook(head, head, 0);
402 static void show_local_changes(struct object *head,
403 const struct diff_options *opts)
406 /* I think we want full paths, even if we're in a subdirectory. */
407 init_revisions(&rev, NULL);
408 rev.diffopt.flags = opts->flags;
409 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
410 diff_setup_done(&rev.diffopt);
411 add_pending_object(&rev, head, NULL);
412 run_diff_index(&rev, 0);
415 static void describe_detached_head(const char *msg, struct commit *commit)
417 struct strbuf sb = STRBUF_INIT;
418 if (!parse_commit(commit))
419 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
420 fprintf(stderr, "%s %s... %s\n", msg,
421 find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV), sb.buf);
425 static int reset_tree(struct tree *tree, const struct checkout_opts *o,
426 int worktree, int *writeout_error)
428 struct unpack_trees_options opts;
429 struct tree_desc tree_desc;
431 memset(&opts, 0, sizeof(opts));
433 opts.update = worktree;
434 opts.skip_unmerged = !worktree;
437 opts.fn = oneway_merge;
438 opts.verbose_update = o->show_progress;
439 opts.src_index = &the_index;
440 opts.dst_index = &the_index;
442 init_tree_desc(&tree_desc, tree->buffer, tree->size);
443 switch (unpack_trees(1, &tree_desc, &opts)) {
447 * We return 0 nevertheless, as the index is all right
448 * and more importantly we have made best efforts to
449 * update paths in the work tree, and we cannot revert
460 const char *name; /* The short name used */
461 const char *path; /* The full name of a real branch */
462 struct commit *commit; /* The named commit */
464 * if not null the branch is detached because it's already
465 * checked out in this checkout
470 static void setup_branch_path(struct branch_info *branch)
472 struct strbuf buf = STRBUF_INIT;
474 strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
475 if (strcmp(buf.buf, branch->name))
476 branch->name = xstrdup(buf.buf);
477 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
478 branch->path = strbuf_detach(&buf, NULL);
481 static int merge_working_tree(const struct checkout_opts *opts,
482 struct branch_info *old,
483 struct branch_info *new,
487 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
489 hold_locked_index(lock_file, LOCK_DIE_ON_ERROR);
490 if (read_cache_preload(NULL) < 0)
491 return error(_("index file corrupt"));
493 resolve_undo_clear();
495 ret = reset_tree(new->commit->tree, opts, 1, writeout_error);
499 struct tree_desc trees[2];
501 struct unpack_trees_options topts;
503 memset(&topts, 0, sizeof(topts));
505 topts.src_index = &the_index;
506 topts.dst_index = &the_index;
508 setup_unpack_trees_porcelain(&topts, "checkout");
510 refresh_cache(REFRESH_QUIET);
512 if (unmerged_cache()) {
513 error(_("you need to resolve your current index first"));
517 /* 2-way merge to the new branch */
518 topts.initial_checkout = is_cache_unborn();
521 topts.gently = opts->merge && old->commit;
522 topts.verbose_update = opts->show_progress;
523 topts.fn = twoway_merge;
524 if (opts->overwrite_ignore) {
525 topts.dir = xcalloc(1, sizeof(*topts.dir));
526 topts.dir->flags |= DIR_SHOW_IGNORED;
527 setup_standard_excludes(topts.dir);
529 tree = parse_tree_indirect(old->commit ?
530 old->commit->object.oid.hash :
531 EMPTY_TREE_SHA1_BIN);
532 init_tree_desc(&trees[0], tree->buffer, tree->size);
533 tree = parse_tree_indirect(new->commit->object.oid.hash);
534 init_tree_desc(&trees[1], tree->buffer, tree->size);
536 ret = unpack_trees(2, trees, &topts);
539 * Unpack couldn't do a trivial merge; either
540 * give up or do a real merge, depending on
541 * whether the merge flag was used.
545 struct merge_options o;
550 * Without old->commit, the below is the same as
551 * the two-tree unpack we already tried and failed.
556 /* Do more real merge */
559 * We update the index fully, then write the
560 * tree from the index, then merge the new
561 * branch with the current tree, with the old
562 * branch as the base. Then we reset the index
563 * (but not the working tree) to the new
564 * branch, leaving the working tree as the
565 * merged version, but skipping unmerged
566 * entries in the index.
569 add_files_to_cache(NULL, NULL, 0);
571 * NEEDSWORK: carrying over local changes
572 * when branches have different end-of-line
573 * normalization (or clean+smudge rules) is
574 * a pain; plumb in an option to set
577 init_merge_options(&o);
579 work = write_tree_from_memory(&o);
581 ret = reset_tree(new->commit->tree, opts, 1,
585 o.ancestor = old->name;
586 o.branch1 = new->name;
588 ret = merge_trees(&o, new->commit->tree, work,
589 old->commit->tree, &result);
592 ret = reset_tree(new->commit->tree, opts, 0,
594 strbuf_release(&o.obuf);
600 if (!active_cache_tree)
601 active_cache_tree = cache_tree();
603 if (!cache_tree_fully_valid(active_cache_tree))
604 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
606 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
607 die(_("unable to write new index file"));
609 if (!opts->force && !opts->quiet)
610 show_local_changes(&new->commit->object, &opts->diff_options);
615 static void report_tracking(struct branch_info *new)
617 struct strbuf sb = STRBUF_INIT;
618 struct branch *branch = branch_get(new->name);
620 if (!format_tracking_info(branch, &sb))
622 fputs(sb.buf, stdout);
626 static void update_refs_for_switch(const struct checkout_opts *opts,
627 struct branch_info *old,
628 struct branch_info *new)
630 struct strbuf msg = STRBUF_INIT;
631 const char *old_desc, *reflog_msg;
632 if (opts->new_branch) {
633 if (opts->new_orphan_branch) {
636 refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
637 if (opts->new_branch_log &&
638 !should_autocreate_reflog(refname)) {
640 struct strbuf err = STRBUF_INIT;
642 ret = safe_create_reflog(refname, 1, &err);
644 fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
645 opts->new_orphan_branch, err.buf);
646 strbuf_release(&err);
650 strbuf_release(&err);
655 create_branch(opts->new_branch, new->name,
656 opts->new_branch_force ? 1 : 0,
657 opts->new_branch_log,
658 opts->new_branch_force ? 1 : 0,
661 new->name = opts->new_branch;
662 setup_branch_path(new);
665 old_desc = old->name;
666 if (!old_desc && old->commit)
667 old_desc = oid_to_hex(&old->commit->object.oid);
669 reflog_msg = getenv("GIT_REFLOG_ACTION");
671 strbuf_addf(&msg, "checkout: moving from %s to %s",
672 old_desc ? old_desc : "(invalid)", new->name);
674 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
676 if (!strcmp(new->name, "HEAD") && !new->path && !opts->force_detach) {
678 } else if (opts->force_detach || !new->path) { /* No longer on any branch. */
679 update_ref(msg.buf, "HEAD", new->commit->object.oid.hash, NULL,
680 REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
683 advice_detached_head && !opts->force_detach)
684 detach_advice(new->name);
685 describe_detached_head(_("HEAD is now at"), new->commit);
687 } else if (new->path) { /* Switch branches. */
688 if (create_symref("HEAD", new->path, msg.buf) < 0)
689 die(_("unable to update HEAD"));
691 if (old->path && !strcmp(new->path, old->path)) {
692 if (opts->new_branch_force)
693 fprintf(stderr, _("Reset branch '%s'\n"),
696 fprintf(stderr, _("Already on '%s'\n"),
698 } else if (opts->new_branch) {
699 if (opts->branch_exists)
700 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new->name);
702 fprintf(stderr, _("Switched to a new branch '%s'\n"), new->name);
704 fprintf(stderr, _("Switched to branch '%s'\n"),
708 if (old->path && old->name) {
709 if (!ref_exists(old->path) && reflog_exists(old->path))
710 delete_reflog(old->path);
713 remove_branch_state();
714 strbuf_release(&msg);
716 (new->path || (!opts->force_detach && !strcmp(new->name, "HEAD"))))
717 report_tracking(new);
720 static int add_pending_uninteresting_ref(const char *refname,
721 const struct object_id *oid,
722 int flags, void *cb_data)
724 add_pending_sha1(cb_data, refname, oid->hash, UNINTERESTING);
728 static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
730 strbuf_addstr(sb, " ");
731 strbuf_add_unique_abbrev(sb, commit->object.oid.hash, DEFAULT_ABBREV);
732 strbuf_addch(sb, ' ');
733 if (!parse_commit(commit))
734 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
735 strbuf_addch(sb, '\n');
738 #define ORPHAN_CUTOFF 4
739 static void suggest_reattach(struct commit *commit, struct rev_info *revs)
741 struct commit *c, *last = NULL;
742 struct strbuf sb = STRBUF_INIT;
744 while ((c = get_revision(revs)) != NULL) {
745 if (lost < ORPHAN_CUTOFF)
746 describe_one_orphan(&sb, c);
750 if (ORPHAN_CUTOFF < lost) {
751 int more = lost - ORPHAN_CUTOFF;
753 describe_one_orphan(&sb, last);
755 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
760 /* The singular version */
761 "Warning: you are leaving %d commit behind, "
763 "any of your branches:\n\n"
765 /* The plural version */
766 "Warning: you are leaving %d commits behind, "
768 "any of your branches:\n\n"
770 /* Give ngettext() the count */
776 if (advice_detached_head)
779 /* The singular version */
780 "If you want to keep it by creating a new branch, "
781 "this may be a good time\nto do so with:\n\n"
782 " git branch <new-branch-name> %s\n\n",
783 /* The plural version */
784 "If you want to keep them by creating a new branch, "
785 "this may be a good time\nto do so with:\n\n"
786 " git branch <new-branch-name> %s\n\n",
787 /* Give ngettext() the count */
789 find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV));
793 * We are about to leave commit that was at the tip of a detached
794 * HEAD. If it is not reachable from any ref, this is the last chance
795 * for the user to do so without resorting to reflog.
797 static void orphaned_commit_warning(struct commit *old, struct commit *new)
799 struct rev_info revs;
800 struct object *object = &old->object;
801 struct object_array refs;
803 init_revisions(&revs, NULL);
804 setup_revisions(0, NULL, &revs, NULL);
806 object->flags &= ~UNINTERESTING;
807 add_pending_object(&revs, object, oid_to_hex(&object->oid));
809 for_each_ref(add_pending_uninteresting_ref, &revs);
810 add_pending_sha1(&revs, "HEAD", new->object.oid.hash, UNINTERESTING);
813 revs.leak_pending = 1;
815 if (prepare_revision_walk(&revs))
816 die(_("internal error in revision walk"));
817 if (!(old->object.flags & UNINTERESTING))
818 suggest_reattach(old, &revs);
820 describe_detached_head(_("Previous HEAD position was"), old);
822 clear_commit_marks_for_object_array(&refs, ALL_REV_FLAGS);
826 static int switch_branches(const struct checkout_opts *opts,
827 struct branch_info *new)
830 struct branch_info old;
832 struct object_id rev;
833 int flag, writeout_error = 0;
834 memset(&old, 0, sizeof(old));
835 old.path = path_to_free = resolve_refdup("HEAD", 0, rev.hash, &flag);
837 old.commit = lookup_commit_reference_gently(rev.hash, 1);
838 if (!(flag & REF_ISSYMREF))
842 skip_prefix(old.path, "refs/heads/", &old.name);
846 new->commit = old.commit;
848 die(_("You are on a branch yet to be born"));
849 parse_commit_or_die(new->commit);
852 ret = merge_working_tree(opts, &old, new, &writeout_error);
858 if (!opts->quiet && !old.path && old.commit && new->commit != old.commit)
859 orphaned_commit_warning(old.commit, new->commit);
861 update_refs_for_switch(opts, &old, new);
863 ret = post_checkout_hook(old.commit, new->commit, 1);
865 return ret || writeout_error;
868 static int git_checkout_config(const char *var, const char *value, void *cb)
870 if (!strcmp(var, "diff.ignoresubmodules")) {
871 struct checkout_opts *opts = cb;
872 handle_ignore_submodules_arg(&opts->diff_options, value);
876 if (starts_with(var, "submodule."))
877 return parse_submodule_config_option(var, value);
879 return git_xmerge_config(var, value, NULL);
882 struct tracking_name_data {
883 /* const */ char *src_ref;
885 struct object_id *dst_oid;
889 static int check_tracking_name(struct remote *remote, void *cb_data)
891 struct tracking_name_data *cb = cb_data;
892 struct refspec query;
893 memset(&query, 0, sizeof(struct refspec));
894 query.src = cb->src_ref;
895 if (remote_find_tracking(remote, &query) ||
896 get_oid(query.dst, cb->dst_oid)) {
905 cb->dst_ref = query.dst;
909 static const char *unique_tracking_name(const char *name, struct object_id *oid)
911 struct tracking_name_data cb_data = { NULL, NULL, NULL, 1 };
912 cb_data.src_ref = xstrfmt("refs/heads/%s", name);
913 cb_data.dst_oid = oid;
914 for_each_remote(check_tracking_name, &cb_data);
915 free(cb_data.src_ref);
917 return cb_data.dst_ref;
918 free(cb_data.dst_ref);
922 static int parse_branchname_arg(int argc, const char **argv,
923 int dwim_new_local_branch_ok,
924 struct branch_info *new,
925 struct checkout_opts *opts,
926 struct object_id *rev)
928 struct tree **source_tree = &opts->source_tree;
929 const char **new_branch = &opts->new_branch;
931 struct object_id branch_rev;
934 int has_dash_dash = 0;
938 * case 1: git checkout <ref> -- [<paths>]
940 * <ref> must be a valid tree, everything after the '--' must be
943 * case 2: git checkout -- [<paths>]
945 * everything after the '--' must be paths.
947 * case 3: git checkout <something> [--]
949 * (a) If <something> is a commit, that is to
950 * switch to the branch or detach HEAD at it. As a special case,
951 * if <something> is A...B (missing A or B means HEAD but you can
952 * omit at most one side), and if there is a unique merge base
953 * between A and B, A...B names that merge base.
955 * (b) If <something> is _not_ a commit, either "--" is present
956 * or <something> is not a path, no -t or -b was given, and
957 * and there is a tracking branch whose name is <something>
958 * in one and only one remote, then this is a short-hand to
959 * fork local <something> from that remote-tracking branch.
961 * (c) Otherwise, if "--" is present, treat it like case (1).
964 * - if it's a reference, treat it like case (1)
965 * - else if it's a path, treat it like case (2)
968 * case 4: git checkout <something> <paths>
970 * The first argument must not be ambiguous.
971 * - If it's *only* a reference, treat it like case (1).
972 * - If it's only a path, treat it like case (2).
981 for (i = 0; i < argc; i++) {
982 if (!strcmp(argv[i], "--")) {
987 if (dash_dash_pos == 0)
988 return 1; /* case (2) */
989 else if (dash_dash_pos == 1)
990 has_dash_dash = 1; /* case (3) or (1) */
991 else if (dash_dash_pos >= 2)
992 die(_("only one reference expected, %d given."), dash_dash_pos);
994 if (!strcmp(arg, "-"))
997 if (get_oid_mb(arg, rev)) {
999 * Either case (3) or (4), with <something> not being
1000 * a commit, or an attempt to use case (1) with an
1003 * It's likely an error, but we need to find out if
1004 * we should auto-create the branch, case (3).(b).
1006 int recover_with_dwim = dwim_new_local_branch_ok;
1008 if (!has_dash_dash &&
1009 (check_filename(opts->prefix, arg) || !no_wildcard(arg)))
1010 recover_with_dwim = 0;
1012 * Accept "git checkout foo" and "git checkout foo --"
1013 * as candidates for dwim.
1015 if (!(argc == 1 && !has_dash_dash) &&
1016 !(argc == 2 && has_dash_dash))
1017 recover_with_dwim = 0;
1019 if (recover_with_dwim) {
1020 const char *remote = unique_tracking_name(arg, rev);
1024 /* DWIMmed to create local branch, case (3).(b) */
1026 recover_with_dwim = 0;
1030 if (!recover_with_dwim) {
1032 die(_("invalid reference: %s"), arg);
1037 /* we can't end up being in (2) anymore, eat the argument */
1043 setup_branch_path(new);
1045 if (!check_refname_format(new->path, 0) &&
1046 !read_ref(new->path, branch_rev.hash))
1047 oidcpy(rev, &branch_rev);
1049 new->path = NULL; /* not an existing branch */
1051 new->commit = lookup_commit_reference_gently(rev->hash, 1);
1054 *source_tree = parse_tree_indirect(rev->hash);
1056 parse_commit_or_die(new->commit);
1057 *source_tree = new->commit->tree;
1060 if (!*source_tree) /* case (1): want a tree */
1061 die(_("reference is not a tree: %s"), arg);
1062 if (!has_dash_dash) { /* case (3).(d) -> (1) */
1064 * Do not complain the most common case
1065 * git checkout branch
1066 * even if there happen to be a file called 'branch';
1067 * it would be extremely annoying.
1070 verify_non_filename(opts->prefix, arg);
1080 static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
1083 struct strbuf branch_ref = STRBUF_INIT;
1085 if (!opts->new_branch)
1086 die(_("You are on a branch yet to be born"));
1087 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1088 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1089 strbuf_release(&branch_ref);
1091 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1096 static int checkout_branch(struct checkout_opts *opts,
1097 struct branch_info *new)
1099 if (opts->pathspec.nr)
1100 die(_("paths cannot be used with switching branches"));
1102 if (opts->patch_mode)
1103 die(_("'%s' cannot be used with switching branches"),
1106 if (opts->writeout_stage)
1107 die(_("'%s' cannot be used with switching branches"),
1110 if (opts->force && opts->merge)
1111 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1113 if (opts->force_detach && opts->new_branch)
1114 die(_("'%s' cannot be used with '%s'"),
1115 "--detach", "-b/-B/--orphan");
1117 if (opts->new_orphan_branch) {
1118 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1119 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1120 } else if (opts->force_detach) {
1121 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1122 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1123 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1124 opts->track = git_branch_track;
1126 if (new->name && !new->commit)
1127 die(_("Cannot switch branch to a non-commit '%s'"),
1130 if (new->path && !opts->force_detach && !opts->new_branch &&
1131 !opts->ignore_other_worktrees) {
1132 struct object_id oid;
1134 char *head_ref = resolve_refdup("HEAD", 0, oid.hash, &flag);
1136 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new->path)))
1137 die_if_checked_out(new->path, 1);
1141 if (!new->commit && opts->new_branch) {
1142 struct object_id rev;
1145 if (!read_ref_full("HEAD", 0, rev.hash, &flag) &&
1146 (flag & REF_ISSYMREF) && is_null_oid(&rev))
1147 return switch_unborn_to_new_branch(opts);
1149 return switch_branches(opts, new);
1152 int cmd_checkout(int argc, const char **argv, const char *prefix)
1154 struct checkout_opts opts;
1155 struct branch_info new;
1156 char *conflict_style = NULL;
1157 int dwim_new_local_branch = 1;
1158 struct option options[] = {
1159 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
1160 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1161 N_("create and checkout a new branch")),
1162 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1163 N_("create/reset and checkout a branch")),
1164 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
1165 OPT_BOOL(0, "detach", &opts.force_detach, N_("detach HEAD at named commit")),
1166 OPT_SET_INT('t', "track", &opts.track, N_("set upstream info for new branch"),
1167 BRANCH_TRACK_EXPLICIT),
1168 OPT_STRING(0, "orphan", &opts.new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
1169 OPT_SET_INT('2', "ours", &opts.writeout_stage, N_("checkout our version for unmerged files"),
1171 OPT_SET_INT('3', "theirs", &opts.writeout_stage, N_("checkout their version for unmerged files"),
1173 OPT__FORCE(&opts.force, N_("force checkout (throw away local modifications)")),
1174 OPT_BOOL('m', "merge", &opts.merge, N_("perform a 3-way merge with the new branch")),
1175 OPT_BOOL(0, "overwrite-ignore", &opts.overwrite_ignore, N_("update ignored files (default)")),
1176 OPT_STRING(0, "conflict", &conflict_style, N_("style"),
1177 N_("conflict style (merge or diff3)")),
1178 OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
1179 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
1180 N_("do not limit pathspecs to sparse entries only")),
1181 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
1182 N_("second guess 'git checkout <no-such-branch>'")),
1183 OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
1184 N_("do not check if another worktree is holding the given ref")),
1185 { OPTION_CALLBACK, 0, "recurse-submodules", &recurse_submodules,
1186 "checkout", "control recursive updating of submodules",
1187 PARSE_OPT_OPTARG, option_parse_recurse_submodules },
1188 OPT_BOOL(0, "progress", &opts.show_progress, N_("force progress reporting")),
1192 memset(&opts, 0, sizeof(opts));
1193 memset(&new, 0, sizeof(new));
1194 opts.overwrite_ignore = 1;
1195 opts.prefix = prefix;
1196 opts.show_progress = -1;
1198 gitmodules_config();
1199 git_config(git_checkout_config, &opts);
1201 opts.track = BRANCH_TRACK_UNSPECIFIED;
1203 argc = parse_options(argc, argv, prefix, options, checkout_usage,
1204 PARSE_OPT_KEEP_DASHDASH);
1206 if (opts.show_progress < 0) {
1208 opts.show_progress = 0;
1210 opts.show_progress = isatty(2);
1213 if (conflict_style) {
1214 opts.merge = 1; /* implied */
1215 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1218 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
1219 git_config(submodule_config, NULL);
1220 if (recurse_submodules != RECURSE_SUBMODULES_DEFAULT)
1221 set_config_update_recurse_submodules(recurse_submodules);
1224 if ((!!opts.new_branch + !!opts.new_branch_force + !!opts.new_orphan_branch) > 1)
1225 die(_("-b, -B and --orphan are mutually exclusive"));
1228 * From here on, new_branch will contain the branch to be checked out,
1229 * and new_branch_force and new_orphan_branch will tell us which one of
1230 * -b/-B/--orphan is being used.
1232 if (opts.new_branch_force)
1233 opts.new_branch = opts.new_branch_force;
1235 if (opts.new_orphan_branch)
1236 opts.new_branch = opts.new_orphan_branch;
1238 /* --track without -b/-B/--orphan should DWIM */
1239 if (opts.track != BRANCH_TRACK_UNSPECIFIED && !opts.new_branch) {
1240 const char *argv0 = argv[0];
1241 if (!argc || !strcmp(argv0, "--"))
1242 die (_("--track needs a branch name"));
1243 skip_prefix(argv0, "refs/", &argv0);
1244 skip_prefix(argv0, "remotes/", &argv0);
1245 argv0 = strchr(argv0, '/');
1246 if (!argv0 || !argv0[1])
1247 die (_("Missing branch name; try -b"));
1248 opts.new_branch = argv0 + 1;
1252 * Extract branch name from command line arguments, so
1253 * all that is left is pathspecs.
1257 * 1) git checkout <tree> -- [<paths>]
1258 * 2) git checkout -- [<paths>]
1259 * 3) git checkout <something> [<paths>]
1261 * including "last branch" syntax and DWIM-ery for names of
1262 * remote branches, erroring out for invalid or ambiguous cases.
1265 struct object_id rev;
1268 dwim_new_local_branch &&
1269 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1271 int n = parse_branchname_arg(argc, argv, dwim_ok,
1278 parse_pathspec(&opts.pathspec, 0,
1279 opts.patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1282 if (!opts.pathspec.nr)
1283 die(_("invalid path specification"));
1286 * Try to give more helpful suggestion.
1287 * new_branch && argc > 1 will be caught later.
1289 if (opts.new_branch && argc == 1)
1290 die(_("Cannot update paths and switch to branch '%s' at the same time.\n"
1291 "Did you intend to checkout '%s' which can not be resolved as commit?"),
1292 opts.new_branch, argv[0]);
1294 if (opts.force_detach)
1295 die(_("git checkout: --detach does not take a path argument '%s'"),
1298 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
1299 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1300 "checking out of the index."));
1303 if (opts.new_branch) {
1304 struct strbuf buf = STRBUF_INIT;
1306 opts.branch_exists =
1307 validate_new_branchname(opts.new_branch, &buf,
1308 !!opts.new_branch_force,
1309 !!opts.new_branch_force);
1311 strbuf_release(&buf);
1314 if (opts.patch_mode || opts.pathspec.nr)
1315 return checkout_paths(&opts, new.name);
1317 return checkout_branch(&opts, &new);