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.h"
23 static const char * const checkout_usage[] = {
24 N_("git checkout [<options>] <branch>"),
25 N_("git checkout [<options>] [<branch>] -- <file>..."),
29 struct checkout_opts {
37 int ignore_skipworktree;
38 int ignore_other_worktrees;
40 const char *new_branch;
41 const char *new_branch_force;
42 const char *new_orphan_branch;
44 enum branch_track track;
45 struct diff_options diff_options;
49 struct pathspec pathspec;
50 struct tree *source_tree;
52 int new_worktree_mode;
55 static int post_checkout_hook(struct commit *old, struct commit *new,
58 return run_hook_le(NULL, "post-checkout",
59 sha1_to_hex(old ? old->object.sha1 : null_sha1),
60 sha1_to_hex(new ? new->object.sha1 : null_sha1),
61 changed ? "1" : "0", NULL);
62 /* "new" can be NULL when checking out from the index before
67 static int update_some(const unsigned char *sha1, struct strbuf *base,
68 const char *pathname, unsigned mode, int stage, void *context)
71 struct cache_entry *ce;
75 return READ_TREE_RECURSIVE;
77 len = base->len + strlen(pathname);
78 ce = xcalloc(1, cache_entry_size(len));
79 hashcpy(ce->sha1, sha1);
80 memcpy(ce->name, base->buf, base->len);
81 memcpy(ce->name + base->len, pathname, len - base->len);
82 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
84 ce->ce_mode = create_ce_mode(mode);
87 * If the entry is the same as the current index, we can leave the old
88 * entry in place. Whether it is UPTODATE or not, checkout_entry will
91 pos = cache_name_pos(ce->name, ce->ce_namelen);
93 struct cache_entry *old = active_cache[pos];
94 if (ce->ce_mode == old->ce_mode &&
95 !hashcmp(ce->sha1, old->sha1)) {
96 old->ce_flags |= CE_UPDATE;
102 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
106 static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
108 read_tree_recursive(tree, "", 0, 0, pathspec, update_some, NULL);
110 /* update the index with the given tree's info
111 * for all args, expanding wildcards, and exit
112 * with any non-zero return code.
117 static int skip_same_name(const struct cache_entry *ce, int pos)
119 while (++pos < active_nr &&
120 !strcmp(active_cache[pos]->name, ce->name))
125 static int check_stage(int stage, const struct cache_entry *ce, int pos)
127 while (pos < active_nr &&
128 !strcmp(active_cache[pos]->name, ce->name)) {
129 if (ce_stage(active_cache[pos]) == stage)
134 return error(_("path '%s' does not have our version"), ce->name);
136 return error(_("path '%s' does not have their version"), ce->name);
139 static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
142 const char *name = ce->name;
144 while (pos < active_nr) {
145 ce = active_cache[pos];
146 if (strcmp(name, ce->name))
148 seen |= (1 << ce_stage(ce));
151 if ((stages & seen) != stages)
152 return error(_("path '%s' does not have all necessary versions"),
157 static int checkout_stage(int stage, struct cache_entry *ce, int pos,
158 struct checkout *state)
160 while (pos < active_nr &&
161 !strcmp(active_cache[pos]->name, ce->name)) {
162 if (ce_stage(active_cache[pos]) == stage)
163 return checkout_entry(active_cache[pos], state, NULL);
167 return error(_("path '%s' does not have our version"), ce->name);
169 return error(_("path '%s' does not have their version"), ce->name);
172 static int checkout_merged(int pos, struct checkout *state)
174 struct cache_entry *ce = active_cache[pos];
175 const char *path = ce->name;
176 mmfile_t ancestor, ours, theirs;
178 unsigned char sha1[20];
179 mmbuffer_t result_buf;
180 unsigned char threeway[3][20];
183 memset(threeway, 0, sizeof(threeway));
184 while (pos < active_nr) {
186 stage = ce_stage(ce);
187 if (!stage || strcmp(path, ce->name))
189 hashcpy(threeway[stage - 1], ce->sha1);
191 mode = create_ce_mode(ce->ce_mode);
193 ce = active_cache[pos];
195 if (is_null_sha1(threeway[1]) || is_null_sha1(threeway[2]))
196 return error(_("path '%s' does not have necessary versions"), path);
198 read_mmblob(&ancestor, threeway[0]);
199 read_mmblob(&ours, threeway[1]);
200 read_mmblob(&theirs, threeway[2]);
203 * NEEDSWORK: re-create conflicts from merges with
204 * merge.renormalize set, too
206 status = ll_merge(&result_buf, path, &ancestor, "base",
207 &ours, "ours", &theirs, "theirs", NULL);
211 if (status < 0 || !result_buf.ptr) {
212 free(result_buf.ptr);
213 return error(_("path '%s': cannot merge"), path);
218 * There is absolutely no reason to write this as a blob object
219 * and create a phony cache entry just to leak. This hack is
220 * primarily to get to the write_entry() machinery that massages
221 * the contents to work-tree format and writes out which only
222 * allows it for a cache entry. The code in write_entry() needs
223 * to be refactored to allow us to feed a <buffer, size, mode>
224 * instead of a cache entry. Such a refactoring would help
225 * merge_recursive as well (it also writes the merge result to the
226 * object database even when it may contain conflicts).
228 if (write_sha1_file(result_buf.ptr, result_buf.size,
230 die(_("Unable to add merge result for '%s'"), path);
231 ce = make_cache_entry(mode, sha1, path, 2, 0);
233 die(_("make_cache_entry failed for path '%s'"), path);
234 status = checkout_entry(ce, state, NULL);
238 static int checkout_paths(const struct checkout_opts *opts,
239 const char *revision)
242 struct checkout state;
243 static char *ps_matched;
244 unsigned char rev[20];
248 struct lock_file *lock_file;
250 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
251 die(_("'%s' cannot be used with updating paths"), "--track");
253 if (opts->new_branch_log)
254 die(_("'%s' cannot be used with updating paths"), "-l");
256 if (opts->force && opts->patch_mode)
257 die(_("'%s' cannot be used with updating paths"), "-f");
259 if (opts->force_detach)
260 die(_("'%s' cannot be used with updating paths"), "--detach");
262 if (opts->merge && opts->patch_mode)
263 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
265 if (opts->force && opts->merge)
266 die(_("'%s' cannot be used with %s"), "-f", "-m");
268 if (opts->new_branch)
269 die(_("Cannot update paths and switch to branch '%s' at the same time."),
272 if (opts->patch_mode)
273 return run_add_interactive(revision, "--patch=checkout",
276 lock_file = xcalloc(1, sizeof(struct lock_file));
278 hold_locked_index(lock_file, 1);
279 if (read_cache_preload(&opts->pathspec) < 0)
280 return error(_("corrupt index file"));
282 if (opts->source_tree)
283 read_tree_some(opts->source_tree, &opts->pathspec);
285 ps_matched = xcalloc(1, opts->pathspec.nr);
288 * Make sure all pathspecs participated in locating the paths
291 for (pos = 0; pos < active_nr; pos++) {
292 struct cache_entry *ce = active_cache[pos];
293 ce->ce_flags &= ~CE_MATCHED;
294 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
296 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
298 * "git checkout tree-ish -- path", but this entry
299 * is in the original index; it will not be checked
300 * out to the working tree and it does not matter
301 * if pathspec matched this entry. We will not do
302 * anything to this entry at all.
306 * Either this entry came from the tree-ish we are
307 * checking the paths out of, or we are checking out
310 * If it comes from the tree-ish, we already know it
311 * matches the pathspec and could just stamp
312 * CE_MATCHED to it from update_some(). But we still
313 * need ps_matched and read_tree_recursive (and
314 * eventually tree_entry_interesting) cannot fill
315 * ps_matched yet. Once it can, we can avoid calling
316 * match_pathspec() for _all_ entries when
317 * opts->source_tree != NULL.
319 if (ce_path_match(ce, &opts->pathspec, ps_matched))
320 ce->ce_flags |= CE_MATCHED;
323 if (report_path_error(ps_matched, &opts->pathspec, opts->prefix)) {
329 /* "checkout -m path" to recreate conflicted state */
331 unmerge_marked_index(&the_index);
333 /* Any unmerged paths? */
334 for (pos = 0; pos < active_nr; pos++) {
335 const struct cache_entry *ce = active_cache[pos];
336 if (ce->ce_flags & CE_MATCHED) {
340 warning(_("path '%s' is unmerged"), ce->name);
341 } else if (opts->writeout_stage) {
342 errs |= check_stage(opts->writeout_stage, ce, pos);
343 } else if (opts->merge) {
344 errs |= check_stages((1<<2) | (1<<3), ce, pos);
347 error(_("path '%s' is unmerged"), ce->name);
349 pos = skip_same_name(ce, pos) - 1;
355 /* Now we are committed to check them out */
356 memset(&state, 0, sizeof(state));
358 state.refresh_cache = 1;
359 state.istate = &the_index;
360 for (pos = 0; pos < active_nr; pos++) {
361 struct cache_entry *ce = active_cache[pos];
362 if (ce->ce_flags & CE_MATCHED) {
364 errs |= checkout_entry(ce, &state, NULL);
367 if (opts->writeout_stage)
368 errs |= checkout_stage(opts->writeout_stage, ce, pos, &state);
369 else if (opts->merge)
370 errs |= checkout_merged(pos, &state);
371 pos = skip_same_name(ce, pos) - 1;
375 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
376 die(_("unable to write new index file"));
378 read_ref_full("HEAD", 0, rev, &flag);
379 head = lookup_commit_reference_gently(rev, 1);
381 errs |= post_checkout_hook(head, head, 0);
385 static void show_local_changes(struct object *head,
386 const struct diff_options *opts)
389 /* I think we want full paths, even if we're in a subdirectory. */
390 init_revisions(&rev, NULL);
391 rev.diffopt.flags = opts->flags;
392 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
393 diff_setup_done(&rev.diffopt);
394 add_pending_object(&rev, head, NULL);
395 run_diff_index(&rev, 0);
398 static void describe_detached_head(const char *msg, struct commit *commit)
400 struct strbuf sb = STRBUF_INIT;
401 if (!parse_commit(commit))
402 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
403 fprintf(stderr, "%s %s... %s\n", msg,
404 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV), sb.buf);
408 static int reset_tree(struct tree *tree, const struct checkout_opts *o,
409 int worktree, int *writeout_error)
411 struct unpack_trees_options opts;
412 struct tree_desc tree_desc;
414 memset(&opts, 0, sizeof(opts));
416 opts.update = worktree;
417 opts.skip_unmerged = !worktree;
420 opts.fn = oneway_merge;
421 opts.verbose_update = !o->quiet && isatty(2);
422 opts.src_index = &the_index;
423 opts.dst_index = &the_index;
425 init_tree_desc(&tree_desc, tree->buffer, tree->size);
426 switch (unpack_trees(1, &tree_desc, &opts)) {
430 * We return 0 nevertheless, as the index is all right
431 * and more importantly we have made best efforts to
432 * update paths in the work tree, and we cannot revert
443 const char *name; /* The short name used */
444 const char *path; /* The full name of a real branch */
445 struct commit *commit; /* The named commit */
447 * if not null the branch is detached because it's already
448 * checked out in this checkout
453 static void setup_branch_path(struct branch_info *branch)
455 struct strbuf buf = STRBUF_INIT;
457 strbuf_branchname(&buf, branch->name);
458 if (strcmp(buf.buf, branch->name))
459 branch->name = xstrdup(buf.buf);
460 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
461 branch->path = strbuf_detach(&buf, NULL);
464 static int merge_working_tree(const struct checkout_opts *opts,
465 struct branch_info *old,
466 struct branch_info *new,
470 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
472 hold_locked_index(lock_file, 1);
473 if (read_cache_preload(NULL) < 0)
474 return error(_("corrupt index file"));
476 resolve_undo_clear();
478 ret = reset_tree(new->commit->tree, opts, 1, writeout_error);
482 struct tree_desc trees[2];
484 struct unpack_trees_options topts;
486 memset(&topts, 0, sizeof(topts));
488 topts.src_index = &the_index;
489 topts.dst_index = &the_index;
491 setup_unpack_trees_porcelain(&topts, "checkout");
493 refresh_cache(REFRESH_QUIET);
495 if (unmerged_cache()) {
496 error(_("you need to resolve your current index first"));
500 /* 2-way merge to the new branch */
501 topts.initial_checkout = is_cache_unborn();
504 topts.gently = opts->merge && old->commit;
505 topts.verbose_update = !opts->quiet && isatty(2);
506 topts.fn = twoway_merge;
507 if (opts->overwrite_ignore) {
508 topts.dir = xcalloc(1, sizeof(*topts.dir));
509 topts.dir->flags |= DIR_SHOW_IGNORED;
510 setup_standard_excludes(topts.dir);
512 tree = parse_tree_indirect(old->commit && !opts->new_worktree_mode ?
513 old->commit->object.sha1 :
514 EMPTY_TREE_SHA1_BIN);
515 init_tree_desc(&trees[0], tree->buffer, tree->size);
516 tree = parse_tree_indirect(new->commit->object.sha1);
517 init_tree_desc(&trees[1], tree->buffer, tree->size);
519 ret = unpack_trees(2, trees, &topts);
522 * Unpack couldn't do a trivial merge; either
523 * give up or do a real merge, depending on
524 * whether the merge flag was used.
528 struct merge_options o;
533 * Without old->commit, the below is the same as
534 * the two-tree unpack we already tried and failed.
539 /* Do more real merge */
542 * We update the index fully, then write the
543 * tree from the index, then merge the new
544 * branch with the current tree, with the old
545 * branch as the base. Then we reset the index
546 * (but not the working tree) to the new
547 * branch, leaving the working tree as the
548 * merged version, but skipping unmerged
549 * entries in the index.
552 add_files_to_cache(NULL, NULL, 0);
554 * NEEDSWORK: carrying over local changes
555 * when branches have different end-of-line
556 * normalization (or clean+smudge rules) is
557 * a pain; plumb in an option to set
560 init_merge_options(&o);
562 work = write_tree_from_memory(&o);
564 ret = reset_tree(new->commit->tree, opts, 1,
568 o.ancestor = old->name;
569 o.branch1 = new->name;
571 merge_trees(&o, new->commit->tree, work,
572 old->commit->tree, &result);
573 ret = reset_tree(new->commit->tree, opts, 0,
580 if (!active_cache_tree)
581 active_cache_tree = cache_tree();
583 if (!cache_tree_fully_valid(active_cache_tree))
584 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
586 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
587 die(_("unable to write new index file"));
589 if (!opts->force && !opts->quiet)
590 show_local_changes(&new->commit->object, &opts->diff_options);
595 static void report_tracking(struct branch_info *new)
597 struct strbuf sb = STRBUF_INIT;
598 struct branch *branch = branch_get(new->name);
600 if (!format_tracking_info(branch, &sb))
602 fputs(sb.buf, stdout);
606 static void update_refs_for_switch(const struct checkout_opts *opts,
607 struct branch_info *old,
608 struct branch_info *new)
610 struct strbuf msg = STRBUF_INIT;
611 const char *old_desc, *reflog_msg;
612 if (opts->new_branch) {
613 if (opts->new_orphan_branch) {
614 if (opts->new_branch_log && !log_all_ref_updates) {
616 struct strbuf log_file = STRBUF_INIT;
618 const char *ref_name;
620 ref_name = mkpath("refs/heads/%s", opts->new_orphan_branch);
621 temp = log_all_ref_updates;
622 log_all_ref_updates = 1;
623 ret = log_ref_setup(ref_name, &log_file);
624 log_all_ref_updates = temp;
625 strbuf_release(&log_file);
627 fprintf(stderr, _("Can not do reflog for '%s'\n"),
628 opts->new_orphan_branch);
634 create_branch(old->name, opts->new_branch, new->name,
635 opts->new_branch_force ? 1 : 0,
636 opts->new_branch_log,
637 opts->new_branch_force ? 1 : 0,
640 new->name = opts->new_branch;
641 setup_branch_path(new);
644 old_desc = old->name;
645 if (!old_desc && old->commit)
646 old_desc = sha1_to_hex(old->commit->object.sha1);
648 reflog_msg = getenv("GIT_REFLOG_ACTION");
650 strbuf_addf(&msg, "checkout: moving from %s to %s",
651 old_desc ? old_desc : "(invalid)", new->name);
653 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
655 if (!strcmp(new->name, "HEAD") && !new->path && !opts->force_detach) {
657 } else if (opts->force_detach || !new->path) { /* No longer on any branch. */
658 update_ref(msg.buf, "HEAD", new->commit->object.sha1, NULL,
659 REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
661 if (old->path && advice_detached_head)
662 detach_advice(new->name);
663 describe_detached_head(_("HEAD is now at"), new->commit);
665 } else if (new->path) { /* Switch branches. */
666 create_symref("HEAD", new->path, msg.buf);
668 if (old->path && !strcmp(new->path, old->path)) {
669 if (opts->new_branch_force)
670 fprintf(stderr, _("Reset branch '%s'\n"),
673 fprintf(stderr, _("Already on '%s'\n"),
675 } else if (opts->new_branch) {
676 if (opts->branch_exists)
677 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new->name);
679 fprintf(stderr, _("Switched to a new branch '%s'\n"), new->name);
681 fprintf(stderr, _("Switched to branch '%s'\n"),
685 if (old->path && old->name) {
686 if (!ref_exists(old->path) && reflog_exists(old->path))
687 delete_reflog(old->path);
690 remove_branch_state();
691 strbuf_release(&msg);
693 (new->path || (!opts->force_detach && !strcmp(new->name, "HEAD"))))
694 report_tracking(new);
697 static int add_pending_uninteresting_ref(const char *refname,
698 const struct object_id *oid,
699 int flags, void *cb_data)
701 add_pending_sha1(cb_data, refname, oid->hash, UNINTERESTING);
705 static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
707 strbuf_addstr(sb, " ");
709 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV));
710 strbuf_addch(sb, ' ');
711 if (!parse_commit(commit))
712 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
713 strbuf_addch(sb, '\n');
716 #define ORPHAN_CUTOFF 4
717 static void suggest_reattach(struct commit *commit, struct rev_info *revs)
719 struct commit *c, *last = NULL;
720 struct strbuf sb = STRBUF_INIT;
722 while ((c = get_revision(revs)) != NULL) {
723 if (lost < ORPHAN_CUTOFF)
724 describe_one_orphan(&sb, c);
728 if (ORPHAN_CUTOFF < lost) {
729 int more = lost - ORPHAN_CUTOFF;
731 describe_one_orphan(&sb, last);
733 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
738 /* The singular version */
739 "Warning: you are leaving %d commit behind, "
741 "any of your branches:\n\n"
743 /* The plural version */
744 "Warning: you are leaving %d commits behind, "
746 "any of your branches:\n\n"
748 /* Give ngettext() the count */
754 if (advice_detached_head)
757 /* The singular version */
758 "If you want to keep it by creating a new branch, "
759 "this may be a good time\nto do so with:\n\n"
760 " git branch <new-branch-name> %s\n\n",
761 /* The plural version */
762 "If you want to keep them by creating a new branch, "
763 "this may be a good time\nto do so with:\n\n"
764 " git branch <new-branch-name> %s\n\n",
765 /* Give ngettext() the count */
767 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV));
771 * We are about to leave commit that was at the tip of a detached
772 * HEAD. If it is not reachable from any ref, this is the last chance
773 * for the user to do so without resorting to reflog.
775 static void orphaned_commit_warning(struct commit *old, struct commit *new)
777 struct rev_info revs;
778 struct object *object = &old->object;
779 struct object_array refs;
781 init_revisions(&revs, NULL);
782 setup_revisions(0, NULL, &revs, NULL);
784 object->flags &= ~UNINTERESTING;
785 add_pending_object(&revs, object, sha1_to_hex(object->sha1));
787 for_each_ref(add_pending_uninteresting_ref, &revs);
788 add_pending_sha1(&revs, "HEAD", new->object.sha1, UNINTERESTING);
791 revs.leak_pending = 1;
793 if (prepare_revision_walk(&revs))
794 die(_("internal error in revision walk"));
795 if (!(old->object.flags & UNINTERESTING))
796 suggest_reattach(old, &revs);
798 describe_detached_head(_("Previous HEAD position was"), old);
800 clear_commit_marks_for_object_array(&refs, ALL_REV_FLAGS);
804 static int switch_branches(const struct checkout_opts *opts,
805 struct branch_info *new)
808 struct branch_info old;
810 unsigned char rev[20];
811 int flag, writeout_error = 0;
812 memset(&old, 0, sizeof(old));
813 old.path = path_to_free = resolve_refdup("HEAD", 0, rev, &flag);
814 old.commit = lookup_commit_reference_gently(rev, 1);
815 if (!(flag & REF_ISSYMREF))
819 skip_prefix(old.path, "refs/heads/", &old.name);
823 new->commit = old.commit;
825 die(_("You are on a branch yet to be born"));
826 parse_commit_or_die(new->commit);
829 ret = merge_working_tree(opts, &old, new, &writeout_error);
835 if (!opts->quiet && !old.path && old.commit &&
836 new->commit != old.commit && !opts->new_worktree_mode)
837 orphaned_commit_warning(old.commit, new->commit);
839 update_refs_for_switch(opts, &old, new);
841 ret = post_checkout_hook(old.commit, new->commit, 1);
843 return ret || writeout_error;
846 static int git_checkout_config(const char *var, const char *value, void *cb)
848 if (!strcmp(var, "diff.ignoresubmodules")) {
849 struct checkout_opts *opts = cb;
850 handle_ignore_submodules_arg(&opts->diff_options, value);
854 if (starts_with(var, "submodule."))
855 return parse_submodule_config_option(var, value);
857 return git_xmerge_config(var, value, NULL);
860 struct tracking_name_data {
861 /* const */ char *src_ref;
863 unsigned char *dst_sha1;
867 static int check_tracking_name(struct remote *remote, void *cb_data)
869 struct tracking_name_data *cb = cb_data;
870 struct refspec query;
871 memset(&query, 0, sizeof(struct refspec));
872 query.src = cb->src_ref;
873 if (remote_find_tracking(remote, &query) ||
874 get_sha1(query.dst, cb->dst_sha1)) {
883 cb->dst_ref = query.dst;
887 static const char *unique_tracking_name(const char *name, unsigned char *sha1)
889 struct tracking_name_data cb_data = { NULL, NULL, NULL, 1 };
890 char src_ref[PATH_MAX];
891 snprintf(src_ref, PATH_MAX, "refs/heads/%s", name);
892 cb_data.src_ref = src_ref;
893 cb_data.dst_sha1 = sha1;
894 for_each_remote(check_tracking_name, &cb_data);
896 return cb_data.dst_ref;
897 free(cb_data.dst_ref);
901 static void check_linked_checkout(struct branch_info *new, const char *id)
903 struct strbuf sb = STRBUF_INIT;
904 struct strbuf path = STRBUF_INIT;
905 struct strbuf gitdir = STRBUF_INIT;
906 const char *start, *end;
909 strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
911 strbuf_addf(&path, "%s/HEAD", get_git_common_dir());
913 if (strbuf_read_file(&sb, path.buf, 0) < 0 ||
914 !skip_prefix(sb.buf, "ref:", &start))
916 while (isspace(*start))
919 while (*end && !isspace(*end))
921 if (strncmp(start, new->path, end - start) || new->path[end - start] != '\0')
925 strbuf_addf(&path, "%s/worktrees/%s/gitdir", get_git_common_dir(), id);
926 if (strbuf_read_file(&gitdir, path.buf, 0) <= 0)
928 strbuf_rtrim(&gitdir);
930 strbuf_addstr(&gitdir, get_git_common_dir());
931 die(_("'%s' is already checked out at '%s'"), new->name, gitdir.buf);
933 strbuf_release(&path);
935 strbuf_release(&gitdir);
938 static void check_linked_checkouts(struct branch_info *new)
940 struct strbuf path = STRBUF_INIT;
944 strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
945 if ((dir = opendir(path.buf)) == NULL) {
946 strbuf_release(&path);
951 * $GIT_COMMON_DIR/HEAD is practically outside
952 * $GIT_DIR so resolve_ref_unsafe() won't work (it
953 * uses git_path). Parse the ref ourselves.
955 check_linked_checkout(new, NULL);
957 while ((d = readdir(dir)) != NULL) {
958 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
960 check_linked_checkout(new, d->d_name);
962 strbuf_release(&path);
966 static int parse_branchname_arg(int argc, const char **argv,
967 int dwim_new_local_branch_ok,
968 struct branch_info *new,
969 struct checkout_opts *opts,
970 unsigned char rev[20])
972 struct tree **source_tree = &opts->source_tree;
973 const char **new_branch = &opts->new_branch;
975 unsigned char branch_rev[20];
978 int has_dash_dash = 0;
982 * case 1: git checkout <ref> -- [<paths>]
984 * <ref> must be a valid tree, everything after the '--' must be
987 * case 2: git checkout -- [<paths>]
989 * everything after the '--' must be paths.
991 * case 3: git checkout <something> [--]
993 * (a) If <something> is a commit, that is to
994 * switch to the branch or detach HEAD at it. As a special case,
995 * if <something> is A...B (missing A or B means HEAD but you can
996 * omit at most one side), and if there is a unique merge base
997 * between A and B, A...B names that merge base.
999 * (b) If <something> is _not_ a commit, either "--" is present
1000 * or <something> is not a path, no -t or -b was given, and
1001 * and there is a tracking branch whose name is <something>
1002 * in one and only one remote, then this is a short-hand to
1003 * fork local <something> from that remote-tracking branch.
1005 * (c) Otherwise, if "--" is present, treat it like case (1).
1008 * - if it's a reference, treat it like case (1)
1009 * - else if it's a path, treat it like case (2)
1012 * case 4: git checkout <something> <paths>
1014 * The first argument must not be ambiguous.
1015 * - If it's *only* a reference, treat it like case (1).
1016 * - If it's only a path, treat it like case (2).
1025 for (i = 0; i < argc; i++) {
1026 if (!strcmp(argv[i], "--")) {
1031 if (dash_dash_pos == 0)
1032 return 1; /* case (2) */
1033 else if (dash_dash_pos == 1)
1034 has_dash_dash = 1; /* case (3) or (1) */
1035 else if (dash_dash_pos >= 2)
1036 die(_("only one reference expected, %d given."), dash_dash_pos);
1038 if (!strcmp(arg, "-"))
1041 if (get_sha1_mb(arg, rev)) {
1043 * Either case (3) or (4), with <something> not being
1044 * a commit, or an attempt to use case (1) with an
1047 * It's likely an error, but we need to find out if
1048 * we should auto-create the branch, case (3).(b).
1050 int recover_with_dwim = dwim_new_local_branch_ok;
1052 if (check_filename(NULL, arg) && !has_dash_dash)
1053 recover_with_dwim = 0;
1055 * Accept "git checkout foo" and "git checkout foo --"
1056 * as candidates for dwim.
1058 if (!(argc == 1 && !has_dash_dash) &&
1059 !(argc == 2 && has_dash_dash))
1060 recover_with_dwim = 0;
1062 if (recover_with_dwim) {
1063 const char *remote = unique_tracking_name(arg, rev);
1067 /* DWIMmed to create local branch, case (3).(b) */
1069 recover_with_dwim = 0;
1073 if (!recover_with_dwim) {
1075 die(_("invalid reference: %s"), arg);
1080 /* we can't end up being in (2) anymore, eat the argument */
1086 setup_branch_path(new);
1088 if (!check_refname_format(new->path, 0) &&
1089 !read_ref(new->path, branch_rev))
1090 hashcpy(rev, branch_rev);
1092 new->path = NULL; /* not an existing branch */
1094 new->commit = lookup_commit_reference_gently(rev, 1);
1097 *source_tree = parse_tree_indirect(rev);
1099 parse_commit_or_die(new->commit);
1100 *source_tree = new->commit->tree;
1103 if (!*source_tree) /* case (1): want a tree */
1104 die(_("reference is not a tree: %s"), arg);
1105 if (!has_dash_dash) {/* case (3).(d) -> (1) */
1107 * Do not complain the most common case
1108 * git checkout branch
1109 * even if there happen to be a file called 'branch';
1110 * it would be extremely annoying.
1113 verify_non_filename(NULL, arg);
1123 static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
1126 struct strbuf branch_ref = STRBUF_INIT;
1128 if (!opts->new_branch)
1129 die(_("You are on a branch yet to be born"));
1130 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1131 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1132 strbuf_release(&branch_ref);
1134 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1139 static int checkout_branch(struct checkout_opts *opts,
1140 struct branch_info *new)
1142 if (opts->pathspec.nr)
1143 die(_("paths cannot be used with switching branches"));
1145 if (opts->patch_mode)
1146 die(_("'%s' cannot be used with switching branches"),
1149 if (opts->writeout_stage)
1150 die(_("'%s' cannot be used with switching branches"),
1153 if (opts->force && opts->merge)
1154 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1156 if (opts->force_detach && opts->new_branch)
1157 die(_("'%s' cannot be used with '%s'"),
1158 "--detach", "-b/-B/--orphan");
1160 if (opts->new_orphan_branch) {
1161 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1162 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1163 } else if (opts->force_detach) {
1164 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1165 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1166 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1167 opts->track = git_branch_track;
1169 if (new->name && !new->commit)
1170 die(_("Cannot switch branch to a non-commit '%s'"),
1173 if (new->path && !opts->force_detach && !opts->new_branch) {
1174 unsigned char sha1[20];
1176 char *head_ref = resolve_refdup("HEAD", 0, sha1, &flag);
1178 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new->path)) &&
1179 !opts->ignore_other_worktrees)
1180 check_linked_checkouts(new);
1184 if (!new->commit && opts->new_branch) {
1185 unsigned char rev[20];
1188 if (!read_ref_full("HEAD", 0, rev, &flag) &&
1189 (flag & REF_ISSYMREF) && is_null_sha1(rev))
1190 return switch_unborn_to_new_branch(opts);
1192 return switch_branches(opts, new);
1195 int cmd_checkout(int argc, const char **argv, const char *prefix)
1197 struct checkout_opts opts;
1198 struct branch_info new;
1199 char *conflict_style = NULL;
1200 int dwim_new_local_branch = 1;
1201 struct option options[] = {
1202 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
1203 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1204 N_("create and checkout a new branch")),
1205 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1206 N_("create/reset and checkout a branch")),
1207 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
1208 OPT_BOOL(0, "detach", &opts.force_detach, N_("detach the HEAD at named commit")),
1209 OPT_SET_INT('t', "track", &opts.track, N_("set upstream info for new branch"),
1210 BRANCH_TRACK_EXPLICIT),
1211 OPT_STRING(0, "orphan", &opts.new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
1212 OPT_SET_INT('2', "ours", &opts.writeout_stage, N_("checkout our version for unmerged files"),
1214 OPT_SET_INT('3', "theirs", &opts.writeout_stage, N_("checkout their version for unmerged files"),
1216 OPT__FORCE(&opts.force, N_("force checkout (throw away local modifications)")),
1217 OPT_BOOL('m', "merge", &opts.merge, N_("perform a 3-way merge with the new branch")),
1218 OPT_BOOL(0, "overwrite-ignore", &opts.overwrite_ignore, N_("update ignored files (default)")),
1219 OPT_STRING(0, "conflict", &conflict_style, N_("style"),
1220 N_("conflict style (merge or diff3)")),
1221 OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
1222 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
1223 N_("do not limit pathspecs to sparse entries only")),
1224 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
1225 N_("second guess 'git checkout <no-such-branch>'")),
1226 OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
1227 N_("do not check if another worktree is holding the given ref")),
1231 memset(&opts, 0, sizeof(opts));
1232 memset(&new, 0, sizeof(new));
1233 opts.overwrite_ignore = 1;
1234 opts.prefix = prefix;
1236 gitmodules_config();
1237 git_config(git_checkout_config, &opts);
1239 opts.track = BRANCH_TRACK_UNSPECIFIED;
1241 argc = parse_options(argc, argv, prefix, options, checkout_usage,
1242 PARSE_OPT_KEEP_DASHDASH);
1244 opts.new_worktree_mode = getenv("GIT_CHECKOUT_NEW_WORKTREE") != NULL;
1246 if (conflict_style) {
1247 opts.merge = 1; /* implied */
1248 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1251 if ((!!opts.new_branch + !!opts.new_branch_force + !!opts.new_orphan_branch) > 1)
1252 die(_("-b, -B and --orphan are mutually exclusive"));
1255 * From here on, new_branch will contain the branch to be checked out,
1256 * and new_branch_force and new_orphan_branch will tell us which one of
1257 * -b/-B/--orphan is being used.
1259 if (opts.new_branch_force)
1260 opts.new_branch = opts.new_branch_force;
1262 if (opts.new_orphan_branch)
1263 opts.new_branch = opts.new_orphan_branch;
1265 /* --track without -b/-B/--orphan should DWIM */
1266 if (opts.track != BRANCH_TRACK_UNSPECIFIED && !opts.new_branch) {
1267 const char *argv0 = argv[0];
1268 if (!argc || !strcmp(argv0, "--"))
1269 die (_("--track needs a branch name"));
1270 skip_prefix(argv0, "refs/", &argv0);
1271 skip_prefix(argv0, "remotes/", &argv0);
1272 argv0 = strchr(argv0, '/');
1273 if (!argv0 || !argv0[1])
1274 die (_("Missing branch name; try -b"));
1275 opts.new_branch = argv0 + 1;
1279 * Extract branch name from command line arguments, so
1280 * all that is left is pathspecs.
1284 * 1) git checkout <tree> -- [<paths>]
1285 * 2) git checkout -- [<paths>]
1286 * 3) git checkout <something> [<paths>]
1288 * including "last branch" syntax and DWIM-ery for names of
1289 * remote branches, erroring out for invalid or ambiguous cases.
1292 unsigned char rev[20];
1295 dwim_new_local_branch &&
1296 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1298 int n = parse_branchname_arg(argc, argv, dwim_ok,
1305 parse_pathspec(&opts.pathspec, 0,
1306 opts.patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1309 if (!opts.pathspec.nr)
1310 die(_("invalid path specification"));
1313 * Try to give more helpful suggestion.
1314 * new_branch && argc > 1 will be caught later.
1316 if (opts.new_branch && argc == 1)
1317 die(_("Cannot update paths and switch to branch '%s' at the same time.\n"
1318 "Did you intend to checkout '%s' which can not be resolved as commit?"),
1319 opts.new_branch, argv[0]);
1321 if (opts.force_detach)
1322 die(_("git checkout: --detach does not take a path argument '%s'"),
1325 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
1326 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1327 "checking out of the index."));
1330 if (opts.new_branch) {
1331 struct strbuf buf = STRBUF_INIT;
1333 opts.branch_exists =
1334 validate_new_branchname(opts.new_branch, &buf,
1335 !!opts.new_branch_force,
1336 !!opts.new_branch_force);
1338 strbuf_release(&buf);
1341 if (opts.patch_mode || opts.pathspec.nr)
1342 return checkout_paths(&opts, new.name);
1344 return checkout_branch(&opts, &new);