5 #include "parse-options.h"
7 #include "object-store.h"
10 #include "tree-walk.h"
11 #include "cache-tree.h"
12 #include "unpack-trees.h"
14 #include "run-command.h"
15 #include "merge-recursive.h"
21 #include "xdiff-interface.h"
23 #include "resolve-undo.h"
24 #include "submodule-config.h"
25 #include "submodule.h"
28 static int checkout_optimize_new_branch;
30 static const char * const checkout_usage[] = {
31 N_("git checkout [<options>] <branch>"),
32 N_("git checkout [<options>] [<branch>] -- <file>..."),
36 struct checkout_opts {
44 int ignore_skipworktree;
45 int ignore_other_worktrees;
48 * If new checkout options are added, skip_merge_working_tree
49 * should be updated accordingly.
52 const char *new_branch;
53 const char *new_branch_force;
54 const char *new_orphan_branch;
56 enum branch_track track;
57 struct diff_options diff_options;
61 struct pathspec pathspec;
62 struct tree *source_tree;
65 static int post_checkout_hook(struct commit *old_commit, struct commit *new_commit,
68 return run_hook_le(NULL, "post-checkout",
69 oid_to_hex(old_commit ? &old_commit->object.oid : &null_oid),
70 oid_to_hex(new_commit ? &new_commit->object.oid : &null_oid),
71 changed ? "1" : "0", NULL);
72 /* "new_commit" can be NULL when checking out from the index before
77 static int update_some(const struct object_id *oid, struct strbuf *base,
78 const char *pathname, unsigned mode, int stage, void *context)
81 struct cache_entry *ce;
85 return READ_TREE_RECURSIVE;
87 len = base->len + strlen(pathname);
88 ce = make_empty_cache_entry(&the_index, len);
89 oidcpy(&ce->oid, oid);
90 memcpy(ce->name, base->buf, base->len);
91 memcpy(ce->name + base->len, pathname, len - base->len);
92 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
94 ce->ce_mode = create_ce_mode(mode);
97 * If the entry is the same as the current index, we can leave the old
98 * entry in place. Whether it is UPTODATE or not, checkout_entry will
101 pos = cache_name_pos(ce->name, ce->ce_namelen);
103 struct cache_entry *old = active_cache[pos];
104 if (ce->ce_mode == old->ce_mode &&
105 oideq(&ce->oid, &old->oid)) {
106 old->ce_flags |= CE_UPDATE;
107 discard_cache_entry(ce);
112 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
116 static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
118 read_tree_recursive(the_repository, tree, "", 0, 0,
119 pathspec, update_some, NULL);
121 /* update the index with the given tree's info
122 * for all args, expanding wildcards, and exit
123 * with any non-zero return code.
128 static int skip_same_name(const struct cache_entry *ce, int pos)
130 while (++pos < active_nr &&
131 !strcmp(active_cache[pos]->name, ce->name))
136 static int check_stage(int stage, const struct cache_entry *ce, int pos)
138 while (pos < active_nr &&
139 !strcmp(active_cache[pos]->name, ce->name)) {
140 if (ce_stage(active_cache[pos]) == stage)
145 return error(_("path '%s' does not have our version"), ce->name);
147 return error(_("path '%s' does not have their version"), ce->name);
150 static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
153 const char *name = ce->name;
155 while (pos < active_nr) {
156 ce = active_cache[pos];
157 if (strcmp(name, ce->name))
159 seen |= (1 << ce_stage(ce));
162 if ((stages & seen) != stages)
163 return error(_("path '%s' does not have all necessary versions"),
168 static int checkout_stage(int stage, const struct cache_entry *ce, int pos,
169 const struct checkout *state)
171 while (pos < active_nr &&
172 !strcmp(active_cache[pos]->name, ce->name)) {
173 if (ce_stage(active_cache[pos]) == stage)
174 return checkout_entry(active_cache[pos], state, NULL);
178 return error(_("path '%s' does not have our version"), ce->name);
180 return error(_("path '%s' does not have their version"), ce->name);
183 static int checkout_merged(int pos, const struct checkout *state)
185 struct cache_entry *ce = active_cache[pos];
186 const char *path = ce->name;
187 mmfile_t ancestor, ours, theirs;
189 struct object_id oid;
190 mmbuffer_t result_buf;
191 struct object_id threeway[3];
194 memset(threeway, 0, sizeof(threeway));
195 while (pos < active_nr) {
197 stage = ce_stage(ce);
198 if (!stage || strcmp(path, ce->name))
200 oidcpy(&threeway[stage - 1], &ce->oid);
202 mode = create_ce_mode(ce->ce_mode);
204 ce = active_cache[pos];
206 if (is_null_oid(&threeway[1]) || is_null_oid(&threeway[2]))
207 return error(_("path '%s' does not have necessary versions"), path);
209 read_mmblob(&ancestor, &threeway[0]);
210 read_mmblob(&ours, &threeway[1]);
211 read_mmblob(&theirs, &threeway[2]);
214 * NEEDSWORK: re-create conflicts from merges with
215 * merge.renormalize set, too
217 status = ll_merge(&result_buf, path, &ancestor, "base",
218 &ours, "ours", &theirs, "theirs",
219 state->istate, NULL);
223 if (status < 0 || !result_buf.ptr) {
224 free(result_buf.ptr);
225 return error(_("path '%s': cannot merge"), path);
230 * There is absolutely no reason to write this as a blob object
231 * and create a phony cache entry. This hack is primarily to get
232 * to the write_entry() machinery that massages the contents to
233 * work-tree format and writes out which only allows it for a
234 * cache entry. The code in write_entry() needs to be refactored
235 * to allow us to feed a <buffer, size, mode> instead of a cache
236 * entry. Such a refactoring would help merge_recursive as well
237 * (it also writes the merge result to the object database even
238 * when it may contain conflicts).
240 if (write_object_file(result_buf.ptr, result_buf.size, blob_type, &oid))
241 die(_("Unable to add merge result for '%s'"), path);
242 free(result_buf.ptr);
243 ce = make_transient_cache_entry(mode, &oid, path, 2);
245 die(_("make_cache_entry failed for path '%s'"), path);
246 status = checkout_entry(ce, state, NULL);
247 discard_cache_entry(ce);
251 static int checkout_paths(const struct checkout_opts *opts,
252 const char *revision)
255 struct checkout state = CHECKOUT_INIT;
256 static char *ps_matched;
257 struct object_id rev;
260 struct lock_file lock_file = LOCK_INIT;
262 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
263 die(_("'%s' cannot be used with updating paths"), "--track");
265 if (opts->new_branch_log)
266 die(_("'%s' cannot be used with updating paths"), "-l");
268 if (opts->force && opts->patch_mode)
269 die(_("'%s' cannot be used with updating paths"), "-f");
271 if (opts->force_detach)
272 die(_("'%s' cannot be used with updating paths"), "--detach");
274 if (opts->merge && opts->patch_mode)
275 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
277 if (opts->force && opts->merge)
278 die(_("'%s' cannot be used with %s"), "-f", "-m");
280 if (opts->new_branch)
281 die(_("Cannot update paths and switch to branch '%s' at the same time."),
284 if (opts->patch_mode)
285 return run_add_interactive(revision, "--patch=checkout",
288 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
289 if (read_cache_preload(&opts->pathspec) < 0)
290 return error(_("index file corrupt"));
292 if (opts->source_tree)
293 read_tree_some(opts->source_tree, &opts->pathspec);
295 ps_matched = xcalloc(opts->pathspec.nr, 1);
298 * Make sure all pathspecs participated in locating the paths
301 for (pos = 0; pos < active_nr; pos++) {
302 struct cache_entry *ce = active_cache[pos];
303 ce->ce_flags &= ~CE_MATCHED;
304 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
306 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
308 * "git checkout tree-ish -- path", but this entry
309 * is in the original index; it will not be checked
310 * out to the working tree and it does not matter
311 * if pathspec matched this entry. We will not do
312 * anything to this entry at all.
316 * Either this entry came from the tree-ish we are
317 * checking the paths out of, or we are checking out
320 * If it comes from the tree-ish, we already know it
321 * matches the pathspec and could just stamp
322 * CE_MATCHED to it from update_some(). But we still
323 * need ps_matched and read_tree_recursive (and
324 * eventually tree_entry_interesting) cannot fill
325 * ps_matched yet. Once it can, we can avoid calling
326 * match_pathspec() for _all_ entries when
327 * opts->source_tree != NULL.
329 if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched))
330 ce->ce_flags |= CE_MATCHED;
333 if (report_path_error(ps_matched, &opts->pathspec, opts->prefix)) {
339 /* "checkout -m path" to recreate conflicted state */
341 unmerge_marked_index(&the_index);
343 /* Any unmerged paths? */
344 for (pos = 0; pos < active_nr; pos++) {
345 const struct cache_entry *ce = active_cache[pos];
346 if (ce->ce_flags & CE_MATCHED) {
350 warning(_("path '%s' is unmerged"), ce->name);
351 } else if (opts->writeout_stage) {
352 errs |= check_stage(opts->writeout_stage, ce, pos);
353 } else if (opts->merge) {
354 errs |= check_stages((1<<2) | (1<<3), ce, pos);
357 error(_("path '%s' is unmerged"), ce->name);
359 pos = skip_same_name(ce, pos) - 1;
365 /* Now we are committed to check them out */
367 state.refresh_cache = 1;
368 state.istate = &the_index;
370 enable_delayed_checkout(&state);
371 for (pos = 0; pos < active_nr; pos++) {
372 struct cache_entry *ce = active_cache[pos];
373 if (ce->ce_flags & CE_MATCHED) {
375 errs |= checkout_entry(ce, &state, NULL);
378 if (opts->writeout_stage)
379 errs |= checkout_stage(opts->writeout_stage, ce, pos, &state);
380 else if (opts->merge)
381 errs |= checkout_merged(pos, &state);
382 pos = skip_same_name(ce, pos) - 1;
385 errs |= finish_delayed_checkout(&state);
387 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
388 die(_("unable to write new index file"));
390 read_ref_full("HEAD", 0, &rev, NULL);
391 head = lookup_commit_reference_gently(the_repository, &rev, 1);
393 errs |= post_checkout_hook(head, head, 0);
397 static void show_local_changes(struct object *head,
398 const struct diff_options *opts)
401 /* I think we want full paths, even if we're in a subdirectory. */
402 repo_init_revisions(the_repository, &rev, NULL);
403 rev.diffopt.flags = opts->flags;
404 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
405 diff_setup_done(&rev.diffopt);
406 add_pending_object(&rev, head, NULL);
407 run_diff_index(&rev, 0);
410 static void describe_detached_head(const char *msg, struct commit *commit)
412 struct strbuf sb = STRBUF_INIT;
414 if (!parse_commit(commit))
415 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
416 if (print_sha1_ellipsis()) {
417 fprintf(stderr, "%s %s... %s\n", msg,
418 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
420 fprintf(stderr, "%s %s %s\n", msg,
421 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
426 static int reset_tree(struct tree *tree, const struct checkout_opts *o,
427 int worktree, int *writeout_error)
429 struct unpack_trees_options opts;
430 struct tree_desc tree_desc;
432 memset(&opts, 0, sizeof(opts));
434 opts.update = worktree;
435 opts.skip_unmerged = !worktree;
438 opts.fn = oneway_merge;
439 opts.verbose_update = o->show_progress;
440 opts.src_index = &the_index;
441 opts.dst_index = &the_index;
443 init_tree_desc(&tree_desc, tree->buffer, tree->size);
444 switch (unpack_trees(1, &tree_desc, &opts)) {
448 * We return 0 nevertheless, as the index is all right
449 * and more importantly we have made best efforts to
450 * update paths in the work tree, and we cannot revert
462 const char *name; /* The short name used */
463 const char *path; /* The full name of a real branch */
464 struct commit *commit; /* The named commit */
466 * if not null the branch is detached because it's already
467 * checked out in this checkout
472 static void setup_branch_path(struct branch_info *branch)
474 struct strbuf buf = STRBUF_INIT;
476 strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
477 if (strcmp(buf.buf, branch->name))
478 branch->name = xstrdup(buf.buf);
479 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
480 branch->path = strbuf_detach(&buf, NULL);
484 * Skip merging the trees, updating the index and working directory if and
485 * only if we are creating a new branch via "git checkout -b <new_branch>."
487 static int skip_merge_working_tree(const struct checkout_opts *opts,
488 const struct branch_info *old_branch_info,
489 const struct branch_info *new_branch_info)
492 * Do the merge if sparse checkout is on and the user has not opted in
493 * to the optimized behavior
495 if (core_apply_sparse_checkout && !checkout_optimize_new_branch)
499 * We must do the merge if we are actually moving to a new commit.
501 if (!old_branch_info->commit || !new_branch_info->commit ||
502 !oideq(&old_branch_info->commit->object.oid,
503 &new_branch_info->commit->object.oid))
507 * opts->patch_mode cannot be used with switching branches so is
512 * opts->quiet only impacts output so doesn't require a merge
516 * Honor the explicit request for a three-way merge or to throw away
519 if (opts->merge || opts->force)
523 * --detach is documented as "updating the index and the files in the
524 * working tree" but this optimization skips those steps so fall through
525 * to the regular code path.
527 if (opts->force_detach)
531 * opts->writeout_stage cannot be used with switching branches so is
536 * Honor the explicit ignore requests
538 if (!opts->overwrite_ignore || opts->ignore_skipworktree ||
539 opts->ignore_other_worktrees)
543 * opts->show_progress only impacts output so doesn't require a merge
547 * If we aren't creating a new branch any changes or updates will
548 * happen in the existing branch. Since that could only be updating
549 * the index and working directory, we don't want to skip those steps
550 * or we've defeated any purpose in running the command.
552 if (!opts->new_branch)
556 * new_branch_force is defined to "create/reset and checkout a branch"
557 * so needs to go through the merge to do the reset
559 if (opts->new_branch_force)
563 * A new orphaned branch requrires the index and the working tree to be
564 * adjusted to <start_point>
566 if (opts->new_orphan_branch)
570 * Remaining variables are not checkout options but used to track state
576 static int merge_working_tree(const struct checkout_opts *opts,
577 struct branch_info *old_branch_info,
578 struct branch_info *new_branch_info,
582 struct lock_file lock_file = LOCK_INIT;
584 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
585 if (read_cache_preload(NULL) < 0)
586 return error(_("index file corrupt"));
588 resolve_undo_clear();
590 ret = reset_tree(get_commit_tree(new_branch_info->commit),
591 opts, 1, writeout_error);
595 struct tree_desc trees[2];
597 struct unpack_trees_options topts;
599 memset(&topts, 0, sizeof(topts));
601 topts.src_index = &the_index;
602 topts.dst_index = &the_index;
604 setup_unpack_trees_porcelain(&topts, "checkout");
606 refresh_cache(REFRESH_QUIET);
608 if (unmerged_cache()) {
609 error(_("you need to resolve your current index first"));
613 /* 2-way merge to the new branch */
614 topts.initial_checkout = is_cache_unborn();
617 topts.gently = opts->merge && old_branch_info->commit;
618 topts.verbose_update = opts->show_progress;
619 topts.fn = twoway_merge;
620 if (opts->overwrite_ignore) {
621 topts.dir = xcalloc(1, sizeof(*topts.dir));
622 topts.dir->flags |= DIR_SHOW_IGNORED;
623 setup_standard_excludes(topts.dir);
625 tree = parse_tree_indirect(old_branch_info->commit ?
626 &old_branch_info->commit->object.oid :
627 the_hash_algo->empty_tree);
628 init_tree_desc(&trees[0], tree->buffer, tree->size);
629 tree = parse_tree_indirect(&new_branch_info->commit->object.oid);
630 init_tree_desc(&trees[1], tree->buffer, tree->size);
632 ret = unpack_trees(2, trees, &topts);
633 clear_unpack_trees_porcelain(&topts);
636 * Unpack couldn't do a trivial merge; either
637 * give up or do a real merge, depending on
638 * whether the merge flag was used.
642 struct merge_options o;
647 * Without old_branch_info->commit, the below is the same as
648 * the two-tree unpack we already tried and failed.
650 if (!old_branch_info->commit)
653 /* Do more real merge */
656 * We update the index fully, then write the
657 * tree from the index, then merge the new
658 * branch with the current tree, with the old
659 * branch as the base. Then we reset the index
660 * (but not the working tree) to the new
661 * branch, leaving the working tree as the
662 * merged version, but skipping unmerged
663 * entries in the index.
666 add_files_to_cache(NULL, NULL, 0);
668 * NEEDSWORK: carrying over local changes
669 * when branches have different end-of-line
670 * normalization (or clean+smudge rules) is
671 * a pain; plumb in an option to set
674 init_merge_options(&o);
676 work = write_tree_from_memory(&o);
678 ret = reset_tree(get_commit_tree(new_branch_info->commit),
683 o.ancestor = old_branch_info->name;
684 o.branch1 = new_branch_info->name;
686 ret = merge_trees(&o,
687 get_commit_tree(new_branch_info->commit),
689 get_commit_tree(old_branch_info->commit),
693 ret = reset_tree(get_commit_tree(new_branch_info->commit),
696 strbuf_release(&o.obuf);
702 if (!active_cache_tree)
703 active_cache_tree = cache_tree();
705 if (!cache_tree_fully_valid(active_cache_tree))
706 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
708 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
709 die(_("unable to write new index file"));
711 if (!opts->force && !opts->quiet)
712 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
717 static void report_tracking(struct branch_info *new_branch_info)
719 struct strbuf sb = STRBUF_INIT;
720 struct branch *branch = branch_get(new_branch_info->name);
722 if (!format_tracking_info(branch, &sb, AHEAD_BEHIND_FULL))
724 fputs(sb.buf, stdout);
728 static void update_refs_for_switch(const struct checkout_opts *opts,
729 struct branch_info *old_branch_info,
730 struct branch_info *new_branch_info)
732 struct strbuf msg = STRBUF_INIT;
733 const char *old_desc, *reflog_msg;
734 if (opts->new_branch) {
735 if (opts->new_orphan_branch) {
738 refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
739 if (opts->new_branch_log &&
740 !should_autocreate_reflog(refname)) {
742 struct strbuf err = STRBUF_INIT;
744 ret = safe_create_reflog(refname, 1, &err);
746 fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
747 opts->new_orphan_branch, err.buf);
748 strbuf_release(&err);
752 strbuf_release(&err);
757 create_branch(the_repository,
758 opts->new_branch, new_branch_info->name,
759 opts->new_branch_force ? 1 : 0,
760 opts->new_branch_force ? 1 : 0,
761 opts->new_branch_log,
764 new_branch_info->name = opts->new_branch;
765 setup_branch_path(new_branch_info);
768 old_desc = old_branch_info->name;
769 if (!old_desc && old_branch_info->commit)
770 old_desc = oid_to_hex(&old_branch_info->commit->object.oid);
772 reflog_msg = getenv("GIT_REFLOG_ACTION");
774 strbuf_addf(&msg, "checkout: moving from %s to %s",
775 old_desc ? old_desc : "(invalid)", new_branch_info->name);
777 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
779 if (!strcmp(new_branch_info->name, "HEAD") && !new_branch_info->path && !opts->force_detach) {
781 } else if (opts->force_detach || !new_branch_info->path) { /* No longer on any branch. */
782 update_ref(msg.buf, "HEAD", &new_branch_info->commit->object.oid, NULL,
783 REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
785 if (old_branch_info->path &&
786 advice_detached_head && !opts->force_detach)
787 detach_advice(new_branch_info->name);
788 describe_detached_head(_("HEAD is now at"), new_branch_info->commit);
790 } else if (new_branch_info->path) { /* Switch branches. */
791 if (create_symref("HEAD", new_branch_info->path, msg.buf) < 0)
792 die(_("unable to update HEAD"));
794 if (old_branch_info->path && !strcmp(new_branch_info->path, old_branch_info->path)) {
795 if (opts->new_branch_force)
796 fprintf(stderr, _("Reset branch '%s'\n"),
797 new_branch_info->name);
799 fprintf(stderr, _("Already on '%s'\n"),
800 new_branch_info->name);
801 } else if (opts->new_branch) {
802 if (opts->branch_exists)
803 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
805 fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
807 fprintf(stderr, _("Switched to branch '%s'\n"),
808 new_branch_info->name);
811 if (old_branch_info->path && old_branch_info->name) {
812 if (!ref_exists(old_branch_info->path) && reflog_exists(old_branch_info->path))
813 delete_reflog(old_branch_info->path);
816 remove_branch_state(the_repository);
817 strbuf_release(&msg);
819 (new_branch_info->path || (!opts->force_detach && !strcmp(new_branch_info->name, "HEAD"))))
820 report_tracking(new_branch_info);
823 static int add_pending_uninteresting_ref(const char *refname,
824 const struct object_id *oid,
825 int flags, void *cb_data)
827 add_pending_oid(cb_data, refname, oid, UNINTERESTING);
831 static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
833 strbuf_addstr(sb, " ");
834 strbuf_add_unique_abbrev(sb, &commit->object.oid, DEFAULT_ABBREV);
835 strbuf_addch(sb, ' ');
836 if (!parse_commit(commit))
837 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
838 strbuf_addch(sb, '\n');
841 #define ORPHAN_CUTOFF 4
842 static void suggest_reattach(struct commit *commit, struct rev_info *revs)
844 struct commit *c, *last = NULL;
845 struct strbuf sb = STRBUF_INIT;
847 while ((c = get_revision(revs)) != NULL) {
848 if (lost < ORPHAN_CUTOFF)
849 describe_one_orphan(&sb, c);
853 if (ORPHAN_CUTOFF < lost) {
854 int more = lost - ORPHAN_CUTOFF;
856 describe_one_orphan(&sb, last);
858 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
863 /* The singular version */
864 "Warning: you are leaving %d commit behind, "
866 "any of your branches:\n\n"
868 /* The plural version */
869 "Warning: you are leaving %d commits behind, "
871 "any of your branches:\n\n"
873 /* Give ngettext() the count */
879 if (advice_detached_head)
882 /* The singular version */
883 "If you want to keep it by creating a new branch, "
884 "this may be a good time\nto do so with:\n\n"
885 " git branch <new-branch-name> %s\n\n",
886 /* The plural version */
887 "If you want to keep them by creating a new branch, "
888 "this may be a good time\nto do so with:\n\n"
889 " git branch <new-branch-name> %s\n\n",
890 /* Give ngettext() the count */
892 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
896 * We are about to leave commit that was at the tip of a detached
897 * HEAD. If it is not reachable from any ref, this is the last chance
898 * for the user to do so without resorting to reflog.
900 static void orphaned_commit_warning(struct commit *old_commit, struct commit *new_commit)
902 struct rev_info revs;
903 struct object *object = &old_commit->object;
905 repo_init_revisions(the_repository, &revs, NULL);
906 setup_revisions(0, NULL, &revs, NULL);
908 object->flags &= ~UNINTERESTING;
909 add_pending_object(&revs, object, oid_to_hex(&object->oid));
911 for_each_ref(add_pending_uninteresting_ref, &revs);
912 add_pending_oid(&revs, "HEAD", &new_commit->object.oid, UNINTERESTING);
914 if (prepare_revision_walk(&revs))
915 die(_("internal error in revision walk"));
916 if (!(old_commit->object.flags & UNINTERESTING))
917 suggest_reattach(old_commit, &revs);
919 describe_detached_head(_("Previous HEAD position was"), old_commit);
921 /* Clean up objects used, as they will be reused. */
922 clear_commit_marks_all(ALL_REV_FLAGS);
925 static int switch_branches(const struct checkout_opts *opts,
926 struct branch_info *new_branch_info)
929 struct branch_info old_branch_info;
931 struct object_id rev;
932 int flag, writeout_error = 0;
933 memset(&old_branch_info, 0, sizeof(old_branch_info));
934 old_branch_info.path = path_to_free = resolve_refdup("HEAD", 0, &rev, &flag);
935 if (old_branch_info.path)
936 old_branch_info.commit = lookup_commit_reference_gently(the_repository, &rev, 1);
937 if (!(flag & REF_ISSYMREF))
938 old_branch_info.path = NULL;
940 if (old_branch_info.path)
941 skip_prefix(old_branch_info.path, "refs/heads/", &old_branch_info.name);
943 if (!new_branch_info->name) {
944 new_branch_info->name = "HEAD";
945 new_branch_info->commit = old_branch_info.commit;
946 if (!new_branch_info->commit)
947 die(_("You are on a branch yet to be born"));
948 parse_commit_or_die(new_branch_info->commit);
951 /* optimize the "checkout -b <new_branch> path */
952 if (skip_merge_working_tree(opts, &old_branch_info, new_branch_info)) {
953 if (!checkout_optimize_new_branch && !opts->quiet) {
954 if (read_cache_preload(NULL) < 0)
955 return error(_("index file corrupt"));
956 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
959 ret = merge_working_tree(opts, &old_branch_info, new_branch_info, &writeout_error);
966 if (!opts->quiet && !old_branch_info.path && old_branch_info.commit && new_branch_info->commit != old_branch_info.commit)
967 orphaned_commit_warning(old_branch_info.commit, new_branch_info->commit);
969 update_refs_for_switch(opts, &old_branch_info, new_branch_info);
971 ret = post_checkout_hook(old_branch_info.commit, new_branch_info->commit, 1);
973 return ret || writeout_error;
976 static int git_checkout_config(const char *var, const char *value, void *cb)
978 if (!strcmp(var, "checkout.optimizenewbranch")) {
979 checkout_optimize_new_branch = git_config_bool(var, value);
983 if (!strcmp(var, "diff.ignoresubmodules")) {
984 struct checkout_opts *opts = cb;
985 handle_ignore_submodules_arg(&opts->diff_options, value);
989 if (starts_with(var, "submodule."))
990 return git_default_submodule_config(var, value, NULL);
992 return git_xmerge_config(var, value, NULL);
995 static int parse_branchname_arg(int argc, const char **argv,
996 int dwim_new_local_branch_ok,
997 struct branch_info *new_branch_info,
998 struct checkout_opts *opts,
999 struct object_id *rev,
1000 int *dwim_remotes_matched)
1002 struct tree **source_tree = &opts->source_tree;
1003 const char **new_branch = &opts->new_branch;
1005 struct object_id branch_rev;
1008 int has_dash_dash = 0;
1012 * case 1: git checkout <ref> -- [<paths>]
1014 * <ref> must be a valid tree, everything after the '--' must be
1017 * case 2: git checkout -- [<paths>]
1019 * everything after the '--' must be paths.
1021 * case 3: git checkout <something> [--]
1023 * (a) If <something> is a commit, that is to
1024 * switch to the branch or detach HEAD at it. As a special case,
1025 * if <something> is A...B (missing A or B means HEAD but you can
1026 * omit at most one side), and if there is a unique merge base
1027 * between A and B, A...B names that merge base.
1029 * (b) If <something> is _not_ a commit, either "--" is present
1030 * or <something> is not a path, no -t or -b was given, and
1031 * and there is a tracking branch whose name is <something>
1032 * in one and only one remote (or if the branch exists on the
1033 * remote named in checkout.defaultRemote), then this is a
1034 * short-hand to fork local <something> from that
1035 * remote-tracking branch.
1037 * (c) Otherwise, if "--" is present, treat it like case (1).
1040 * - if it's a reference, treat it like case (1)
1041 * - else if it's a path, treat it like case (2)
1044 * case 4: git checkout <something> <paths>
1046 * The first argument must not be ambiguous.
1047 * - If it's *only* a reference, treat it like case (1).
1048 * - If it's only a path, treat it like case (2).
1057 for (i = 0; i < argc; i++) {
1058 if (!strcmp(argv[i], "--")) {
1063 if (dash_dash_pos == 0)
1064 return 1; /* case (2) */
1065 else if (dash_dash_pos == 1)
1066 has_dash_dash = 1; /* case (3) or (1) */
1067 else if (dash_dash_pos >= 2)
1068 die(_("only one reference expected, %d given."), dash_dash_pos);
1070 if (!strcmp(arg, "-"))
1073 if (get_oid_mb(arg, rev)) {
1075 * Either case (3) or (4), with <something> not being
1076 * a commit, or an attempt to use case (1) with an
1079 * It's likely an error, but we need to find out if
1080 * we should auto-create the branch, case (3).(b).
1082 int recover_with_dwim = dwim_new_local_branch_ok;
1084 int could_be_checkout_paths = !has_dash_dash &&
1085 check_filename(opts->prefix, arg);
1087 if (!has_dash_dash && !no_wildcard(arg))
1088 recover_with_dwim = 0;
1091 * Accept "git checkout foo" and "git checkout foo --"
1092 * as candidates for dwim.
1094 if (!(argc == 1 && !has_dash_dash) &&
1095 !(argc == 2 && has_dash_dash))
1096 recover_with_dwim = 0;
1098 if (recover_with_dwim) {
1099 const char *remote = unique_tracking_name(arg, rev,
1100 dwim_remotes_matched);
1102 if (could_be_checkout_paths)
1103 die(_("'%s' could be both a local file and a tracking branch.\n"
1104 "Please use -- (and optionally --no-guess) to disambiguate"),
1108 /* DWIMmed to create local branch, case (3).(b) */
1110 recover_with_dwim = 0;
1114 if (!recover_with_dwim) {
1116 die(_("invalid reference: %s"), arg);
1121 /* we can't end up being in (2) anymore, eat the argument */
1126 new_branch_info->name = arg;
1127 setup_branch_path(new_branch_info);
1129 if (!check_refname_format(new_branch_info->path, 0) &&
1130 !read_ref(new_branch_info->path, &branch_rev))
1131 oidcpy(rev, &branch_rev);
1133 new_branch_info->path = NULL; /* not an existing branch */
1135 new_branch_info->commit = lookup_commit_reference_gently(the_repository, rev, 1);
1136 if (!new_branch_info->commit) {
1138 *source_tree = parse_tree_indirect(rev);
1140 parse_commit_or_die(new_branch_info->commit);
1141 *source_tree = get_commit_tree(new_branch_info->commit);
1144 if (!*source_tree) /* case (1): want a tree */
1145 die(_("reference is not a tree: %s"), arg);
1146 if (!has_dash_dash) { /* case (3).(d) -> (1) */
1148 * Do not complain the most common case
1149 * git checkout branch
1150 * even if there happen to be a file called 'branch';
1151 * it would be extremely annoying.
1154 verify_non_filename(opts->prefix, arg);
1164 static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
1167 struct strbuf branch_ref = STRBUF_INIT;
1169 if (!opts->new_branch)
1170 die(_("You are on a branch yet to be born"));
1171 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1172 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1173 strbuf_release(&branch_ref);
1175 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1180 static int checkout_branch(struct checkout_opts *opts,
1181 struct branch_info *new_branch_info)
1183 if (opts->pathspec.nr)
1184 die(_("paths cannot be used with switching branches"));
1186 if (opts->patch_mode)
1187 die(_("'%s' cannot be used with switching branches"),
1190 if (opts->writeout_stage)
1191 die(_("'%s' cannot be used with switching branches"),
1194 if (opts->force && opts->merge)
1195 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1197 if (opts->force_detach && opts->new_branch)
1198 die(_("'%s' cannot be used with '%s'"),
1199 "--detach", "-b/-B/--orphan");
1201 if (opts->new_orphan_branch) {
1202 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1203 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1204 } else if (opts->force_detach) {
1205 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1206 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1207 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1208 opts->track = git_branch_track;
1210 if (new_branch_info->name && !new_branch_info->commit)
1211 die(_("Cannot switch branch to a non-commit '%s'"),
1212 new_branch_info->name);
1214 if (new_branch_info->path && !opts->force_detach && !opts->new_branch &&
1215 !opts->ignore_other_worktrees) {
1217 char *head_ref = resolve_refdup("HEAD", 0, NULL, &flag);
1219 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new_branch_info->path)))
1220 die_if_checked_out(new_branch_info->path, 1);
1224 if (!new_branch_info->commit && opts->new_branch) {
1225 struct object_id rev;
1228 if (!read_ref_full("HEAD", 0, &rev, &flag) &&
1229 (flag & REF_ISSYMREF) && is_null_oid(&rev))
1230 return switch_unborn_to_new_branch(opts);
1232 return switch_branches(opts, new_branch_info);
1235 int cmd_checkout(int argc, const char **argv, const char *prefix)
1237 struct checkout_opts opts;
1238 struct branch_info new_branch_info;
1239 char *conflict_style = NULL;
1240 int dwim_new_local_branch, no_dwim_new_local_branch = 0;
1241 int dwim_remotes_matched = 0;
1242 struct option options[] = {
1243 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
1244 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1245 N_("create and checkout a new branch")),
1246 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1247 N_("create/reset and checkout a branch")),
1248 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
1249 OPT_BOOL(0, "detach", &opts.force_detach, N_("detach HEAD at named commit")),
1250 OPT_SET_INT('t', "track", &opts.track, N_("set upstream info for new branch"),
1251 BRANCH_TRACK_EXPLICIT),
1252 OPT_STRING(0, "orphan", &opts.new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
1253 OPT_SET_INT_F('2', "ours", &opts.writeout_stage,
1254 N_("checkout our version for unmerged files"),
1255 2, PARSE_OPT_NONEG),
1256 OPT_SET_INT_F('3', "theirs", &opts.writeout_stage,
1257 N_("checkout their version for unmerged files"),
1258 3, PARSE_OPT_NONEG),
1259 OPT__FORCE(&opts.force, N_("force checkout (throw away local modifications)"),
1260 PARSE_OPT_NOCOMPLETE),
1261 OPT_BOOL('m', "merge", &opts.merge, N_("perform a 3-way merge with the new branch")),
1262 OPT_BOOL_F(0, "overwrite-ignore", &opts.overwrite_ignore,
1263 N_("update ignored files (default)"),
1264 PARSE_OPT_NOCOMPLETE),
1265 OPT_STRING(0, "conflict", &conflict_style, N_("style"),
1266 N_("conflict style (merge or diff3)")),
1267 OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
1268 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
1269 N_("do not limit pathspecs to sparse entries only")),
1270 OPT_BOOL(0, "no-guess", &no_dwim_new_local_branch,
1271 N_("do not second guess 'git checkout <no-such-branch>'")),
1272 OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
1273 N_("do not check if another worktree is holding the given ref")),
1274 { OPTION_CALLBACK, 0, "recurse-submodules", NULL,
1275 "checkout", "control recursive updating of submodules",
1276 PARSE_OPT_OPTARG, option_parse_recurse_submodules_worktree_updater },
1277 OPT_BOOL(0, "progress", &opts.show_progress, N_("force progress reporting")),
1281 memset(&opts, 0, sizeof(opts));
1282 memset(&new_branch_info, 0, sizeof(new_branch_info));
1283 opts.overwrite_ignore = 1;
1284 opts.prefix = prefix;
1285 opts.show_progress = -1;
1287 git_config(git_checkout_config, &opts);
1289 opts.track = BRANCH_TRACK_UNSPECIFIED;
1291 argc = parse_options(argc, argv, prefix, options, checkout_usage,
1292 PARSE_OPT_KEEP_DASHDASH);
1294 dwim_new_local_branch = !no_dwim_new_local_branch;
1295 if (opts.show_progress < 0) {
1297 opts.show_progress = 0;
1299 opts.show_progress = isatty(2);
1302 if (conflict_style) {
1303 opts.merge = 1; /* implied */
1304 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1307 if ((!!opts.new_branch + !!opts.new_branch_force + !!opts.new_orphan_branch) > 1)
1308 die(_("-b, -B and --orphan are mutually exclusive"));
1311 * From here on, new_branch will contain the branch to be checked out,
1312 * and new_branch_force and new_orphan_branch will tell us which one of
1313 * -b/-B/--orphan is being used.
1315 if (opts.new_branch_force)
1316 opts.new_branch = opts.new_branch_force;
1318 if (opts.new_orphan_branch)
1319 opts.new_branch = opts.new_orphan_branch;
1321 /* --track without -b/-B/--orphan should DWIM */
1322 if (opts.track != BRANCH_TRACK_UNSPECIFIED && !opts.new_branch) {
1323 const char *argv0 = argv[0];
1324 if (!argc || !strcmp(argv0, "--"))
1325 die(_("--track needs a branch name"));
1326 skip_prefix(argv0, "refs/", &argv0);
1327 skip_prefix(argv0, "remotes/", &argv0);
1328 argv0 = strchr(argv0, '/');
1329 if (!argv0 || !argv0[1])
1330 die(_("missing branch name; try -b"));
1331 opts.new_branch = argv0 + 1;
1335 * Extract branch name from command line arguments, so
1336 * all that is left is pathspecs.
1340 * 1) git checkout <tree> -- [<paths>]
1341 * 2) git checkout -- [<paths>]
1342 * 3) git checkout <something> [<paths>]
1344 * including "last branch" syntax and DWIM-ery for names of
1345 * remote branches, erroring out for invalid or ambiguous cases.
1348 struct object_id rev;
1351 dwim_new_local_branch &&
1352 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1354 int n = parse_branchname_arg(argc, argv, dwim_ok,
1355 &new_branch_info, &opts, &rev,
1356 &dwim_remotes_matched);
1362 parse_pathspec(&opts.pathspec, 0,
1363 opts.patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1366 if (!opts.pathspec.nr)
1367 die(_("invalid path specification"));
1370 * Try to give more helpful suggestion.
1371 * new_branch && argc > 1 will be caught later.
1373 if (opts.new_branch && argc == 1)
1374 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1375 argv[0], opts.new_branch);
1377 if (opts.force_detach)
1378 die(_("git checkout: --detach does not take a path argument '%s'"),
1381 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
1382 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1383 "checking out of the index."));
1386 if (opts.new_branch) {
1387 struct strbuf buf = STRBUF_INIT;
1389 if (opts.new_branch_force)
1390 opts.branch_exists = validate_branchname(opts.new_branch, &buf);
1392 opts.branch_exists =
1393 validate_new_branchname(opts.new_branch, &buf, 0);
1394 strbuf_release(&buf);
1398 if (opts.patch_mode || opts.pathspec.nr) {
1399 int ret = checkout_paths(&opts, new_branch_info.name);
1400 if (ret && dwim_remotes_matched > 1 &&
1401 advice_checkout_ambiguous_remote_branch_name)
1402 advise(_("'%s' matched more than one remote tracking branch.\n"
1403 "We found %d remotes with a reference that matched. So we fell back\n"
1404 "on trying to resolve the argument as a path, but failed there too!\n"
1406 "If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1407 "you can do so by fully qualifying the name with the --track option:\n"
1409 " git checkout --track origin/<name>\n"
1411 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1412 "one remote, e.g. the 'origin' remote, consider setting\n"
1413 "checkout.defaultRemote=origin in your config."),
1415 dwim_remotes_matched);
1418 return checkout_branch(&opts, &new_branch_info);