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"
31 static const char * const checkout_usage
[] = {
32 N_("git checkout [<options>] <branch>"),
33 N_("git checkout [<options>] [<branch>] -- <file>..."),
37 static const char * const switch_branch_usage
[] = {
38 N_("git switch [<options>] [<branch>]"),
42 static const char * const restore_usage
[] = {
43 N_("git restore [<options>] [--source=<branch>] <file>..."),
47 struct checkout_opts
{
56 int ignore_skipworktree
;
57 int ignore_other_worktrees
;
59 int count_checkout_paths
;
61 int dwim_new_local_branch
;
65 int switch_branch_doing_nothing_is_ok
;
66 int only_merge_on_switching_branches
;
67 int can_switch_when_in_progress
;
68 int orphan_from_empty_tree
;
69 int empty_pathspec_ok
;
71 int checkout_worktree
;
72 const char *ignore_unmerged_opt
;
74 int pathspec_file_nul
;
75 const char *pathspec_from_file
;
77 const char *new_branch
;
78 const char *new_branch_force
;
79 const char *new_orphan_branch
;
81 enum branch_track track
;
82 struct diff_options diff_options
;
87 struct pathspec pathspec
;
88 const char *from_treeish
;
89 struct tree
*source_tree
;
93 const char *name
; /* The short name used */
94 const char *path
; /* The full name of a real branch */
95 struct commit
*commit
; /* The named commit */
96 char *refname
; /* The full name of the ref being checked out. */
97 struct object_id oid
; /* The object ID of the commit being checked out. */
99 * if not null the branch is detached because it's already
100 * checked out in this checkout
105 static int post_checkout_hook(struct commit
*old_commit
, struct commit
*new_commit
,
108 return run_hook_le(NULL
, "post-checkout",
109 oid_to_hex(old_commit
? &old_commit
->object
.oid
: &null_oid
),
110 oid_to_hex(new_commit
? &new_commit
->object
.oid
: &null_oid
),
111 changed
? "1" : "0", NULL
);
112 /* "new_commit" can be NULL when checking out from the index before
117 static int update_some(const struct object_id
*oid
, struct strbuf
*base
,
118 const char *pathname
, unsigned mode
, int stage
, void *context
)
121 struct cache_entry
*ce
;
125 return READ_TREE_RECURSIVE
;
127 len
= base
->len
+ strlen(pathname
);
128 ce
= make_empty_cache_entry(&the_index
, len
);
129 oidcpy(&ce
->oid
, oid
);
130 memcpy(ce
->name
, base
->buf
, base
->len
);
131 memcpy(ce
->name
+ base
->len
, pathname
, len
- base
->len
);
132 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
133 ce
->ce_namelen
= len
;
134 ce
->ce_mode
= create_ce_mode(mode
);
137 * If the entry is the same as the current index, we can leave the old
138 * entry in place. Whether it is UPTODATE or not, checkout_entry will
139 * do the right thing.
141 pos
= cache_name_pos(ce
->name
, ce
->ce_namelen
);
143 struct cache_entry
*old
= active_cache
[pos
];
144 if (ce
->ce_mode
== old
->ce_mode
&&
145 !ce_intent_to_add(old
) &&
146 oideq(&ce
->oid
, &old
->oid
)) {
147 old
->ce_flags
|= CE_UPDATE
;
148 discard_cache_entry(ce
);
153 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
157 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
159 read_tree_recursive(the_repository
, tree
, "", 0, 0,
160 pathspec
, update_some
, NULL
);
162 /* update the index with the given tree's info
163 * for all args, expanding wildcards, and exit
164 * with any non-zero return code.
169 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
171 while (++pos
< active_nr
&&
172 !strcmp(active_cache
[pos
]->name
, ce
->name
))
177 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
,
180 while (pos
< active_nr
&&
181 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
182 if (ce_stage(active_cache
[pos
]) == stage
)
189 return error(_("path '%s' does not have our version"), ce
->name
);
191 return error(_("path '%s' does not have their version"), ce
->name
);
194 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
197 const char *name
= ce
->name
;
199 while (pos
< active_nr
) {
200 ce
= active_cache
[pos
];
201 if (strcmp(name
, ce
->name
))
203 seen
|= (1 << ce_stage(ce
));
206 if ((stages
& seen
) != stages
)
207 return error(_("path '%s' does not have all necessary versions"),
212 static int checkout_stage(int stage
, const struct cache_entry
*ce
, int pos
,
213 const struct checkout
*state
, int *nr_checkouts
,
216 while (pos
< active_nr
&&
217 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
218 if (ce_stage(active_cache
[pos
]) == stage
)
219 return checkout_entry(active_cache
[pos
], state
,
228 return error(_("path '%s' does not have our version"), ce
->name
);
230 return error(_("path '%s' does not have their version"), ce
->name
);
233 static int checkout_merged(int pos
, const struct checkout
*state
, int *nr_checkouts
)
235 struct cache_entry
*ce
= active_cache
[pos
];
236 const char *path
= ce
->name
;
237 mmfile_t ancestor
, ours
, theirs
;
239 struct object_id oid
;
240 mmbuffer_t result_buf
;
241 struct object_id threeway
[3];
243 struct ll_merge_options ll_opts
;
246 memset(threeway
, 0, sizeof(threeway
));
247 while (pos
< active_nr
) {
249 stage
= ce_stage(ce
);
250 if (!stage
|| strcmp(path
, ce
->name
))
252 oidcpy(&threeway
[stage
- 1], &ce
->oid
);
254 mode
= create_ce_mode(ce
->ce_mode
);
256 ce
= active_cache
[pos
];
258 if (is_null_oid(&threeway
[1]) || is_null_oid(&threeway
[2]))
259 return error(_("path '%s' does not have necessary versions"), path
);
261 read_mmblob(&ancestor
, &threeway
[0]);
262 read_mmblob(&ours
, &threeway
[1]);
263 read_mmblob(&theirs
, &threeway
[2]);
265 memset(&ll_opts
, 0, sizeof(ll_opts
));
266 git_config_get_bool("merge.renormalize", &renormalize
);
267 ll_opts
.renormalize
= renormalize
;
268 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
269 &ours
, "ours", &theirs
, "theirs",
270 state
->istate
, &ll_opts
);
274 if (status
< 0 || !result_buf
.ptr
) {
275 free(result_buf
.ptr
);
276 return error(_("path '%s': cannot merge"), path
);
281 * There is absolutely no reason to write this as a blob object
282 * and create a phony cache entry. This hack is primarily to get
283 * to the write_entry() machinery that massages the contents to
284 * work-tree format and writes out which only allows it for a
285 * cache entry. The code in write_entry() needs to be refactored
286 * to allow us to feed a <buffer, size, mode> instead of a cache
287 * entry. Such a refactoring would help merge_recursive as well
288 * (it also writes the merge result to the object database even
289 * when it may contain conflicts).
291 if (write_object_file(result_buf
.ptr
, result_buf
.size
, blob_type
, &oid
))
292 die(_("Unable to add merge result for '%s'"), path
);
293 free(result_buf
.ptr
);
294 ce
= make_transient_cache_entry(mode
, &oid
, path
, 2);
296 die(_("make_cache_entry failed for path '%s'"), path
);
297 status
= checkout_entry(ce
, state
, NULL
, nr_checkouts
);
298 discard_cache_entry(ce
);
302 static void mark_ce_for_checkout_overlay(struct cache_entry
*ce
,
304 const struct checkout_opts
*opts
)
306 ce
->ce_flags
&= ~CE_MATCHED
;
307 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
309 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
311 * "git checkout tree-ish -- path", but this entry
312 * is in the original index but is not in tree-ish
313 * or does not match the pathspec; it will not be
314 * checked out to the working tree. We will not do
315 * anything to this entry at all.
319 * Either this entry came from the tree-ish we are
320 * checking the paths out of, or we are checking out
323 * If it comes from the tree-ish, we already know it
324 * matches the pathspec and could just stamp
325 * CE_MATCHED to it from update_some(). But we still
326 * need ps_matched and read_tree_recursive (and
327 * eventually tree_entry_interesting) cannot fill
328 * ps_matched yet. Once it can, we can avoid calling
329 * match_pathspec() for _all_ entries when
330 * opts->source_tree != NULL.
332 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
))
333 ce
->ce_flags
|= CE_MATCHED
;
336 static void mark_ce_for_checkout_no_overlay(struct cache_entry
*ce
,
338 const struct checkout_opts
*opts
)
340 ce
->ce_flags
&= ~CE_MATCHED
;
341 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
343 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
)) {
344 ce
->ce_flags
|= CE_MATCHED
;
345 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
347 * In overlay mode, but the path is not in
348 * tree-ish, which means we should remove it
349 * from the index and the working tree.
351 ce
->ce_flags
|= CE_REMOVE
| CE_WT_REMOVE
;
355 static int checkout_worktree(const struct checkout_opts
*opts
,
356 const struct branch_info
*info
)
358 struct checkout state
= CHECKOUT_INIT
;
359 int nr_checkouts
= 0, nr_unmerged
= 0;
364 state
.refresh_cache
= 1;
365 state
.istate
= &the_index
;
367 init_checkout_metadata(&state
.meta
, info
->refname
,
368 info
->commit
? &info
->commit
->object
.oid
: &info
->oid
,
371 enable_delayed_checkout(&state
);
372 for (pos
= 0; pos
< active_nr
; pos
++) {
373 struct cache_entry
*ce
= active_cache
[pos
];
374 if (ce
->ce_flags
& CE_MATCHED
) {
376 errs
|= checkout_entry(ce
, &state
,
377 NULL
, &nr_checkouts
);
380 if (opts
->writeout_stage
)
381 errs
|= checkout_stage(opts
->writeout_stage
,
384 &nr_checkouts
, opts
->overlay_mode
);
385 else if (opts
->merge
)
386 errs
|= checkout_merged(pos
, &state
,
388 pos
= skip_same_name(ce
, pos
) - 1;
391 remove_marked_cache_entries(&the_index
, 1);
392 remove_scheduled_dirs();
393 errs
|= finish_delayed_checkout(&state
, &nr_checkouts
);
395 if (opts
->count_checkout_paths
) {
397 fprintf_ln(stderr
, Q_("Recreated %d merge conflict",
398 "Recreated %d merge conflicts",
401 if (opts
->source_tree
)
402 fprintf_ln(stderr
, Q_("Updated %d path from %s",
403 "Updated %d paths from %s",
406 find_unique_abbrev(&opts
->source_tree
->object
.oid
,
408 else if (!nr_unmerged
|| nr_checkouts
)
409 fprintf_ln(stderr
, Q_("Updated %d path from the index",
410 "Updated %d paths from the index",
418 static int checkout_paths(const struct checkout_opts
*opts
,
419 const struct branch_info
*new_branch_info
)
422 static char *ps_matched
;
423 struct object_id rev
;
426 struct lock_file lock_file
= LOCK_INIT
;
429 trace2_cmd_mode(opts
->patch_mode
? "patch" : "path");
431 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
432 die(_("'%s' cannot be used with updating paths"), "--track");
434 if (opts
->new_branch_log
)
435 die(_("'%s' cannot be used with updating paths"), "-l");
437 if (opts
->ignore_unmerged
&& opts
->patch_mode
)
438 die(_("'%s' cannot be used with updating paths"),
439 opts
->ignore_unmerged_opt
);
441 if (opts
->force_detach
)
442 die(_("'%s' cannot be used with updating paths"), "--detach");
444 if (opts
->merge
&& opts
->patch_mode
)
445 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
447 if (opts
->ignore_unmerged
&& opts
->merge
)
448 die(_("'%s' cannot be used with %s"),
449 opts
->ignore_unmerged_opt
, "-m");
451 if (opts
->new_branch
)
452 die(_("Cannot update paths and switch to branch '%s' at the same time."),
455 if (!opts
->checkout_worktree
&& !opts
->checkout_index
)
456 die(_("neither '%s' or '%s' is specified"),
457 "--staged", "--worktree");
459 if (!opts
->checkout_worktree
&& !opts
->from_treeish
)
460 die(_("'%s' must be used when '%s' is not specified"),
461 "--worktree", "--source");
463 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
464 opts
->writeout_stage
)
465 die(_("'%s' or '%s' cannot be used with %s"),
466 "--ours", "--theirs", "--staged");
468 if (opts
->checkout_index
&& !opts
->checkout_worktree
&&
470 die(_("'%s' or '%s' cannot be used with %s"),
471 "--merge", "--conflict", "--staged");
473 if (opts
->patch_mode
) {
474 const char *patch_mode
;
475 const char *rev
= new_branch_info
->name
;
476 char rev_oid
[GIT_MAX_HEXSZ
+ 1];
479 * Since rev can be in the form of `<a>...<b>` (which is not
480 * recognized by diff-index), we will always replace the name
481 * with the hex of the commit (whether it's in `...` form or
482 * not) for the run_add_interactive() machinery to work
483 * properly. However, there is special logic for the HEAD case
484 * so we mustn't replace that. Also, when we were given a
485 * tree-object, new_branch_info->commit would be NULL, but we
486 * do not have to do any replacement, either.
488 if (rev
&& new_branch_info
->commit
&& strcmp(rev
, "HEAD"))
489 rev
= oid_to_hex_r(rev_oid
, &new_branch_info
->commit
->object
.oid
);
491 if (opts
->checkout_index
&& opts
->checkout_worktree
)
492 patch_mode
= "--patch=checkout";
493 else if (opts
->checkout_index
&& !opts
->checkout_worktree
)
494 patch_mode
= "--patch=reset";
495 else if (!opts
->checkout_index
&& opts
->checkout_worktree
)
496 patch_mode
= "--patch=worktree";
498 BUG("either flag must have been set, worktree=%d, index=%d",
499 opts
->checkout_worktree
, opts
->checkout_index
);
500 return run_add_interactive(rev
, patch_mode
, &opts
->pathspec
);
503 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
504 if (read_cache_preload(&opts
->pathspec
) < 0)
505 return error(_("index file corrupt"));
507 if (opts
->source_tree
)
508 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
510 ps_matched
= xcalloc(opts
->pathspec
.nr
, 1);
513 * Make sure all pathspecs participated in locating the paths
516 for (pos
= 0; pos
< active_nr
; pos
++)
517 if (opts
->overlay_mode
)
518 mark_ce_for_checkout_overlay(active_cache
[pos
],
522 mark_ce_for_checkout_no_overlay(active_cache
[pos
],
526 if (report_path_error(ps_matched
, &opts
->pathspec
)) {
532 /* "checkout -m path" to recreate conflicted state */
534 unmerge_marked_index(&the_index
);
536 /* Any unmerged paths? */
537 for (pos
= 0; pos
< active_nr
; pos
++) {
538 const struct cache_entry
*ce
= active_cache
[pos
];
539 if (ce
->ce_flags
& CE_MATCHED
) {
542 if (opts
->ignore_unmerged
) {
544 warning(_("path '%s' is unmerged"), ce
->name
);
545 } else if (opts
->writeout_stage
) {
546 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
, opts
->overlay_mode
);
547 } else if (opts
->merge
) {
548 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
551 error(_("path '%s' is unmerged"), ce
->name
);
553 pos
= skip_same_name(ce
, pos
) - 1;
559 /* Now we are committed to check them out */
560 if (opts
->checkout_worktree
)
561 errs
|= checkout_worktree(opts
, new_branch_info
);
563 remove_marked_cache_entries(&the_index
, 1);
566 * Allow updating the index when checking out from the index.
567 * This is to save new stat info.
569 if (opts
->checkout_worktree
&& !opts
->checkout_index
&& !opts
->source_tree
)
572 checkout_index
= opts
->checkout_index
;
574 if (checkout_index
) {
575 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
576 die(_("unable to write new index file"));
579 * NEEDSWORK: if --worktree is not specified, we
580 * should save stat info of checked out files in the
581 * index to avoid the next (potentially costly)
582 * refresh. But it's a bit tricker to do...
584 rollback_lock_file(&lock_file
);
587 read_ref_full("HEAD", 0, &rev
, NULL
);
588 head
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
590 errs
|= post_checkout_hook(head
, head
, 0);
594 static void show_local_changes(struct object
*head
,
595 const struct diff_options
*opts
)
598 /* I think we want full paths, even if we're in a subdirectory. */
599 repo_init_revisions(the_repository
, &rev
, NULL
);
600 rev
.diffopt
.flags
= opts
->flags
;
601 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
602 diff_setup_done(&rev
.diffopt
);
603 add_pending_object(&rev
, head
, NULL
);
604 run_diff_index(&rev
, 0);
607 static void describe_detached_head(const char *msg
, struct commit
*commit
)
609 struct strbuf sb
= STRBUF_INIT
;
611 if (!parse_commit(commit
))
612 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
613 if (print_sha1_ellipsis()) {
614 fprintf(stderr
, "%s %s... %s\n", msg
,
615 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
617 fprintf(stderr
, "%s %s %s\n", msg
,
618 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
623 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
624 int worktree
, int *writeout_error
,
625 struct branch_info
*info
)
627 struct unpack_trees_options opts
;
628 struct tree_desc tree_desc
;
630 memset(&opts
, 0, sizeof(opts
));
632 opts
.update
= worktree
;
633 opts
.skip_unmerged
= !worktree
;
636 opts
.fn
= oneway_merge
;
637 opts
.verbose_update
= o
->show_progress
;
638 opts
.src_index
= &the_index
;
639 opts
.dst_index
= &the_index
;
640 init_checkout_metadata(&opts
.meta
, info
->refname
,
641 info
->commit
? &info
->commit
->object
.oid
: &null_oid
,
644 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
645 switch (unpack_trees(1, &tree_desc
, &opts
)) {
649 * We return 0 nevertheless, as the index is all right
650 * and more importantly we have made best efforts to
651 * update paths in the work tree, and we cannot revert
662 static void setup_branch_path(struct branch_info
*branch
)
664 struct strbuf buf
= STRBUF_INIT
;
667 * If this is a ref, resolve it; otherwise, look up the OID for our
668 * expression. Failure here is okay.
670 if (!dwim_ref(branch
->name
, strlen(branch
->name
), &branch
->oid
, &branch
->refname
, 0))
671 repo_get_oid_committish(the_repository
, branch
->name
, &branch
->oid
);
673 strbuf_branchname(&buf
, branch
->name
, INTERPRET_BRANCH_LOCAL
);
674 if (strcmp(buf
.buf
, branch
->name
))
675 branch
->name
= xstrdup(buf
.buf
);
676 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
677 branch
->path
= strbuf_detach(&buf
, NULL
);
680 static int merge_working_tree(const struct checkout_opts
*opts
,
681 struct branch_info
*old_branch_info
,
682 struct branch_info
*new_branch_info
,
686 struct lock_file lock_file
= LOCK_INIT
;
687 struct tree
*new_tree
;
689 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
690 if (read_cache_preload(NULL
) < 0)
691 return error(_("index file corrupt"));
693 resolve_undo_clear();
694 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
695 if (new_branch_info
->commit
)
696 BUG("'switch --orphan' should never accept a commit as starting point");
697 new_tree
= parse_tree_indirect(the_hash_algo
->empty_tree
);
699 new_tree
= get_commit_tree(new_branch_info
->commit
);
700 if (opts
->discard_changes
) {
701 ret
= reset_tree(new_tree
, opts
, 1, writeout_error
, new_branch_info
);
705 struct tree_desc trees
[2];
707 struct unpack_trees_options topts
;
709 memset(&topts
, 0, sizeof(topts
));
711 topts
.src_index
= &the_index
;
712 topts
.dst_index
= &the_index
;
714 setup_unpack_trees_porcelain(&topts
, "checkout");
716 refresh_cache(REFRESH_QUIET
);
718 if (unmerged_cache()) {
719 error(_("you need to resolve your current index first"));
723 /* 2-way merge to the new branch */
724 topts
.initial_checkout
= is_cache_unborn();
727 topts
.quiet
= opts
->merge
&& old_branch_info
->commit
;
728 topts
.verbose_update
= opts
->show_progress
;
729 topts
.fn
= twoway_merge
;
730 init_checkout_metadata(&topts
.meta
, new_branch_info
->refname
,
731 new_branch_info
->commit
?
732 &new_branch_info
->commit
->object
.oid
:
733 &new_branch_info
->oid
, NULL
);
734 if (opts
->overwrite_ignore
) {
735 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
736 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
737 setup_standard_excludes(topts
.dir
);
739 tree
= parse_tree_indirect(old_branch_info
->commit
?
740 &old_branch_info
->commit
->object
.oid
:
741 the_hash_algo
->empty_tree
);
742 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
743 parse_tree(new_tree
);
745 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
747 ret
= unpack_trees(2, trees
, &topts
);
748 clear_unpack_trees_porcelain(&topts
);
751 * Unpack couldn't do a trivial merge; either
752 * give up or do a real merge, depending on
753 * whether the merge flag was used.
756 struct tree
*old_tree
;
757 struct merge_options o
;
758 struct strbuf sb
= STRBUF_INIT
;
759 struct strbuf old_commit_shortname
= STRBUF_INIT
;
765 * Without old_branch_info->commit, the below is the same as
766 * the two-tree unpack we already tried and failed.
768 if (!old_branch_info
->commit
)
770 old_tree
= get_commit_tree(old_branch_info
->commit
);
772 if (repo_index_has_changes(the_repository
, old_tree
, &sb
))
773 die(_("cannot continue with staged changes in "
774 "the following files:\n%s"), sb
.buf
);
777 /* Do more real merge */
780 * We update the index fully, then write the
781 * tree from the index, then merge the new
782 * branch with the current tree, with the old
783 * branch as the base. Then we reset the index
784 * (but not the working tree) to the new
785 * branch, leaving the working tree as the
786 * merged version, but skipping unmerged
787 * entries in the index.
790 add_files_to_cache(NULL
, NULL
, 0);
791 init_merge_options(&o
, the_repository
);
793 work
= write_in_core_index_as_tree(the_repository
);
795 ret
= reset_tree(new_tree
,
797 writeout_error
, new_branch_info
);
800 o
.ancestor
= old_branch_info
->name
;
801 if (old_branch_info
->name
== NULL
) {
802 strbuf_add_unique_abbrev(&old_commit_shortname
,
803 &old_branch_info
->commit
->object
.oid
,
805 o
.ancestor
= old_commit_shortname
.buf
;
807 o
.branch1
= new_branch_info
->name
;
809 ret
= merge_trees(&o
,
815 ret
= reset_tree(new_tree
,
817 writeout_error
, new_branch_info
);
818 strbuf_release(&o
.obuf
);
819 strbuf_release(&old_commit_shortname
);
825 if (!cache_tree_fully_valid(active_cache_tree
))
826 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
828 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
829 die(_("unable to write new index file"));
831 if (!opts
->discard_changes
&& !opts
->quiet
&& new_branch_info
->commit
)
832 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
837 static void report_tracking(struct branch_info
*new_branch_info
)
839 struct strbuf sb
= STRBUF_INIT
;
840 struct branch
*branch
= branch_get(new_branch_info
->name
);
842 if (!format_tracking_info(branch
, &sb
, AHEAD_BEHIND_FULL
))
844 fputs(sb
.buf
, stdout
);
848 static void update_refs_for_switch(const struct checkout_opts
*opts
,
849 struct branch_info
*old_branch_info
,
850 struct branch_info
*new_branch_info
)
852 struct strbuf msg
= STRBUF_INIT
;
853 const char *old_desc
, *reflog_msg
;
854 if (opts
->new_branch
) {
855 if (opts
->new_orphan_branch
) {
858 refname
= mkpathdup("refs/heads/%s", opts
->new_orphan_branch
);
859 if (opts
->new_branch_log
&&
860 !should_autocreate_reflog(refname
)) {
862 struct strbuf err
= STRBUF_INIT
;
864 ret
= safe_create_reflog(refname
, 1, &err
);
866 fprintf(stderr
, _("Can not do reflog for '%s': %s\n"),
867 opts
->new_orphan_branch
, err
.buf
);
868 strbuf_release(&err
);
872 strbuf_release(&err
);
877 create_branch(the_repository
,
878 opts
->new_branch
, new_branch_info
->name
,
879 opts
->new_branch_force
? 1 : 0,
880 opts
->new_branch_force
? 1 : 0,
881 opts
->new_branch_log
,
884 new_branch_info
->name
= opts
->new_branch
;
885 setup_branch_path(new_branch_info
);
888 old_desc
= old_branch_info
->name
;
889 if (!old_desc
&& old_branch_info
->commit
)
890 old_desc
= oid_to_hex(&old_branch_info
->commit
->object
.oid
);
892 reflog_msg
= getenv("GIT_REFLOG_ACTION");
894 strbuf_addf(&msg
, "checkout: moving from %s to %s",
895 old_desc
? old_desc
: "(invalid)", new_branch_info
->name
);
897 strbuf_insertstr(&msg
, 0, reflog_msg
);
899 if (!strcmp(new_branch_info
->name
, "HEAD") && !new_branch_info
->path
&& !opts
->force_detach
) {
901 } else if (opts
->force_detach
|| !new_branch_info
->path
) { /* No longer on any branch. */
902 update_ref(msg
.buf
, "HEAD", &new_branch_info
->commit
->object
.oid
, NULL
,
903 REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
905 if (old_branch_info
->path
&&
906 advice_detached_head
&& !opts
->force_detach
)
907 detach_advice(new_branch_info
->name
);
908 describe_detached_head(_("HEAD is now at"), new_branch_info
->commit
);
910 } else if (new_branch_info
->path
) { /* Switch branches. */
911 if (create_symref("HEAD", new_branch_info
->path
, msg
.buf
) < 0)
912 die(_("unable to update HEAD"));
914 if (old_branch_info
->path
&& !strcmp(new_branch_info
->path
, old_branch_info
->path
)) {
915 if (opts
->new_branch_force
)
916 fprintf(stderr
, _("Reset branch '%s'\n"),
917 new_branch_info
->name
);
919 fprintf(stderr
, _("Already on '%s'\n"),
920 new_branch_info
->name
);
921 } else if (opts
->new_branch
) {
922 if (opts
->branch_exists
)
923 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new_branch_info
->name
);
925 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new_branch_info
->name
);
927 fprintf(stderr
, _("Switched to branch '%s'\n"),
928 new_branch_info
->name
);
931 if (old_branch_info
->path
&& old_branch_info
->name
) {
932 if (!ref_exists(old_branch_info
->path
) && reflog_exists(old_branch_info
->path
))
933 delete_reflog(old_branch_info
->path
);
936 remove_branch_state(the_repository
, !opts
->quiet
);
937 strbuf_release(&msg
);
939 (new_branch_info
->path
|| (!opts
->force_detach
&& !strcmp(new_branch_info
->name
, "HEAD"))))
940 report_tracking(new_branch_info
);
943 static int add_pending_uninteresting_ref(const char *refname
,
944 const struct object_id
*oid
,
945 int flags
, void *cb_data
)
947 add_pending_oid(cb_data
, refname
, oid
, UNINTERESTING
);
951 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
953 strbuf_addstr(sb
, " ");
954 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
, DEFAULT_ABBREV
);
955 strbuf_addch(sb
, ' ');
956 if (!parse_commit(commit
))
957 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
958 strbuf_addch(sb
, '\n');
961 #define ORPHAN_CUTOFF 4
962 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
964 struct commit
*c
, *last
= NULL
;
965 struct strbuf sb
= STRBUF_INIT
;
967 while ((c
= get_revision(revs
)) != NULL
) {
968 if (lost
< ORPHAN_CUTOFF
)
969 describe_one_orphan(&sb
, c
);
973 if (ORPHAN_CUTOFF
< lost
) {
974 int more
= lost
- ORPHAN_CUTOFF
;
976 describe_one_orphan(&sb
, last
);
978 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
983 /* The singular version */
984 "Warning: you are leaving %d commit behind, "
986 "any of your branches:\n\n"
988 /* The plural version */
989 "Warning: you are leaving %d commits behind, "
991 "any of your branches:\n\n"
993 /* Give ngettext() the count */
999 if (advice_detached_head
)
1002 /* The singular version */
1003 "If you want to keep it by creating a new branch, "
1004 "this may be a good time\nto do so with:\n\n"
1005 " git branch <new-branch-name> %s\n\n",
1006 /* The plural version */
1007 "If you want to keep them by creating a new branch, "
1008 "this may be a good time\nto do so with:\n\n"
1009 " git branch <new-branch-name> %s\n\n",
1010 /* Give ngettext() the count */
1012 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
1016 * We are about to leave commit that was at the tip of a detached
1017 * HEAD. If it is not reachable from any ref, this is the last chance
1018 * for the user to do so without resorting to reflog.
1020 static void orphaned_commit_warning(struct commit
*old_commit
, struct commit
*new_commit
)
1022 struct rev_info revs
;
1023 struct object
*object
= &old_commit
->object
;
1025 repo_init_revisions(the_repository
, &revs
, NULL
);
1026 setup_revisions(0, NULL
, &revs
, NULL
);
1028 object
->flags
&= ~UNINTERESTING
;
1029 add_pending_object(&revs
, object
, oid_to_hex(&object
->oid
));
1031 for_each_ref(add_pending_uninteresting_ref
, &revs
);
1033 add_pending_oid(&revs
, "HEAD",
1034 &new_commit
->object
.oid
,
1037 if (prepare_revision_walk(&revs
))
1038 die(_("internal error in revision walk"));
1039 if (!(old_commit
->object
.flags
& UNINTERESTING
))
1040 suggest_reattach(old_commit
, &revs
);
1042 describe_detached_head(_("Previous HEAD position was"), old_commit
);
1044 /* Clean up objects used, as they will be reused. */
1045 repo_clear_commit_marks(the_repository
, ALL_REV_FLAGS
);
1048 static int switch_branches(const struct checkout_opts
*opts
,
1049 struct branch_info
*new_branch_info
)
1052 struct branch_info old_branch_info
;
1054 struct object_id rev
;
1055 int flag
, writeout_error
= 0;
1058 trace2_cmd_mode("branch");
1060 memset(&old_branch_info
, 0, sizeof(old_branch_info
));
1061 old_branch_info
.path
= path_to_free
= resolve_refdup("HEAD", 0, &rev
, &flag
);
1062 if (old_branch_info
.path
)
1063 old_branch_info
.commit
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
1064 if (!(flag
& REF_ISSYMREF
))
1065 old_branch_info
.path
= NULL
;
1067 if (old_branch_info
.path
)
1068 skip_prefix(old_branch_info
.path
, "refs/heads/", &old_branch_info
.name
);
1070 if (opts
->new_orphan_branch
&& opts
->orphan_from_empty_tree
) {
1071 if (new_branch_info
->name
)
1072 BUG("'switch --orphan' should never accept a commit as starting point");
1073 new_branch_info
->commit
= NULL
;
1074 new_branch_info
->name
= "(empty)";
1078 if (!new_branch_info
->name
) {
1079 new_branch_info
->name
= "HEAD";
1080 new_branch_info
->commit
= old_branch_info
.commit
;
1081 if (!new_branch_info
->commit
)
1082 die(_("You are on a branch yet to be born"));
1083 parse_commit_or_die(new_branch_info
->commit
);
1085 if (opts
->only_merge_on_switching_branches
)
1090 ret
= merge_working_tree(opts
, &old_branch_info
, new_branch_info
, &writeout_error
);
1097 if (!opts
->quiet
&& !old_branch_info
.path
&& old_branch_info
.commit
&& new_branch_info
->commit
!= old_branch_info
.commit
)
1098 orphaned_commit_warning(old_branch_info
.commit
, new_branch_info
->commit
);
1100 update_refs_for_switch(opts
, &old_branch_info
, new_branch_info
);
1102 ret
= post_checkout_hook(old_branch_info
.commit
, new_branch_info
->commit
, 1);
1104 return ret
|| writeout_error
;
1107 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
1109 struct checkout_opts
*opts
= cb
;
1111 if (!strcmp(var
, "diff.ignoresubmodules")) {
1112 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
1115 if (!strcmp(var
, "checkout.guess")) {
1116 opts
->dwim_new_local_branch
= git_config_bool(var
, value
);
1120 if (starts_with(var
, "submodule."))
1121 return git_default_submodule_config(var
, value
, NULL
);
1123 return git_xmerge_config(var
, value
, NULL
);
1126 static void setup_new_branch_info_and_source_tree(
1127 struct branch_info
*new_branch_info
,
1128 struct checkout_opts
*opts
,
1129 struct object_id
*rev
,
1132 struct tree
**source_tree
= &opts
->source_tree
;
1133 struct object_id branch_rev
;
1135 new_branch_info
->name
= arg
;
1136 setup_branch_path(new_branch_info
);
1138 if (!check_refname_format(new_branch_info
->path
, 0) &&
1139 !read_ref(new_branch_info
->path
, &branch_rev
))
1140 oidcpy(rev
, &branch_rev
);
1142 free((char *)new_branch_info
->path
);
1143 new_branch_info
->path
= NULL
; /* not an existing branch */
1146 new_branch_info
->commit
= lookup_commit_reference_gently(the_repository
, rev
, 1);
1147 if (!new_branch_info
->commit
) {
1149 *source_tree
= parse_tree_indirect(rev
);
1151 parse_commit_or_die(new_branch_info
->commit
);
1152 *source_tree
= get_commit_tree(new_branch_info
->commit
);
1156 static const char *parse_remote_branch(const char *arg
,
1157 struct object_id
*rev
,
1158 int could_be_checkout_paths
)
1160 int num_matches
= 0;
1161 const char *remote
= unique_tracking_name(arg
, rev
, &num_matches
);
1163 if (remote
&& could_be_checkout_paths
) {
1164 die(_("'%s' could be both a local file and a tracking branch.\n"
1165 "Please use -- (and optionally --no-guess) to disambiguate"),
1169 if (!remote
&& num_matches
> 1) {
1170 if (advice_checkout_ambiguous_remote_branch_name
) {
1171 advise(_("If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1172 "you can do so by fully qualifying the name with the --track option:\n"
1174 " git checkout --track origin/<name>\n"
1176 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1177 "one remote, e.g. the 'origin' remote, consider setting\n"
1178 "checkout.defaultRemote=origin in your config."));
1181 die(_("'%s' matched multiple (%d) remote tracking branches"),
1188 static int parse_branchname_arg(int argc
, const char **argv
,
1189 int dwim_new_local_branch_ok
,
1190 struct branch_info
*new_branch_info
,
1191 struct checkout_opts
*opts
,
1192 struct object_id
*rev
)
1194 const char **new_branch
= &opts
->new_branch
;
1198 int has_dash_dash
= 0;
1202 * case 1: git checkout <ref> -- [<paths>]
1204 * <ref> must be a valid tree, everything after the '--' must be
1207 * case 2: git checkout -- [<paths>]
1209 * everything after the '--' must be paths.
1211 * case 3: git checkout <something> [--]
1213 * (a) If <something> is a commit, that is to
1214 * switch to the branch or detach HEAD at it. As a special case,
1215 * if <something> is A...B (missing A or B means HEAD but you can
1216 * omit at most one side), and if there is a unique merge base
1217 * between A and B, A...B names that merge base.
1219 * (b) If <something> is _not_ a commit, either "--" is present
1220 * or <something> is not a path, no -t or -b was given, and
1221 * and there is a tracking branch whose name is <something>
1222 * in one and only one remote (or if the branch exists on the
1223 * remote named in checkout.defaultRemote), then this is a
1224 * short-hand to fork local <something> from that
1225 * remote-tracking branch.
1227 * (c) Otherwise, if "--" is present, treat it like case (1).
1230 * - if it's a reference, treat it like case (1)
1231 * - else if it's a path, treat it like case (2)
1234 * case 4: git checkout <something> <paths>
1236 * The first argument must not be ambiguous.
1237 * - If it's *only* a reference, treat it like case (1).
1238 * - If it's only a path, treat it like case (2).
1245 if (!opts
->accept_pathspec
) {
1247 die(_("only one reference expected"));
1248 has_dash_dash
= 1; /* helps disambiguate */
1253 for (i
= 0; i
< argc
; i
++) {
1254 if (opts
->accept_pathspec
&& !strcmp(argv
[i
], "--")) {
1259 if (dash_dash_pos
== 0)
1260 return 1; /* case (2) */
1261 else if (dash_dash_pos
== 1)
1262 has_dash_dash
= 1; /* case (3) or (1) */
1263 else if (dash_dash_pos
>= 2)
1264 die(_("only one reference expected, %d given."), dash_dash_pos
);
1265 opts
->count_checkout_paths
= !opts
->quiet
&& !has_dash_dash
;
1267 if (!strcmp(arg
, "-"))
1270 if (get_oid_mb(arg
, rev
)) {
1272 * Either case (3) or (4), with <something> not being
1273 * a commit, or an attempt to use case (1) with an
1276 * It's likely an error, but we need to find out if
1277 * we should auto-create the branch, case (3).(b).
1279 int recover_with_dwim
= dwim_new_local_branch_ok
;
1281 int could_be_checkout_paths
= !has_dash_dash
&&
1282 check_filename(opts
->prefix
, arg
);
1284 if (!has_dash_dash
&& !no_wildcard(arg
))
1285 recover_with_dwim
= 0;
1288 * Accept "git checkout foo", "git checkout foo --"
1289 * and "git switch foo" as candidates for dwim.
1291 if (!(argc
== 1 && !has_dash_dash
) &&
1292 !(argc
== 2 && has_dash_dash
) &&
1293 opts
->accept_pathspec
)
1294 recover_with_dwim
= 0;
1296 if (recover_with_dwim
) {
1297 const char *remote
= parse_remote_branch(arg
, rev
,
1298 could_be_checkout_paths
);
1302 /* DWIMmed to create local branch, case (3).(b) */
1304 recover_with_dwim
= 0;
1308 if (!recover_with_dwim
) {
1310 die(_("invalid reference: %s"), arg
);
1315 /* we can't end up being in (2) anymore, eat the argument */
1320 setup_new_branch_info_and_source_tree(new_branch_info
, opts
, rev
, arg
);
1322 if (!opts
->source_tree
) /* case (1): want a tree */
1323 die(_("reference is not a tree: %s"), arg
);
1325 if (!has_dash_dash
) { /* case (3).(d) -> (1) */
1327 * Do not complain the most common case
1328 * git checkout branch
1329 * even if there happen to be a file called 'branch';
1330 * it would be extremely annoying.
1333 verify_non_filename(opts
->prefix
, arg
);
1334 } else if (opts
->accept_pathspec
) {
1343 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1346 struct strbuf branch_ref
= STRBUF_INIT
;
1348 trace2_cmd_mode("unborn");
1350 if (!opts
->new_branch
)
1351 die(_("You are on a branch yet to be born"));
1352 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1353 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1354 strbuf_release(&branch_ref
);
1356 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1361 static void die_expecting_a_branch(const struct branch_info
*branch_info
)
1363 struct object_id oid
;
1366 if (dwim_ref(branch_info
->name
, strlen(branch_info
->name
), &oid
, &to_free
, 0) == 1) {
1367 const char *ref
= to_free
;
1369 if (skip_prefix(ref
, "refs/tags/", &ref
))
1370 die(_("a branch is expected, got tag '%s'"), ref
);
1371 if (skip_prefix(ref
, "refs/remotes/", &ref
))
1372 die(_("a branch is expected, got remote branch '%s'"), ref
);
1373 die(_("a branch is expected, got '%s'"), ref
);
1375 if (branch_info
->commit
)
1376 die(_("a branch is expected, got commit '%s'"), branch_info
->name
);
1378 * This case should never happen because we already die() on
1379 * non-commit, but just in case.
1381 die(_("a branch is expected, got '%s'"), branch_info
->name
);
1384 static void die_if_some_operation_in_progress(void)
1386 struct wt_status_state state
;
1388 memset(&state
, 0, sizeof(state
));
1389 wt_status_get_state(the_repository
, &state
, 0);
1391 if (state
.merge_in_progress
)
1392 die(_("cannot switch branch while merging\n"
1393 "Consider \"git merge --quit\" "
1394 "or \"git worktree add\"."));
1395 if (state
.am_in_progress
)
1396 die(_("cannot switch branch in the middle of an am session\n"
1397 "Consider \"git am --quit\" "
1398 "or \"git worktree add\"."));
1399 if (state
.rebase_interactive_in_progress
|| state
.rebase_in_progress
)
1400 die(_("cannot switch branch while rebasing\n"
1401 "Consider \"git rebase --quit\" "
1402 "or \"git worktree add\"."));
1403 if (state
.cherry_pick_in_progress
)
1404 die(_("cannot switch branch while cherry-picking\n"
1405 "Consider \"git cherry-pick --quit\" "
1406 "or \"git worktree add\"."));
1407 if (state
.revert_in_progress
)
1408 die(_("cannot switch branch while reverting\n"
1409 "Consider \"git revert --quit\" "
1410 "or \"git worktree add\"."));
1411 if (state
.bisect_in_progress
)
1412 warning(_("you are switching branch while bisecting"));
1415 static int checkout_branch(struct checkout_opts
*opts
,
1416 struct branch_info
*new_branch_info
)
1418 if (opts
->pathspec
.nr
)
1419 die(_("paths cannot be used with switching branches"));
1421 if (opts
->patch_mode
)
1422 die(_("'%s' cannot be used with switching branches"),
1425 if (opts
->overlay_mode
!= -1)
1426 die(_("'%s' cannot be used with switching branches"),
1429 if (opts
->writeout_stage
)
1430 die(_("'%s' cannot be used with switching branches"),
1433 if (opts
->force
&& opts
->merge
)
1434 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1436 if (opts
->discard_changes
&& opts
->merge
)
1437 die(_("'%s' cannot be used with '%s'"), "--discard-changes", "--merge");
1439 if (opts
->force_detach
&& opts
->new_branch
)
1440 die(_("'%s' cannot be used with '%s'"),
1441 "--detach", "-b/-B/--orphan");
1443 if (opts
->new_orphan_branch
) {
1444 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1445 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1446 if (opts
->orphan_from_empty_tree
&& new_branch_info
->name
)
1447 die(_("'%s' cannot take <start-point>"), "--orphan");
1448 } else if (opts
->force_detach
) {
1449 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1450 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1451 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1452 opts
->track
= git_branch_track
;
1454 if (new_branch_info
->name
&& !new_branch_info
->commit
)
1455 die(_("Cannot switch branch to a non-commit '%s'"),
1456 new_branch_info
->name
);
1458 if (!opts
->switch_branch_doing_nothing_is_ok
&&
1459 !new_branch_info
->name
&&
1460 !opts
->new_branch
&&
1461 !opts
->force_detach
)
1462 die(_("missing branch or commit argument"));
1464 if (!opts
->implicit_detach
&&
1465 !opts
->force_detach
&&
1466 !opts
->new_branch
&&
1467 !opts
->new_branch_force
&&
1468 new_branch_info
->name
&&
1469 !new_branch_info
->path
)
1470 die_expecting_a_branch(new_branch_info
);
1472 if (!opts
->can_switch_when_in_progress
)
1473 die_if_some_operation_in_progress();
1475 if (new_branch_info
->path
&& !opts
->force_detach
&& !opts
->new_branch
&&
1476 !opts
->ignore_other_worktrees
) {
1478 char *head_ref
= resolve_refdup("HEAD", 0, NULL
, &flag
);
1480 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new_branch_info
->path
)))
1481 die_if_checked_out(new_branch_info
->path
, 1);
1485 if (!new_branch_info
->commit
&& opts
->new_branch
) {
1486 struct object_id rev
;
1489 if (!read_ref_full("HEAD", 0, &rev
, &flag
) &&
1490 (flag
& REF_ISSYMREF
) && is_null_oid(&rev
))
1491 return switch_unborn_to_new_branch(opts
);
1493 return switch_branches(opts
, new_branch_info
);
1496 static struct option
*add_common_options(struct checkout_opts
*opts
,
1497 struct option
*prevopts
)
1499 struct option options
[] = {
1500 OPT__QUIET(&opts
->quiet
, N_("suppress progress reporting")),
1501 OPT_CALLBACK_F(0, "recurse-submodules", NULL
,
1502 "checkout", "control recursive updating of submodules",
1503 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
),
1504 OPT_BOOL(0, "progress", &opts
->show_progress
, N_("force progress reporting")),
1505 OPT_BOOL('m', "merge", &opts
->merge
, N_("perform a 3-way merge with the new branch")),
1506 OPT_STRING(0, "conflict", &opts
->conflict_style
, N_("style"),
1507 N_("conflict style (merge or diff3)")),
1510 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1515 static struct option
*add_common_switch_branch_options(
1516 struct checkout_opts
*opts
, struct option
*prevopts
)
1518 struct option options
[] = {
1519 OPT_BOOL('d', "detach", &opts
->force_detach
, N_("detach HEAD at named commit")),
1520 OPT_SET_INT('t', "track", &opts
->track
, N_("set upstream info for new branch"),
1521 BRANCH_TRACK_EXPLICIT
),
1522 OPT__FORCE(&opts
->force
, N_("force checkout (throw away local modifications)"),
1523 PARSE_OPT_NOCOMPLETE
),
1524 OPT_STRING(0, "orphan", &opts
->new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1525 OPT_BOOL_F(0, "overwrite-ignore", &opts
->overwrite_ignore
,
1526 N_("update ignored files (default)"),
1527 PARSE_OPT_NOCOMPLETE
),
1528 OPT_BOOL(0, "ignore-other-worktrees", &opts
->ignore_other_worktrees
,
1529 N_("do not check if another worktree is holding the given ref")),
1532 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1537 static struct option
*add_checkout_path_options(struct checkout_opts
*opts
,
1538 struct option
*prevopts
)
1540 struct option options
[] = {
1541 OPT_SET_INT_F('2', "ours", &opts
->writeout_stage
,
1542 N_("checkout our version for unmerged files"),
1543 2, PARSE_OPT_NONEG
),
1544 OPT_SET_INT_F('3', "theirs", &opts
->writeout_stage
,
1545 N_("checkout their version for unmerged files"),
1546 3, PARSE_OPT_NONEG
),
1547 OPT_BOOL('p', "patch", &opts
->patch_mode
, N_("select hunks interactively")),
1548 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
->ignore_skipworktree
,
1549 N_("do not limit pathspecs to sparse entries only")),
1550 OPT_PATHSPEC_FROM_FILE(&opts
->pathspec_from_file
),
1551 OPT_PATHSPEC_FILE_NUL(&opts
->pathspec_file_nul
),
1554 struct option
*newopts
= parse_options_concat(prevopts
, options
);
1559 /* create-branch option (either b or c) */
1560 static char cb_option
= 'b';
1562 static int checkout_main(int argc
, const char **argv
, const char *prefix
,
1563 struct checkout_opts
*opts
, struct option
*options
,
1564 const char * const usagestr
[])
1566 struct branch_info new_branch_info
;
1567 int parseopt_flags
= 0;
1569 memset(&new_branch_info
, 0, sizeof(new_branch_info
));
1570 opts
->overwrite_ignore
= 1;
1571 opts
->prefix
= prefix
;
1572 opts
->show_progress
= -1;
1574 git_config(git_checkout_config
, opts
);
1576 opts
->track
= BRANCH_TRACK_UNSPECIFIED
;
1578 if (!opts
->accept_pathspec
&& !opts
->accept_ref
)
1579 BUG("make up your mind, you need to take _something_");
1580 if (opts
->accept_pathspec
&& opts
->accept_ref
)
1581 parseopt_flags
= PARSE_OPT_KEEP_DASHDASH
;
1583 argc
= parse_options(argc
, argv
, prefix
, options
,
1584 usagestr
, parseopt_flags
);
1586 if (opts
->show_progress
< 0) {
1588 opts
->show_progress
= 0;
1590 opts
->show_progress
= isatty(2);
1593 if (opts
->conflict_style
) {
1594 opts
->merge
= 1; /* implied */
1595 git_xmerge_config("merge.conflictstyle", opts
->conflict_style
, NULL
);
1598 opts
->discard_changes
= 1;
1599 opts
->ignore_unmerged_opt
= "--force";
1600 opts
->ignore_unmerged
= 1;
1603 if ((!!opts
->new_branch
+ !!opts
->new_branch_force
+ !!opts
->new_orphan_branch
) > 1)
1604 die(_("-%c, -%c and --orphan are mutually exclusive"),
1605 cb_option
, toupper(cb_option
));
1607 if (opts
->overlay_mode
== 1 && opts
->patch_mode
)
1608 die(_("-p and --overlay are mutually exclusive"));
1610 if (opts
->checkout_index
>= 0 || opts
->checkout_worktree
>= 0) {
1611 if (opts
->checkout_index
< 0)
1612 opts
->checkout_index
= 0;
1613 if (opts
->checkout_worktree
< 0)
1614 opts
->checkout_worktree
= 0;
1616 if (opts
->checkout_index
< 0)
1617 opts
->checkout_index
= -opts
->checkout_index
- 1;
1618 if (opts
->checkout_worktree
< 0)
1619 opts
->checkout_worktree
= -opts
->checkout_worktree
- 1;
1621 if (opts
->checkout_index
< 0 || opts
->checkout_worktree
< 0)
1622 BUG("these flags should be non-negative by now");
1624 * convenient shortcut: "git restore --staged [--worktree]" equals
1625 * "git restore --staged [--worktree] --source HEAD"
1627 if (!opts
->from_treeish
&& opts
->checkout_index
)
1628 opts
->from_treeish
= "HEAD";
1631 * From here on, new_branch will contain the branch to be checked out,
1632 * and new_branch_force and new_orphan_branch will tell us which one of
1633 * -b/-B/-c/-C/--orphan is being used.
1635 if (opts
->new_branch_force
)
1636 opts
->new_branch
= opts
->new_branch_force
;
1638 if (opts
->new_orphan_branch
)
1639 opts
->new_branch
= opts
->new_orphan_branch
;
1641 /* --track without -c/-C/-b/-B/--orphan should DWIM */
1642 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
->new_branch
) {
1643 const char *argv0
= argv
[0];
1644 if (!argc
|| !strcmp(argv0
, "--"))
1645 die(_("--track needs a branch name"));
1646 skip_prefix(argv0
, "refs/", &argv0
);
1647 skip_prefix(argv0
, "remotes/", &argv0
);
1648 argv0
= strchr(argv0
, '/');
1649 if (!argv0
|| !argv0
[1])
1650 die(_("missing branch name; try -%c"), cb_option
);
1651 opts
->new_branch
= argv0
+ 1;
1655 * Extract branch name from command line arguments, so
1656 * all that is left is pathspecs.
1660 * 1) git checkout <tree> -- [<paths>]
1661 * 2) git checkout -- [<paths>]
1662 * 3) git checkout <something> [<paths>]
1664 * including "last branch" syntax and DWIM-ery for names of
1665 * remote branches, erroring out for invalid or ambiguous cases.
1667 if (argc
&& opts
->accept_ref
) {
1668 struct object_id rev
;
1670 !opts
->patch_mode
&&
1671 opts
->dwim_new_local_branch
&&
1672 opts
->track
== BRANCH_TRACK_UNSPECIFIED
&&
1674 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1675 &new_branch_info
, opts
, &rev
);
1678 } else if (!opts
->accept_ref
&& opts
->from_treeish
) {
1679 struct object_id rev
;
1681 if (get_oid_mb(opts
->from_treeish
, &rev
))
1682 die(_("could not resolve %s"), opts
->from_treeish
);
1684 setup_new_branch_info_and_source_tree(&new_branch_info
,
1686 opts
->from_treeish
);
1688 if (!opts
->source_tree
)
1689 die(_("reference is not a tree: %s"), opts
->from_treeish
);
1693 parse_pathspec(&opts
->pathspec
, 0,
1694 opts
->patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1697 if (!opts
->pathspec
.nr
)
1698 die(_("invalid path specification"));
1701 * Try to give more helpful suggestion.
1702 * new_branch && argc > 1 will be caught later.
1704 if (opts
->new_branch
&& argc
== 1 && !new_branch_info
.commit
)
1705 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1706 argv
[0], opts
->new_branch
);
1708 if (opts
->force_detach
)
1709 die(_("git checkout: --detach does not take a path argument '%s'"),
1713 if (opts
->pathspec_from_file
) {
1714 if (opts
->pathspec
.nr
)
1715 die(_("--pathspec-from-file is incompatible with pathspec arguments"));
1717 if (opts
->force_detach
)
1718 die(_("--pathspec-from-file is incompatible with --detach"));
1720 if (opts
->patch_mode
)
1721 die(_("--pathspec-from-file is incompatible with --patch"));
1723 parse_pathspec_file(&opts
->pathspec
, 0,
1725 prefix
, opts
->pathspec_from_file
, opts
->pathspec_file_nul
);
1726 } else if (opts
->pathspec_file_nul
) {
1727 die(_("--pathspec-file-nul requires --pathspec-from-file"));
1730 opts
->pathspec
.recursive
= 1;
1732 if (opts
->pathspec
.nr
) {
1733 if (1 < !!opts
->writeout_stage
+ !!opts
->force
+ !!opts
->merge
)
1734 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1735 "checking out of the index."));
1737 if (opts
->accept_pathspec
&& !opts
->empty_pathspec_ok
&&
1738 !opts
->patch_mode
) /* patch mode is special */
1739 die(_("you must specify path(s) to restore"));
1742 if (opts
->new_branch
) {
1743 struct strbuf buf
= STRBUF_INIT
;
1745 if (opts
->new_branch_force
)
1746 opts
->branch_exists
= validate_branchname(opts
->new_branch
, &buf
);
1748 opts
->branch_exists
=
1749 validate_new_branchname(opts
->new_branch
, &buf
, 0);
1750 strbuf_release(&buf
);
1754 if (opts
->patch_mode
|| opts
->pathspec
.nr
)
1755 return checkout_paths(opts
, &new_branch_info
);
1757 return checkout_branch(opts
, &new_branch_info
);
1760 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1762 struct checkout_opts opts
;
1763 struct option
*options
;
1764 struct option checkout_options
[] = {
1765 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1766 N_("create and checkout a new branch")),
1767 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1768 N_("create/reset and checkout a branch")),
1769 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1770 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1771 N_("second guess 'git checkout <no-such-branch>' (default)")),
1772 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode (default)")),
1777 memset(&opts
, 0, sizeof(opts
));
1778 opts
.dwim_new_local_branch
= 1;
1779 opts
.switch_branch_doing_nothing_is_ok
= 1;
1780 opts
.only_merge_on_switching_branches
= 0;
1781 opts
.accept_ref
= 1;
1782 opts
.accept_pathspec
= 1;
1783 opts
.implicit_detach
= 1;
1784 opts
.can_switch_when_in_progress
= 1;
1785 opts
.orphan_from_empty_tree
= 0;
1786 opts
.empty_pathspec_ok
= 1;
1787 opts
.overlay_mode
= -1;
1788 opts
.checkout_index
= -2; /* default on */
1789 opts
.checkout_worktree
= -2; /* default on */
1791 if (argc
== 3 && !strcmp(argv
[1], "-b")) {
1793 * User ran 'git checkout -b <branch>' and expects
1794 * the same behavior as 'git switch -c <branch>'.
1796 opts
.switch_branch_doing_nothing_is_ok
= 0;
1797 opts
.only_merge_on_switching_branches
= 1;
1800 options
= parse_options_dup(checkout_options
);
1801 options
= add_common_options(&opts
, options
);
1802 options
= add_common_switch_branch_options(&opts
, options
);
1803 options
= add_checkout_path_options(&opts
, options
);
1805 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1806 options
, checkout_usage
);
1807 FREE_AND_NULL(options
);
1811 int cmd_switch(int argc
, const char **argv
, const char *prefix
)
1813 struct checkout_opts opts
;
1814 struct option
*options
= NULL
;
1815 struct option switch_options
[] = {
1816 OPT_STRING('c', "create", &opts
.new_branch
, N_("branch"),
1817 N_("create and switch to a new branch")),
1818 OPT_STRING('C', "force-create", &opts
.new_branch_force
, N_("branch"),
1819 N_("create/reset and switch to a branch")),
1820 OPT_BOOL(0, "guess", &opts
.dwim_new_local_branch
,
1821 N_("second guess 'git switch <no-such-branch>'")),
1822 OPT_BOOL(0, "discard-changes", &opts
.discard_changes
,
1823 N_("throw away local modifications")),
1828 memset(&opts
, 0, sizeof(opts
));
1829 opts
.dwim_new_local_branch
= 1;
1830 opts
.accept_ref
= 1;
1831 opts
.accept_pathspec
= 0;
1832 opts
.switch_branch_doing_nothing_is_ok
= 0;
1833 opts
.only_merge_on_switching_branches
= 1;
1834 opts
.implicit_detach
= 0;
1835 opts
.can_switch_when_in_progress
= 0;
1836 opts
.orphan_from_empty_tree
= 1;
1837 opts
.overlay_mode
= -1;
1839 options
= parse_options_dup(switch_options
);
1840 options
= add_common_options(&opts
, options
);
1841 options
= add_common_switch_branch_options(&opts
, options
);
1845 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1846 options
, switch_branch_usage
);
1847 FREE_AND_NULL(options
);
1851 int cmd_restore(int argc
, const char **argv
, const char *prefix
)
1853 struct checkout_opts opts
;
1854 struct option
*options
;
1855 struct option restore_options
[] = {
1856 OPT_STRING('s', "source", &opts
.from_treeish
, "<tree-ish>",
1857 N_("which tree-ish to checkout from")),
1858 OPT_BOOL('S', "staged", &opts
.checkout_index
,
1859 N_("restore the index")),
1860 OPT_BOOL('W', "worktree", &opts
.checkout_worktree
,
1861 N_("restore the working tree (default)")),
1862 OPT_BOOL(0, "ignore-unmerged", &opts
.ignore_unmerged
,
1863 N_("ignore unmerged entries")),
1864 OPT_BOOL(0, "overlay", &opts
.overlay_mode
, N_("use overlay mode")),
1869 memset(&opts
, 0, sizeof(opts
));
1870 opts
.accept_ref
= 0;
1871 opts
.accept_pathspec
= 1;
1872 opts
.empty_pathspec_ok
= 0;
1873 opts
.overlay_mode
= 0;
1874 opts
.checkout_index
= -1; /* default off */
1875 opts
.checkout_worktree
= -2; /* default on */
1876 opts
.ignore_unmerged_opt
= "--ignore-unmerged";
1878 options
= parse_options_dup(restore_options
);
1879 options
= add_common_options(&opts
, options
);
1880 options
= add_checkout_path_options(&opts
, options
);
1882 ret
= checkout_main(argc
, argv
, prefix
, &opts
,
1883 options
, restore_usage
);
1884 FREE_AND_NULL(options
);