1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
6 #include "cache-tree.h"
14 #include "merge-recursive.h"
15 #include "object-store.h"
16 #include "parse-options.h"
19 #include "resolve-undo.h"
21 #include "run-command.h"
22 #include "submodule.h"
23 #include "submodule-config.h"
25 #include "tree-walk.h"
26 #include "unpack-trees.h"
27 #include "wt-status.h"
28 #include "xdiff-interface.h"
30 static const char * const checkout_usage
[] = {
31 N_("git checkout [<options>] <branch>"),
32 N_("git checkout [<options>] [<branch>] -- <file>..."),
36 static const char * const switch_branch_usage
[] = {
37 N_("git switch [<options>] [<branch>]"),
41 static const char * const restore_usage
[] = {
42 N_("git restore [<options>] [--source=<branch>] <file>..."),
46 struct checkout_opts
{
55 int ignore_skipworktree
;
56 int ignore_other_worktrees
;
58 int count_checkout_paths
;
60 int dwim_new_local_branch
;
64 int switch_branch_doing_nothing_is_ok
;
65 int only_merge_on_switching_branches
;
66 int can_switch_when_in_progress
;
67 int orphan_from_empty_tree
;
68 int empty_pathspec_ok
;
70 int checkout_worktree
;
71 const char *ignore_unmerged_opt
;
73 int pathspec_file_nul
;
74 const char *pathspec_from_file
;
76 const char *new_branch
;
77 const char *new_branch_force
;
78 const char *new_orphan_branch
;
80 enum branch_track track
;
81 struct diff_options diff_options
;
86 struct pathspec pathspec
;
87 const char *from_treeish
;
88 struct tree
*source_tree
;
92 const char *name
; /* The short name used */
93 const char *path
; /* The full name of a real branch */
94 struct commit
*commit
; /* The named commit */
95 char *refname
; /* The full name of the ref being checked out. */
96 struct object_id oid
; /* The object ID of the commit being checked out. */
98 * if not null the branch is detached because it's already
99 * checked out in this checkout
104 static int post_checkout_hook(struct commit
*old_commit
, struct commit
*new_commit
,
107 return run_hook_le(NULL
, "post-checkout",
108 oid_to_hex(old_commit
? &old_commit
->object
.oid
: &null_oid
),
109 oid_to_hex(new_commit
? &new_commit
->object
.oid
: &null_oid
),
110 changed
? "1" : "0", NULL
);
111 /* "new_commit" can be NULL when checking out from the index before
116 static int update_some(const struct object_id
*oid
, struct strbuf
*base
,
117 const char *pathname
, unsigned mode
, int stage
, void *context
)
120 struct cache_entry
*ce
;
124 return READ_TREE_RECURSIVE
;
126 len
= base
->len
+ strlen(pathname
);
127 ce
= make_empty_cache_entry(&the_index
, len
);
128 oidcpy(&ce
->oid
, oid
);
129 memcpy(ce
->name
, base
->buf
, base
->len
);
130 memcpy(ce
->name
+ base
->len
, pathname
, len
- base
->len
);
131 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
132 ce
->ce_namelen
= len
;
133 ce
->ce_mode
= create_ce_mode(mode
);
136 * If the entry is the same as the current index, we can leave the old
137 * entry in place. Whether it is UPTODATE or not, checkout_entry will
138 * do the right thing.
140 pos
= cache_name_pos(ce
->name
, ce
->ce_namelen
);
142 struct cache_entry
*old
= active_cache
[pos
];
143 if (ce
->ce_mode
== old
->ce_mode
&&
144 !ce_intent_to_add(old
) &&
145 oideq(&ce
->oid
, &old
->oid
)) {
146 old
->ce_flags
|= CE_UPDATE
;
147 discard_cache_entry(ce
);
152 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
156 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
158 read_tree_recursive(the_repository
, tree
, "", 0, 0,
159 pathspec
, update_some
, NULL
);
161 /* update the index with the given tree's info
162 * for all args, expanding wildcards, and exit
163 * with any non-zero return code.
168 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
170 while (++pos
< active_nr
&&
171 !strcmp(active_cache
[pos
]->name
, ce
->name
))
176 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
,
179 while (pos
< active_nr
&&
180 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
181 if (ce_stage(active_cache
[pos
]) == stage
)
188 return error(_("path '%s' does not have our version"), ce
->name
);
190 return error(_("path '%s' does not have their version"), ce
->name
);
193 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
196 const char *name
= ce
->name
;
198 while (pos
< active_nr
) {
199 ce
= active_cache
[pos
];
200 if (strcmp(name
, ce
->name
))
202 seen
|= (1 << ce_stage(ce
));
205 if ((stages
& seen
) != stages
)
206 return error(_("path '%s' does not have all necessary versions"),
211 static int checkout_stage(int stage
, const struct cache_entry
*ce
, int pos
,
212 const struct checkout
*state
, int *nr_checkouts
,
215 while (pos
< active_nr
&&
216 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
217 if (ce_stage(active_cache
[pos
]) == stage
)
218 return checkout_entry(active_cache
[pos
], state
,
227 return error(_("path '%s' does not have our version"), ce
->name
);
229 return error(_("path '%s' does not have their version"), ce
->name
);
232 static int checkout_merged(int pos
, const struct checkout
*state
, int *nr_checkouts
)
234 struct cache_entry
*ce
= active_cache
[pos
];
235 const char *path
= ce
->name
;
236 mmfile_t ancestor
, ours
, theirs
;
238 struct object_id oid
;
239 mmbuffer_t result_buf
;
240 struct object_id threeway
[3];
242 struct ll_merge_options ll_opts
;
245 memset(threeway
, 0, sizeof(threeway
));
246 while (pos
< active_nr
) {
248 stage
= ce_stage(ce
);
249 if (!stage
|| strcmp(path
, ce
->name
))
251 oidcpy(&threeway
[stage
- 1], &ce
->oid
);
253 mode
= create_ce_mode(ce
->ce_mode
);
255 ce
= active_cache
[pos
];
257 if (is_null_oid(&threeway
[1]) || is_null_oid(&threeway
[2]))
258 return error(_("path '%s' does not have necessary versions"), path
);
260 read_mmblob(&ancestor
, &threeway
[0]);
261 read_mmblob(&ours
, &threeway
[1]);
262 read_mmblob(&theirs
, &threeway
[2]);
264 memset(&ll_opts
, 0, sizeof(ll_opts
));
265 git_config_get_bool("merge.renormalize", &renormalize
);
266 ll_opts
.renormalize
= renormalize
;
267 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
268 &ours
, "ours", &theirs
, "theirs",
269 state
->istate
, &ll_opts
);
273 if (status
< 0 || !result_buf
.ptr
) {
274 free(result_buf
.ptr
);
275 return error(_("path '%s': cannot merge"), path
);
280 * There is absolutely no reason to write this as a blob object
281 * and create a phony cache entry. This hack is primarily to get
282 * to the write_entry() machinery that massages the contents to
283 * work-tree format and writes out which only allows it for a
284 * cache entry. The code in write_entry() needs to be refactored
285 * to allow us to feed a <buffer, size, mode> instead of a cache
286 * entry. Such a refactoring would help merge_recursive as well
287 * (it also writes the merge result to the object database even
288 * when it may contain conflicts).
290 if (write_object_file(result_buf
.ptr
, result_buf
.size
, blob_type
, &oid
))
291 die(_("Unable to add merge result for '%s'"), path
);
292 free(result_buf
.ptr
);
293 ce
= make_transient_cache_entry(mode
, &oid
, path
, 2);
295 die(_("make_cache_entry failed for path '%s'"), path
);
296 status
= checkout_entry(ce
, state
, NULL
, nr_checkouts
);
297 discard_cache_entry(ce
);
301 static void mark_ce_for_checkout_overlay(struct cache_entry
*ce
,
303 const struct checkout_opts
*opts
)
305 ce
->ce_flags
&= ~CE_MATCHED
;
306 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
308 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
310 * "git checkout tree-ish -- path", but this entry
311 * is in the original index but is not in tree-ish
312 * or does not match the pathspec; it will not be
313 * checked out to the working tree. We will not do
314 * anything to this entry at all.
318 * Either this entry came from the tree-ish we are
319 * checking the paths out of, or we are checking out
322 * If it comes from the tree-ish, we already know it
323 * matches the pathspec and could just stamp
324 * CE_MATCHED to it from update_some(). But we still
325 * need ps_matched and read_tree_recursive (and
326 * eventually tree_entry_interesting) cannot fill
327 * ps_matched yet. Once it can, we can avoid calling
328 * match_pathspec() for _all_ entries when
329 * opts->source_tree != NULL.
331 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
))
332 ce
->ce_flags
|= CE_MATCHED
;
335 static void mark_ce_for_checkout_no_overlay(struct cache_entry
*ce
,
337 const struct checkout_opts
*opts
)
339 ce
->ce_flags
&= ~CE_MATCHED
;
340 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
342 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
)) {
343 ce
->ce_flags
|= CE_MATCHED
;
344 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
346 * In overlay mode, but the path is not in
347 * tree-ish, which means we should remove it
348 * from the index and the working tree.
350 ce
->ce_flags
|= CE_REMOVE
| CE_WT_REMOVE
;
354 static int checkout_worktree(const struct checkout_opts
*opts
,
355 const struct branch_info
*info
)
357 struct checkout state
= CHECKOUT_INIT
;
358 int nr_checkouts
= 0, nr_unmerged
= 0;
363 state
.refresh_cache
= 1;
364 state
.istate
= &the_index
;
366 init_checkout_metadata(&state
.meta
, info
->refname
,
367 info
->commit
? &info
->commit
->object
.oid
: &info
->oid
,
370 enable_delayed_checkout(&state
);
371 for (pos
= 0; pos
< active_nr
; pos
++) {
372 struct cache_entry
*ce
= active_cache
[pos
];
373 if (ce
->ce_flags
& CE_MATCHED
) {
375 errs
|= checkout_entry(ce
, &state
,
376 NULL
, &nr_checkouts
);
379 if (opts
->writeout_stage
)
380 errs
|= checkout_stage(opts
->writeout_stage
,
383 &nr_checkouts
, opts
->overlay_mode
);
384 else if (opts
->merge
)
385 errs
|= checkout_merged(pos
, &state
,
387 pos
= skip_same_name(ce
, pos
) - 1;
390 remove_marked_cache_entries(&the_index
, 1);
391 remove_scheduled_dirs();
392 errs
|= finish_delayed_checkout(&state
, &nr_checkouts
);
394 if (opts
->count_checkout_paths
) {
396 fprintf_ln(stderr
, Q_("Recreated %d merge conflict",
397 "Recreated %d merge conflicts",
400 if (opts
->source_tree
)
401 fprintf_ln(stderr
, Q_("Updated %d path from %s",
402 "Updated %d paths from %s",
405 find_unique_abbrev(&opts
->source_tree
->object
.oid
,
407 else if (!nr_unmerged
|| nr_checkouts
)
408 fprintf_ln(stderr
, Q_("Updated %d path from the index",
409 "Updated %d paths from the index",
417 static int checkout_paths(const struct checkout_opts
*opts
,
418 const struct branch_info
*new_branch_info
)
421 static char *ps_matched
;
422 struct object_id rev
;
425 struct lock_file lock_file
= LOCK_INIT
;
428 trace2_cmd_mode(opts
->patch_mode
? "patch" : "path");
430 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
431 die(_("'%s' cannot be used with updating paths"), "--track");
433 if (opts
->new_branch_log
)
434 die(_("'%s' cannot be used with updating paths"), "-l");
436 if (opts
->ignore_unmerged
&& opts
->patch_mode
)
437 die(_("'%s' cannot be used with updating paths"),
438 opts
->ignore_unmerged_opt
);
440 if (opts
->force_detach
)
441 die(_("'%s' cannot be used with updating paths"), "--detach");
443 if (opts
->merge
&& opts
->patch_mode
)
444 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
446 if (opts
->ignore_unmerged
&& opts
->merge
)
447 die(_("'%s' cannot be used with %s"),
448 opts
->ignore_unmerged_opt
, "-m");
450 if (opts
->new_branch
)
451 die(_("Cannot update paths and switch to branch '%s' at the same time."),
454 if (!opts
->checkout_worktree
&& !opts
->checkout_index
)
455 die(_("neither '%s' or '%s' is specified"),
456 "--staged", "--worktree");
458 if (!opts
->checkout_worktree
&& !opts
->from_treeish
)
459 die(_("'%s' must be used when '%s' is not specified"),
460 "--worktree", "--source");
462 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
463 opts
->writeout_stage
)
464 die(_("'%s' or '%s' cannot be used with %s"),
465 "--ours", "--theirs", "--staged");
467 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
469 die(_("'%s' or '%s' cannot be used with %s"),
470 "--merge", "--conflict", "--staged");
472 if (opts
->patch_mode
) {
473 const char *patch_mode
;
475 if (opts
->checkout_index
&& opts
->checkout_worktree
)
476 patch_mode
= "--patch=checkout";
477 else if (opts
->checkout_index
&& !opts
->checkout_worktree
)
478 patch_mode
= "--patch=reset";
479 else if (!opts
->checkout_index
&& opts
->checkout_worktree
)
480 patch_mode
= "--patch=worktree";
482 BUG("either flag must have been set, worktree=%d, index=%d",
483 opts
->checkout_worktree
, opts
->checkout_index
);
484 return run_add_interactive(new_branch_info
->name
, patch_mode
, &opts
->pathspec
);
487 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
488 if (read_cache_preload(&opts
->pathspec
) < 0)
489 return error(_("index file corrupt"));
491 if (opts
->source_tree
)
492 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
494 ps_matched
= xcalloc(opts
->pathspec
.nr
, 1);
497 * Make sure all pathspecs participated in locating the paths
500 for (pos
= 0; pos
< active_nr
; pos
++)
501 if (opts
->overlay_mode
)
502 mark_ce_for_checkout_overlay(active_cache
[pos
],
506 mark_ce_for_checkout_no_overlay(active_cache
[pos
],
510 if (report_path_error(ps_matched
, &opts
->pathspec
)) {
516 /* "checkout -m path" to recreate conflicted state */
518 unmerge_marked_index(&the_index
);
520 /* Any unmerged paths? */
521 for (pos
= 0; pos
< active_nr
; pos
++) {
522 const struct cache_entry
*ce
= active_cache
[pos
];
523 if (ce
->ce_flags
& CE_MATCHED
) {
526 if (opts
->ignore_unmerged
) {
528 warning(_("path '%s' is unmerged"), ce
->name
);
529 } else if (opts
->writeout_stage
) {
530 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
, opts
->overlay_mode
);
531 } else if (opts
->merge
) {
532 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
535 error(_("path '%s' is unmerged"), ce
->name
);
537 pos
= skip_same_name(ce
, pos
) - 1;
543 /* Now we are committed to check them out */
544 if (opts
->checkout_worktree
)
545 errs
|= checkout_worktree(opts
, new_branch_info
);
547 remove_marked_cache_entries(&the_index
, 1);
550 * Allow updating the index when checking out from the index.
551 * This is to save new stat info.
553 if (opts
->checkout_worktree
&& !opts
->checkout_index
&& !opts
->source_tree
)
556 checkout_index
= opts
->checkout_index
;
558 if (checkout_index
) {
559 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
560 die(_("unable to write new index file"));
563 * NEEDSWORK: if --worktree is not specified, we
564 * should save stat info of checked out files in the
565 * index to avoid the next (potentially costly)
566 * refresh. But it's a bit tricker to do...
568 rollback_lock_file(&lock_file
);
571 read_ref_full("HEAD", 0, &rev
, NULL
);
572 head
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
574 errs
|= post_checkout_hook(head
, head
, 0);
578 static void show_local_changes(struct object
*head
,
579 const struct diff_options
*opts
)
582 /* I think we want full paths, even if we're in a subdirectory. */
583 repo_init_revisions(the_repository
, &rev
, NULL
);
584 rev
.diffopt
.flags
= opts
->flags
;
585 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
586 diff_setup_done(&rev
.diffopt
);
587 add_pending_object(&rev
, head
, NULL
);
588 run_diff_index(&rev
, 0);
591 static void describe_detached_head(const char *msg
, struct commit
*commit
)
593 struct strbuf sb
= STRBUF_INIT
;
595 if (!parse_commit(commit
))
596 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
597 if (print_sha1_ellipsis()) {
598 fprintf(stderr
, "%s %s... %s\n", msg
,
599 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
601 fprintf(stderr
, "%s %s %s\n", msg
,
602 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
607 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
608 int worktree
, int *writeout_error
,
609 struct branch_info
*info
)
611 struct unpack_trees_options opts
;
612 struct tree_desc tree_desc
;
614 memset(&opts
, 0, sizeof(opts
));
616 opts
.update
= worktree
;
617 opts
.skip_unmerged
= !worktree
;
620 opts
.fn
= oneway_merge
;
621 opts
.verbose_update
= o
->show_progress
;
622 opts
.src_index
= &the_index
;
623 opts
.dst_index
= &the_index
;
624 init_checkout_metadata(&opts
.meta
, info
->refname
,
625 info
->commit
? &info
->commit
->object
.oid
: &null_oid
,
628 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
629 switch (unpack_trees(1, &tree_desc
, &opts
)) {
633 * We return 0 nevertheless, as the index is all right
634 * and more importantly we have made best efforts to
635 * update paths in the work tree, and we cannot revert
646 static void setup_branch_path(struct branch_info
*branch
)
648 struct strbuf buf
= STRBUF_INIT
;
651 * If this is a ref, resolve it; otherwise, look up the OID for our
652 * expression. Failure here is okay.
654 if (!dwim_ref(branch
->name
, strlen(branch
->name
), &branch
->oid
, &branch
->refname
, 0))
655 repo_get_oid_committish(the_repository
, branch
->name
, &branch
->oid
);
657 strbuf_branchname(&buf
, branch
->name
, INTERPRET_BRANCH_LOCAL
);
658 if (strcmp(buf
.buf
, branch
->name
))
659 branch
->name
= xstrdup(buf
.buf
);
660 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
661 branch
->path
= strbuf_detach(&buf
, NULL
);
664 static int merge_working_tree(const struct checkout_opts
*opts
,
665 struct branch_info
*old_branch_info
,
666 struct branch_info
*new_branch_info
,
670 struct lock_file lock_file
= LOCK_INIT
;
671 struct tree
*new_tree
;
673 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
674 if (read_cache_preload(NULL
) < 0)
675 return error(_("index file corrupt"));
677 resolve_undo_clear();
678 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
679 if (new_branch_info
->commit
)
680 BUG("'switch --orphan' should never accept a commit as starting point");
681 new_tree
= parse_tree_indirect(the_hash_algo
->empty_tree
);
683 new_tree
= get_commit_tree(new_branch_info
->commit
);
684 if (opts
->discard_changes
) {
685 ret
= reset_tree(new_tree
, opts
, 1, writeout_error
, new_branch_info
);
689 struct tree_desc trees
[2];
691 struct unpack_trees_options topts
;
693 memset(&topts
, 0, sizeof(topts
));
695 topts
.src_index
= &the_index
;
696 topts
.dst_index
= &the_index
;
698 setup_unpack_trees_porcelain(&topts
, "checkout");
700 refresh_cache(REFRESH_QUIET
);
702 if (unmerged_cache()) {
703 error(_("you need to resolve your current index first"));
707 /* 2-way merge to the new branch */
708 topts
.initial_checkout
= is_cache_unborn();
711 topts
.quiet
= opts
->merge
&& old_branch_info
->commit
;
712 topts
.verbose_update
= opts
->show_progress
;
713 topts
.fn
= twoway_merge
;
714 init_checkout_metadata(&topts
.meta
, new_branch_info
->refname
,
715 new_branch_info
->commit
?
716 &new_branch_info
->commit
->object
.oid
:
717 &new_branch_info
->oid
, NULL
);
718 if (opts
->overwrite_ignore
) {
719 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
720 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
721 setup_standard_excludes(topts
.dir
);
723 tree
= parse_tree_indirect(old_branch_info
->commit
?
724 &old_branch_info
->commit
->object
.oid
:
725 the_hash_algo
->empty_tree
);
726 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
727 parse_tree(new_tree
);
729 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
731 ret
= unpack_trees(2, trees
, &topts
);
732 clear_unpack_trees_porcelain(&topts
);
735 * Unpack couldn't do a trivial merge; either
736 * give up or do a real merge, depending on
737 * whether the merge flag was used.
740 struct tree
*old_tree
;
741 struct merge_options o
;
742 struct strbuf sb
= STRBUF_INIT
;
743 struct strbuf old_commit_shortname
= STRBUF_INIT
;
749 * Without old_branch_info->commit, the below is the same as
750 * the two-tree unpack we already tried and failed.
752 if (!old_branch_info
->commit
)
754 old_tree
= get_commit_tree(old_branch_info
->commit
);
756 if (repo_index_has_changes(the_repository
, old_tree
, &sb
))
757 die(_("cannot continue with staged changes in "
758 "the following files:\n%s"), sb
.buf
);
761 /* Do more real merge */
764 * We update the index fully, then write the
765 * tree from the index, then merge the new
766 * branch with the current tree, with the old
767 * branch as the base. Then we reset the index
768 * (but not the working tree) to the new
769 * branch, leaving the working tree as the
770 * merged version, but skipping unmerged
771 * entries in the index.
774 add_files_to_cache(NULL
, NULL
, 0);
775 init_merge_options(&o
, the_repository
);
777 work
= write_in_core_index_as_tree(the_repository
);
779 ret
= reset_tree(new_tree
,
781 writeout_error
, new_branch_info
);
784 o
.ancestor
= old_branch_info
->name
;
785 if (old_branch_info
->name
== NULL
) {
786 strbuf_add_unique_abbrev(&old_commit_shortname
,
787 &old_branch_info
->commit
->object
.oid
,
789 o
.ancestor
= old_commit_shortname
.buf
;
791 o
.branch1
= new_branch_info
->name
;
793 ret
= merge_trees(&o
,
799 ret
= reset_tree(new_tree
,
801 writeout_error
, new_branch_info
);
802 strbuf_release(&o
.obuf
);
803 strbuf_release(&old_commit_shortname
);
809 if (!active_cache_tree
)
810 active_cache_tree
= cache_tree();
812 if (!cache_tree_fully_valid(active_cache_tree
))
813 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
815 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
816 die(_("unable to write new index file"));
818 if (!opts
->discard_changes
&& !opts
->quiet
&& new_branch_info
->commit
)
819 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
824 static void report_tracking(struct branch_info
*new_branch_info
)
826 struct strbuf sb
= STRBUF_INIT
;
827 struct branch
*branch
= branch_get(new_branch_info
->name
);
829 if (!format_tracking_info(branch
, &sb
, AHEAD_BEHIND_FULL
))
831 fputs(sb
.buf
, stdout
);
835 static void update_refs_for_switch(const struct checkout_opts
*opts
,
836 struct branch_info
*old_branch_info
,
837 struct branch_info
*new_branch_info
)
839 struct strbuf msg
= STRBUF_INIT
;
840 const char *old_desc
, *reflog_msg
;
841 if (opts
->new_branch
) {
842 if (opts
->new_orphan_branch
) {
845 refname
= mkpathdup("refs/heads/%s", opts
->new_orphan_branch
);
846 if (opts
->new_branch_log
&&
847 !should_autocreate_reflog(refname
)) {
849 struct strbuf err
= STRBUF_INIT
;
851 ret
= safe_create_reflog(refname
, 1, &err
);
853 fprintf(stderr
, _("Can not do reflog for '%s': %s\n"),
854 opts
->new_orphan_branch
, err
.buf
);
855 strbuf_release(&err
);
859 strbuf_release(&err
);
864 create_branch(the_repository
,
865 opts
->new_branch
, new_branch_info
->name
,
866 opts
->new_branch_force
? 1 : 0,
867 opts
->new_branch_force
? 1 : 0,
868 opts
->new_branch_log
,
871 new_branch_info
->name
= opts
->new_branch
;
872 setup_branch_path(new_branch_info
);
875 old_desc
= old_branch_info
->name
;
876 if (!old_desc
&& old_branch_info
->commit
)
877 old_desc
= oid_to_hex(&old_branch_info
->commit
->object
.oid
);
879 reflog_msg
= getenv("GIT_REFLOG_ACTION");
881 strbuf_addf(&msg
, "checkout: moving from %s to %s",
882 old_desc
? old_desc
: "(invalid)", new_branch_info
->name
);
884 strbuf_insertstr(&msg
, 0, reflog_msg
);
886 if (!strcmp(new_branch_info
->name
, "HEAD") && !new_branch_info
->path
&& !opts
->force_detach
) {
888 } else if (opts
->force_detach
|| !new_branch_info
->path
) { /* No longer on any branch. */
889 update_ref(msg
.buf
, "HEAD", &new_branch_info
->commit
->object
.oid
, NULL
,
890 REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
892 if (old_branch_info
->path
&&
893 advice_detached_head
&& !opts
->force_detach
)
894 detach_advice(new_branch_info
->name
);
895 describe_detached_head(_("HEAD is now at"), new_branch_info
->commit
);
897 } else if (new_branch_info
->path
) { /* Switch branches. */
898 if (create_symref("HEAD", new_branch_info
->path
, msg
.buf
) < 0)
899 die(_("unable to update HEAD"));
901 if (old_branch_info
->path
&& !strcmp(new_branch_info
->path
, old_branch_info
->path
)) {
902 if (opts
->new_branch_force
)
903 fprintf(stderr
, _("Reset branch '%s'\n"),
904 new_branch_info
->name
);
906 fprintf(stderr
, _("Already on '%s'\n"),
907 new_branch_info
->name
);
908 } else if (opts
->new_branch
) {
909 if (opts
->branch_exists
)
910 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new_branch_info
->name
);
912 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new_branch_info
->name
);
914 fprintf(stderr
, _("Switched to branch '%s'\n"),
915 new_branch_info
->name
);
918 if (old_branch_info
->path
&& old_branch_info
->name
) {
919 if (!ref_exists(old_branch_info
->path
) && reflog_exists(old_branch_info
->path
))
920 delete_reflog(old_branch_info
->path
);
923 remove_branch_state(the_repository
, !opts
->quiet
);
924 strbuf_release(&msg
);
926 (new_branch_info
->path
|| (!opts
->force_detach
&& !strcmp(new_branch_info
->name
, "HEAD"))))
927 report_tracking(new_branch_info
);
930 static int add_pending_uninteresting_ref(const char *refname
,
931 const struct object_id
*oid
,
932 int flags
, void *cb_data
)
934 add_pending_oid(cb_data
, refname
, oid
, UNINTERESTING
);
938 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
940 strbuf_addstr(sb
, " ");
941 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
, DEFAULT_ABBREV
);
942 strbuf_addch(sb
, ' ');
943 if (!parse_commit(commit
))
944 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
945 strbuf_addch(sb
, '\n');
948 #define ORPHAN_CUTOFF 4
949 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
951 struct commit
*c
, *last
= NULL
;
952 struct strbuf sb
= STRBUF_INIT
;
954 while ((c
= get_revision(revs
)) != NULL
) {
955 if (lost
< ORPHAN_CUTOFF
)
956 describe_one_orphan(&sb
, c
);
960 if (ORPHAN_CUTOFF
< lost
) {
961 int more
= lost
- ORPHAN_CUTOFF
;
963 describe_one_orphan(&sb
, last
);
965 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
970 /* The singular version */
971 "Warning: you are leaving %d commit behind, "
973 "any of your branches:\n\n"
975 /* The plural version */
976 "Warning: you are leaving %d commits behind, "
978 "any of your branches:\n\n"
980 /* Give ngettext() the count */
986 if (advice_detached_head
)
989 /* The singular version */
990 "If you want to keep it by creating a new branch, "
991 "this may be a good time\nto do so with:\n\n"
992 " git branch <new-branch-name> %s\n\n",
993 /* The plural version */
994 "If you want to keep them by creating a new branch, "
995 "this may be a good time\nto do so with:\n\n"
996 " git branch <new-branch-name> %s\n\n",
997 /* Give ngettext() the count */
999 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
1003 * We are about to leave commit that was at the tip of a detached
1004 * HEAD. If it is not reachable from any ref, this is the last chance
1005 * for the user to do so without resorting to reflog.
1007 static void orphaned_commit_warning(struct commit
*old_commit
, struct commit
*new_commit
)
1009 struct rev_info revs
;
1010 struct object
*object
= &old_commit
->object
;
1012 repo_init_revisions(the_repository
, &revs
, NULL
);
1013 setup_revisions(0, NULL
, &revs
, NULL
);
1015 object
->flags
&= ~UNINTERESTING
;
1016 add_pending_object(&revs
, object
, oid_to_hex(&object
->oid
));
1018 for_each_ref(add_pending_uninteresting_ref
, &revs
);
1020 add_pending_oid(&revs
, "HEAD",
1021 &new_commit
->object
.oid
,
1024 if (prepare_revision_walk(&revs
))
1025 die(_("internal error in revision walk"));
1026 if (!(old_commit
->object
.flags
& UNINTERESTING
))
1027 suggest_reattach(old_commit
, &revs
);
1029 describe_detached_head(_("Previous HEAD position was"), old_commit
);
1031 /* Clean up objects used, as they will be reused. */
1032 clear_commit_marks_all(ALL_REV_FLAGS
);
1035 static int switch_branches(const struct checkout_opts
*opts
,
1036 struct branch_info
*new_branch_info
)
1039 struct branch_info old_branch_info
;
1041 struct object_id rev
;
1042 int flag
, writeout_error
= 0;
1045 trace2_cmd_mode("branch");
1047 memset(&old_branch_info
, 0, sizeof(old_branch_info
));
1048 old_branch_info
.path
= path_to_free
= resolve_refdup("HEAD", 0, &rev
, &flag
);
1049 if (old_branch_info
.path
)
1050 old_branch_info
.commit
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
1051 if (!(flag
& REF_ISSYMREF
))
1052 old_branch_info
.path
= NULL
;
1054 if (old_branch_info
.path
)
1055 skip_prefix(old_branch_info
.path
, "refs/heads/", &old_branch_info
.name
);
1057 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
1058 if (new_branch_info
->name
)
1059 BUG("'switch --orphan' should never accept a commit as starting point");
1060 new_branch_info
->commit
= NULL
;
1061 new_branch_info
->name
= "(empty)";
1065 if (!new_branch_info
->name
) {
1066 new_branch_info
->name
= "HEAD";
1067 new_branch_info
->commit
= old_branch_info
.commit
;
1068 if (!new_branch_info
->commit
)
1069 die(_("You are on a branch yet to be born"));
1070 parse_commit_or_die(new_branch_info
->commit
);
1072 if (opts
->only_merge_on_switching_branches
)
1077 ret
= merge_working_tree(opts
, &old_branch_info
, new_branch_info
, &writeout_error
);
1084 if (!opts
->quiet
&& !old_branch_info
.path
&& old_branch_info
.commit
&& new_branch_info
->commit
!= old_branch_info
.commit
)
1085 orphaned_commit_warning(old_branch_info
.commit
, new_branch_info
->commit
);
1087 update_refs_for_switch(opts
, &old_branch_info
, new_branch_info
);
1089 ret
= post_checkout_hook(old_branch_info
.commit
, new_branch_info
->commit
, 1);
1091 return ret
|| writeout_error
;
1094 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
1096 if (!strcmp(var
, "diff.ignoresubmodules")) {
1097 struct checkout_opts
*opts
= cb
;
1098 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
1102 if (starts_with(var
, "submodule."))
1103 return git_default_submodule_config(var
, value
, NULL
);
1105 return git_xmerge_config(var
, value
, NULL
);
1108 static void setup_new_branch_info_and_source_tree(
1109 struct branch_info
*new_branch_info
,
1110 struct checkout_opts
*opts
,
1111 struct object_id
*rev
,
1114 struct tree
**source_tree
= &opts
->source_tree
;
1115 struct object_id branch_rev
;
1117 new_branch_info
->name
= arg
;
1118 setup_branch_path(new_branch_info
);
1120 if (!check_refname_format(new_branch_info
->path
, 0) &&
1121 !read_ref(new_branch_info
->path
, &branch_rev
))
1122 oidcpy(rev
, &branch_rev
);
1124 free((char *)new_branch_info
->path
);
1125 new_branch_info
->path
= NULL
; /* not an existing branch */
1128 new_branch_info
->commit
= lookup_commit_reference_gently(the_repository
, rev
, 1);
1129 if (!new_branch_info
->commit
) {
1131 *source_tree
= parse_tree_indirect(rev
);
1133 parse_commit_or_die(new_branch_info
->commit
);
1134 *source_tree
= get_commit_tree(new_branch_info
->commit
);
1138 static const char *parse_remote_branch(const char *arg
,
1139 struct object_id
*rev
,
1140 int could_be_checkout_paths
)
1142 int num_matches
= 0;
1143 const char *remote
= unique_tracking_name(arg
, rev
, &num_matches
);
1145 if (remote
&& could_be_checkout_paths
) {
1146 die(_("'%s' could be both a local file and a tracking branch.\n"
1147 "Please use -- (and optionally --no-guess) to disambiguate"),
1151 if (!remote
&& num_matches
> 1) {
1152 if (advice_checkout_ambiguous_remote_branch_name
) {
1153 advise(_("If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1154 "you can do so by fully qualifying the name with the --track option:\n"
1156 " git checkout --track origin/<name>\n"
1158 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1159 "one remote, e.g. the 'origin' remote, consider setting\n"
1160 "checkout.defaultRemote=origin in your config."));
1163 die(_("'%s' matched multiple (%d) remote tracking branches"),
1170 static int parse_branchname_arg(int argc
, const char **argv
,
1171 int dwim_new_local_branch_ok
,
1172 struct branch_info
*new_branch_info
,
1173 struct checkout_opts
*opts
,
1174 struct object_id
*rev
)
1176 const char **new_branch
= &opts
->new_branch
;
1180 int has_dash_dash
= 0;
1184 * case 1: git checkout <ref> -- [<paths>]
1186 * <ref> must be a valid tree, everything after the '--' must be
1189 * case 2: git checkout -- [<paths>]
1191 * everything after the '--' must be paths.
1193 * case 3: git checkout <something> [--]
1195 * (a) If <something> is a commit, that is to
1196 * switch to the branch or detach HEAD at it. As a special case,
1197 * if <something> is A...B (missing A or B means HEAD but you can
1198 * omit at most one side), and if there is a unique merge base
1199 * between A and B, A...B names that merge base.
1201 * (b) If <something> is _not_ a commit, either "--" is present
1202 * or <something> is not a path, no -t or -b was given, and
1203 * and there is a tracking branch whose name is <something>
1204 * in one and only one remote (or if the branch exists on the
1205 * remote named in checkout.defaultRemote), then this is a
1206 * short-hand to fork local <something> from that
1207 * remote-tracking branch.
1209 * (c) Otherwise, if "--" is present, treat it like case (1).
1212 * - if it's a reference, treat it like case (1)
1213 * - else if it's a path, treat it like case (2)
1216 * case 4: git checkout <something> <paths>
1218 * The first argument must not be ambiguous.
1219 * - If it's *only* a reference, treat it like case (1).
1220 * - If it's only a path, treat it like case (2).
1227 if (!opts
->accept_pathspec
) {
1229 die(_("only one reference expected"));
1230 has_dash_dash
= 1; /* helps disambiguate */
1235 for (i
= 0; i
< argc
; i
++) {
1236 if (opts
->accept_pathspec
&& !strcmp(argv
[i
], "--")) {
1241 if (dash_dash_pos
== 0)
1242 return 1; /* case (2) */
1243 else if (dash_dash_pos
== 1)
1244 has_dash_dash
= 1; /* case (3) or (1) */
1245 else if (dash_dash_pos
>= 2)
1246 die(_("only one reference expected, %d given."), dash_dash_pos
);
1247 opts
->count_checkout_paths
= !opts
->quiet
&& !has_dash_dash
;
1249 if (!strcmp(arg
, "-"))
1252 if (get_oid_mb(arg
, rev
)) {
1254 * Either case (3) or (4), with <something> not being
1255 * a commit, or an attempt to use case (1) with an
1258 * It's likely an error, but we need to find out if
1259 * we should auto-create the branch, case (3).(b).
1261 int recover_with_dwim
= dwim_new_local_branch_ok
;
1263 int could_be_checkout_paths
= !has_dash_dash
&&
1264 check_filename(opts
->prefix
, arg
);
1266 if (!has_dash_dash
&& !no_wildcard(arg
))
1267 recover_with_dwim
= 0;
1270 * Accept "git checkout foo", "git checkout foo --"
1271 * and "git switch foo" as candidates for dwim.
1273 if (!(argc
== 1 && !has_dash_dash
) &&
1274 !(argc
== 2 && has_dash_dash
) &&
1275 opts
->accept_pathspec
)
1276 recover_with_dwim
= 0;
1278 if (recover_with_dwim
) {
1279 const char *remote
= parse_remote_branch(arg
, rev
,
1280 could_be_checkout_paths
);
1284 /* DWIMmed to create local branch, case (3).(b) */
1286 recover_with_dwim
= 0;
1290 if (!recover_with_dwim
) {
1292 die(_("invalid reference: %s"), arg
);
1297 /* we can't end up being in (2) anymore, eat the argument */
1302 setup_new_branch_info_and_source_tree(new_branch_info
, opts
, rev
, arg
);
1304 if (!opts
->source_tree
) /* case (1): want a tree */
1305 die(_("reference is not a tree: %s"), arg
);
1307 if (!has_dash_dash
) { /* case (3).(d) -> (1) */
1309 * Do not complain the most common case
1310 * git checkout branch
1311 * even if there happen to be a file called 'branch';
1312 * it would be extremely annoying.
1315 verify_non_filename(opts
->prefix
, arg
);
1316 } else if (opts
->accept_pathspec
) {
1325 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1328 struct strbuf branch_ref
= STRBUF_INIT
;
1330 trace2_cmd_mode("unborn");
1332 if (!opts
->new_branch
)
1333 die(_("You are on a branch yet to be born"));
1334 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1335 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1336 strbuf_release(&branch_ref
);
1338 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1343 static void die_expecting_a_branch(const struct branch_info
*branch_info
)
1345 struct object_id oid
;
1348 if (dwim_ref(branch_info
->name
, strlen(branch_info
->name
), &oid
, &to_free
, 0) == 1) {
1349 const char *ref
= to_free
;
1351 if (skip_prefix(ref
, "refs/tags/", &ref
))
1352 die(_("a branch is expected, got tag '%s'"), ref
);
1353 if (skip_prefix(ref
, "refs/remotes/", &ref
))
1354 die(_("a branch is expected, got remote branch '%s'"), ref
);
1355 die(_("a branch is expected, got '%s'"), ref
);
1357 if (branch_info
->commit
)
1358 die(_("a branch is expected, got commit '%s'"), branch_info
->name
);
1360 * This case should never happen because we already die() on
1361 * non-commit, but just in case.
1363 die(_("a branch is expected, got '%s'"), branch_info
->name
);
1366 static void die_if_some_operation_in_progress(void)
1368 struct wt_status_state state
;
1370 memset(&state
, 0, sizeof(state
));
1371 wt_status_get_state(the_repository
, &state
, 0);
1373 if (state
.merge_in_progress
)
1374 die(_("cannot switch branch while merging\n"
1375 "Consider \"git merge --quit\" "
1376 "or \"git worktree add\"."));
1377 if (state
.am_in_progress
)
1378 die(_("cannot switch branch in the middle of an am session\n"
1379 "Consider \"git am --quit\" "
1380 "or \"git worktree add\"."));
1381 if (state
.rebase_interactive_in_progress
|| state
.rebase_in_progress
)
1382 die(_("cannot switch branch while rebasing\n"
1383 "Consider \"git rebase --quit\" "
1384 "or \"git worktree add\"."));
1385 if (state
.cherry_pick_in_progress
)
1386 die(_("cannot switch branch while cherry-picking\n"
1387 "Consider \"git cherry-pick --quit\" "
1388 "or \"git worktree add\"."));
1389 if (state
.revert_in_progress
)
1390 die(_("cannot switch branch while reverting\n"
1391 "Consider \"git revert --quit\" "
1392 "or \"git worktree add\"."));
1393 if (state
.bisect_in_progress
)
1394 warning(_("you are switching branch while bisecting"));
1397 static int checkout_branch(struct checkout_opts
*opts
,
1398 struct branch_info
*new_branch_info
)
1400 if (opts
->pathspec
.nr
)
1401 die(_("paths cannot be used with switching branches"));
1403 if (opts
->patch_mode
)
1404 die(_("'%s' cannot be used with switching branches"),
1407 if (opts
->overlay_mode
!= -1)
1408 die(_("'%s' cannot be used with switching branches"),
1411 if (opts
->writeout_stage
)
1412 die(_("'%s' cannot be used with switching branches"),
1415 if (opts
->force
&& opts
->merge
)
1416 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1418 if (opts
->discard_changes
&& opts
->merge
)
1419 die(_("'%s' cannot be used with '%s'"), "--discard-changes", "--merge");
1421 if (opts
->force_detach
&& opts
->new_branch
)
1422 die(_("'%s' cannot be used with '%s'"),
1423 "--detach", "-b/-B/--orphan");
1425 if (opts
->new_orphan_branch
) {
1426 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1427 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1428 if (opts
->orphan_from_empty_tree
&& new_branch_info
->name
)
1429 die(_("'%s' cannot take <start-point>"), "--orphan");
1430 } else if (opts
->force_detach
) {
1431 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1432 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1433 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1434 opts
->track
= git_branch_track
;
1436 if (new_branch_info
->name
&& !new_branch_info
->commit
)
1437 die(_("Cannot switch branch to a non-commit '%s'"),
1438 new_branch_info
->name
);
1440 if (!opts
->switch_branch_doing_nothing_is_ok
&&
1441 !new_branch_info
->name
&&
1442 !opts
->new_branch
&&
1443 !opts
->force_detach
)
1444 die(_("missing branch or commit argument"));
1446 if (!opts
->implicit_detach
&&
1447 !opts
->force_detach
&&
1448 !opts
->new_branch
&&
1449 !opts
->new_branch_force
&&
1450 new_branch_info
->name
&&
1451 !new_branch_info
->path
)
1452 die_expecting_a_branch(new_branch_info
);
1454 if (!opts
->can_switch_when_in_progress
)
1455 die_if_some_operation_in_progress();
1457 if (new_branch_info
->path
&& !opts
->force_detach
&& !opts
->new_branch
&&
1458 !opts
->ignore_other_worktrees
) {
1460 char *head_ref
= resolve_refdup("HEAD", 0, NULL
, &flag
);
1462 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new_branch_info
->path
)))
1463 die_if_checked_out(new_branch_info
->path
, 1);
1467 if (!new_branch_info
->commit
&& opts
->new_branch
) {
1468 struct object_id rev
;
1471 if (!read_ref_full("HEAD", 0, &rev
, &flag
) &&
1472 (flag
& REF_ISSYMREF
) && is_null_oid(&rev
))
1473 return switch_unborn_to_new_branch(opts
);
1475 return switch_branches(opts
, new_branch_info
);
1478 static struct option
*add_common_options(struct checkout_opts
*opts
,
1479 struct option
*prevopts
)
1481 struct option options
[] = {
1482 OPT__QUIET(&opts
->quiet
, N_("suppress progress reporting")),
1483 OPT_CALLBACK_F(0, "recurse-submodules", NULL
,
1484 "checkout", "control recursive updating of submodules",
1485 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
),
1486 OPT_BOOL(0, "progress", &opts
->show_progress
, N_("force progress reporting")),
1487 OPT_BOOL('m', "merge", &opts
->merge
, N_("perform a 3-way merge with the new branch")),
1488 OPT_STRING(0, "conflict", &opts
->conflict_style
, N_("style"),
1489 N_("conflict style (merge or diff3)")),
1492 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1497 static struct option
*add_common_switch_branch_options(
1498 struct checkout_opts
*opts
, struct option
*prevopts
)
1500 struct option options
[] = {
1501 OPT_BOOL('d', "detach", &opts
->force_detach
, N_("detach HEAD at named commit")),
1502 OPT_SET_INT('t', "track", &opts
->track
, N_("set upstream info for new branch"),
1503 BRANCH_TRACK_EXPLICIT
),
1504 OPT__FORCE(&opts
->force
, N_("force checkout (throw away local modifications)"),
1505 PARSE_OPT_NOCOMPLETE
),
1506 OPT_STRING(0, "orphan", &opts
->new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1507 OPT_BOOL_F(0, "overwrite-ignore", &opts
->overwrite_ignore
,
1508 N_("update ignored files (default)"),
1509 PARSE_OPT_NOCOMPLETE
),
1510 OPT_BOOL(0, "ignore-other-worktrees", &opts
->ignore_other_worktrees
,
1511 N_("do not check if another worktree is holding the given ref")),
1514 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1519 static struct option
*add_checkout_path_options(struct checkout_opts
*opts
,
1520 struct option
*prevopts
)
1522 struct option options
[] = {
1523 OPT_SET_INT_F('2', "ours", &opts
->writeout_stage
,
1524 N_("checkout our version for unmerged files"),
1525 2, PARSE_OPT_NONEG
),
1526 OPT_SET_INT_F('3', "theirs", &opts
->writeout_stage
,
1527 N_("checkout their version for unmerged files"),
1528 3, PARSE_OPT_NONEG
),
1529 OPT_BOOL('p', "patch", &opts
->patch_mode
, N_("select hunks interactively")),
1530 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
->ignore_skipworktree
,
1531 N_("do not limit pathspecs to sparse entries only")),
1532 OPT_PATHSPEC_FROM_FILE(&opts
->pathspec_from_file
),
1533 OPT_PATHSPEC_FILE_NUL(&opts
->pathspec_file_nul
),
1536 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1541 /* create-branch option (either b or c) */
1542 static char cb_option
= 'b';
1544 static int checkout_main(int argc
, const char **argv
, const char *prefix
,
1545 struct checkout_opts
*opts
, struct option
*options
,
1546 const char * const usagestr
[])
1548 struct branch_info new_branch_info
;
1549 int parseopt_flags
= 0;
1551 memset(&new_branch_info
, 0, sizeof(new_branch_info
));
1552 opts
->overwrite_ignore
= 1;
1553 opts
->prefix
= prefix
;
1554 opts
->show_progress
= -1;
1556 git_config(git_checkout_config
, opts
);
1558 opts
->track
= BRANCH_TRACK_UNSPECIFIED
;
1560 if (!opts
->accept_pathspec
&& !opts
->accept_ref
)
1561 BUG("make up your mind, you need to take _something_");
1562 if (opts
->accept_pathspec
&& opts
->accept_ref
)
1563 parseopt_flags
= PARSE_OPT_KEEP_DASHDASH
;
1565 argc
= parse_options(argc
, argv
, prefix
, options
,
1566 usagestr
, parseopt_flags
);
1568 if (opts
->show_progress
< 0) {
1570 opts
->show_progress
= 0;
1572 opts
->show_progress
= isatty(2);
1575 if (opts
->conflict_style
) {
1576 opts
->merge
= 1; /* implied */
1577 git_xmerge_config("merge.conflictstyle", opts
->conflict_style
, NULL
);
1580 opts
->discard_changes
= 1;
1581 opts
->ignore_unmerged_opt
= "--force";
1582 opts
->ignore_unmerged
= 1;
1585 if ((!!opts
->new_branch
+ !!opts
->new_branch_force
+ !!opts
->new_orphan_branch
) > 1)
1586 die(_("-%c, -%c and --orphan are mutually exclusive"),
1587 cb_option
, toupper(cb_option
));
1589 if (opts
->overlay_mode
== 1 && opts
->patch_mode
)
1590 die(_("-p and --overlay are mutually exclusive"));
1592 if (opts
->checkout_index
>= 0 || opts
->checkout_worktree
>= 0) {
1593 if (opts
->checkout_index
< 0)
1594 opts
->checkout_index
= 0;
1595 if (opts
->checkout_worktree
< 0)
1596 opts
->checkout_worktree
= 0;
1598 if (opts
->checkout_index
< 0)
1599 opts
->checkout_index
= -opts
->checkout_index
- 1;
1600 if (opts
->checkout_worktree
< 0)
1601 opts
->checkout_worktree
= -opts
->checkout_worktree
- 1;
1603 if (opts
->checkout_index
< 0 || opts
->checkout_worktree
< 0)
1604 BUG("these flags should be non-negative by now");
1606 * convenient shortcut: "git restore --staged [--worktree]" equals
1607 * "git restore --staged [--worktree] --source HEAD"
1609 if (!opts
->from_treeish
&& opts
->checkout_index
)
1610 opts
->from_treeish
= "HEAD";
1613 * From here on, new_branch will contain the branch to be checked out,
1614 * and new_branch_force and new_orphan_branch will tell us which one of
1615 * -b/-B/-c/-C/--orphan is being used.
1617 if (opts
->new_branch_force
)
1618 opts
->new_branch
= opts
->new_branch_force
;
1620 if (opts
->new_orphan_branch
)
1621 opts
->new_branch
= opts
->new_orphan_branch
;
1623 /* --track without -c/-C/-b/-B/--orphan should DWIM */
1624 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
->new_branch
) {
1625 const char *argv0
= argv
[0];
1626 if (!argc
|| !strcmp(argv0
, "--"))
1627 die(_("--track needs a branch name"));
1628 skip_prefix(argv0
, "refs/", &argv0
);
1629 skip_prefix(argv0
, "remotes/", &argv0
);
1630 argv0
= strchr(argv0
, '/');
1631 if (!argv0
|| !argv0
[1])
1632 die(_("missing branch name; try -%c"), cb_option
);
1633 opts
->new_branch
= argv0
+ 1;
1637 * Extract branch name from command line arguments, so
1638 * all that is left is pathspecs.
1642 * 1) git checkout <tree> -- [<paths>]
1643 * 2) git checkout -- [<paths>]
1644 * 3) git checkout <something> [<paths>]
1646 * including "last branch" syntax and DWIM-ery for names of
1647 * remote branches, erroring out for invalid or ambiguous cases.
1649 if (argc
&& opts
->accept_ref
) {
1650 struct object_id rev
;
1652 !opts
->patch_mode
&&
1653 opts
->dwim_new_local_branch
&&
1654 opts
->track
== BRANCH_TRACK_UNSPECIFIED
&&
1656 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1657 &new_branch_info
, opts
, &rev
);
1660 } else if (!opts
->accept_ref
&& opts
->from_treeish
) {
1661 struct object_id rev
;
1663 if (get_oid_mb(opts
->from_treeish
, &rev
))
1664 die(_("could not resolve %s"), opts
->from_treeish
);
1666 setup_new_branch_info_and_source_tree(&new_branch_info
,
1668 opts
->from_treeish
);
1670 if (!opts
->source_tree
)
1671 die(_("reference is not a tree: %s"), opts
->from_treeish
);
1675 parse_pathspec(&opts
->pathspec
, 0,
1676 opts
->patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1679 if (!opts
->pathspec
.nr
)
1680 die(_("invalid path specification"));
1683 * Try to give more helpful suggestion.
1684 * new_branch && argc > 1 will be caught later.
1686 if (opts
->new_branch
&& argc
== 1 && !new_branch_info
.commit
)
1687 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1688 argv
[0], opts
->new_branch
);
1690 if (opts
->force_detach
)
1691 die(_("git checkout: --detach does not take a path argument '%s'"),
1695 if (opts
->pathspec_from_file
) {
1696 if (opts
->pathspec
.nr
)
1697 die(_("--pathspec-from-file is incompatible with pathspec arguments"));
1699 if (opts
->force_detach
)
1700 die(_("--pathspec-from-file is incompatible with --detach"));
1702 if (opts
->patch_mode
)
1703 die(_("--pathspec-from-file is incompatible with --patch"));
1705 parse_pathspec_file(&opts
->pathspec
, 0,
1707 prefix
, opts
->pathspec_from_file
, opts
->pathspec_file_nul
);
1708 } else if (opts
->pathspec_file_nul
) {
1709 die(_("--pathspec-file-nul requires --pathspec-from-file"));
1712 opts
->pathspec
.recursive
= 1;
1714 if (opts
->pathspec
.nr
) {
1715 if (1 < !!opts
->writeout_stage
+ !!opts
->force
+ !!opts
->merge
)
1716 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1717 "checking out of the index."));
1719 if (opts
->accept_pathspec
&& !opts
->empty_pathspec_ok
&&
1720 !opts
->patch_mode
) /* patch mode is special */
1721 die(_("you must specify path(s) to restore"));
1724 if (opts
->new_branch
) {
1725 struct strbuf buf
= STRBUF_INIT
;
1727 if (opts
->new_branch_force
)
1728 opts
->branch_exists
= validate_branchname(opts
->new_branch
, &buf
);
1730 opts
->branch_exists
=
1731 validate_new_branchname(opts
->new_branch
, &buf
, 0);
1732 strbuf_release(&buf
);
1736 if (opts
->patch_mode
|| opts
->pathspec
.nr
)
1737 return checkout_paths(opts
, &new_branch_info
);
1739 return checkout_branch(opts
, &new_branch_info
);
1742 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1744 struct checkout_opts opts
;
1745 struct option
*options
;
1746 struct option checkout_options
[] = {
1747 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1748 N_("create and checkout a new branch")),
1749 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1750 N_("create/reset and checkout a branch")),
1751 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1752 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1753 N_("second guess 'git checkout <no-such-branch>' (default)")),
1754 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode (default)")),
1759 memset(&opts
, 0, sizeof(opts
));
1760 opts
.dwim_new_local_branch
= 1;
1761 opts
.switch_branch_doing_nothing_is_ok
= 1;
1762 opts
.only_merge_on_switching_branches
= 0;
1763 opts
.accept_ref
= 1;
1764 opts
.accept_pathspec
= 1;
1765 opts
.implicit_detach
= 1;
1766 opts
.can_switch_when_in_progress
= 1;
1767 opts
.orphan_from_empty_tree
= 0;
1768 opts
.empty_pathspec_ok
= 1;
1769 opts
.overlay_mode
= -1;
1770 opts
.checkout_index
= -2; /* default on */
1771 opts
.checkout_worktree
= -2; /* default on */
1773 if (argc
== 3 && !strcmp(argv
[1], "-b")) {
1775 * User ran 'git checkout -b <branch>' and expects
1776 * the same behavior as 'git switch -c <branch>'.
1778 opts
.switch_branch_doing_nothing_is_ok
= 0;
1779 opts
.only_merge_on_switching_branches
= 1;
1782 options
= parse_options_dup(checkout_options
);
1783 options
= add_common_options(&opts
, options
);
1784 options
= add_common_switch_branch_options(&opts
, options
);
1785 options
= add_checkout_path_options(&opts
, options
);
1787 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1788 options
, checkout_usage
);
1789 FREE_AND_NULL(options
);
1793 int cmd_switch(int argc
, const char **argv
, const char *prefix
)
1795 struct checkout_opts opts
;
1796 struct option
*options
= NULL
;
1797 struct option switch_options
[] = {
1798 OPT_STRING('c', "create", &opts
.new_branch
, N_("branch"),
1799 N_("create and switch to a new branch")),
1800 OPT_STRING('C', "force-create", &opts
.new_branch_force
, N_("branch"),
1801 N_("create/reset and switch to a branch")),
1802 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1803 N_("second guess 'git switch <no-such-branch>'")),
1804 OPT_BOOL(0, "discard-changes", &opts
.discard_changes
,
1805 N_("throw away local modifications")),
1810 memset(&opts
, 0, sizeof(opts
));
1811 opts
.dwim_new_local_branch
= 1;
1812 opts
.accept_ref
= 1;
1813 opts
.accept_pathspec
= 0;
1814 opts
.switch_branch_doing_nothing_is_ok
= 0;
1815 opts
.only_merge_on_switching_branches
= 1;
1816 opts
.implicit_detach
= 0;
1817 opts
.can_switch_when_in_progress
= 0;
1818 opts
.orphan_from_empty_tree
= 1;
1819 opts
.overlay_mode
= -1;
1821 options
= parse_options_dup(switch_options
);
1822 options
= add_common_options(&opts
, options
);
1823 options
= add_common_switch_branch_options(&opts
, options
);
1827 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1828 options
, switch_branch_usage
);
1829 FREE_AND_NULL(options
);
1833 int cmd_restore(int argc
, const char **argv
, const char *prefix
)
1835 struct checkout_opts opts
;
1836 struct option
*options
;
1837 struct option restore_options
[] = {
1838 OPT_STRING('s', "source", &opts
.from_treeish
, "<tree-ish>",
1839 N_("which tree-ish to checkout from")),
1840 OPT_BOOL('S', "staged", &opts
.checkout_index
,
1841 N_("restore the index")),
1842 OPT_BOOL('W', "worktree", &opts
.checkout_worktree
,
1843 N_("restore the working tree (default)")),
1844 OPT_BOOL(0, "ignore-unmerged", &opts
.ignore_unmerged
,
1845 N_("ignore unmerged entries")),
1846 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode")),
1851 memset(&opts
, 0, sizeof(opts
));
1852 opts
.accept_ref
= 0;
1853 opts
.accept_pathspec
= 1;
1854 opts
.empty_pathspec_ok
= 0;
1855 opts
.overlay_mode
= 0;
1856 opts
.checkout_index
= -1; /* default off */
1857 opts
.checkout_worktree
= -2; /* default on */
1858 opts
.ignore_unmerged_opt
= "--ignore-unmerged";
1860 options
= parse_options_dup(restore_options
);
1861 options
= add_common_options(&opts
, options
);
1862 options
= add_checkout_path_options(&opts
, options
);
1864 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1865 options
, restore_usage
);
1866 FREE_AND_NULL(options
);