Merge branch 'ml/doc-merge-updates' into maint-2.43
[alt-git.git] / builtin / checkout.c
blob369e9cd3d82338a623ed926b02037869f3958123
1 #define USE_THE_INDEX_VARIABLE
2 #include "builtin.h"
3 #include "advice.h"
4 #include "blob.h"
5 #include "branch.h"
6 #include "cache-tree.h"
7 #include "checkout.h"
8 #include "commit.h"
9 #include "config.h"
10 #include "diff.h"
11 #include "dir.h"
12 #include "environment.h"
13 #include "gettext.h"
14 #include "hex.h"
15 #include "hook.h"
16 #include "merge-ll.h"
17 #include "lockfile.h"
18 #include "mem-pool.h"
19 #include "merge-recursive.h"
20 #include "object-name.h"
21 #include "object-store-ll.h"
22 #include "parse-options.h"
23 #include "path.h"
24 #include "preload-index.h"
25 #include "read-cache.h"
26 #include "refs.h"
27 #include "remote.h"
28 #include "resolve-undo.h"
29 #include "revision.h"
30 #include "run-command.h"
31 #include "setup.h"
32 #include "submodule.h"
33 #include "submodule-config.h"
34 #include "symlinks.h"
35 #include "trace2.h"
36 #include "tree.h"
37 #include "tree-walk.h"
38 #include "unpack-trees.h"
39 #include "wt-status.h"
40 #include "xdiff-interface.h"
41 #include "entry.h"
42 #include "parallel-checkout.h"
43 #include "add-interactive.h"
45 static const char * const checkout_usage[] = {
46 N_("git checkout [<options>] <branch>"),
47 N_("git checkout [<options>] [<branch>] -- <file>..."),
48 NULL,
51 static const char * const switch_branch_usage[] = {
52 N_("git switch [<options>] [<branch>]"),
53 NULL,
56 static const char * const restore_usage[] = {
57 N_("git restore [<options>] [--source=<branch>] <file>..."),
58 NULL,
61 struct checkout_opts {
62 int patch_mode;
63 int quiet;
64 int merge;
65 int force;
66 int force_detach;
67 int implicit_detach;
68 int writeout_stage;
69 int overwrite_ignore;
70 int ignore_skipworktree;
71 int ignore_other_worktrees;
72 int show_progress;
73 int count_checkout_paths;
74 int overlay_mode;
75 int dwim_new_local_branch;
76 int discard_changes;
77 int accept_ref;
78 int accept_pathspec;
79 int switch_branch_doing_nothing_is_ok;
80 int only_merge_on_switching_branches;
81 int can_switch_when_in_progress;
82 int orphan_from_empty_tree;
83 int empty_pathspec_ok;
84 int checkout_index;
85 int checkout_worktree;
86 const char *ignore_unmerged_opt;
87 int ignore_unmerged;
88 int pathspec_file_nul;
89 char *pathspec_from_file;
91 const char *new_branch;
92 const char *new_branch_force;
93 const char *new_orphan_branch;
94 int new_branch_log;
95 enum branch_track track;
96 struct diff_options diff_options;
97 char *conflict_style;
99 int branch_exists;
100 const char *prefix;
101 struct pathspec pathspec;
102 const char *from_treeish;
103 struct tree *source_tree;
106 struct branch_info {
107 char *name; /* The short name used */
108 char *path; /* The full name of a real branch */
109 struct commit *commit; /* The named commit */
110 char *refname; /* The full name of the ref being checked out. */
111 struct object_id oid; /* The object ID of the commit being checked out. */
113 * if not null the branch is detached because it's already
114 * checked out in this checkout
116 char *checkout;
119 static void branch_info_release(struct branch_info *info)
121 free(info->name);
122 free(info->path);
123 free(info->refname);
124 free(info->checkout);
127 static int post_checkout_hook(struct commit *old_commit, struct commit *new_commit,
128 int changed)
130 return run_hooks_l("post-checkout",
131 oid_to_hex(old_commit ? &old_commit->object.oid : null_oid()),
132 oid_to_hex(new_commit ? &new_commit->object.oid : null_oid()),
133 changed ? "1" : "0", NULL);
134 /* "new_commit" can be NULL when checking out from the index before
135 a commit exists. */
139 static int update_some(const struct object_id *oid, struct strbuf *base,
140 const char *pathname, unsigned mode, void *context UNUSED)
142 int len;
143 struct cache_entry *ce;
144 int pos;
146 if (S_ISDIR(mode))
147 return READ_TREE_RECURSIVE;
149 len = base->len + strlen(pathname);
150 ce = make_empty_cache_entry(&the_index, len);
151 oidcpy(&ce->oid, oid);
152 memcpy(ce->name, base->buf, base->len);
153 memcpy(ce->name + base->len, pathname, len - base->len);
154 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
155 ce->ce_namelen = len;
156 ce->ce_mode = create_ce_mode(mode);
159 * If the entry is the same as the current index, we can leave the old
160 * entry in place. Whether it is UPTODATE or not, checkout_entry will
161 * do the right thing.
163 pos = index_name_pos(&the_index, ce->name, ce->ce_namelen);
164 if (pos >= 0) {
165 struct cache_entry *old = the_index.cache[pos];
166 if (ce->ce_mode == old->ce_mode &&
167 !ce_intent_to_add(old) &&
168 oideq(&ce->oid, &old->oid)) {
169 old->ce_flags |= CE_UPDATE;
170 discard_cache_entry(ce);
171 return 0;
175 add_index_entry(&the_index, ce,
176 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
177 return 0;
180 static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
182 read_tree(the_repository, tree,
183 pathspec, update_some, NULL);
185 /* update the index with the given tree's info
186 * for all args, expanding wildcards, and exit
187 * with any non-zero return code.
189 return 0;
192 static int skip_same_name(const struct cache_entry *ce, int pos)
194 while (++pos < the_index.cache_nr &&
195 !strcmp(the_index.cache[pos]->name, ce->name))
196 ; /* skip */
197 return pos;
200 static int check_stage(int stage, const struct cache_entry *ce, int pos,
201 int overlay_mode)
203 while (pos < the_index.cache_nr &&
204 !strcmp(the_index.cache[pos]->name, ce->name)) {
205 if (ce_stage(the_index.cache[pos]) == stage)
206 return 0;
207 pos++;
209 if (!overlay_mode)
210 return 0;
211 if (stage == 2)
212 return error(_("path '%s' does not have our version"), ce->name);
213 else
214 return error(_("path '%s' does not have their version"), ce->name);
217 static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
219 unsigned seen = 0;
220 const char *name = ce->name;
222 while (pos < the_index.cache_nr) {
223 ce = the_index.cache[pos];
224 if (strcmp(name, ce->name))
225 break;
226 seen |= (1 << ce_stage(ce));
227 pos++;
229 if ((stages & seen) != stages)
230 return error(_("path '%s' does not have all necessary versions"),
231 name);
232 return 0;
235 static int checkout_stage(int stage, const struct cache_entry *ce, int pos,
236 const struct checkout *state, int *nr_checkouts,
237 int overlay_mode)
239 while (pos < the_index.cache_nr &&
240 !strcmp(the_index.cache[pos]->name, ce->name)) {
241 if (ce_stage(the_index.cache[pos]) == stage)
242 return checkout_entry(the_index.cache[pos], state,
243 NULL, nr_checkouts);
244 pos++;
246 if (!overlay_mode) {
247 unlink_entry(ce, NULL);
248 return 0;
250 if (stage == 2)
251 return error(_("path '%s' does not have our version"), ce->name);
252 else
253 return error(_("path '%s' does not have their version"), ce->name);
256 static int checkout_merged(int pos, const struct checkout *state,
257 int *nr_checkouts, struct mem_pool *ce_mem_pool)
259 struct cache_entry *ce = the_index.cache[pos];
260 const char *path = ce->name;
261 mmfile_t ancestor, ours, theirs;
262 enum ll_merge_result merge_status;
263 int status;
264 struct object_id oid;
265 mmbuffer_t result_buf;
266 struct object_id threeway[3];
267 unsigned mode = 0;
268 struct ll_merge_options ll_opts;
269 int renormalize = 0;
271 memset(threeway, 0, sizeof(threeway));
272 while (pos < the_index.cache_nr) {
273 int stage;
274 stage = ce_stage(ce);
275 if (!stage || strcmp(path, ce->name))
276 break;
277 oidcpy(&threeway[stage - 1], &ce->oid);
278 if (stage == 2)
279 mode = create_ce_mode(ce->ce_mode);
280 pos++;
281 ce = the_index.cache[pos];
283 if (is_null_oid(&threeway[1]) || is_null_oid(&threeway[2]))
284 return error(_("path '%s' does not have necessary versions"), path);
286 read_mmblob(&ancestor, &threeway[0]);
287 read_mmblob(&ours, &threeway[1]);
288 read_mmblob(&theirs, &threeway[2]);
290 memset(&ll_opts, 0, sizeof(ll_opts));
291 git_config_get_bool("merge.renormalize", &renormalize);
292 ll_opts.renormalize = renormalize;
293 merge_status = ll_merge(&result_buf, path, &ancestor, "base",
294 &ours, "ours", &theirs, "theirs",
295 state->istate, &ll_opts);
296 free(ancestor.ptr);
297 free(ours.ptr);
298 free(theirs.ptr);
299 if (merge_status == LL_MERGE_BINARY_CONFLICT)
300 warning("Cannot merge binary files: %s (%s vs. %s)",
301 path, "ours", "theirs");
302 if (merge_status < 0 || !result_buf.ptr) {
303 free(result_buf.ptr);
304 return error(_("path '%s': cannot merge"), path);
308 * NEEDSWORK:
309 * There is absolutely no reason to write this as a blob object
310 * and create a phony cache entry. This hack is primarily to get
311 * to the write_entry() machinery that massages the contents to
312 * work-tree format and writes out which only allows it for a
313 * cache entry. The code in write_entry() needs to be refactored
314 * to allow us to feed a <buffer, size, mode> instead of a cache
315 * entry. Such a refactoring would help merge_recursive as well
316 * (it also writes the merge result to the object database even
317 * when it may contain conflicts).
319 if (write_object_file(result_buf.ptr, result_buf.size, OBJ_BLOB, &oid))
320 die(_("Unable to add merge result for '%s'"), path);
321 free(result_buf.ptr);
322 ce = make_transient_cache_entry(mode, &oid, path, 2, ce_mem_pool);
323 if (!ce)
324 die(_("make_cache_entry failed for path '%s'"), path);
325 status = checkout_entry(ce, state, NULL, nr_checkouts);
326 return status;
329 static void mark_ce_for_checkout_overlay(struct cache_entry *ce,
330 char *ps_matched,
331 const struct checkout_opts *opts)
333 ce->ce_flags &= ~CE_MATCHED;
334 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
335 return;
336 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
338 * "git checkout tree-ish -- path", but this entry
339 * is in the original index but is not in tree-ish
340 * or does not match the pathspec; it will not be
341 * checked out to the working tree. We will not do
342 * anything to this entry at all.
344 return;
346 * Either this entry came from the tree-ish we are
347 * checking the paths out of, or we are checking out
348 * of the index.
350 * If it comes from the tree-ish, we already know it
351 * matches the pathspec and could just stamp
352 * CE_MATCHED to it from update_some(). But we still
353 * need ps_matched and read_tree (and
354 * eventually tree_entry_interesting) cannot fill
355 * ps_matched yet. Once it can, we can avoid calling
356 * match_pathspec() for _all_ entries when
357 * opts->source_tree != NULL.
359 if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched))
360 ce->ce_flags |= CE_MATCHED;
363 static void mark_ce_for_checkout_no_overlay(struct cache_entry *ce,
364 char *ps_matched,
365 const struct checkout_opts *opts)
367 ce->ce_flags &= ~CE_MATCHED;
368 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
369 return;
370 if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched)) {
371 ce->ce_flags |= CE_MATCHED;
372 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
374 * In overlay mode, but the path is not in
375 * tree-ish, which means we should remove it
376 * from the index and the working tree.
378 ce->ce_flags |= CE_REMOVE | CE_WT_REMOVE;
382 static int checkout_worktree(const struct checkout_opts *opts,
383 const struct branch_info *info)
385 struct checkout state = CHECKOUT_INIT;
386 int nr_checkouts = 0, nr_unmerged = 0;
387 int errs = 0;
388 int pos;
389 int pc_workers, pc_threshold;
390 struct mem_pool ce_mem_pool;
392 state.force = 1;
393 state.refresh_cache = 1;
394 state.istate = &the_index;
396 mem_pool_init(&ce_mem_pool, 0);
397 get_parallel_checkout_configs(&pc_workers, &pc_threshold);
398 init_checkout_metadata(&state.meta, info->refname,
399 info->commit ? &info->commit->object.oid : &info->oid,
400 NULL);
402 enable_delayed_checkout(&state);
404 if (pc_workers > 1)
405 init_parallel_checkout();
407 for (pos = 0; pos < the_index.cache_nr; pos++) {
408 struct cache_entry *ce = the_index.cache[pos];
409 if (ce->ce_flags & CE_MATCHED) {
410 if (!ce_stage(ce)) {
411 errs |= checkout_entry(ce, &state,
412 NULL, &nr_checkouts);
413 continue;
415 if (opts->writeout_stage)
416 errs |= checkout_stage(opts->writeout_stage,
417 ce, pos,
418 &state,
419 &nr_checkouts, opts->overlay_mode);
420 else if (opts->merge)
421 errs |= checkout_merged(pos, &state,
422 &nr_unmerged,
423 &ce_mem_pool);
424 pos = skip_same_name(ce, pos) - 1;
427 if (pc_workers > 1)
428 errs |= run_parallel_checkout(&state, pc_workers, pc_threshold,
429 NULL, NULL);
430 mem_pool_discard(&ce_mem_pool, should_validate_cache_entries());
431 remove_marked_cache_entries(&the_index, 1);
432 remove_scheduled_dirs();
433 errs |= finish_delayed_checkout(&state, opts->show_progress);
435 if (opts->count_checkout_paths) {
436 if (nr_unmerged)
437 fprintf_ln(stderr, Q_("Recreated %d merge conflict",
438 "Recreated %d merge conflicts",
439 nr_unmerged),
440 nr_unmerged);
441 if (opts->source_tree)
442 fprintf_ln(stderr, Q_("Updated %d path from %s",
443 "Updated %d paths from %s",
444 nr_checkouts),
445 nr_checkouts,
446 repo_find_unique_abbrev(the_repository, &opts->source_tree->object.oid,
447 DEFAULT_ABBREV));
448 else if (!nr_unmerged || nr_checkouts)
449 fprintf_ln(stderr, Q_("Updated %d path from the index",
450 "Updated %d paths from the index",
451 nr_checkouts),
452 nr_checkouts);
455 return errs;
458 static int checkout_paths(const struct checkout_opts *opts,
459 const struct branch_info *new_branch_info)
461 int pos;
462 static char *ps_matched;
463 struct object_id rev;
464 struct commit *head;
465 int errs = 0;
466 struct lock_file lock_file = LOCK_INIT;
467 int checkout_index;
469 trace2_cmd_mode(opts->patch_mode ? "patch" : "path");
471 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
472 die(_("'%s' cannot be used with updating paths"), "--track");
474 if (opts->new_branch_log)
475 die(_("'%s' cannot be used with updating paths"), "-l");
477 if (opts->ignore_unmerged && opts->patch_mode)
478 die(_("'%s' cannot be used with updating paths"),
479 opts->ignore_unmerged_opt);
481 if (opts->force_detach)
482 die(_("'%s' cannot be used with updating paths"), "--detach");
484 if (opts->merge && opts->patch_mode)
485 die(_("options '%s' and '%s' cannot be used together"), "--merge", "--patch");
487 if (opts->ignore_unmerged && opts->merge)
488 die(_("options '%s' and '%s' cannot be used together"),
489 opts->ignore_unmerged_opt, "-m");
491 if (opts->new_branch)
492 die(_("Cannot update paths and switch to branch '%s' at the same time."),
493 opts->new_branch);
495 if (!opts->checkout_worktree && !opts->checkout_index)
496 die(_("neither '%s' or '%s' is specified"),
497 "--staged", "--worktree");
499 if (!opts->checkout_worktree && !opts->from_treeish)
500 die(_("'%s' must be used when '%s' is not specified"),
501 "--worktree", "--source");
504 * Reject --staged option to the restore command when combined with
505 * merge-related options. Use the accept_ref flag to distinguish it
506 * from the checkout command, which does not accept --staged anyway.
508 * `restore --ours|--theirs --worktree --staged` could mean resolving
509 * conflicted paths to one side in both the worktree and the index,
510 * but does not currently.
512 * `restore --merge|--conflict=<style>` already recreates conflicts
513 * in both the worktree and the index, so adding --staged would be
514 * meaningless.
516 if (!opts->accept_ref && opts->checkout_index) {
517 if (opts->writeout_stage)
518 die(_("'%s' or '%s' cannot be used with %s"),
519 "--ours", "--theirs", "--staged");
521 if (opts->merge)
522 die(_("'%s' or '%s' cannot be used with %s"),
523 "--merge", "--conflict", "--staged");
527 * recreating unmerged index entries and writing out data from
528 * unmerged index entries would make no sense when checking out
529 * of a tree-ish.
531 if ((opts->merge || opts->writeout_stage) && opts->source_tree)
532 die(_("'%s', '%s', or '%s' cannot be used when checking out of a tree"),
533 "--merge", "--ours", "--theirs");
535 if (opts->patch_mode) {
536 enum add_p_mode patch_mode;
537 const char *rev = new_branch_info->name;
538 char rev_oid[GIT_MAX_HEXSZ + 1];
541 * Since rev can be in the form of `<a>...<b>` (which is not
542 * recognized by diff-index), we will always replace the name
543 * with the hex of the commit (whether it's in `...` form or
544 * not) for the run_add_interactive() machinery to work
545 * properly. However, there is special logic for the HEAD case
546 * so we mustn't replace that. Also, when we were given a
547 * tree-object, new_branch_info->commit would be NULL, but we
548 * do not have to do any replacement, either.
550 if (rev && new_branch_info->commit && strcmp(rev, "HEAD"))
551 rev = oid_to_hex_r(rev_oid, &new_branch_info->commit->object.oid);
553 if (opts->checkout_index && opts->checkout_worktree)
554 patch_mode = ADD_P_CHECKOUT;
555 else if (opts->checkout_index && !opts->checkout_worktree)
556 patch_mode = ADD_P_RESET;
557 else if (!opts->checkout_index && opts->checkout_worktree)
558 patch_mode = ADD_P_WORKTREE;
559 else
560 BUG("either flag must have been set, worktree=%d, index=%d",
561 opts->checkout_worktree, opts->checkout_index);
562 return !!run_add_p(the_repository, patch_mode, rev,
563 &opts->pathspec);
566 repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
567 if (repo_read_index_preload(the_repository, &opts->pathspec, 0) < 0)
568 return error(_("index file corrupt"));
570 if (opts->source_tree)
571 read_tree_some(opts->source_tree, &opts->pathspec);
572 if (opts->merge)
573 unmerge_index(&the_index, &opts->pathspec, CE_MATCHED);
575 ps_matched = xcalloc(opts->pathspec.nr, 1);
578 * Make sure all pathspecs participated in locating the paths
579 * to be checked out.
581 for (pos = 0; pos < the_index.cache_nr; pos++)
582 if (opts->overlay_mode)
583 mark_ce_for_checkout_overlay(the_index.cache[pos],
584 ps_matched,
585 opts);
586 else
587 mark_ce_for_checkout_no_overlay(the_index.cache[pos],
588 ps_matched,
589 opts);
591 if (report_path_error(ps_matched, &opts->pathspec)) {
592 free(ps_matched);
593 return 1;
595 free(ps_matched);
597 /* Any unmerged paths? */
598 for (pos = 0; pos < the_index.cache_nr; pos++) {
599 const struct cache_entry *ce = the_index.cache[pos];
600 if (ce->ce_flags & CE_MATCHED) {
601 if (!ce_stage(ce))
602 continue;
603 if (opts->ignore_unmerged) {
604 if (!opts->quiet)
605 warning(_("path '%s' is unmerged"), ce->name);
606 } else if (opts->writeout_stage) {
607 errs |= check_stage(opts->writeout_stage, ce, pos, opts->overlay_mode);
608 } else if (opts->merge) {
609 errs |= check_stages((1<<2) | (1<<3), ce, pos);
610 } else {
611 errs = 1;
612 error(_("path '%s' is unmerged"), ce->name);
614 pos = skip_same_name(ce, pos) - 1;
617 if (errs)
618 return 1;
620 /* Now we are committed to check them out */
621 if (opts->checkout_worktree)
622 errs |= checkout_worktree(opts, new_branch_info);
623 else
624 remove_marked_cache_entries(&the_index, 1);
627 * Allow updating the index when checking out from the index.
628 * This is to save new stat info.
630 if (opts->checkout_worktree && !opts->checkout_index && !opts->source_tree)
631 checkout_index = 1;
632 else
633 checkout_index = opts->checkout_index;
635 if (checkout_index) {
636 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
637 die(_("unable to write new index file"));
638 } else {
640 * NEEDSWORK: if --worktree is not specified, we
641 * should save stat info of checked out files in the
642 * index to avoid the next (potentially costly)
643 * refresh. But it's a bit tricker to do...
645 rollback_lock_file(&lock_file);
648 read_ref_full("HEAD", 0, &rev, NULL);
649 head = lookup_commit_reference_gently(the_repository, &rev, 1);
651 errs |= post_checkout_hook(head, head, 0);
652 return errs;
655 static void show_local_changes(struct object *head,
656 const struct diff_options *opts)
658 struct rev_info rev;
659 /* I think we want full paths, even if we're in a subdirectory. */
660 repo_init_revisions(the_repository, &rev, NULL);
661 rev.diffopt.flags = opts->flags;
662 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
663 rev.diffopt.flags.recursive = 1;
664 diff_setup_done(&rev.diffopt);
665 add_pending_object(&rev, head, NULL);
666 run_diff_index(&rev, 0);
667 release_revisions(&rev);
670 static void describe_detached_head(const char *msg, struct commit *commit)
672 struct strbuf sb = STRBUF_INIT;
674 if (!repo_parse_commit(the_repository, commit))
675 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
676 if (print_sha1_ellipsis()) {
677 fprintf(stderr, "%s %s... %s\n", msg,
678 repo_find_unique_abbrev(the_repository, &commit->object.oid, DEFAULT_ABBREV),
679 sb.buf);
680 } else {
681 fprintf(stderr, "%s %s %s\n", msg,
682 repo_find_unique_abbrev(the_repository, &commit->object.oid, DEFAULT_ABBREV),
683 sb.buf);
685 strbuf_release(&sb);
688 static int reset_tree(struct tree *tree, const struct checkout_opts *o,
689 int worktree, int *writeout_error,
690 struct branch_info *info)
692 struct unpack_trees_options opts;
693 struct tree_desc tree_desc;
695 memset(&opts, 0, sizeof(opts));
696 opts.head_idx = -1;
697 opts.update = worktree;
698 opts.skip_unmerged = !worktree;
699 opts.reset = o->force ? UNPACK_RESET_OVERWRITE_UNTRACKED :
700 UNPACK_RESET_PROTECT_UNTRACKED;
701 opts.preserve_ignored = (!o->force && !o->overwrite_ignore);
702 opts.merge = 1;
703 opts.fn = oneway_merge;
704 opts.verbose_update = o->show_progress;
705 opts.src_index = &the_index;
706 opts.dst_index = &the_index;
707 init_checkout_metadata(&opts.meta, info->refname,
708 info->commit ? &info->commit->object.oid : null_oid(),
709 NULL);
710 parse_tree(tree);
711 init_tree_desc(&tree_desc, tree->buffer, tree->size);
712 switch (unpack_trees(1, &tree_desc, &opts)) {
713 case -2:
714 *writeout_error = 1;
716 * We return 0 nevertheless, as the index is all right
717 * and more importantly we have made best efforts to
718 * update paths in the work tree, and we cannot revert
719 * them.
721 /* fallthrough */
722 case 0:
723 return 0;
724 default:
725 return 128;
729 static void setup_branch_path(struct branch_info *branch)
731 struct strbuf buf = STRBUF_INIT;
734 * If this is a ref, resolve it; otherwise, look up the OID for our
735 * expression. Failure here is okay.
737 if (!repo_dwim_ref(the_repository, branch->name, strlen(branch->name),
738 &branch->oid, &branch->refname, 0))
739 repo_get_oid_committish(the_repository, branch->name, &branch->oid);
741 strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
742 if (strcmp(buf.buf, branch->name)) {
743 free(branch->name);
744 branch->name = xstrdup(buf.buf);
746 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
747 free(branch->path);
748 branch->path = strbuf_detach(&buf, NULL);
751 static void init_topts(struct unpack_trees_options *topts, int merge,
752 int show_progress, int overwrite_ignore,
753 struct commit *old_commit)
755 memset(topts, 0, sizeof(*topts));
756 topts->head_idx = -1;
757 topts->src_index = &the_index;
758 topts->dst_index = &the_index;
760 setup_unpack_trees_porcelain(topts, "checkout");
762 topts->initial_checkout = is_index_unborn(&the_index);
763 topts->update = 1;
764 topts->merge = 1;
765 topts->quiet = merge && old_commit;
766 topts->verbose_update = show_progress;
767 topts->fn = twoway_merge;
768 topts->preserve_ignored = !overwrite_ignore;
771 static int merge_working_tree(const struct checkout_opts *opts,
772 struct branch_info *old_branch_info,
773 struct branch_info *new_branch_info,
774 int *writeout_error)
776 int ret;
777 struct lock_file lock_file = LOCK_INIT;
778 struct tree *new_tree;
780 repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
781 if (repo_read_index_preload(the_repository, NULL, 0) < 0)
782 return error(_("index file corrupt"));
784 resolve_undo_clear_index(&the_index);
785 if (opts->new_orphan_branch && opts->orphan_from_empty_tree) {
786 if (new_branch_info->commit)
787 BUG("'switch --orphan' should never accept a commit as starting point");
788 new_tree = parse_tree_indirect(the_hash_algo->empty_tree);
789 } else
790 new_tree = repo_get_commit_tree(the_repository,
791 new_branch_info->commit);
792 if (opts->discard_changes) {
793 ret = reset_tree(new_tree, opts, 1, writeout_error, new_branch_info);
794 if (ret)
795 return ret;
796 } else {
797 struct tree_desc trees[2];
798 struct tree *tree;
799 struct unpack_trees_options topts;
800 const struct object_id *old_commit_oid;
802 refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL);
804 if (unmerged_index(&the_index)) {
805 error(_("you need to resolve your current index first"));
806 return 1;
809 /* 2-way merge to the new branch */
810 init_topts(&topts, opts->merge, opts->show_progress,
811 opts->overwrite_ignore, old_branch_info->commit);
812 init_checkout_metadata(&topts.meta, new_branch_info->refname,
813 new_branch_info->commit ?
814 &new_branch_info->commit->object.oid :
815 &new_branch_info->oid, NULL);
817 old_commit_oid = old_branch_info->commit ?
818 &old_branch_info->commit->object.oid :
819 the_hash_algo->empty_tree;
820 tree = parse_tree_indirect(old_commit_oid);
821 if (!tree)
822 die(_("unable to parse commit %s"),
823 oid_to_hex(old_commit_oid));
825 init_tree_desc(&trees[0], tree->buffer, tree->size);
826 parse_tree(new_tree);
827 tree = new_tree;
828 init_tree_desc(&trees[1], tree->buffer, tree->size);
830 ret = unpack_trees(2, trees, &topts);
831 clear_unpack_trees_porcelain(&topts);
832 if (ret == -1) {
834 * Unpack couldn't do a trivial merge; either
835 * give up or do a real merge, depending on
836 * whether the merge flag was used.
838 struct tree *work;
839 struct tree *old_tree;
840 struct merge_options o;
841 struct strbuf sb = STRBUF_INIT;
842 struct strbuf old_commit_shortname = STRBUF_INIT;
844 if (!opts->merge)
845 return 1;
848 * Without old_branch_info->commit, the below is the same as
849 * the two-tree unpack we already tried and failed.
851 if (!old_branch_info->commit)
852 return 1;
853 old_tree = repo_get_commit_tree(the_repository,
854 old_branch_info->commit);
856 if (repo_index_has_changes(the_repository, old_tree, &sb))
857 die(_("cannot continue with staged changes in "
858 "the following files:\n%s"), sb.buf);
859 strbuf_release(&sb);
861 /* Do more real merge */
864 * We update the index fully, then write the
865 * tree from the index, then merge the new
866 * branch with the current tree, with the old
867 * branch as the base. Then we reset the index
868 * (but not the working tree) to the new
869 * branch, leaving the working tree as the
870 * merged version, but skipping unmerged
871 * entries in the index.
874 add_files_to_cache(the_repository, NULL, NULL, 0, 0);
875 init_merge_options(&o, the_repository);
876 o.verbosity = 0;
877 work = write_in_core_index_as_tree(the_repository);
879 ret = reset_tree(new_tree,
880 opts, 1,
881 writeout_error, new_branch_info);
882 if (ret)
883 return ret;
884 o.ancestor = old_branch_info->name;
885 if (!old_branch_info->name) {
886 strbuf_add_unique_abbrev(&old_commit_shortname,
887 &old_branch_info->commit->object.oid,
888 DEFAULT_ABBREV);
889 o.ancestor = old_commit_shortname.buf;
891 o.branch1 = new_branch_info->name;
892 o.branch2 = "local";
893 ret = merge_trees(&o,
894 new_tree,
895 work,
896 old_tree);
897 if (ret < 0)
898 exit(128);
899 ret = reset_tree(new_tree,
900 opts, 0,
901 writeout_error, new_branch_info);
902 strbuf_release(&o.obuf);
903 strbuf_release(&old_commit_shortname);
904 if (ret)
905 return ret;
909 if (!cache_tree_fully_valid(the_index.cache_tree))
910 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
912 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
913 die(_("unable to write new index file"));
915 if (!opts->discard_changes && !opts->quiet && new_branch_info->commit)
916 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
918 return 0;
921 static void report_tracking(struct branch_info *new_branch_info)
923 struct strbuf sb = STRBUF_INIT;
924 struct branch *branch = branch_get(new_branch_info->name);
926 if (!format_tracking_info(branch, &sb, AHEAD_BEHIND_FULL, 1))
927 return;
928 fputs(sb.buf, stdout);
929 strbuf_release(&sb);
932 static void update_refs_for_switch(const struct checkout_opts *opts,
933 struct branch_info *old_branch_info,
934 struct branch_info *new_branch_info)
936 struct strbuf msg = STRBUF_INIT;
937 const char *old_desc, *reflog_msg;
938 if (opts->new_branch) {
939 if (opts->new_orphan_branch) {
940 char *refname;
942 refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
943 if (opts->new_branch_log &&
944 !should_autocreate_reflog(refname)) {
945 int ret;
946 struct strbuf err = STRBUF_INIT;
948 ret = safe_create_reflog(refname, &err);
949 if (ret) {
950 fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
951 opts->new_orphan_branch, err.buf);
952 strbuf_release(&err);
953 free(refname);
954 return;
956 strbuf_release(&err);
958 free(refname);
960 else
961 create_branch(the_repository,
962 opts->new_branch, new_branch_info->name,
963 opts->new_branch_force ? 1 : 0,
964 opts->new_branch_force ? 1 : 0,
965 opts->new_branch_log,
966 opts->quiet,
967 opts->track,
969 free(new_branch_info->name);
970 free(new_branch_info->refname);
971 new_branch_info->name = xstrdup(opts->new_branch);
972 setup_branch_path(new_branch_info);
975 old_desc = old_branch_info->name;
976 if (!old_desc && old_branch_info->commit)
977 old_desc = oid_to_hex(&old_branch_info->commit->object.oid);
979 reflog_msg = getenv("GIT_REFLOG_ACTION");
980 if (!reflog_msg)
981 strbuf_addf(&msg, "checkout: moving from %s to %s",
982 old_desc ? old_desc : "(invalid)", new_branch_info->name);
983 else
984 strbuf_insertstr(&msg, 0, reflog_msg);
986 if (!strcmp(new_branch_info->name, "HEAD") && !new_branch_info->path && !opts->force_detach) {
987 /* Nothing to do. */
988 } else if (opts->force_detach || !new_branch_info->path) { /* No longer on any branch. */
989 update_ref(msg.buf, "HEAD", &new_branch_info->commit->object.oid, NULL,
990 REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
991 if (!opts->quiet) {
992 if (old_branch_info->path &&
993 advice_enabled(ADVICE_DETACHED_HEAD) && !opts->force_detach)
994 detach_advice(new_branch_info->name);
995 describe_detached_head(_("HEAD is now at"), new_branch_info->commit);
997 } else if (new_branch_info->path) { /* Switch branches. */
998 if (create_symref("HEAD", new_branch_info->path, msg.buf) < 0)
999 die(_("unable to update HEAD"));
1000 if (!opts->quiet) {
1001 if (old_branch_info->path && !strcmp(new_branch_info->path, old_branch_info->path)) {
1002 if (opts->new_branch_force)
1003 fprintf(stderr, _("Reset branch '%s'\n"),
1004 new_branch_info->name);
1005 else
1006 fprintf(stderr, _("Already on '%s'\n"),
1007 new_branch_info->name);
1008 } else if (opts->new_branch) {
1009 if (opts->branch_exists)
1010 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
1011 else
1012 fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
1013 } else {
1014 fprintf(stderr, _("Switched to branch '%s'\n"),
1015 new_branch_info->name);
1018 if (old_branch_info->path && old_branch_info->name) {
1019 if (!ref_exists(old_branch_info->path) && reflog_exists(old_branch_info->path))
1020 delete_reflog(old_branch_info->path);
1023 remove_branch_state(the_repository, !opts->quiet);
1024 strbuf_release(&msg);
1025 if (!opts->quiet &&
1026 (new_branch_info->path || (!opts->force_detach && !strcmp(new_branch_info->name, "HEAD"))))
1027 report_tracking(new_branch_info);
1030 static int add_pending_uninteresting_ref(const char *refname,
1031 const struct object_id *oid,
1032 int flags UNUSED, void *cb_data)
1034 add_pending_oid(cb_data, refname, oid, UNINTERESTING);
1035 return 0;
1038 static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
1040 strbuf_addstr(sb, " ");
1041 strbuf_add_unique_abbrev(sb, &commit->object.oid, DEFAULT_ABBREV);
1042 strbuf_addch(sb, ' ');
1043 if (!repo_parse_commit(the_repository, commit))
1044 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
1045 strbuf_addch(sb, '\n');
1048 #define ORPHAN_CUTOFF 4
1049 static void suggest_reattach(struct commit *commit, struct rev_info *revs)
1051 struct commit *c, *last = NULL;
1052 struct strbuf sb = STRBUF_INIT;
1053 int lost = 0;
1054 while ((c = get_revision(revs)) != NULL) {
1055 if (lost < ORPHAN_CUTOFF)
1056 describe_one_orphan(&sb, c);
1057 last = c;
1058 lost++;
1060 if (ORPHAN_CUTOFF < lost) {
1061 int more = lost - ORPHAN_CUTOFF;
1062 if (more == 1)
1063 describe_one_orphan(&sb, last);
1064 else
1065 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
1068 fprintf(stderr,
1070 /* The singular version */
1071 "Warning: you are leaving %d commit behind, "
1072 "not connected to\n"
1073 "any of your branches:\n\n"
1074 "%s\n",
1075 /* The plural version */
1076 "Warning: you are leaving %d commits behind, "
1077 "not connected to\n"
1078 "any of your branches:\n\n"
1079 "%s\n",
1080 /* Give ngettext() the count */
1081 lost),
1082 lost,
1083 sb.buf);
1084 strbuf_release(&sb);
1086 if (advice_enabled(ADVICE_DETACHED_HEAD))
1087 fprintf(stderr,
1089 /* The singular version */
1090 "If you want to keep it by creating a new branch, "
1091 "this may be a good time\nto do so with:\n\n"
1092 " git branch <new-branch-name> %s\n\n",
1093 /* The plural version */
1094 "If you want to keep them by creating a new branch, "
1095 "this may be a good time\nto do so with:\n\n"
1096 " git branch <new-branch-name> %s\n\n",
1097 /* Give ngettext() the count */
1098 lost),
1099 repo_find_unique_abbrev(the_repository, &commit->object.oid, DEFAULT_ABBREV));
1103 * We are about to leave commit that was at the tip of a detached
1104 * HEAD. If it is not reachable from any ref, this is the last chance
1105 * for the user to do so without resorting to reflog.
1107 static void orphaned_commit_warning(struct commit *old_commit, struct commit *new_commit)
1109 struct rev_info revs;
1110 struct object *object = &old_commit->object;
1112 repo_init_revisions(the_repository, &revs, NULL);
1113 setup_revisions(0, NULL, &revs, NULL);
1115 object->flags &= ~UNINTERESTING;
1116 add_pending_object(&revs, object, oid_to_hex(&object->oid));
1118 for_each_ref(add_pending_uninteresting_ref, &revs);
1119 if (new_commit)
1120 add_pending_oid(&revs, "HEAD",
1121 &new_commit->object.oid,
1122 UNINTERESTING);
1124 if (prepare_revision_walk(&revs))
1125 die(_("internal error in revision walk"));
1126 if (!(old_commit->object.flags & UNINTERESTING))
1127 suggest_reattach(old_commit, &revs);
1128 else
1129 describe_detached_head(_("Previous HEAD position was"), old_commit);
1131 /* Clean up objects used, as they will be reused. */
1132 repo_clear_commit_marks(the_repository, ALL_REV_FLAGS);
1133 release_revisions(&revs);
1136 static int switch_branches(const struct checkout_opts *opts,
1137 struct branch_info *new_branch_info)
1139 int ret = 0;
1140 struct branch_info old_branch_info = { 0 };
1141 struct object_id rev;
1142 int flag, writeout_error = 0;
1143 int do_merge = 1;
1145 trace2_cmd_mode("branch");
1147 memset(&old_branch_info, 0, sizeof(old_branch_info));
1148 old_branch_info.path = resolve_refdup("HEAD", 0, &rev, &flag);
1149 if (old_branch_info.path)
1150 old_branch_info.commit = lookup_commit_reference_gently(the_repository, &rev, 1);
1151 if (!(flag & REF_ISSYMREF))
1152 FREE_AND_NULL(old_branch_info.path);
1154 if (old_branch_info.path) {
1155 const char *const prefix = "refs/heads/";
1156 const char *p;
1157 if (skip_prefix(old_branch_info.path, prefix, &p))
1158 old_branch_info.name = xstrdup(p);
1161 if (opts->new_orphan_branch && opts->orphan_from_empty_tree) {
1162 if (new_branch_info->name)
1163 BUG("'switch --orphan' should never accept a commit as starting point");
1164 new_branch_info->commit = NULL;
1165 new_branch_info->name = xstrdup("(empty)");
1166 do_merge = 1;
1169 if (!new_branch_info->name) {
1170 new_branch_info->name = xstrdup("HEAD");
1171 new_branch_info->commit = old_branch_info.commit;
1172 if (!new_branch_info->commit)
1173 die(_("You are on a branch yet to be born"));
1174 parse_commit_or_die(new_branch_info->commit);
1176 if (opts->only_merge_on_switching_branches)
1177 do_merge = 0;
1180 if (do_merge) {
1181 ret = merge_working_tree(opts, &old_branch_info, new_branch_info, &writeout_error);
1182 if (ret) {
1183 branch_info_release(&old_branch_info);
1184 return ret;
1188 if (!opts->quiet && !old_branch_info.path && old_branch_info.commit && new_branch_info->commit != old_branch_info.commit)
1189 orphaned_commit_warning(old_branch_info.commit, new_branch_info->commit);
1191 update_refs_for_switch(opts, &old_branch_info, new_branch_info);
1193 ret = post_checkout_hook(old_branch_info.commit, new_branch_info->commit, 1);
1194 branch_info_release(&old_branch_info);
1196 return ret || writeout_error;
1199 static int git_checkout_config(const char *var, const char *value,
1200 const struct config_context *ctx, void *cb)
1202 struct checkout_opts *opts = cb;
1204 if (!strcmp(var, "diff.ignoresubmodules")) {
1205 if (!value)
1206 return config_error_nonbool(var);
1207 handle_ignore_submodules_arg(&opts->diff_options, value);
1208 return 0;
1210 if (!strcmp(var, "checkout.guess")) {
1211 opts->dwim_new_local_branch = git_config_bool(var, value);
1212 return 0;
1215 if (starts_with(var, "submodule."))
1216 return git_default_submodule_config(var, value, NULL);
1218 return git_xmerge_config(var, value, ctx, NULL);
1221 static void setup_new_branch_info_and_source_tree(
1222 struct branch_info *new_branch_info,
1223 struct checkout_opts *opts,
1224 struct object_id *rev,
1225 const char *arg)
1227 struct tree **source_tree = &opts->source_tree;
1228 struct object_id branch_rev;
1230 new_branch_info->name = xstrdup(arg);
1231 setup_branch_path(new_branch_info);
1233 if (!check_refname_format(new_branch_info->path, 0) &&
1234 !read_ref(new_branch_info->path, &branch_rev))
1235 oidcpy(rev, &branch_rev);
1236 else
1237 /* not an existing branch */
1238 FREE_AND_NULL(new_branch_info->path);
1240 new_branch_info->commit = lookup_commit_reference_gently(the_repository, rev, 1);
1241 if (!new_branch_info->commit) {
1242 /* not a commit */
1243 *source_tree = parse_tree_indirect(rev);
1244 } else {
1245 parse_commit_or_die(new_branch_info->commit);
1246 *source_tree = repo_get_commit_tree(the_repository,
1247 new_branch_info->commit);
1251 static const char *parse_remote_branch(const char *arg,
1252 struct object_id *rev,
1253 int could_be_checkout_paths)
1255 int num_matches = 0;
1256 const char *remote = unique_tracking_name(arg, rev, &num_matches);
1258 if (remote && could_be_checkout_paths) {
1259 die(_("'%s' could be both a local file and a tracking branch.\n"
1260 "Please use -- (and optionally --no-guess) to disambiguate"),
1261 arg);
1264 if (!remote && num_matches > 1) {
1265 if (advice_enabled(ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME)) {
1266 advise(_("If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1267 "you can do so by fully qualifying the name with the --track option:\n"
1268 "\n"
1269 " git checkout --track origin/<name>\n"
1270 "\n"
1271 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1272 "one remote, e.g. the 'origin' remote, consider setting\n"
1273 "checkout.defaultRemote=origin in your config."));
1276 die(_("'%s' matched multiple (%d) remote tracking branches"),
1277 arg, num_matches);
1280 return remote;
1283 static int parse_branchname_arg(int argc, const char **argv,
1284 int dwim_new_local_branch_ok,
1285 struct branch_info *new_branch_info,
1286 struct checkout_opts *opts,
1287 struct object_id *rev)
1289 const char **new_branch = &opts->new_branch;
1290 int argcount = 0;
1291 const char *arg;
1292 int dash_dash_pos;
1293 int has_dash_dash = 0;
1294 int i;
1297 * case 1: git checkout <ref> -- [<paths>]
1299 * <ref> must be a valid tree, everything after the '--' must be
1300 * a path.
1302 * case 2: git checkout -- [<paths>]
1304 * everything after the '--' must be paths.
1306 * case 3: git checkout <something> [--]
1308 * (a) If <something> is a commit, that is to
1309 * switch to the branch or detach HEAD at it. As a special case,
1310 * if <something> is A...B (missing A or B means HEAD but you can
1311 * omit at most one side), and if there is a unique merge base
1312 * between A and B, A...B names that merge base.
1314 * (b) If <something> is _not_ a commit, either "--" is present
1315 * or <something> is not a path, no -t or -b was given,
1316 * and there is a tracking branch whose name is <something>
1317 * in one and only one remote (or if the branch exists on the
1318 * remote named in checkout.defaultRemote), then this is a
1319 * short-hand to fork local <something> from that
1320 * remote-tracking branch.
1322 * (c) Otherwise, if "--" is present, treat it like case (1).
1324 * (d) Otherwise :
1325 * - if it's a reference, treat it like case (1)
1326 * - else if it's a path, treat it like case (2)
1327 * - else: fail.
1329 * case 4: git checkout <something> <paths>
1331 * The first argument must not be ambiguous.
1332 * - If it's *only* a reference, treat it like case (1).
1333 * - If it's only a path, treat it like case (2).
1334 * - else: fail.
1337 if (!argc)
1338 return 0;
1340 if (!opts->accept_pathspec) {
1341 if (argc > 1)
1342 die(_("only one reference expected"));
1343 has_dash_dash = 1; /* helps disambiguate */
1346 arg = argv[0];
1347 dash_dash_pos = -1;
1348 for (i = 0; i < argc; i++) {
1349 if (opts->accept_pathspec && !strcmp(argv[i], "--")) {
1350 dash_dash_pos = i;
1351 break;
1354 if (dash_dash_pos == 0)
1355 return 1; /* case (2) */
1356 else if (dash_dash_pos == 1)
1357 has_dash_dash = 1; /* case (3) or (1) */
1358 else if (dash_dash_pos >= 2)
1359 die(_("only one reference expected, %d given."), dash_dash_pos);
1360 opts->count_checkout_paths = !opts->quiet && !has_dash_dash;
1362 if (!strcmp(arg, "-"))
1363 arg = "@{-1}";
1365 if (repo_get_oid_mb(the_repository, arg, rev)) {
1367 * Either case (3) or (4), with <something> not being
1368 * a commit, or an attempt to use case (1) with an
1369 * invalid ref.
1371 * It's likely an error, but we need to find out if
1372 * we should auto-create the branch, case (3).(b).
1374 int recover_with_dwim = dwim_new_local_branch_ok;
1376 int could_be_checkout_paths = !has_dash_dash &&
1377 check_filename(opts->prefix, arg);
1379 if (!has_dash_dash && !no_wildcard(arg))
1380 recover_with_dwim = 0;
1383 * Accept "git checkout foo", "git checkout foo --"
1384 * and "git switch foo" as candidates for dwim.
1386 if (!(argc == 1 && !has_dash_dash) &&
1387 !(argc == 2 && has_dash_dash) &&
1388 opts->accept_pathspec)
1389 recover_with_dwim = 0;
1391 if (recover_with_dwim) {
1392 const char *remote = parse_remote_branch(arg, rev,
1393 could_be_checkout_paths);
1394 if (remote) {
1395 *new_branch = arg;
1396 arg = remote;
1397 /* DWIMmed to create local branch, case (3).(b) */
1398 } else {
1399 recover_with_dwim = 0;
1403 if (!recover_with_dwim) {
1404 if (has_dash_dash)
1405 die(_("invalid reference: %s"), arg);
1406 return argcount;
1410 /* we can't end up being in (2) anymore, eat the argument */
1411 argcount++;
1412 argv++;
1413 argc--;
1415 setup_new_branch_info_and_source_tree(new_branch_info, opts, rev, arg);
1417 if (!opts->source_tree) /* case (1): want a tree */
1418 die(_("reference is not a tree: %s"), arg);
1420 if (!has_dash_dash) { /* case (3).(d) -> (1) */
1422 * Do not complain the most common case
1423 * git checkout branch
1424 * even if there happen to be a file called 'branch';
1425 * it would be extremely annoying.
1427 if (argc)
1428 verify_non_filename(opts->prefix, arg);
1429 } else if (opts->accept_pathspec) {
1430 argcount++;
1431 argv++;
1432 argc--;
1435 return argcount;
1438 static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
1440 int status;
1441 struct strbuf branch_ref = STRBUF_INIT;
1443 trace2_cmd_mode("unborn");
1445 if (!opts->new_branch)
1446 die(_("You are on a branch yet to be born"));
1447 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1448 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1449 strbuf_release(&branch_ref);
1450 if (!opts->quiet)
1451 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1452 opts->new_branch);
1453 return status;
1456 static void die_expecting_a_branch(const struct branch_info *branch_info)
1458 struct object_id oid;
1459 char *to_free;
1460 int code;
1462 if (repo_dwim_ref(the_repository, branch_info->name,
1463 strlen(branch_info->name), &oid, &to_free, 0) == 1) {
1464 const char *ref = to_free;
1466 if (skip_prefix(ref, "refs/tags/", &ref))
1467 code = die_message(_("a branch is expected, got tag '%s'"), ref);
1468 else if (skip_prefix(ref, "refs/remotes/", &ref))
1469 code = die_message(_("a branch is expected, got remote branch '%s'"), ref);
1470 else
1471 code = die_message(_("a branch is expected, got '%s'"), ref);
1473 else if (branch_info->commit)
1474 code = die_message(_("a branch is expected, got commit '%s'"), branch_info->name);
1475 else
1477 * This case should never happen because we already die() on
1478 * non-commit, but just in case.
1480 code = die_message(_("a branch is expected, got '%s'"), branch_info->name);
1482 if (advice_enabled(ADVICE_SUGGEST_DETACHING_HEAD))
1483 advise(_("If you want to detach HEAD at the commit, try again with the --detach option."));
1485 exit(code);
1488 static void die_if_some_operation_in_progress(void)
1490 struct wt_status_state state;
1492 memset(&state, 0, sizeof(state));
1493 wt_status_get_state(the_repository, &state, 0);
1495 if (state.merge_in_progress)
1496 die(_("cannot switch branch while merging\n"
1497 "Consider \"git merge --quit\" "
1498 "or \"git worktree add\"."));
1499 if (state.am_in_progress)
1500 die(_("cannot switch branch in the middle of an am session\n"
1501 "Consider \"git am --quit\" "
1502 "or \"git worktree add\"."));
1503 if (state.rebase_interactive_in_progress || state.rebase_in_progress)
1504 die(_("cannot switch branch while rebasing\n"
1505 "Consider \"git rebase --quit\" "
1506 "or \"git worktree add\"."));
1507 if (state.cherry_pick_in_progress)
1508 die(_("cannot switch branch while cherry-picking\n"
1509 "Consider \"git cherry-pick --quit\" "
1510 "or \"git worktree add\"."));
1511 if (state.revert_in_progress)
1512 die(_("cannot switch branch while reverting\n"
1513 "Consider \"git revert --quit\" "
1514 "or \"git worktree add\"."));
1515 if (state.bisect_in_progress)
1516 warning(_("you are switching branch while bisecting"));
1518 wt_status_state_free_buffers(&state);
1521 static int checkout_branch(struct checkout_opts *opts,
1522 struct branch_info *new_branch_info)
1524 if (opts->pathspec.nr)
1525 die(_("paths cannot be used with switching branches"));
1527 if (opts->patch_mode)
1528 die(_("'%s' cannot be used with switching branches"),
1529 "--patch");
1531 if (opts->overlay_mode != -1)
1532 die(_("'%s' cannot be used with switching branches"),
1533 "--[no]-overlay");
1535 if (opts->writeout_stage)
1536 die(_("'%s' cannot be used with switching branches"),
1537 "--ours/--theirs");
1539 if (opts->force && opts->merge)
1540 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1542 if (opts->discard_changes && opts->merge)
1543 die(_("'%s' cannot be used with '%s'"), "--discard-changes", "--merge");
1545 if (opts->force_detach && opts->new_branch)
1546 die(_("'%s' cannot be used with '%s'"),
1547 "--detach", "-b/-B/--orphan");
1549 if (opts->new_orphan_branch) {
1550 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1551 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1552 if (opts->orphan_from_empty_tree && new_branch_info->name)
1553 die(_("'%s' cannot take <start-point>"), "--orphan");
1554 } else if (opts->force_detach) {
1555 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1556 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1557 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1558 opts->track = git_branch_track;
1560 if (new_branch_info->name && !new_branch_info->commit)
1561 die(_("Cannot switch branch to a non-commit '%s'"),
1562 new_branch_info->name);
1564 if (!opts->switch_branch_doing_nothing_is_ok &&
1565 !new_branch_info->name &&
1566 !opts->new_branch &&
1567 !opts->force_detach)
1568 die(_("missing branch or commit argument"));
1570 if (!opts->implicit_detach &&
1571 !opts->force_detach &&
1572 !opts->new_branch &&
1573 !opts->new_branch_force &&
1574 new_branch_info->name &&
1575 !new_branch_info->path)
1576 die_expecting_a_branch(new_branch_info);
1578 if (!opts->can_switch_when_in_progress)
1579 die_if_some_operation_in_progress();
1581 if (new_branch_info->path && !opts->force_detach && !opts->new_branch &&
1582 !opts->ignore_other_worktrees) {
1583 int flag;
1584 char *head_ref = resolve_refdup("HEAD", 0, NULL, &flag);
1585 if (head_ref &&
1586 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new_branch_info->path)))
1587 die_if_checked_out(new_branch_info->path, 1);
1588 free(head_ref);
1591 if (!new_branch_info->commit && opts->new_branch) {
1592 struct object_id rev;
1593 int flag;
1595 if (!read_ref_full("HEAD", 0, &rev, &flag) &&
1596 (flag & REF_ISSYMREF) && is_null_oid(&rev))
1597 return switch_unborn_to_new_branch(opts);
1599 return switch_branches(opts, new_branch_info);
1602 static struct option *add_common_options(struct checkout_opts *opts,
1603 struct option *prevopts)
1605 struct option options[] = {
1606 OPT__QUIET(&opts->quiet, N_("suppress progress reporting")),
1607 OPT_CALLBACK_F(0, "recurse-submodules", NULL,
1608 "checkout", "control recursive updating of submodules",
1609 PARSE_OPT_OPTARG, option_parse_recurse_submodules_worktree_updater),
1610 OPT_BOOL(0, "progress", &opts->show_progress, N_("force progress reporting")),
1611 OPT_BOOL('m', "merge", &opts->merge, N_("perform a 3-way merge with the new branch")),
1612 OPT_STRING(0, "conflict", &opts->conflict_style, N_("style"),
1613 N_("conflict style (merge, diff3, or zdiff3)")),
1614 OPT_END()
1616 struct option *newopts = parse_options_concat(prevopts, options);
1617 free(prevopts);
1618 return newopts;
1621 static struct option *add_common_switch_branch_options(
1622 struct checkout_opts *opts, struct option *prevopts)
1624 struct option options[] = {
1625 OPT_BOOL('d', "detach", &opts->force_detach, N_("detach HEAD at named commit")),
1626 OPT_CALLBACK_F('t', "track", &opts->track, "(direct|inherit)",
1627 N_("set branch tracking configuration"),
1628 PARSE_OPT_OPTARG,
1629 parse_opt_tracking_mode),
1630 OPT__FORCE(&opts->force, N_("force checkout (throw away local modifications)"),
1631 PARSE_OPT_NOCOMPLETE),
1632 OPT_STRING(0, "orphan", &opts->new_orphan_branch, N_("new-branch"), N_("new unborn branch")),
1633 OPT_BOOL_F(0, "overwrite-ignore", &opts->overwrite_ignore,
1634 N_("update ignored files (default)"),
1635 PARSE_OPT_NOCOMPLETE),
1636 OPT_BOOL(0, "ignore-other-worktrees", &opts->ignore_other_worktrees,
1637 N_("do not check if another worktree is holding the given ref")),
1638 OPT_END()
1640 struct option *newopts = parse_options_concat(prevopts, options);
1641 free(prevopts);
1642 return newopts;
1645 static struct option *add_checkout_path_options(struct checkout_opts *opts,
1646 struct option *prevopts)
1648 struct option options[] = {
1649 OPT_SET_INT_F('2', "ours", &opts->writeout_stage,
1650 N_("checkout our version for unmerged files"),
1651 2, PARSE_OPT_NONEG),
1652 OPT_SET_INT_F('3', "theirs", &opts->writeout_stage,
1653 N_("checkout their version for unmerged files"),
1654 3, PARSE_OPT_NONEG),
1655 OPT_BOOL('p', "patch", &opts->patch_mode, N_("select hunks interactively")),
1656 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts->ignore_skipworktree,
1657 N_("do not limit pathspecs to sparse entries only")),
1658 OPT_PATHSPEC_FROM_FILE(&opts->pathspec_from_file),
1659 OPT_PATHSPEC_FILE_NUL(&opts->pathspec_file_nul),
1660 OPT_END()
1662 struct option *newopts = parse_options_concat(prevopts, options);
1663 free(prevopts);
1664 return newopts;
1667 /* create-branch option (either b or c) */
1668 static char cb_option = 'b';
1670 static int checkout_main(int argc, const char **argv, const char *prefix,
1671 struct checkout_opts *opts, struct option *options,
1672 const char * const usagestr[],
1673 struct branch_info *new_branch_info)
1675 int parseopt_flags = 0;
1677 opts->overwrite_ignore = 1;
1678 opts->prefix = prefix;
1679 opts->show_progress = -1;
1681 git_config(git_checkout_config, opts);
1682 if (the_repository->gitdir) {
1683 prepare_repo_settings(the_repository);
1684 the_repository->settings.command_requires_full_index = 0;
1687 opts->track = BRANCH_TRACK_UNSPECIFIED;
1689 if (!opts->accept_pathspec && !opts->accept_ref)
1690 BUG("make up your mind, you need to take _something_");
1691 if (opts->accept_pathspec && opts->accept_ref)
1692 parseopt_flags = PARSE_OPT_KEEP_DASHDASH;
1694 argc = parse_options(argc, argv, prefix, options,
1695 usagestr, parseopt_flags);
1697 if (opts->show_progress < 0) {
1698 if (opts->quiet)
1699 opts->show_progress = 0;
1700 else
1701 opts->show_progress = isatty(2);
1704 if (opts->conflict_style) {
1705 struct key_value_info kvi = KVI_INIT;
1706 struct config_context ctx = {
1707 .kvi = &kvi,
1709 opts->merge = 1; /* implied */
1710 git_xmerge_config("merge.conflictstyle", opts->conflict_style,
1711 &ctx, NULL);
1713 if (opts->force) {
1714 opts->discard_changes = 1;
1715 opts->ignore_unmerged_opt = "--force";
1716 opts->ignore_unmerged = 1;
1719 if ((!!opts->new_branch + !!opts->new_branch_force + !!opts->new_orphan_branch) > 1)
1720 die(_("options '-%c', '-%c', and '%s' cannot be used together"),
1721 cb_option, toupper(cb_option), "--orphan");
1723 if (opts->overlay_mode == 1 && opts->patch_mode)
1724 die(_("options '%s' and '%s' cannot be used together"), "-p", "--overlay");
1726 if (opts->checkout_index >= 0 || opts->checkout_worktree >= 0) {
1727 if (opts->checkout_index < 0)
1728 opts->checkout_index = 0;
1729 if (opts->checkout_worktree < 0)
1730 opts->checkout_worktree = 0;
1731 } else {
1732 if (opts->checkout_index < 0)
1733 opts->checkout_index = -opts->checkout_index - 1;
1734 if (opts->checkout_worktree < 0)
1735 opts->checkout_worktree = -opts->checkout_worktree - 1;
1737 if (opts->checkout_index < 0 || opts->checkout_worktree < 0)
1738 BUG("these flags should be non-negative by now");
1740 * convenient shortcut: "git restore --staged [--worktree]" equals
1741 * "git restore --staged [--worktree] --source HEAD"
1743 if (!opts->from_treeish && opts->checkout_index)
1744 opts->from_treeish = "HEAD";
1747 * From here on, new_branch will contain the branch to be checked out,
1748 * and new_branch_force and new_orphan_branch will tell us which one of
1749 * -b/-B/-c/-C/--orphan is being used.
1751 if (opts->new_branch_force)
1752 opts->new_branch = opts->new_branch_force;
1754 if (opts->new_orphan_branch)
1755 opts->new_branch = opts->new_orphan_branch;
1757 /* --track without -c/-C/-b/-B/--orphan should DWIM */
1758 if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch) {
1759 const char *argv0 = argv[0];
1760 if (!argc || !strcmp(argv0, "--"))
1761 die(_("--track needs a branch name"));
1762 skip_prefix(argv0, "refs/", &argv0);
1763 skip_prefix(argv0, "remotes/", &argv0);
1764 argv0 = strchr(argv0, '/');
1765 if (!argv0 || !argv0[1])
1766 die(_("missing branch name; try -%c"), cb_option);
1767 opts->new_branch = argv0 + 1;
1771 * Extract branch name from command line arguments, so
1772 * all that is left is pathspecs.
1774 * Handle
1776 * 1) git checkout <tree> -- [<paths>]
1777 * 2) git checkout -- [<paths>]
1778 * 3) git checkout <something> [<paths>]
1780 * including "last branch" syntax and DWIM-ery for names of
1781 * remote branches, erroring out for invalid or ambiguous cases.
1783 if (argc && opts->accept_ref) {
1784 struct object_id rev;
1785 int dwim_ok =
1786 !opts->patch_mode &&
1787 opts->dwim_new_local_branch &&
1788 opts->track == BRANCH_TRACK_UNSPECIFIED &&
1789 !opts->new_branch;
1790 int n = parse_branchname_arg(argc, argv, dwim_ok,
1791 new_branch_info, opts, &rev);
1792 argv += n;
1793 argc -= n;
1794 } else if (!opts->accept_ref && opts->from_treeish) {
1795 struct object_id rev;
1797 if (repo_get_oid_mb(the_repository, opts->from_treeish, &rev))
1798 die(_("could not resolve %s"), opts->from_treeish);
1800 setup_new_branch_info_and_source_tree(new_branch_info,
1801 opts, &rev,
1802 opts->from_treeish);
1804 if (!opts->source_tree)
1805 die(_("reference is not a tree: %s"), opts->from_treeish);
1808 if (argc) {
1809 parse_pathspec(&opts->pathspec, 0,
1810 opts->patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1811 prefix, argv);
1813 if (!opts->pathspec.nr)
1814 die(_("invalid path specification"));
1817 * Try to give more helpful suggestion.
1818 * new_branch && argc > 1 will be caught later.
1820 if (opts->new_branch && argc == 1 && !new_branch_info->commit)
1821 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1822 argv[0], opts->new_branch);
1824 if (opts->force_detach)
1825 die(_("git checkout: --detach does not take a path argument '%s'"),
1826 argv[0]);
1829 if (opts->pathspec_from_file) {
1830 if (opts->pathspec.nr)
1831 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
1833 if (opts->force_detach)
1834 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--detach");
1836 if (opts->patch_mode)
1837 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
1839 parse_pathspec_file(&opts->pathspec, 0,
1841 prefix, opts->pathspec_from_file, opts->pathspec_file_nul);
1842 } else if (opts->pathspec_file_nul) {
1843 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
1846 opts->pathspec.recursive = 1;
1848 if (opts->pathspec.nr) {
1849 if (1 < !!opts->writeout_stage + !!opts->force + !!opts->merge)
1850 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1851 "checking out of the index."));
1852 } else {
1853 if (opts->accept_pathspec && !opts->empty_pathspec_ok &&
1854 !opts->patch_mode) /* patch mode is special */
1855 die(_("you must specify path(s) to restore"));
1858 if (opts->new_branch) {
1859 struct strbuf buf = STRBUF_INIT;
1861 if (opts->new_branch_force)
1862 opts->branch_exists = validate_branchname(opts->new_branch, &buf);
1863 else
1864 opts->branch_exists =
1865 validate_new_branchname(opts->new_branch, &buf, 0);
1866 strbuf_release(&buf);
1869 if (opts->patch_mode || opts->pathspec.nr)
1870 return checkout_paths(opts, new_branch_info);
1871 else
1872 return checkout_branch(opts, new_branch_info);
1875 int cmd_checkout(int argc, const char **argv, const char *prefix)
1877 struct checkout_opts opts;
1878 struct option *options;
1879 struct option checkout_options[] = {
1880 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1881 N_("create and checkout a new branch")),
1882 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1883 N_("create/reset and checkout a branch")),
1884 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
1885 OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
1886 N_("second guess 'git checkout <no-such-branch>' (default)")),
1887 OPT_BOOL(0, "overlay", &opts.overlay_mode, N_("use overlay mode (default)")),
1888 OPT_END()
1890 int ret;
1891 struct branch_info new_branch_info = { 0 };
1893 memset(&opts, 0, sizeof(opts));
1894 opts.dwim_new_local_branch = 1;
1895 opts.switch_branch_doing_nothing_is_ok = 1;
1896 opts.only_merge_on_switching_branches = 0;
1897 opts.accept_ref = 1;
1898 opts.accept_pathspec = 1;
1899 opts.implicit_detach = 1;
1900 opts.can_switch_when_in_progress = 1;
1901 opts.orphan_from_empty_tree = 0;
1902 opts.empty_pathspec_ok = 1;
1903 opts.overlay_mode = -1;
1904 opts.checkout_index = -2; /* default on */
1905 opts.checkout_worktree = -2; /* default on */
1907 if (argc == 3 && !strcmp(argv[1], "-b")) {
1909 * User ran 'git checkout -b <branch>' and expects
1910 * the same behavior as 'git switch -c <branch>'.
1912 opts.switch_branch_doing_nothing_is_ok = 0;
1913 opts.only_merge_on_switching_branches = 1;
1916 options = parse_options_dup(checkout_options);
1917 options = add_common_options(&opts, options);
1918 options = add_common_switch_branch_options(&opts, options);
1919 options = add_checkout_path_options(&opts, options);
1921 ret = checkout_main(argc, argv, prefix, &opts,
1922 options, checkout_usage, &new_branch_info);
1923 branch_info_release(&new_branch_info);
1924 clear_pathspec(&opts.pathspec);
1925 free(opts.pathspec_from_file);
1926 FREE_AND_NULL(options);
1927 return ret;
1930 int cmd_switch(int argc, const char **argv, const char *prefix)
1932 struct checkout_opts opts;
1933 struct option *options = NULL;
1934 struct option switch_options[] = {
1935 OPT_STRING('c', "create", &opts.new_branch, N_("branch"),
1936 N_("create and switch to a new branch")),
1937 OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"),
1938 N_("create/reset and switch to a branch")),
1939 OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
1940 N_("second guess 'git switch <no-such-branch>'")),
1941 OPT_BOOL(0, "discard-changes", &opts.discard_changes,
1942 N_("throw away local modifications")),
1943 OPT_END()
1945 int ret;
1946 struct branch_info new_branch_info = { 0 };
1948 memset(&opts, 0, sizeof(opts));
1949 opts.dwim_new_local_branch = 1;
1950 opts.accept_ref = 1;
1951 opts.accept_pathspec = 0;
1952 opts.switch_branch_doing_nothing_is_ok = 0;
1953 opts.only_merge_on_switching_branches = 1;
1954 opts.implicit_detach = 0;
1955 opts.can_switch_when_in_progress = 0;
1956 opts.orphan_from_empty_tree = 1;
1957 opts.overlay_mode = -1;
1959 options = parse_options_dup(switch_options);
1960 options = add_common_options(&opts, options);
1961 options = add_common_switch_branch_options(&opts, options);
1963 cb_option = 'c';
1965 ret = checkout_main(argc, argv, prefix, &opts,
1966 options, switch_branch_usage, &new_branch_info);
1967 branch_info_release(&new_branch_info);
1968 FREE_AND_NULL(options);
1969 return ret;
1972 int cmd_restore(int argc, const char **argv, const char *prefix)
1974 struct checkout_opts opts;
1975 struct option *options;
1976 struct option restore_options[] = {
1977 OPT_STRING('s', "source", &opts.from_treeish, "<tree-ish>",
1978 N_("which tree-ish to checkout from")),
1979 OPT_BOOL('S', "staged", &opts.checkout_index,
1980 N_("restore the index")),
1981 OPT_BOOL('W', "worktree", &opts.checkout_worktree,
1982 N_("restore the working tree (default)")),
1983 OPT_BOOL(0, "ignore-unmerged", &opts.ignore_unmerged,
1984 N_("ignore unmerged entries")),
1985 OPT_BOOL(0, "overlay", &opts.overlay_mode, N_("use overlay mode")),
1986 OPT_END()
1988 int ret;
1989 struct branch_info new_branch_info = { 0 };
1991 memset(&opts, 0, sizeof(opts));
1992 opts.accept_ref = 0;
1993 opts.accept_pathspec = 1;
1994 opts.empty_pathspec_ok = 0;
1995 opts.overlay_mode = 0;
1996 opts.checkout_index = -1; /* default off */
1997 opts.checkout_worktree = -2; /* default on */
1998 opts.ignore_unmerged_opt = "--ignore-unmerged";
2000 options = parse_options_dup(restore_options);
2001 options = add_common_options(&opts, options);
2002 options = add_checkout_path_options(&opts, options);
2004 ret = checkout_main(argc, argv, prefix, &opts,
2005 options, restore_usage, &new_branch_info);
2006 branch_info_release(&new_branch_info);
2007 FREE_AND_NULL(options);
2008 return ret;