1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
6 #include "cache-tree.h"
15 #include "merge-recursive.h"
16 #include "object-store.h"
17 #include "parse-options.h"
20 #include "resolve-undo.h"
22 #include "run-command.h"
23 #include "submodule.h"
24 #include "submodule-config.h"
26 #include "tree-walk.h"
27 #include "unpack-trees.h"
28 #include "wt-status.h"
29 #include "xdiff-interface.h"
31 #include "parallel-checkout.h"
33 static const char * const checkout_usage
[] = {
34 N_("git checkout [<options>] <branch>"),
35 N_("git checkout [<options>] [<branch>] -- <file>..."),
39 static const char * const switch_branch_usage
[] = {
40 N_("git switch [<options>] [<branch>]"),
44 static const char * const restore_usage
[] = {
45 N_("git restore [<options>] [--source=<branch>] <file>..."),
49 struct checkout_opts
{
58 int ignore_skipworktree
;
59 int ignore_other_worktrees
;
61 int count_checkout_paths
;
63 int dwim_new_local_branch
;
67 int switch_branch_doing_nothing_is_ok
;
68 int only_merge_on_switching_branches
;
69 int can_switch_when_in_progress
;
70 int orphan_from_empty_tree
;
71 int empty_pathspec_ok
;
73 int checkout_worktree
;
74 const char *ignore_unmerged_opt
;
76 int pathspec_file_nul
;
77 const char *pathspec_from_file
;
79 const char *new_branch
;
80 const char *new_branch_force
;
81 const char *new_orphan_branch
;
83 enum branch_track track
;
84 struct diff_options diff_options
;
89 struct pathspec pathspec
;
90 const char *from_treeish
;
91 struct tree
*source_tree
;
95 char *name
; /* The short name used */
96 char *path
; /* The full name of a real branch */
97 struct commit
*commit
; /* The named commit */
98 char *refname
; /* The full name of the ref being checked out. */
99 struct object_id oid
; /* The object ID of the commit being checked out. */
101 * if not null the branch is detached because it's already
102 * checked out in this checkout
107 static void branch_info_release(struct branch_info
*info
)
112 free(info
->checkout
);
115 static int post_checkout_hook(struct commit
*old_commit
, struct commit
*new_commit
,
118 return run_hooks_l("post-checkout",
119 oid_to_hex(old_commit
? &old_commit
->object
.oid
: null_oid()),
120 oid_to_hex(new_commit
? &new_commit
->object
.oid
: null_oid()),
121 changed
? "1" : "0", NULL
);
122 /* "new_commit" can be NULL when checking out from the index before
127 static int update_some(const struct object_id
*oid
, struct strbuf
*base
,
128 const char *pathname
, unsigned mode
, void *context
)
131 struct cache_entry
*ce
;
135 return READ_TREE_RECURSIVE
;
137 len
= base
->len
+ strlen(pathname
);
138 ce
= make_empty_cache_entry(&the_index
, len
);
139 oidcpy(&ce
->oid
, oid
);
140 memcpy(ce
->name
, base
->buf
, base
->len
);
141 memcpy(ce
->name
+ base
->len
, pathname
, len
- base
->len
);
142 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
143 ce
->ce_namelen
= len
;
144 ce
->ce_mode
= create_ce_mode(mode
);
147 * If the entry is the same as the current index, we can leave the old
148 * entry in place. Whether it is UPTODATE or not, checkout_entry will
149 * do the right thing.
151 pos
= cache_name_pos(ce
->name
, ce
->ce_namelen
);
153 struct cache_entry
*old
= active_cache
[pos
];
154 if (ce
->ce_mode
== old
->ce_mode
&&
155 !ce_intent_to_add(old
) &&
156 oideq(&ce
->oid
, &old
->oid
)) {
157 old
->ce_flags
|= CE_UPDATE
;
158 discard_cache_entry(ce
);
163 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
167 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
169 read_tree(the_repository
, tree
,
170 pathspec
, update_some
, NULL
);
172 /* update the index with the given tree's info
173 * for all args, expanding wildcards, and exit
174 * with any non-zero return code.
179 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
181 while (++pos
< active_nr
&&
182 !strcmp(active_cache
[pos
]->name
, ce
->name
))
187 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
,
190 while (pos
< active_nr
&&
191 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
192 if (ce_stage(active_cache
[pos
]) == stage
)
199 return error(_("path '%s' does not have our version"), ce
->name
);
201 return error(_("path '%s' does not have their version"), ce
->name
);
204 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
207 const char *name
= ce
->name
;
209 while (pos
< active_nr
) {
210 ce
= active_cache
[pos
];
211 if (strcmp(name
, ce
->name
))
213 seen
|= (1 << ce_stage(ce
));
216 if ((stages
& seen
) != stages
)
217 return error(_("path '%s' does not have all necessary versions"),
222 static int checkout_stage(int stage
, const struct cache_entry
*ce
, int pos
,
223 const struct checkout
*state
, int *nr_checkouts
,
226 while (pos
< active_nr
&&
227 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
228 if (ce_stage(active_cache
[pos
]) == stage
)
229 return checkout_entry(active_cache
[pos
], state
,
238 return error(_("path '%s' does not have our version"), ce
->name
);
240 return error(_("path '%s' does not have their version"), ce
->name
);
243 static int checkout_merged(int pos
, const struct checkout
*state
,
244 int *nr_checkouts
, struct mem_pool
*ce_mem_pool
)
246 struct cache_entry
*ce
= active_cache
[pos
];
247 const char *path
= ce
->name
;
248 mmfile_t ancestor
, ours
, theirs
;
249 enum ll_merge_result merge_status
;
251 struct object_id oid
;
252 mmbuffer_t result_buf
;
253 struct object_id threeway
[3];
255 struct ll_merge_options ll_opts
;
258 memset(threeway
, 0, sizeof(threeway
));
259 while (pos
< active_nr
) {
261 stage
= ce_stage(ce
);
262 if (!stage
|| strcmp(path
, ce
->name
))
264 oidcpy(&threeway
[stage
- 1], &ce
->oid
);
266 mode
= create_ce_mode(ce
->ce_mode
);
268 ce
= active_cache
[pos
];
270 if (is_null_oid(&threeway
[1]) || is_null_oid(&threeway
[2]))
271 return error(_("path '%s' does not have necessary versions"), path
);
273 read_mmblob(&ancestor
, &threeway
[0]);
274 read_mmblob(&ours
, &threeway
[1]);
275 read_mmblob(&theirs
, &threeway
[2]);
277 memset(&ll_opts
, 0, sizeof(ll_opts
));
278 git_config_get_bool("merge.renormalize", &renormalize
);
279 ll_opts
.renormalize
= renormalize
;
280 merge_status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
281 &ours
, "ours", &theirs
, "theirs",
282 state
->istate
, &ll_opts
);
286 if (merge_status
== LL_MERGE_BINARY_CONFLICT
)
287 warning("Cannot merge binary files: %s (%s vs. %s)",
288 path
, "ours", "theirs");
289 if (merge_status
< 0 || !result_buf
.ptr
) {
290 free(result_buf
.ptr
);
291 return error(_("path '%s': cannot merge"), path
);
296 * There is absolutely no reason to write this as a blob object
297 * and create a phony cache entry. This hack is primarily to get
298 * to the write_entry() machinery that massages the contents to
299 * work-tree format and writes out which only allows it for a
300 * cache entry. The code in write_entry() needs to be refactored
301 * to allow us to feed a <buffer, size, mode> instead of a cache
302 * entry. Such a refactoring would help merge_recursive as well
303 * (it also writes the merge result to the object database even
304 * when it may contain conflicts).
306 if (write_object_file(result_buf
.ptr
, result_buf
.size
, OBJ_BLOB
, &oid
))
307 die(_("Unable to add merge result for '%s'"), path
);
308 free(result_buf
.ptr
);
309 ce
= make_transient_cache_entry(mode
, &oid
, path
, 2, ce_mem_pool
);
311 die(_("make_cache_entry failed for path '%s'"), path
);
312 status
= checkout_entry(ce
, state
, NULL
, nr_checkouts
);
316 static void mark_ce_for_checkout_overlay(struct cache_entry
*ce
,
318 const struct checkout_opts
*opts
)
320 ce
->ce_flags
&= ~CE_MATCHED
;
321 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
323 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
325 * "git checkout tree-ish -- path", but this entry
326 * is in the original index but is not in tree-ish
327 * or does not match the pathspec; it will not be
328 * checked out to the working tree. We will not do
329 * anything to this entry at all.
333 * Either this entry came from the tree-ish we are
334 * checking the paths out of, or we are checking out
337 * If it comes from the tree-ish, we already know it
338 * matches the pathspec and could just stamp
339 * CE_MATCHED to it from update_some(). But we still
340 * need ps_matched and read_tree (and
341 * eventually tree_entry_interesting) cannot fill
342 * ps_matched yet. Once it can, we can avoid calling
343 * match_pathspec() for _all_ entries when
344 * opts->source_tree != NULL.
346 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
))
347 ce
->ce_flags
|= CE_MATCHED
;
350 static void mark_ce_for_checkout_no_overlay(struct cache_entry
*ce
,
352 const struct checkout_opts
*opts
)
354 ce
->ce_flags
&= ~CE_MATCHED
;
355 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
357 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
)) {
358 ce
->ce_flags
|= CE_MATCHED
;
359 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
361 * In overlay mode, but the path is not in
362 * tree-ish, which means we should remove it
363 * from the index and the working tree.
365 ce
->ce_flags
|= CE_REMOVE
| CE_WT_REMOVE
;
369 static int checkout_worktree(const struct checkout_opts
*opts
,
370 const struct branch_info
*info
)
372 struct checkout state
= CHECKOUT_INIT
;
373 int nr_checkouts
= 0, nr_unmerged
= 0;
376 int pc_workers
, pc_threshold
;
377 struct mem_pool ce_mem_pool
;
380 state
.refresh_cache
= 1;
381 state
.istate
= &the_index
;
383 mem_pool_init(&ce_mem_pool
, 0);
384 get_parallel_checkout_configs(&pc_workers
, &pc_threshold
);
385 init_checkout_metadata(&state
.meta
, info
->refname
,
386 info
->commit
? &info
->commit
->object
.oid
: &info
->oid
,
389 enable_delayed_checkout(&state
);
392 init_parallel_checkout();
394 for (pos
= 0; pos
< active_nr
; pos
++) {
395 struct cache_entry
*ce
= active_cache
[pos
];
396 if (ce
->ce_flags
& CE_MATCHED
) {
398 errs
|= checkout_entry(ce
, &state
,
399 NULL
, &nr_checkouts
);
402 if (opts
->writeout_stage
)
403 errs
|= checkout_stage(opts
->writeout_stage
,
406 &nr_checkouts
, opts
->overlay_mode
);
407 else if (opts
->merge
)
408 errs
|= checkout_merged(pos
, &state
,
411 pos
= skip_same_name(ce
, pos
) - 1;
415 errs
|= run_parallel_checkout(&state
, pc_workers
, pc_threshold
,
417 mem_pool_discard(&ce_mem_pool
, should_validate_cache_entries());
418 remove_marked_cache_entries(&the_index
, 1);
419 remove_scheduled_dirs();
420 errs
|= finish_delayed_checkout(&state
, opts
->show_progress
);
422 if (opts
->count_checkout_paths
) {
424 fprintf_ln(stderr
, Q_("Recreated %d merge conflict",
425 "Recreated %d merge conflicts",
428 if (opts
->source_tree
)
429 fprintf_ln(stderr
, Q_("Updated %d path from %s",
430 "Updated %d paths from %s",
433 find_unique_abbrev(&opts
->source_tree
->object
.oid
,
435 else if (!nr_unmerged
|| nr_checkouts
)
436 fprintf_ln(stderr
, Q_("Updated %d path from the index",
437 "Updated %d paths from the index",
445 static int checkout_paths(const struct checkout_opts
*opts
,
446 const struct branch_info
*new_branch_info
)
449 static char *ps_matched
;
450 struct object_id rev
;
453 struct lock_file lock_file
= LOCK_INIT
;
456 trace2_cmd_mode(opts
->patch_mode
? "patch" : "path");
458 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
459 die(_("'%s' cannot be used with updating paths"), "--track");
461 if (opts
->new_branch_log
)
462 die(_("'%s' cannot be used with updating paths"), "-l");
464 if (opts
->ignore_unmerged
&& opts
->patch_mode
)
465 die(_("'%s' cannot be used with updating paths"),
466 opts
->ignore_unmerged_opt
);
468 if (opts
->force_detach
)
469 die(_("'%s' cannot be used with updating paths"), "--detach");
471 if (opts
->merge
&& opts
->patch_mode
)
472 die(_("options '%s' and '%s' cannot be used together"), "--merge", "--patch");
474 if (opts
->ignore_unmerged
&& opts
->merge
)
475 die(_("options '%s' and '%s' cannot be used together"),
476 opts
->ignore_unmerged_opt
, "-m");
478 if (opts
->new_branch
)
479 die(_("Cannot update paths and switch to branch '%s' at the same time."),
482 if (!opts
->checkout_worktree
&& !opts
->checkout_index
)
483 die(_("neither '%s' or '%s' is specified"),
484 "--staged", "--worktree");
486 if (!opts
->checkout_worktree
&& !opts
->from_treeish
)
487 die(_("'%s' must be used when '%s' is not specified"),
488 "--worktree", "--source");
490 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
491 opts
->writeout_stage
)
492 die(_("'%s' or '%s' cannot be used with %s"),
493 "--ours", "--theirs", "--staged");
495 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
497 die(_("'%s' or '%s' cannot be used with %s"),
498 "--merge", "--conflict", "--staged");
500 if (opts
->patch_mode
) {
501 const char *patch_mode
;
502 const char *rev
= new_branch_info
->name
;
503 char rev_oid
[GIT_MAX_HEXSZ
+ 1];
506 * Since rev can be in the form of `<a>...<b>` (which is not
507 * recognized by diff-index), we will always replace the name
508 * with the hex of the commit (whether it's in `...` form or
509 * not) for the run_add_interactive() machinery to work
510 * properly. However, there is special logic for the HEAD case
511 * so we mustn't replace that. Also, when we were given a
512 * tree-object, new_branch_info->commit would be NULL, but we
513 * do not have to do any replacement, either.
515 if (rev
&& new_branch_info
->commit
&& strcmp(rev
, "HEAD"))
516 rev
= oid_to_hex_r(rev_oid
, &new_branch_info
->commit
->object
.oid
);
518 if (opts
->checkout_index
&& opts
->checkout_worktree
)
519 patch_mode
= "--patch=checkout";
520 else if (opts
->checkout_index
&& !opts
->checkout_worktree
)
521 patch_mode
= "--patch=reset";
522 else if (!opts
->checkout_index
&& opts
->checkout_worktree
)
523 patch_mode
= "--patch=worktree";
525 BUG("either flag must have been set, worktree=%d, index=%d",
526 opts
->checkout_worktree
, opts
->checkout_index
);
527 return run_add_interactive(rev
, patch_mode
, &opts
->pathspec
);
530 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
531 if (read_cache_preload(&opts
->pathspec
) < 0)
532 return error(_("index file corrupt"));
534 if (opts
->source_tree
)
535 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
537 ps_matched
= xcalloc(opts
->pathspec
.nr
, 1);
540 * Make sure all pathspecs participated in locating the paths
543 for (pos
= 0; pos
< active_nr
; pos
++)
544 if (opts
->overlay_mode
)
545 mark_ce_for_checkout_overlay(active_cache
[pos
],
549 mark_ce_for_checkout_no_overlay(active_cache
[pos
],
553 if (report_path_error(ps_matched
, &opts
->pathspec
)) {
559 /* "checkout -m path" to recreate conflicted state */
561 unmerge_marked_index(&the_index
);
563 /* Any unmerged paths? */
564 for (pos
= 0; pos
< active_nr
; pos
++) {
565 const struct cache_entry
*ce
= active_cache
[pos
];
566 if (ce
->ce_flags
& CE_MATCHED
) {
569 if (opts
->ignore_unmerged
) {
571 warning(_("path '%s' is unmerged"), ce
->name
);
572 } else if (opts
->writeout_stage
) {
573 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
, opts
->overlay_mode
);
574 } else if (opts
->merge
) {
575 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
578 error(_("path '%s' is unmerged"), ce
->name
);
580 pos
= skip_same_name(ce
, pos
) - 1;
586 /* Now we are committed to check them out */
587 if (opts
->checkout_worktree
)
588 errs
|= checkout_worktree(opts
, new_branch_info
);
590 remove_marked_cache_entries(&the_index
, 1);
593 * Allow updating the index when checking out from the index.
594 * This is to save new stat info.
596 if (opts
->checkout_worktree
&& !opts
->checkout_index
&& !opts
->source_tree
)
599 checkout_index
= opts
->checkout_index
;
601 if (checkout_index
) {
602 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
603 die(_("unable to write new index file"));
606 * NEEDSWORK: if --worktree is not specified, we
607 * should save stat info of checked out files in the
608 * index to avoid the next (potentially costly)
609 * refresh. But it's a bit tricker to do...
611 rollback_lock_file(&lock_file
);
614 read_ref_full("HEAD", 0, &rev
, NULL
);
615 head
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
617 errs
|= post_checkout_hook(head
, head
, 0);
621 static void show_local_changes(struct object
*head
,
622 const struct diff_options
*opts
)
625 /* I think we want full paths, even if we're in a subdirectory. */
626 repo_init_revisions(the_repository
, &rev
, NULL
);
627 rev
.diffopt
.flags
= opts
->flags
;
628 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
629 rev
.diffopt
.flags
.recursive
= 1;
630 diff_setup_done(&rev
.diffopt
);
631 add_pending_object(&rev
, head
, NULL
);
632 run_diff_index(&rev
, 0);
633 release_revisions(&rev
);
636 static void describe_detached_head(const char *msg
, struct commit
*commit
)
638 struct strbuf sb
= STRBUF_INIT
;
640 if (!parse_commit(commit
))
641 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
642 if (print_sha1_ellipsis()) {
643 fprintf(stderr
, "%s %s... %s\n", msg
,
644 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
646 fprintf(stderr
, "%s %s %s\n", msg
,
647 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
652 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
653 int worktree
, int *writeout_error
,
654 struct branch_info
*info
)
656 struct unpack_trees_options opts
;
657 struct tree_desc tree_desc
;
659 memset(&opts
, 0, sizeof(opts
));
661 opts
.update
= worktree
;
662 opts
.skip_unmerged
= !worktree
;
663 opts
.reset
= o
->force
? UNPACK_RESET_OVERWRITE_UNTRACKED
:
664 UNPACK_RESET_PROTECT_UNTRACKED
;
665 opts
.preserve_ignored
= (!o
->force
&& !o
->overwrite_ignore
);
667 opts
.fn
= oneway_merge
;
668 opts
.verbose_update
= o
->show_progress
;
669 opts
.src_index
= &the_index
;
670 opts
.dst_index
= &the_index
;
671 init_checkout_metadata(&opts
.meta
, info
->refname
,
672 info
->commit
? &info
->commit
->object
.oid
: null_oid(),
675 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
676 switch (unpack_trees(1, &tree_desc
, &opts
)) {
680 * We return 0 nevertheless, as the index is all right
681 * and more importantly we have made best efforts to
682 * update paths in the work tree, and we cannot revert
693 static void setup_branch_path(struct branch_info
*branch
)
695 struct strbuf buf
= STRBUF_INIT
;
698 * If this is a ref, resolve it; otherwise, look up the OID for our
699 * expression. Failure here is okay.
701 if (!dwim_ref(branch
->name
, strlen(branch
->name
), &branch
->oid
, &branch
->refname
, 0))
702 repo_get_oid_committish(the_repository
, branch
->name
, &branch
->oid
);
704 strbuf_branchname(&buf
, branch
->name
, INTERPRET_BRANCH_LOCAL
);
705 if (strcmp(buf
.buf
, branch
->name
)) {
707 branch
->name
= xstrdup(buf
.buf
);
709 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
711 branch
->path
= strbuf_detach(&buf
, NULL
);
714 static int merge_working_tree(const struct checkout_opts
*opts
,
715 struct branch_info
*old_branch_info
,
716 struct branch_info
*new_branch_info
,
720 struct lock_file lock_file
= LOCK_INIT
;
721 struct tree
*new_tree
;
723 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
724 if (read_cache_preload(NULL
) < 0)
725 return error(_("index file corrupt"));
727 resolve_undo_clear();
728 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
729 if (new_branch_info
->commit
)
730 BUG("'switch --orphan' should never accept a commit as starting point");
731 new_tree
= parse_tree_indirect(the_hash_algo
->empty_tree
);
733 new_tree
= get_commit_tree(new_branch_info
->commit
);
734 if (opts
->discard_changes
) {
735 ret
= reset_tree(new_tree
, opts
, 1, writeout_error
, new_branch_info
);
739 struct tree_desc trees
[2];
741 struct unpack_trees_options topts
;
742 const struct object_id
*old_commit_oid
;
744 memset(&topts
, 0, sizeof(topts
));
746 topts
.src_index
= &the_index
;
747 topts
.dst_index
= &the_index
;
749 setup_unpack_trees_porcelain(&topts
, "checkout");
751 refresh_cache(REFRESH_QUIET
);
753 if (unmerged_cache()) {
754 error(_("you need to resolve your current index first"));
758 /* 2-way merge to the new branch */
759 topts
.initial_checkout
= is_cache_unborn();
762 topts
.quiet
= opts
->merge
&& old_branch_info
->commit
;
763 topts
.verbose_update
= opts
->show_progress
;
764 topts
.fn
= twoway_merge
;
765 init_checkout_metadata(&topts
.meta
, new_branch_info
->refname
,
766 new_branch_info
->commit
?
767 &new_branch_info
->commit
->object
.oid
:
768 &new_branch_info
->oid
, NULL
);
769 topts
.preserve_ignored
= !opts
->overwrite_ignore
;
771 old_commit_oid
= old_branch_info
->commit
?
772 &old_branch_info
->commit
->object
.oid
:
773 the_hash_algo
->empty_tree
;
774 tree
= parse_tree_indirect(old_commit_oid
);
776 die(_("unable to parse commit %s"),
777 oid_to_hex(old_commit_oid
));
779 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
780 parse_tree(new_tree
);
782 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
784 ret
= unpack_trees(2, trees
, &topts
);
785 clear_unpack_trees_porcelain(&topts
);
788 * Unpack couldn't do a trivial merge; either
789 * give up or do a real merge, depending on
790 * whether the merge flag was used.
793 struct tree
*old_tree
;
794 struct merge_options o
;
795 struct strbuf sb
= STRBUF_INIT
;
796 struct strbuf old_commit_shortname
= STRBUF_INIT
;
802 * Without old_branch_info->commit, the below is the same as
803 * the two-tree unpack we already tried and failed.
805 if (!old_branch_info
->commit
)
807 old_tree
= get_commit_tree(old_branch_info
->commit
);
809 if (repo_index_has_changes(the_repository
, old_tree
, &sb
))
810 die(_("cannot continue with staged changes in "
811 "the following files:\n%s"), sb
.buf
);
814 /* Do more real merge */
817 * We update the index fully, then write the
818 * tree from the index, then merge the new
819 * branch with the current tree, with the old
820 * branch as the base. Then we reset the index
821 * (but not the working tree) to the new
822 * branch, leaving the working tree as the
823 * merged version, but skipping unmerged
824 * entries in the index.
827 add_files_to_cache(NULL
, NULL
, 0);
828 init_merge_options(&o
, the_repository
);
830 work
= write_in_core_index_as_tree(the_repository
);
832 ret
= reset_tree(new_tree
,
834 writeout_error
, new_branch_info
);
837 o
.ancestor
= old_branch_info
->name
;
838 if (!old_branch_info
->name
) {
839 strbuf_add_unique_abbrev(&old_commit_shortname
,
840 &old_branch_info
->commit
->object
.oid
,
842 o
.ancestor
= old_commit_shortname
.buf
;
844 o
.branch1
= new_branch_info
->name
;
846 ret
= merge_trees(&o
,
852 ret
= reset_tree(new_tree
,
854 writeout_error
, new_branch_info
);
855 strbuf_release(&o
.obuf
);
856 strbuf_release(&old_commit_shortname
);
862 if (!cache_tree_fully_valid(active_cache_tree
))
863 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
865 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
866 die(_("unable to write new index file"));
868 if (!opts
->discard_changes
&& !opts
->quiet
&& new_branch_info
->commit
)
869 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
874 static void report_tracking(struct branch_info
*new_branch_info
)
876 struct strbuf sb
= STRBUF_INIT
;
877 struct branch
*branch
= branch_get(new_branch_info
->name
);
879 if (!format_tracking_info(branch
, &sb
, AHEAD_BEHIND_FULL
))
881 fputs(sb
.buf
, stdout
);
885 static void update_refs_for_switch(const struct checkout_opts
*opts
,
886 struct branch_info
*old_branch_info
,
887 struct branch_info
*new_branch_info
)
889 struct strbuf msg
= STRBUF_INIT
;
890 const char *old_desc
, *reflog_msg
;
891 if (opts
->new_branch
) {
892 if (opts
->new_orphan_branch
) {
895 refname
= mkpathdup("refs/heads/%s", opts
->new_orphan_branch
);
896 if (opts
->new_branch_log
&&
897 !should_autocreate_reflog(refname
)) {
899 struct strbuf err
= STRBUF_INIT
;
901 ret
= safe_create_reflog(refname
, &err
);
903 fprintf(stderr
, _("Can not do reflog for '%s': %s\n"),
904 opts
->new_orphan_branch
, err
.buf
);
905 strbuf_release(&err
);
909 strbuf_release(&err
);
914 create_branch(the_repository
,
915 opts
->new_branch
, new_branch_info
->name
,
916 opts
->new_branch_force
? 1 : 0,
917 opts
->new_branch_force
? 1 : 0,
918 opts
->new_branch_log
,
922 free(new_branch_info
->name
);
923 free(new_branch_info
->refname
);
924 new_branch_info
->name
= xstrdup(opts
->new_branch
);
925 setup_branch_path(new_branch_info
);
928 old_desc
= old_branch_info
->name
;
929 if (!old_desc
&& old_branch_info
->commit
)
930 old_desc
= oid_to_hex(&old_branch_info
->commit
->object
.oid
);
932 reflog_msg
= getenv("GIT_REFLOG_ACTION");
934 strbuf_addf(&msg
, "checkout: moving from %s to %s",
935 old_desc
? old_desc
: "(invalid)", new_branch_info
->name
);
937 strbuf_insertstr(&msg
, 0, reflog_msg
);
939 if (!strcmp(new_branch_info
->name
, "HEAD") && !new_branch_info
->path
&& !opts
->force_detach
) {
941 } else if (opts
->force_detach
|| !new_branch_info
->path
) { /* No longer on any branch. */
942 update_ref(msg
.buf
, "HEAD", &new_branch_info
->commit
->object
.oid
, NULL
,
943 REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
945 if (old_branch_info
->path
&&
946 advice_enabled(ADVICE_DETACHED_HEAD
) && !opts
->force_detach
)
947 detach_advice(new_branch_info
->name
);
948 describe_detached_head(_("HEAD is now at"), new_branch_info
->commit
);
950 } else if (new_branch_info
->path
) { /* Switch branches. */
951 if (create_symref("HEAD", new_branch_info
->path
, msg
.buf
) < 0)
952 die(_("unable to update HEAD"));
954 if (old_branch_info
->path
&& !strcmp(new_branch_info
->path
, old_branch_info
->path
)) {
955 if (opts
->new_branch_force
)
956 fprintf(stderr
, _("Reset branch '%s'\n"),
957 new_branch_info
->name
);
959 fprintf(stderr
, _("Already on '%s'\n"),
960 new_branch_info
->name
);
961 } else if (opts
->new_branch
) {
962 if (opts
->branch_exists
)
963 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new_branch_info
->name
);
965 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new_branch_info
->name
);
967 fprintf(stderr
, _("Switched to branch '%s'\n"),
968 new_branch_info
->name
);
971 if (old_branch_info
->path
&& old_branch_info
->name
) {
972 if (!ref_exists(old_branch_info
->path
) && reflog_exists(old_branch_info
->path
))
973 delete_reflog(old_branch_info
->path
);
976 remove_branch_state(the_repository
, !opts
->quiet
);
977 strbuf_release(&msg
);
979 (new_branch_info
->path
|| (!opts
->force_detach
&& !strcmp(new_branch_info
->name
, "HEAD"))))
980 report_tracking(new_branch_info
);
983 static int add_pending_uninteresting_ref(const char *refname
,
984 const struct object_id
*oid
,
985 int flags
, void *cb_data
)
987 add_pending_oid(cb_data
, refname
, oid
, UNINTERESTING
);
991 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
993 strbuf_addstr(sb
, " ");
994 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
, DEFAULT_ABBREV
);
995 strbuf_addch(sb
, ' ');
996 if (!parse_commit(commit
))
997 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
998 strbuf_addch(sb
, '\n');
1001 #define ORPHAN_CUTOFF 4
1002 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
1004 struct commit
*c
, *last
= NULL
;
1005 struct strbuf sb
= STRBUF_INIT
;
1007 while ((c
= get_revision(revs
)) != NULL
) {
1008 if (lost
< ORPHAN_CUTOFF
)
1009 describe_one_orphan(&sb
, c
);
1013 if (ORPHAN_CUTOFF
< lost
) {
1014 int more
= lost
- ORPHAN_CUTOFF
;
1016 describe_one_orphan(&sb
, last
);
1018 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
1023 /* The singular version */
1024 "Warning: you are leaving %d commit behind, "
1025 "not connected to\n"
1026 "any of your branches:\n\n"
1028 /* The plural version */
1029 "Warning: you are leaving %d commits behind, "
1030 "not connected to\n"
1031 "any of your branches:\n\n"
1033 /* Give ngettext() the count */
1037 strbuf_release(&sb
);
1039 if (advice_enabled(ADVICE_DETACHED_HEAD
))
1042 /* The singular version */
1043 "If you want to keep it by creating a new branch, "
1044 "this may be a good time\nto do so with:\n\n"
1045 " git branch <new-branch-name> %s\n\n",
1046 /* The plural version */
1047 "If you want to keep them by creating a new branch, "
1048 "this may be a good time\nto do so with:\n\n"
1049 " git branch <new-branch-name> %s\n\n",
1050 /* Give ngettext() the count */
1052 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
1056 * We are about to leave commit that was at the tip of a detached
1057 * HEAD. If it is not reachable from any ref, this is the last chance
1058 * for the user to do so without resorting to reflog.
1060 static void orphaned_commit_warning(struct commit
*old_commit
, struct commit
*new_commit
)
1062 struct rev_info revs
;
1063 struct object
*object
= &old_commit
->object
;
1065 repo_init_revisions(the_repository
, &revs
, NULL
);
1066 setup_revisions(0, NULL
, &revs
, NULL
);
1068 object
->flags
&= ~UNINTERESTING
;
1069 add_pending_object(&revs
, object
, oid_to_hex(&object
->oid
));
1071 for_each_ref(add_pending_uninteresting_ref
, &revs
);
1073 add_pending_oid(&revs
, "HEAD",
1074 &new_commit
->object
.oid
,
1077 if (prepare_revision_walk(&revs
))
1078 die(_("internal error in revision walk"));
1079 if (!(old_commit
->object
.flags
& UNINTERESTING
))
1080 suggest_reattach(old_commit
, &revs
);
1082 describe_detached_head(_("Previous HEAD position was"), old_commit
);
1084 /* Clean up objects used, as they will be reused. */
1085 repo_clear_commit_marks(the_repository
, ALL_REV_FLAGS
);
1086 release_revisions(&revs
);
1089 static int switch_branches(const struct checkout_opts
*opts
,
1090 struct branch_info
*new_branch_info
)
1093 struct branch_info old_branch_info
= { 0 };
1094 struct object_id rev
;
1095 int flag
, writeout_error
= 0;
1098 trace2_cmd_mode("branch");
1100 memset(&old_branch_info
, 0, sizeof(old_branch_info
));
1101 old_branch_info
.path
= resolve_refdup("HEAD", 0, &rev
, &flag
);
1102 if (old_branch_info
.path
)
1103 old_branch_info
.commit
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
1104 if (!(flag
& REF_ISSYMREF
))
1105 FREE_AND_NULL(old_branch_info
.path
);
1107 if (old_branch_info
.path
) {
1108 const char *const prefix
= "refs/heads/";
1110 if (skip_prefix(old_branch_info
.path
, prefix
, &p
))
1111 old_branch_info
.name
= xstrdup(p
);
1114 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
1115 if (new_branch_info
->name
)
1116 BUG("'switch --orphan' should never accept a commit as starting point");
1117 new_branch_info
->commit
= NULL
;
1118 new_branch_info
->name
= xstrdup("(empty)");
1122 if (!new_branch_info
->name
) {
1123 new_branch_info
->name
= xstrdup("HEAD");
1124 new_branch_info
->commit
= old_branch_info
.commit
;
1125 if (!new_branch_info
->commit
)
1126 die(_("You are on a branch yet to be born"));
1127 parse_commit_or_die(new_branch_info
->commit
);
1129 if (opts
->only_merge_on_switching_branches
)
1134 ret
= merge_working_tree(opts
, &old_branch_info
, new_branch_info
, &writeout_error
);
1136 branch_info_release(&old_branch_info
);
1141 if (!opts
->quiet
&& !old_branch_info
.path
&& old_branch_info
.commit
&& new_branch_info
->commit
!= old_branch_info
.commit
)
1142 orphaned_commit_warning(old_branch_info
.commit
, new_branch_info
->commit
);
1144 update_refs_for_switch(opts
, &old_branch_info
, new_branch_info
);
1146 ret
= post_checkout_hook(old_branch_info
.commit
, new_branch_info
->commit
, 1);
1147 branch_info_release(&old_branch_info
);
1149 return ret
|| writeout_error
;
1152 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
1154 struct checkout_opts
*opts
= cb
;
1156 if (!strcmp(var
, "diff.ignoresubmodules")) {
1157 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
1160 if (!strcmp(var
, "checkout.guess")) {
1161 opts
->dwim_new_local_branch
= git_config_bool(var
, value
);
1165 if (starts_with(var
, "submodule."))
1166 return git_default_submodule_config(var
, value
, NULL
);
1168 return git_xmerge_config(var
, value
, NULL
);
1171 static void setup_new_branch_info_and_source_tree(
1172 struct branch_info
*new_branch_info
,
1173 struct checkout_opts
*opts
,
1174 struct object_id
*rev
,
1177 struct tree
**source_tree
= &opts
->source_tree
;
1178 struct object_id branch_rev
;
1180 new_branch_info
->name
= xstrdup(arg
);
1181 setup_branch_path(new_branch_info
);
1183 if (!check_refname_format(new_branch_info
->path
, 0) &&
1184 !read_ref(new_branch_info
->path
, &branch_rev
))
1185 oidcpy(rev
, &branch_rev
);
1187 /* not an existing branch */
1188 FREE_AND_NULL(new_branch_info
->path
);
1190 new_branch_info
->commit
= lookup_commit_reference_gently(the_repository
, rev
, 1);
1191 if (!new_branch_info
->commit
) {
1193 *source_tree
= parse_tree_indirect(rev
);
1195 parse_commit_or_die(new_branch_info
->commit
);
1196 *source_tree
= get_commit_tree(new_branch_info
->commit
);
1200 static const char *parse_remote_branch(const char *arg
,
1201 struct object_id
*rev
,
1202 int could_be_checkout_paths
)
1204 int num_matches
= 0;
1205 const char *remote
= unique_tracking_name(arg
, rev
, &num_matches
);
1207 if (remote
&& could_be_checkout_paths
) {
1208 die(_("'%s' could be both a local file and a tracking branch.\n"
1209 "Please use -- (and optionally --no-guess) to disambiguate"),
1213 if (!remote
&& num_matches
> 1) {
1214 if (advice_enabled(ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME
)) {
1215 advise(_("If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1216 "you can do so by fully qualifying the name with the --track option:\n"
1218 " git checkout --track origin/<name>\n"
1220 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1221 "one remote, e.g. the 'origin' remote, consider setting\n"
1222 "checkout.defaultRemote=origin in your config."));
1225 die(_("'%s' matched multiple (%d) remote tracking branches"),
1232 static int parse_branchname_arg(int argc
, const char **argv
,
1233 int dwim_new_local_branch_ok
,
1234 struct branch_info
*new_branch_info
,
1235 struct checkout_opts
*opts
,
1236 struct object_id
*rev
)
1238 const char **new_branch
= &opts
->new_branch
;
1242 int has_dash_dash
= 0;
1246 * case 1: git checkout <ref> -- [<paths>]
1248 * <ref> must be a valid tree, everything after the '--' must be
1251 * case 2: git checkout -- [<paths>]
1253 * everything after the '--' must be paths.
1255 * case 3: git checkout <something> [--]
1257 * (a) If <something> is a commit, that is to
1258 * switch to the branch or detach HEAD at it. As a special case,
1259 * if <something> is A...B (missing A or B means HEAD but you can
1260 * omit at most one side), and if there is a unique merge base
1261 * between A and B, A...B names that merge base.
1263 * (b) If <something> is _not_ a commit, either "--" is present
1264 * or <something> is not a path, no -t or -b was given, and
1265 * and there is a tracking branch whose name is <something>
1266 * in one and only one remote (or if the branch exists on the
1267 * remote named in checkout.defaultRemote), then this is a
1268 * short-hand to fork local <something> from that
1269 * remote-tracking branch.
1271 * (c) Otherwise, if "--" is present, treat it like case (1).
1274 * - if it's a reference, treat it like case (1)
1275 * - else if it's a path, treat it like case (2)
1278 * case 4: git checkout <something> <paths>
1280 * The first argument must not be ambiguous.
1281 * - If it's *only* a reference, treat it like case (1).
1282 * - If it's only a path, treat it like case (2).
1289 if (!opts
->accept_pathspec
) {
1291 die(_("only one reference expected"));
1292 has_dash_dash
= 1; /* helps disambiguate */
1297 for (i
= 0; i
< argc
; i
++) {
1298 if (opts
->accept_pathspec
&& !strcmp(argv
[i
], "--")) {
1303 if (dash_dash_pos
== 0)
1304 return 1; /* case (2) */
1305 else if (dash_dash_pos
== 1)
1306 has_dash_dash
= 1; /* case (3) or (1) */
1307 else if (dash_dash_pos
>= 2)
1308 die(_("only one reference expected, %d given."), dash_dash_pos
);
1309 opts
->count_checkout_paths
= !opts
->quiet
&& !has_dash_dash
;
1311 if (!strcmp(arg
, "-"))
1314 if (get_oid_mb(arg
, rev
)) {
1316 * Either case (3) or (4), with <something> not being
1317 * a commit, or an attempt to use case (1) with an
1320 * It's likely an error, but we need to find out if
1321 * we should auto-create the branch, case (3).(b).
1323 int recover_with_dwim
= dwim_new_local_branch_ok
;
1325 int could_be_checkout_paths
= !has_dash_dash
&&
1326 check_filename(opts
->prefix
, arg
);
1328 if (!has_dash_dash
&& !no_wildcard(arg
))
1329 recover_with_dwim
= 0;
1332 * Accept "git checkout foo", "git checkout foo --"
1333 * and "git switch foo" as candidates for dwim.
1335 if (!(argc
== 1 && !has_dash_dash
) &&
1336 !(argc
== 2 && has_dash_dash
) &&
1337 opts
->accept_pathspec
)
1338 recover_with_dwim
= 0;
1340 if (recover_with_dwim
) {
1341 const char *remote
= parse_remote_branch(arg
, rev
,
1342 could_be_checkout_paths
);
1346 /* DWIMmed to create local branch, case (3).(b) */
1348 recover_with_dwim
= 0;
1352 if (!recover_with_dwim
) {
1354 die(_("invalid reference: %s"), arg
);
1359 /* we can't end up being in (2) anymore, eat the argument */
1364 setup_new_branch_info_and_source_tree(new_branch_info
, opts
, rev
, arg
);
1366 if (!opts
->source_tree
) /* case (1): want a tree */
1367 die(_("reference is not a tree: %s"), arg
);
1369 if (!has_dash_dash
) { /* case (3).(d) -> (1) */
1371 * Do not complain the most common case
1372 * git checkout branch
1373 * even if there happen to be a file called 'branch';
1374 * it would be extremely annoying.
1377 verify_non_filename(opts
->prefix
, arg
);
1378 } else if (opts
->accept_pathspec
) {
1387 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1390 struct strbuf branch_ref
= STRBUF_INIT
;
1392 trace2_cmd_mode("unborn");
1394 if (!opts
->new_branch
)
1395 die(_("You are on a branch yet to be born"));
1396 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1397 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1398 strbuf_release(&branch_ref
);
1400 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1405 static void die_expecting_a_branch(const struct branch_info
*branch_info
)
1407 struct object_id oid
;
1411 if (dwim_ref(branch_info
->name
, strlen(branch_info
->name
), &oid
, &to_free
, 0) == 1) {
1412 const char *ref
= to_free
;
1414 if (skip_prefix(ref
, "refs/tags/", &ref
))
1415 code
= die_message(_("a branch is expected, got tag '%s'"), ref
);
1416 else if (skip_prefix(ref
, "refs/remotes/", &ref
))
1417 code
= die_message(_("a branch is expected, got remote branch '%s'"), ref
);
1419 code
= die_message(_("a branch is expected, got '%s'"), ref
);
1421 else if (branch_info
->commit
)
1422 code
= die_message(_("a branch is expected, got commit '%s'"), branch_info
->name
);
1425 * This case should never happen because we already die() on
1426 * non-commit, but just in case.
1428 code
= die_message(_("a branch is expected, got '%s'"), branch_info
->name
);
1430 if (advice_enabled(ADVICE_SUGGEST_DETACHING_HEAD
))
1431 advise(_("If you want to detach HEAD at the commit, try again with the --detach option."));
1436 static void die_if_some_operation_in_progress(void)
1438 struct wt_status_state state
;
1440 memset(&state
, 0, sizeof(state
));
1441 wt_status_get_state(the_repository
, &state
, 0);
1443 if (state
.merge_in_progress
)
1444 die(_("cannot switch branch while merging\n"
1445 "Consider \"git merge --quit\" "
1446 "or \"git worktree add\"."));
1447 if (state
.am_in_progress
)
1448 die(_("cannot switch branch in the middle of an am session\n"
1449 "Consider \"git am --quit\" "
1450 "or \"git worktree add\"."));
1451 if (state
.rebase_interactive_in_progress
|| state
.rebase_in_progress
)
1452 die(_("cannot switch branch while rebasing\n"
1453 "Consider \"git rebase --quit\" "
1454 "or \"git worktree add\"."));
1455 if (state
.cherry_pick_in_progress
)
1456 die(_("cannot switch branch while cherry-picking\n"
1457 "Consider \"git cherry-pick --quit\" "
1458 "or \"git worktree add\"."));
1459 if (state
.revert_in_progress
)
1460 die(_("cannot switch branch while reverting\n"
1461 "Consider \"git revert --quit\" "
1462 "or \"git worktree add\"."));
1463 if (state
.bisect_in_progress
)
1464 warning(_("you are switching branch while bisecting"));
1467 static int checkout_branch(struct checkout_opts
*opts
,
1468 struct branch_info
*new_branch_info
)
1470 if (opts
->pathspec
.nr
)
1471 die(_("paths cannot be used with switching branches"));
1473 if (opts
->patch_mode
)
1474 die(_("'%s' cannot be used with switching branches"),
1477 if (opts
->overlay_mode
!= -1)
1478 die(_("'%s' cannot be used with switching branches"),
1481 if (opts
->writeout_stage
)
1482 die(_("'%s' cannot be used with switching branches"),
1485 if (opts
->force
&& opts
->merge
)
1486 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1488 if (opts
->discard_changes
&& opts
->merge
)
1489 die(_("'%s' cannot be used with '%s'"), "--discard-changes", "--merge");
1491 if (opts
->force_detach
&& opts
->new_branch
)
1492 die(_("'%s' cannot be used with '%s'"),
1493 "--detach", "-b/-B/--orphan");
1495 if (opts
->new_orphan_branch
) {
1496 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1497 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1498 if (opts
->orphan_from_empty_tree
&& new_branch_info
->name
)
1499 die(_("'%s' cannot take <start-point>"), "--orphan");
1500 } else if (opts
->force_detach
) {
1501 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1502 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1503 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1504 opts
->track
= git_branch_track
;
1506 if (new_branch_info
->name
&& !new_branch_info
->commit
)
1507 die(_("Cannot switch branch to a non-commit '%s'"),
1508 new_branch_info
->name
);
1510 if (!opts
->switch_branch_doing_nothing_is_ok
&&
1511 !new_branch_info
->name
&&
1512 !opts
->new_branch
&&
1513 !opts
->force_detach
)
1514 die(_("missing branch or commit argument"));
1516 if (!opts
->implicit_detach
&&
1517 !opts
->force_detach
&&
1518 !opts
->new_branch
&&
1519 !opts
->new_branch_force
&&
1520 new_branch_info
->name
&&
1521 !new_branch_info
->path
)
1522 die_expecting_a_branch(new_branch_info
);
1524 if (!opts
->can_switch_when_in_progress
)
1525 die_if_some_operation_in_progress();
1527 if (new_branch_info
->path
&& !opts
->force_detach
&& !opts
->new_branch
&&
1528 !opts
->ignore_other_worktrees
) {
1530 char *head_ref
= resolve_refdup("HEAD", 0, NULL
, &flag
);
1532 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new_branch_info
->path
)))
1533 die_if_checked_out(new_branch_info
->path
, 1);
1537 if (!new_branch_info
->commit
&& opts
->new_branch
) {
1538 struct object_id rev
;
1541 if (!read_ref_full("HEAD", 0, &rev
, &flag
) &&
1542 (flag
& REF_ISSYMREF
) && is_null_oid(&rev
))
1543 return switch_unborn_to_new_branch(opts
);
1545 return switch_branches(opts
, new_branch_info
);
1548 static struct option
*add_common_options(struct checkout_opts
*opts
,
1549 struct option
*prevopts
)
1551 struct option options
[] = {
1552 OPT__QUIET(&opts
->quiet
, N_("suppress progress reporting")),
1553 OPT_CALLBACK_F(0, "recurse-submodules", NULL
,
1554 "checkout", "control recursive updating of submodules",
1555 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
),
1556 OPT_BOOL(0, "progress", &opts
->show_progress
, N_("force progress reporting")),
1557 OPT_BOOL('m', "merge", &opts
->merge
, N_("perform a 3-way merge with the new branch")),
1558 OPT_STRING(0, "conflict", &opts
->conflict_style
, N_("style"),
1559 N_("conflict style (merge, diff3, or zdiff3)")),
1562 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1567 static struct option
*add_common_switch_branch_options(
1568 struct checkout_opts
*opts
, struct option
*prevopts
)
1570 struct option options
[] = {
1571 OPT_BOOL('d', "detach", &opts
->force_detach
, N_("detach HEAD at named commit")),
1572 OPT_CALLBACK_F('t', "track", &opts
->track
, "(direct|inherit)",
1573 N_("set branch tracking configuration"),
1575 parse_opt_tracking_mode
),
1576 OPT__FORCE(&opts
->force
, N_("force checkout (throw away local modifications)"),
1577 PARSE_OPT_NOCOMPLETE
),
1578 OPT_STRING(0, "orphan", &opts
->new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1579 OPT_BOOL_F(0, "overwrite-ignore", &opts
->overwrite_ignore
,
1580 N_("update ignored files (default)"),
1581 PARSE_OPT_NOCOMPLETE
),
1582 OPT_BOOL(0, "ignore-other-worktrees", &opts
->ignore_other_worktrees
,
1583 N_("do not check if another worktree is holding the given ref")),
1586 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1591 static struct option
*add_checkout_path_options(struct checkout_opts
*opts
,
1592 struct option
*prevopts
)
1594 struct option options
[] = {
1595 OPT_SET_INT_F('2', "ours", &opts
->writeout_stage
,
1596 N_("checkout our version for unmerged files"),
1597 2, PARSE_OPT_NONEG
),
1598 OPT_SET_INT_F('3', "theirs", &opts
->writeout_stage
,
1599 N_("checkout their version for unmerged files"),
1600 3, PARSE_OPT_NONEG
),
1601 OPT_BOOL('p', "patch", &opts
->patch_mode
, N_("select hunks interactively")),
1602 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
->ignore_skipworktree
,
1603 N_("do not limit pathspecs to sparse entries only")),
1604 OPT_PATHSPEC_FROM_FILE(&opts
->pathspec_from_file
),
1605 OPT_PATHSPEC_FILE_NUL(&opts
->pathspec_file_nul
),
1608 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1613 /* create-branch option (either b or c) */
1614 static char cb_option
= 'b';
1616 static int checkout_main(int argc
, const char **argv
, const char *prefix
,
1617 struct checkout_opts
*opts
, struct option
*options
,
1618 const char * const usagestr
[],
1619 struct branch_info
*new_branch_info
)
1621 int parseopt_flags
= 0;
1623 opts
->overwrite_ignore
= 1;
1624 opts
->prefix
= prefix
;
1625 opts
->show_progress
= -1;
1627 git_config(git_checkout_config
, opts
);
1628 if (the_repository
->gitdir
) {
1629 prepare_repo_settings(the_repository
);
1630 the_repository
->settings
.command_requires_full_index
= 0;
1633 opts
->track
= BRANCH_TRACK_UNSPECIFIED
;
1635 if (!opts
->accept_pathspec
&& !opts
->accept_ref
)
1636 BUG("make up your mind, you need to take _something_");
1637 if (opts
->accept_pathspec
&& opts
->accept_ref
)
1638 parseopt_flags
= PARSE_OPT_KEEP_DASHDASH
;
1640 argc
= parse_options(argc
, argv
, prefix
, options
,
1641 usagestr
, parseopt_flags
);
1643 if (opts
->show_progress
< 0) {
1645 opts
->show_progress
= 0;
1647 opts
->show_progress
= isatty(2);
1650 if (opts
->conflict_style
) {
1651 opts
->merge
= 1; /* implied */
1652 git_xmerge_config("merge.conflictstyle", opts
->conflict_style
, NULL
);
1655 opts
->discard_changes
= 1;
1656 opts
->ignore_unmerged_opt
= "--force";
1657 opts
->ignore_unmerged
= 1;
1660 if ((!!opts
->new_branch
+ !!opts
->new_branch_force
+ !!opts
->new_orphan_branch
) > 1)
1661 die(_("options '-%c', '-%c', and '%s' cannot be used together"),
1662 cb_option
, toupper(cb_option
), "--orphan");
1664 if (opts
->overlay_mode
== 1 && opts
->patch_mode
)
1665 die(_("options '%s' and '%s' cannot be used together"), "-p", "--overlay");
1667 if (opts
->checkout_index
>= 0 || opts
->checkout_worktree
>= 0) {
1668 if (opts
->checkout_index
< 0)
1669 opts
->checkout_index
= 0;
1670 if (opts
->checkout_worktree
< 0)
1671 opts
->checkout_worktree
= 0;
1673 if (opts
->checkout_index
< 0)
1674 opts
->checkout_index
= -opts
->checkout_index
- 1;
1675 if (opts
->checkout_worktree
< 0)
1676 opts
->checkout_worktree
= -opts
->checkout_worktree
- 1;
1678 if (opts
->checkout_index
< 0 || opts
->checkout_worktree
< 0)
1679 BUG("these flags should be non-negative by now");
1681 * convenient shortcut: "git restore --staged [--worktree]" equals
1682 * "git restore --staged [--worktree] --source HEAD"
1684 if (!opts
->from_treeish
&& opts
->checkout_index
)
1685 opts
->from_treeish
= "HEAD";
1688 * From here on, new_branch will contain the branch to be checked out,
1689 * and new_branch_force and new_orphan_branch will tell us which one of
1690 * -b/-B/-c/-C/--orphan is being used.
1692 if (opts
->new_branch_force
)
1693 opts
->new_branch
= opts
->new_branch_force
;
1695 if (opts
->new_orphan_branch
)
1696 opts
->new_branch
= opts
->new_orphan_branch
;
1698 /* --track without -c/-C/-b/-B/--orphan should DWIM */
1699 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
->new_branch
) {
1700 const char *argv0
= argv
[0];
1701 if (!argc
|| !strcmp(argv0
, "--"))
1702 die(_("--track needs a branch name"));
1703 skip_prefix(argv0
, "refs/", &argv0
);
1704 skip_prefix(argv0
, "remotes/", &argv0
);
1705 argv0
= strchr(argv0
, '/');
1706 if (!argv0
|| !argv0
[1])
1707 die(_("missing branch name; try -%c"), cb_option
);
1708 opts
->new_branch
= argv0
+ 1;
1712 * Extract branch name from command line arguments, so
1713 * all that is left is pathspecs.
1717 * 1) git checkout <tree> -- [<paths>]
1718 * 2) git checkout -- [<paths>]
1719 * 3) git checkout <something> [<paths>]
1721 * including "last branch" syntax and DWIM-ery for names of
1722 * remote branches, erroring out for invalid or ambiguous cases.
1724 if (argc
&& opts
->accept_ref
) {
1725 struct object_id rev
;
1727 !opts
->patch_mode
&&
1728 opts
->dwim_new_local_branch
&&
1729 opts
->track
== BRANCH_TRACK_UNSPECIFIED
&&
1731 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1732 new_branch_info
, opts
, &rev
);
1735 } else if (!opts
->accept_ref
&& opts
->from_treeish
) {
1736 struct object_id rev
;
1738 if (get_oid_mb(opts
->from_treeish
, &rev
))
1739 die(_("could not resolve %s"), opts
->from_treeish
);
1741 setup_new_branch_info_and_source_tree(new_branch_info
,
1743 opts
->from_treeish
);
1745 if (!opts
->source_tree
)
1746 die(_("reference is not a tree: %s"), opts
->from_treeish
);
1750 parse_pathspec(&opts
->pathspec
, 0,
1751 opts
->patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1754 if (!opts
->pathspec
.nr
)
1755 die(_("invalid path specification"));
1758 * Try to give more helpful suggestion.
1759 * new_branch && argc > 1 will be caught later.
1761 if (opts
->new_branch
&& argc
== 1 && !new_branch_info
->commit
)
1762 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1763 argv
[0], opts
->new_branch
);
1765 if (opts
->force_detach
)
1766 die(_("git checkout: --detach does not take a path argument '%s'"),
1770 if (opts
->pathspec_from_file
) {
1771 if (opts
->pathspec
.nr
)
1772 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
1774 if (opts
->force_detach
)
1775 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--detach");
1777 if (opts
->patch_mode
)
1778 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
1780 parse_pathspec_file(&opts
->pathspec
, 0,
1782 prefix
, opts
->pathspec_from_file
, opts
->pathspec_file_nul
);
1783 } else if (opts
->pathspec_file_nul
) {
1784 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
1787 opts
->pathspec
.recursive
= 1;
1789 if (opts
->pathspec
.nr
) {
1790 if (1 < !!opts
->writeout_stage
+ !!opts
->force
+ !!opts
->merge
)
1791 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1792 "checking out of the index."));
1794 if (opts
->accept_pathspec
&& !opts
->empty_pathspec_ok
&&
1795 !opts
->patch_mode
) /* patch mode is special */
1796 die(_("you must specify path(s) to restore"));
1799 if (opts
->new_branch
) {
1800 struct strbuf buf
= STRBUF_INIT
;
1802 if (opts
->new_branch_force
)
1803 opts
->branch_exists
= validate_branchname(opts
->new_branch
, &buf
);
1805 opts
->branch_exists
=
1806 validate_new_branchname(opts
->new_branch
, &buf
, 0);
1807 strbuf_release(&buf
);
1810 if (opts
->patch_mode
|| opts
->pathspec
.nr
)
1811 return checkout_paths(opts
, new_branch_info
);
1813 return checkout_branch(opts
, new_branch_info
);
1816 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1818 struct checkout_opts opts
;
1819 struct option
*options
;
1820 struct option checkout_options
[] = {
1821 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1822 N_("create and checkout a new branch")),
1823 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1824 N_("create/reset and checkout a branch")),
1825 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1826 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1827 N_("second guess 'git checkout <no-such-branch>' (default)")),
1828 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode (default)")),
1832 struct branch_info new_branch_info
= { 0 };
1834 memset(&opts
, 0, sizeof(opts
));
1835 opts
.dwim_new_local_branch
= 1;
1836 opts
.switch_branch_doing_nothing_is_ok
= 1;
1837 opts
.only_merge_on_switching_branches
= 0;
1838 opts
.accept_ref
= 1;
1839 opts
.accept_pathspec
= 1;
1840 opts
.implicit_detach
= 1;
1841 opts
.can_switch_when_in_progress
= 1;
1842 opts
.orphan_from_empty_tree
= 0;
1843 opts
.empty_pathspec_ok
= 1;
1844 opts
.overlay_mode
= -1;
1845 opts
.checkout_index
= -2; /* default on */
1846 opts
.checkout_worktree
= -2; /* default on */
1848 if (argc
== 3 && !strcmp(argv
[1], "-b")) {
1850 * User ran 'git checkout -b <branch>' and expects
1851 * the same behavior as 'git switch -c <branch>'.
1853 opts
.switch_branch_doing_nothing_is_ok
= 0;
1854 opts
.only_merge_on_switching_branches
= 1;
1857 options
= parse_options_dup(checkout_options
);
1858 options
= add_common_options(&opts
, options
);
1859 options
= add_common_switch_branch_options(&opts
, options
);
1860 options
= add_checkout_path_options(&opts
, options
);
1862 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1863 options
, checkout_usage
, &new_branch_info
);
1864 branch_info_release(&new_branch_info
);
1865 clear_pathspec(&opts
.pathspec
);
1866 FREE_AND_NULL(options
);
1870 int cmd_switch(int argc
, const char **argv
, const char *prefix
)
1872 struct checkout_opts opts
;
1873 struct option
*options
= NULL
;
1874 struct option switch_options
[] = {
1875 OPT_STRING('c', "create", &opts
.new_branch
, N_("branch"),
1876 N_("create and switch to a new branch")),
1877 OPT_STRING('C', "force-create", &opts
.new_branch_force
, N_("branch"),
1878 N_("create/reset and switch to a branch")),
1879 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1880 N_("second guess 'git switch <no-such-branch>'")),
1881 OPT_BOOL(0, "discard-changes", &opts
.discard_changes
,
1882 N_("throw away local modifications")),
1886 struct branch_info new_branch_info
= { 0 };
1888 memset(&opts
, 0, sizeof(opts
));
1889 opts
.dwim_new_local_branch
= 1;
1890 opts
.accept_ref
= 1;
1891 opts
.accept_pathspec
= 0;
1892 opts
.switch_branch_doing_nothing_is_ok
= 0;
1893 opts
.only_merge_on_switching_branches
= 1;
1894 opts
.implicit_detach
= 0;
1895 opts
.can_switch_when_in_progress
= 0;
1896 opts
.orphan_from_empty_tree
= 1;
1897 opts
.overlay_mode
= -1;
1899 options
= parse_options_dup(switch_options
);
1900 options
= add_common_options(&opts
, options
);
1901 options
= add_common_switch_branch_options(&opts
, options
);
1905 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1906 options
, switch_branch_usage
, &new_branch_info
);
1907 branch_info_release(&new_branch_info
);
1908 FREE_AND_NULL(options
);
1912 int cmd_restore(int argc
, const char **argv
, const char *prefix
)
1914 struct checkout_opts opts
;
1915 struct option
*options
;
1916 struct option restore_options
[] = {
1917 OPT_STRING('s', "source", &opts
.from_treeish
, "<tree-ish>",
1918 N_("which tree-ish to checkout from")),
1919 OPT_BOOL('S', "staged", &opts
.checkout_index
,
1920 N_("restore the index")),
1921 OPT_BOOL('W', "worktree", &opts
.checkout_worktree
,
1922 N_("restore the working tree (default)")),
1923 OPT_BOOL(0, "ignore-unmerged", &opts
.ignore_unmerged
,
1924 N_("ignore unmerged entries")),
1925 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode")),
1929 struct branch_info new_branch_info
= { 0 };
1931 memset(&opts
, 0, sizeof(opts
));
1932 opts
.accept_ref
= 0;
1933 opts
.accept_pathspec
= 1;
1934 opts
.empty_pathspec_ok
= 0;
1935 opts
.overlay_mode
= 0;
1936 opts
.checkout_index
= -1; /* default off */
1937 opts
.checkout_worktree
= -2; /* default on */
1938 opts
.ignore_unmerged_opt
= "--ignore-unmerged";
1940 options
= parse_options_dup(restore_options
);
1941 options
= add_common_options(&opts
, options
);
1942 options
= add_checkout_path_options(&opts
, options
);
1944 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1945 options
, restore_usage
, &new_branch_info
);
1946 branch_info_release(&new_branch_info
);
1947 FREE_AND_NULL(options
);