1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
6 #include "parse-options.h"
8 #include "object-store.h"
11 #include "tree-walk.h"
12 #include "cache-tree.h"
13 #include "unpack-trees.h"
15 #include "run-command.h"
16 #include "merge-recursive.h"
22 #include "xdiff-interface.h"
24 #include "resolve-undo.h"
25 #include "submodule-config.h"
26 #include "submodule.h"
29 static int checkout_optimize_new_branch
;
31 static const char * const checkout_usage
[] = {
32 N_("git checkout [<options>] <branch>"),
33 N_("git checkout [<options>] [<branch>] -- <file>..."),
37 struct checkout_opts
{
45 int ignore_skipworktree
;
46 int ignore_other_worktrees
;
48 int count_checkout_paths
;
50 * If new checkout options are added, skip_merge_working_tree
51 * should be updated accordingly.
54 const char *new_branch
;
55 const char *new_branch_force
;
56 const char *new_orphan_branch
;
58 enum branch_track track
;
59 struct diff_options diff_options
;
63 struct pathspec pathspec
;
64 struct tree
*source_tree
;
67 static int post_checkout_hook(struct commit
*old_commit
, struct commit
*new_commit
,
70 return run_hook_le(NULL
, "post-checkout",
71 oid_to_hex(old_commit
? &old_commit
->object
.oid
: &null_oid
),
72 oid_to_hex(new_commit
? &new_commit
->object
.oid
: &null_oid
),
73 changed
? "1" : "0", NULL
);
74 /* "new_commit" can be NULL when checking out from the index before
79 static int update_some(const struct object_id
*oid
, struct strbuf
*base
,
80 const char *pathname
, unsigned mode
, int stage
, void *context
)
83 struct cache_entry
*ce
;
87 return READ_TREE_RECURSIVE
;
89 len
= base
->len
+ strlen(pathname
);
90 ce
= make_empty_cache_entry(&the_index
, len
);
91 oidcpy(&ce
->oid
, oid
);
92 memcpy(ce
->name
, base
->buf
, base
->len
);
93 memcpy(ce
->name
+ base
->len
, pathname
, len
- base
->len
);
94 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
96 ce
->ce_mode
= create_ce_mode(mode
);
99 * If the entry is the same as the current index, we can leave the old
100 * entry in place. Whether it is UPTODATE or not, checkout_entry will
101 * do the right thing.
103 pos
= cache_name_pos(ce
->name
, ce
->ce_namelen
);
105 struct cache_entry
*old
= active_cache
[pos
];
106 if (ce
->ce_mode
== old
->ce_mode
&&
107 oideq(&ce
->oid
, &old
->oid
)) {
108 old
->ce_flags
|= CE_UPDATE
;
109 discard_cache_entry(ce
);
114 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
118 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
120 read_tree_recursive(the_repository
, tree
, "", 0, 0,
121 pathspec
, update_some
, NULL
);
123 /* update the index with the given tree's info
124 * for all args, expanding wildcards, and exit
125 * with any non-zero return code.
130 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
132 while (++pos
< active_nr
&&
133 !strcmp(active_cache
[pos
]->name
, ce
->name
))
138 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
)
140 while (pos
< active_nr
&&
141 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
142 if (ce_stage(active_cache
[pos
]) == stage
)
147 return error(_("path '%s' does not have our version"), ce
->name
);
149 return error(_("path '%s' does not have their version"), ce
->name
);
152 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
155 const char *name
= ce
->name
;
157 while (pos
< active_nr
) {
158 ce
= active_cache
[pos
];
159 if (strcmp(name
, ce
->name
))
161 seen
|= (1 << ce_stage(ce
));
164 if ((stages
& seen
) != stages
)
165 return error(_("path '%s' does not have all necessary versions"),
170 static int checkout_stage(int stage
, const struct cache_entry
*ce
, int pos
,
171 const struct checkout
*state
, int *nr_checkouts
)
173 while (pos
< active_nr
&&
174 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
175 if (ce_stage(active_cache
[pos
]) == stage
)
176 return checkout_entry(active_cache
[pos
], state
,
181 return error(_("path '%s' does not have our version"), ce
->name
);
183 return error(_("path '%s' does not have their version"), ce
->name
);
186 static int checkout_merged(int pos
, const struct checkout
*state
, int *nr_checkouts
)
188 struct cache_entry
*ce
= active_cache
[pos
];
189 const char *path
= ce
->name
;
190 mmfile_t ancestor
, ours
, theirs
;
192 struct object_id oid
;
193 mmbuffer_t result_buf
;
194 struct object_id threeway
[3];
197 memset(threeway
, 0, sizeof(threeway
));
198 while (pos
< active_nr
) {
200 stage
= ce_stage(ce
);
201 if (!stage
|| strcmp(path
, ce
->name
))
203 oidcpy(&threeway
[stage
- 1], &ce
->oid
);
205 mode
= create_ce_mode(ce
->ce_mode
);
207 ce
= active_cache
[pos
];
209 if (is_null_oid(&threeway
[1]) || is_null_oid(&threeway
[2]))
210 return error(_("path '%s' does not have necessary versions"), path
);
212 read_mmblob(&ancestor
, &threeway
[0]);
213 read_mmblob(&ours
, &threeway
[1]);
214 read_mmblob(&theirs
, &threeway
[2]);
217 * NEEDSWORK: re-create conflicts from merges with
218 * merge.renormalize set, too
220 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
221 &ours
, "ours", &theirs
, "theirs",
222 state
->istate
, NULL
);
226 if (status
< 0 || !result_buf
.ptr
) {
227 free(result_buf
.ptr
);
228 return error(_("path '%s': cannot merge"), path
);
233 * There is absolutely no reason to write this as a blob object
234 * and create a phony cache entry. This hack is primarily to get
235 * to the write_entry() machinery that massages the contents to
236 * work-tree format and writes out which only allows it for a
237 * cache entry. The code in write_entry() needs to be refactored
238 * to allow us to feed a <buffer, size, mode> instead of a cache
239 * entry. Such a refactoring would help merge_recursive as well
240 * (it also writes the merge result to the object database even
241 * when it may contain conflicts).
243 if (write_object_file(result_buf
.ptr
, result_buf
.size
, blob_type
, &oid
))
244 die(_("Unable to add merge result for '%s'"), path
);
245 free(result_buf
.ptr
);
246 ce
= make_transient_cache_entry(mode
, &oid
, path
, 2);
248 die(_("make_cache_entry failed for path '%s'"), path
);
249 status
= checkout_entry(ce
, state
, NULL
, nr_checkouts
);
250 discard_cache_entry(ce
);
254 static int checkout_paths(const struct checkout_opts
*opts
,
255 const char *revision
)
258 struct checkout state
= CHECKOUT_INIT
;
259 static char *ps_matched
;
260 struct object_id rev
;
263 struct lock_file lock_file
= LOCK_INIT
;
264 int nr_checkouts
= 0;
266 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
267 die(_("'%s' cannot be used with updating paths"), "--track");
269 if (opts
->new_branch_log
)
270 die(_("'%s' cannot be used with updating paths"), "-l");
272 if (opts
->force
&& opts
->patch_mode
)
273 die(_("'%s' cannot be used with updating paths"), "-f");
275 if (opts
->force_detach
)
276 die(_("'%s' cannot be used with updating paths"), "--detach");
278 if (opts
->merge
&& opts
->patch_mode
)
279 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
281 if (opts
->force
&& opts
->merge
)
282 die(_("'%s' cannot be used with %s"), "-f", "-m");
284 if (opts
->new_branch
)
285 die(_("Cannot update paths and switch to branch '%s' at the same time."),
288 if (opts
->patch_mode
)
289 return run_add_interactive(revision
, "--patch=checkout",
292 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
293 if (read_cache_preload(&opts
->pathspec
) < 0)
294 return error(_("index file corrupt"));
296 if (opts
->source_tree
)
297 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
299 ps_matched
= xcalloc(opts
->pathspec
.nr
, 1);
302 * Make sure all pathspecs participated in locating the paths
305 for (pos
= 0; pos
< active_nr
; pos
++) {
306 struct cache_entry
*ce
= active_cache
[pos
];
307 ce
->ce_flags
&= ~CE_MATCHED
;
308 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
310 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
312 * "git checkout tree-ish -- path", but this entry
313 * is in the original index; it will not be checked
314 * out to the working tree and it does not matter
315 * if pathspec matched this entry. We will not do
316 * anything to this entry at all.
320 * Either this entry came from the tree-ish we are
321 * checking the paths out of, or we are checking out
324 * If it comes from the tree-ish, we already know it
325 * matches the pathspec and could just stamp
326 * CE_MATCHED to it from update_some(). But we still
327 * need ps_matched and read_tree_recursive (and
328 * eventually tree_entry_interesting) cannot fill
329 * ps_matched yet. Once it can, we can avoid calling
330 * match_pathspec() for _all_ entries when
331 * opts->source_tree != NULL.
333 if (ce_path_match(&the_index
, ce
, &opts
->pathspec
, ps_matched
))
334 ce
->ce_flags
|= CE_MATCHED
;
337 if (report_path_error(ps_matched
, &opts
->pathspec
, opts
->prefix
)) {
343 /* "checkout -m path" to recreate conflicted state */
345 unmerge_marked_index(&the_index
);
347 /* Any unmerged paths? */
348 for (pos
= 0; pos
< active_nr
; pos
++) {
349 const struct cache_entry
*ce
= active_cache
[pos
];
350 if (ce
->ce_flags
& CE_MATCHED
) {
354 warning(_("path '%s' is unmerged"), ce
->name
);
355 } else if (opts
->writeout_stage
) {
356 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
);
357 } else if (opts
->merge
) {
358 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
361 error(_("path '%s' is unmerged"), ce
->name
);
363 pos
= skip_same_name(ce
, pos
) - 1;
369 /* Now we are committed to check them out */
371 state
.refresh_cache
= 1;
372 state
.istate
= &the_index
;
374 enable_delayed_checkout(&state
);
375 for (pos
= 0; pos
< active_nr
; pos
++) {
376 struct cache_entry
*ce
= active_cache
[pos
];
377 if (ce
->ce_flags
& CE_MATCHED
) {
379 errs
|= checkout_entry(ce
, &state
,
380 NULL
, &nr_checkouts
);
383 if (opts
->writeout_stage
)
384 errs
|= checkout_stage(opts
->writeout_stage
,
386 &state
, &nr_checkouts
);
387 else if (opts
->merge
)
388 errs
|= checkout_merged(pos
, &state
,
390 pos
= skip_same_name(ce
, pos
) - 1;
393 errs
|= finish_delayed_checkout(&state
, &nr_checkouts
);
395 if (opts
->count_checkout_paths
) {
396 if (opts
->source_tree
)
397 fprintf_ln(stderr
, Q_("Checked out %d path out of %s",
398 "Checked out %d paths out of %s",
401 find_unique_abbrev(&opts
->source_tree
->object
.oid
,
404 fprintf_ln(stderr
, Q_("Checked out %d path out of the index",
405 "Checked out %d paths out of the index",
410 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
411 die(_("unable to write new index file"));
413 read_ref_full("HEAD", 0, &rev
, NULL
);
414 head
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
416 errs
|= post_checkout_hook(head
, head
, 0);
420 static void show_local_changes(struct object
*head
,
421 const struct diff_options
*opts
)
424 /* I think we want full paths, even if we're in a subdirectory. */
425 repo_init_revisions(the_repository
, &rev
, NULL
);
426 rev
.diffopt
.flags
= opts
->flags
;
427 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
428 diff_setup_done(&rev
.diffopt
);
429 add_pending_object(&rev
, head
, NULL
);
430 run_diff_index(&rev
, 0);
433 static void describe_detached_head(const char *msg
, struct commit
*commit
)
435 struct strbuf sb
= STRBUF_INIT
;
437 if (!parse_commit(commit
))
438 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
439 if (print_sha1_ellipsis()) {
440 fprintf(stderr
, "%s %s... %s\n", msg
,
441 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
443 fprintf(stderr
, "%s %s %s\n", msg
,
444 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
449 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
450 int worktree
, int *writeout_error
)
452 struct unpack_trees_options opts
;
453 struct tree_desc tree_desc
;
455 memset(&opts
, 0, sizeof(opts
));
457 opts
.update
= worktree
;
458 opts
.skip_unmerged
= !worktree
;
461 opts
.fn
= oneway_merge
;
462 opts
.verbose_update
= o
->show_progress
;
463 opts
.src_index
= &the_index
;
464 opts
.dst_index
= &the_index
;
466 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
467 switch (unpack_trees(1, &tree_desc
, &opts
)) {
471 * We return 0 nevertheless, as the index is all right
472 * and more importantly we have made best efforts to
473 * update paths in the work tree, and we cannot revert
485 const char *name
; /* The short name used */
486 const char *path
; /* The full name of a real branch */
487 struct commit
*commit
; /* The named commit */
489 * if not null the branch is detached because it's already
490 * checked out in this checkout
495 static void setup_branch_path(struct branch_info
*branch
)
497 struct strbuf buf
= STRBUF_INIT
;
499 strbuf_branchname(&buf
, branch
->name
, INTERPRET_BRANCH_LOCAL
);
500 if (strcmp(buf
.buf
, branch
->name
))
501 branch
->name
= xstrdup(buf
.buf
);
502 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
503 branch
->path
= strbuf_detach(&buf
, NULL
);
507 * Skip merging the trees, updating the index and working directory if and
508 * only if we are creating a new branch via "git checkout -b <new_branch>."
510 static int skip_merge_working_tree(const struct checkout_opts
*opts
,
511 const struct branch_info
*old_branch_info
,
512 const struct branch_info
*new_branch_info
)
515 * Do the merge if sparse checkout is on and the user has not opted in
516 * to the optimized behavior
518 if (core_apply_sparse_checkout
&& !checkout_optimize_new_branch
)
522 * We must do the merge if we are actually moving to a new commit.
524 if (!old_branch_info
->commit
|| !new_branch_info
->commit
||
525 !oideq(&old_branch_info
->commit
->object
.oid
,
526 &new_branch_info
->commit
->object
.oid
))
530 * opts->patch_mode cannot be used with switching branches so is
535 * opts->quiet only impacts output so doesn't require a merge
539 * Honor the explicit request for a three-way merge or to throw away
542 if (opts
->merge
|| opts
->force
)
546 * --detach is documented as "updating the index and the files in the
547 * working tree" but this optimization skips those steps so fall through
548 * to the regular code path.
550 if (opts
->force_detach
)
554 * opts->writeout_stage cannot be used with switching branches so is
559 * Honor the explicit ignore requests
561 if (!opts
->overwrite_ignore
|| opts
->ignore_skipworktree
||
562 opts
->ignore_other_worktrees
)
566 * opts->show_progress only impacts output so doesn't require a merge
570 * If we aren't creating a new branch any changes or updates will
571 * happen in the existing branch. Since that could only be updating
572 * the index and working directory, we don't want to skip those steps
573 * or we've defeated any purpose in running the command.
575 if (!opts
->new_branch
)
579 * new_branch_force is defined to "create/reset and checkout a branch"
580 * so needs to go through the merge to do the reset
582 if (opts
->new_branch_force
)
586 * A new orphaned branch requrires the index and the working tree to be
587 * adjusted to <start_point>
589 if (opts
->new_orphan_branch
)
593 * Remaining variables are not checkout options but used to track state
597 * Do the merge if this is the initial checkout. We cannot use
598 * is_cache_unborn() here because the index hasn't been loaded yet
599 * so cache_nr and timestamp.sec are always zero.
601 if (!file_exists(get_index_file()))
607 static int merge_working_tree(const struct checkout_opts
*opts
,
608 struct branch_info
*old_branch_info
,
609 struct branch_info
*new_branch_info
,
613 struct lock_file lock_file
= LOCK_INIT
;
615 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
616 if (read_cache_preload(NULL
) < 0)
617 return error(_("index file corrupt"));
619 resolve_undo_clear();
621 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
622 opts
, 1, writeout_error
);
626 struct tree_desc trees
[2];
628 struct unpack_trees_options topts
;
630 memset(&topts
, 0, sizeof(topts
));
632 topts
.src_index
= &the_index
;
633 topts
.dst_index
= &the_index
;
635 setup_unpack_trees_porcelain(&topts
, "checkout");
637 refresh_cache(REFRESH_QUIET
);
639 if (unmerged_cache()) {
640 error(_("you need to resolve your current index first"));
644 /* 2-way merge to the new branch */
645 topts
.initial_checkout
= is_cache_unborn();
648 topts
.gently
= opts
->merge
&& old_branch_info
->commit
;
649 topts
.verbose_update
= opts
->show_progress
;
650 topts
.fn
= twoway_merge
;
651 if (opts
->overwrite_ignore
) {
652 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
653 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
654 setup_standard_excludes(topts
.dir
);
656 tree
= parse_tree_indirect(old_branch_info
->commit
?
657 &old_branch_info
->commit
->object
.oid
:
658 the_hash_algo
->empty_tree
);
659 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
660 tree
= parse_tree_indirect(&new_branch_info
->commit
->object
.oid
);
661 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
663 ret
= unpack_trees(2, trees
, &topts
);
664 clear_unpack_trees_porcelain(&topts
);
667 * Unpack couldn't do a trivial merge; either
668 * give up or do a real merge, depending on
669 * whether the merge flag was used.
673 struct merge_options o
;
678 * Without old_branch_info->commit, the below is the same as
679 * the two-tree unpack we already tried and failed.
681 if (!old_branch_info
->commit
)
684 /* Do more real merge */
687 * We update the index fully, then write the
688 * tree from the index, then merge the new
689 * branch with the current tree, with the old
690 * branch as the base. Then we reset the index
691 * (but not the working tree) to the new
692 * branch, leaving the working tree as the
693 * merged version, but skipping unmerged
694 * entries in the index.
697 add_files_to_cache(NULL
, NULL
, 0);
699 * NEEDSWORK: carrying over local changes
700 * when branches have different end-of-line
701 * normalization (or clean+smudge rules) is
702 * a pain; plumb in an option to set
705 init_merge_options(&o
, the_repository
);
707 work
= write_tree_from_memory(&o
);
709 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
714 o
.ancestor
= old_branch_info
->name
;
715 o
.branch1
= new_branch_info
->name
;
717 ret
= merge_trees(&o
,
718 get_commit_tree(new_branch_info
->commit
),
720 get_commit_tree(old_branch_info
->commit
),
724 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
727 strbuf_release(&o
.obuf
);
733 if (!active_cache_tree
)
734 active_cache_tree
= cache_tree();
736 if (!cache_tree_fully_valid(active_cache_tree
))
737 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
739 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
740 die(_("unable to write new index file"));
742 if (!opts
->force
&& !opts
->quiet
)
743 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
748 static void report_tracking(struct branch_info
*new_branch_info
)
750 struct strbuf sb
= STRBUF_INIT
;
751 struct branch
*branch
= branch_get(new_branch_info
->name
);
753 if (!format_tracking_info(branch
, &sb
, AHEAD_BEHIND_FULL
))
755 fputs(sb
.buf
, stdout
);
759 static void update_refs_for_switch(const struct checkout_opts
*opts
,
760 struct branch_info
*old_branch_info
,
761 struct branch_info
*new_branch_info
)
763 struct strbuf msg
= STRBUF_INIT
;
764 const char *old_desc
, *reflog_msg
;
765 if (opts
->new_branch
) {
766 if (opts
->new_orphan_branch
) {
769 refname
= mkpathdup("refs/heads/%s", opts
->new_orphan_branch
);
770 if (opts
->new_branch_log
&&
771 !should_autocreate_reflog(refname
)) {
773 struct strbuf err
= STRBUF_INIT
;
775 ret
= safe_create_reflog(refname
, 1, &err
);
777 fprintf(stderr
, _("Can not do reflog for '%s': %s\n"),
778 opts
->new_orphan_branch
, err
.buf
);
779 strbuf_release(&err
);
783 strbuf_release(&err
);
788 create_branch(the_repository
,
789 opts
->new_branch
, new_branch_info
->name
,
790 opts
->new_branch_force
? 1 : 0,
791 opts
->new_branch_force
? 1 : 0,
792 opts
->new_branch_log
,
795 new_branch_info
->name
= opts
->new_branch
;
796 setup_branch_path(new_branch_info
);
799 old_desc
= old_branch_info
->name
;
800 if (!old_desc
&& old_branch_info
->commit
)
801 old_desc
= oid_to_hex(&old_branch_info
->commit
->object
.oid
);
803 reflog_msg
= getenv("GIT_REFLOG_ACTION");
805 strbuf_addf(&msg
, "checkout: moving from %s to %s",
806 old_desc
? old_desc
: "(invalid)", new_branch_info
->name
);
808 strbuf_insert(&msg
, 0, reflog_msg
, strlen(reflog_msg
));
810 if (!strcmp(new_branch_info
->name
, "HEAD") && !new_branch_info
->path
&& !opts
->force_detach
) {
812 } else if (opts
->force_detach
|| !new_branch_info
->path
) { /* No longer on any branch. */
813 update_ref(msg
.buf
, "HEAD", &new_branch_info
->commit
->object
.oid
, NULL
,
814 REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
816 if (old_branch_info
->path
&&
817 advice_detached_head
&& !opts
->force_detach
)
818 detach_advice(new_branch_info
->name
);
819 describe_detached_head(_("HEAD is now at"), new_branch_info
->commit
);
821 } else if (new_branch_info
->path
) { /* Switch branches. */
822 if (create_symref("HEAD", new_branch_info
->path
, msg
.buf
) < 0)
823 die(_("unable to update HEAD"));
825 if (old_branch_info
->path
&& !strcmp(new_branch_info
->path
, old_branch_info
->path
)) {
826 if (opts
->new_branch_force
)
827 fprintf(stderr
, _("Reset branch '%s'\n"),
828 new_branch_info
->name
);
830 fprintf(stderr
, _("Already on '%s'\n"),
831 new_branch_info
->name
);
832 } else if (opts
->new_branch
) {
833 if (opts
->branch_exists
)
834 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new_branch_info
->name
);
836 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new_branch_info
->name
);
838 fprintf(stderr
, _("Switched to branch '%s'\n"),
839 new_branch_info
->name
);
842 if (old_branch_info
->path
&& old_branch_info
->name
) {
843 if (!ref_exists(old_branch_info
->path
) && reflog_exists(old_branch_info
->path
))
844 delete_reflog(old_branch_info
->path
);
847 remove_branch_state(the_repository
);
848 strbuf_release(&msg
);
850 (new_branch_info
->path
|| (!opts
->force_detach
&& !strcmp(new_branch_info
->name
, "HEAD"))))
851 report_tracking(new_branch_info
);
854 static int add_pending_uninteresting_ref(const char *refname
,
855 const struct object_id
*oid
,
856 int flags
, void *cb_data
)
858 add_pending_oid(cb_data
, refname
, oid
, UNINTERESTING
);
862 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
864 strbuf_addstr(sb
, " ");
865 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
, DEFAULT_ABBREV
);
866 strbuf_addch(sb
, ' ');
867 if (!parse_commit(commit
))
868 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
869 strbuf_addch(sb
, '\n');
872 #define ORPHAN_CUTOFF 4
873 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
875 struct commit
*c
, *last
= NULL
;
876 struct strbuf sb
= STRBUF_INIT
;
878 while ((c
= get_revision(revs
)) != NULL
) {
879 if (lost
< ORPHAN_CUTOFF
)
880 describe_one_orphan(&sb
, c
);
884 if (ORPHAN_CUTOFF
< lost
) {
885 int more
= lost
- ORPHAN_CUTOFF
;
887 describe_one_orphan(&sb
, last
);
889 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
894 /* The singular version */
895 "Warning: you are leaving %d commit behind, "
897 "any of your branches:\n\n"
899 /* The plural version */
900 "Warning: you are leaving %d commits behind, "
902 "any of your branches:\n\n"
904 /* Give ngettext() the count */
910 if (advice_detached_head
)
913 /* The singular version */
914 "If you want to keep it by creating a new branch, "
915 "this may be a good time\nto do so with:\n\n"
916 " git branch <new-branch-name> %s\n\n",
917 /* The plural version */
918 "If you want to keep them by creating a new branch, "
919 "this may be a good time\nto do so with:\n\n"
920 " git branch <new-branch-name> %s\n\n",
921 /* Give ngettext() the count */
923 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
927 * We are about to leave commit that was at the tip of a detached
928 * HEAD. If it is not reachable from any ref, this is the last chance
929 * for the user to do so without resorting to reflog.
931 static void orphaned_commit_warning(struct commit
*old_commit
, struct commit
*new_commit
)
933 struct rev_info revs
;
934 struct object
*object
= &old_commit
->object
;
936 repo_init_revisions(the_repository
, &revs
, NULL
);
937 setup_revisions(0, NULL
, &revs
, NULL
);
939 object
->flags
&= ~UNINTERESTING
;
940 add_pending_object(&revs
, object
, oid_to_hex(&object
->oid
));
942 for_each_ref(add_pending_uninteresting_ref
, &revs
);
943 add_pending_oid(&revs
, "HEAD", &new_commit
->object
.oid
, UNINTERESTING
);
945 if (prepare_revision_walk(&revs
))
946 die(_("internal error in revision walk"));
947 if (!(old_commit
->object
.flags
& UNINTERESTING
))
948 suggest_reattach(old_commit
, &revs
);
950 describe_detached_head(_("Previous HEAD position was"), old_commit
);
952 /* Clean up objects used, as they will be reused. */
953 clear_commit_marks_all(ALL_REV_FLAGS
);
956 static int switch_branches(const struct checkout_opts
*opts
,
957 struct branch_info
*new_branch_info
)
960 struct branch_info old_branch_info
;
962 struct object_id rev
;
963 int flag
, writeout_error
= 0;
964 memset(&old_branch_info
, 0, sizeof(old_branch_info
));
965 old_branch_info
.path
= path_to_free
= resolve_refdup("HEAD", 0, &rev
, &flag
);
966 if (old_branch_info
.path
)
967 old_branch_info
.commit
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
968 if (!(flag
& REF_ISSYMREF
))
969 old_branch_info
.path
= NULL
;
971 if (old_branch_info
.path
)
972 skip_prefix(old_branch_info
.path
, "refs/heads/", &old_branch_info
.name
);
974 if (!new_branch_info
->name
) {
975 new_branch_info
->name
= "HEAD";
976 new_branch_info
->commit
= old_branch_info
.commit
;
977 if (!new_branch_info
->commit
)
978 die(_("You are on a branch yet to be born"));
979 parse_commit_or_die(new_branch_info
->commit
);
982 /* optimize the "checkout -b <new_branch> path */
983 if (skip_merge_working_tree(opts
, &old_branch_info
, new_branch_info
)) {
984 if (!checkout_optimize_new_branch
&& !opts
->quiet
) {
985 if (read_cache_preload(NULL
) < 0)
986 return error(_("index file corrupt"));
987 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
990 ret
= merge_working_tree(opts
, &old_branch_info
, new_branch_info
, &writeout_error
);
997 if (!opts
->quiet
&& !old_branch_info
.path
&& old_branch_info
.commit
&& new_branch_info
->commit
!= old_branch_info
.commit
)
998 orphaned_commit_warning(old_branch_info
.commit
, new_branch_info
->commit
);
1000 update_refs_for_switch(opts
, &old_branch_info
, new_branch_info
);
1002 ret
= post_checkout_hook(old_branch_info
.commit
, new_branch_info
->commit
, 1);
1004 return ret
|| writeout_error
;
1007 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
1009 if (!strcmp(var
, "checkout.optimizenewbranch")) {
1010 checkout_optimize_new_branch
= git_config_bool(var
, value
);
1014 if (!strcmp(var
, "diff.ignoresubmodules")) {
1015 struct checkout_opts
*opts
= cb
;
1016 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
1020 if (starts_with(var
, "submodule."))
1021 return git_default_submodule_config(var
, value
, NULL
);
1023 return git_xmerge_config(var
, value
, NULL
);
1026 static int parse_branchname_arg(int argc
, const char **argv
,
1027 int dwim_new_local_branch_ok
,
1028 struct branch_info
*new_branch_info
,
1029 struct checkout_opts
*opts
,
1030 struct object_id
*rev
,
1031 int *dwim_remotes_matched
)
1033 struct tree
**source_tree
= &opts
->source_tree
;
1034 const char **new_branch
= &opts
->new_branch
;
1036 struct object_id branch_rev
;
1039 int has_dash_dash
= 0;
1043 * case 1: git checkout <ref> -- [<paths>]
1045 * <ref> must be a valid tree, everything after the '--' must be
1048 * case 2: git checkout -- [<paths>]
1050 * everything after the '--' must be paths.
1052 * case 3: git checkout <something> [--]
1054 * (a) If <something> is a commit, that is to
1055 * switch to the branch or detach HEAD at it. As a special case,
1056 * if <something> is A...B (missing A or B means HEAD but you can
1057 * omit at most one side), and if there is a unique merge base
1058 * between A and B, A...B names that merge base.
1060 * (b) If <something> is _not_ a commit, either "--" is present
1061 * or <something> is not a path, no -t or -b was given, and
1062 * and there is a tracking branch whose name is <something>
1063 * in one and only one remote (or if the branch exists on the
1064 * remote named in checkout.defaultRemote), then this is a
1065 * short-hand to fork local <something> from that
1066 * remote-tracking branch.
1068 * (c) Otherwise, if "--" is present, treat it like case (1).
1071 * - if it's a reference, treat it like case (1)
1072 * - else if it's a path, treat it like case (2)
1075 * case 4: git checkout <something> <paths>
1077 * The first argument must not be ambiguous.
1078 * - If it's *only* a reference, treat it like case (1).
1079 * - If it's only a path, treat it like case (2).
1088 for (i
= 0; i
< argc
; i
++) {
1089 if (!strcmp(argv
[i
], "--")) {
1094 if (dash_dash_pos
== 0)
1095 return 1; /* case (2) */
1096 else if (dash_dash_pos
== 1)
1097 has_dash_dash
= 1; /* case (3) or (1) */
1098 else if (dash_dash_pos
>= 2)
1099 die(_("only one reference expected, %d given."), dash_dash_pos
);
1100 opts
->count_checkout_paths
= !opts
->quiet
&& !has_dash_dash
;
1102 if (!strcmp(arg
, "-"))
1105 if (get_oid_mb(arg
, rev
)) {
1107 * Either case (3) or (4), with <something> not being
1108 * a commit, or an attempt to use case (1) with an
1111 * It's likely an error, but we need to find out if
1112 * we should auto-create the branch, case (3).(b).
1114 int recover_with_dwim
= dwim_new_local_branch_ok
;
1116 int could_be_checkout_paths
= !has_dash_dash
&&
1117 check_filename(opts
->prefix
, arg
);
1119 if (!has_dash_dash
&& !no_wildcard(arg
))
1120 recover_with_dwim
= 0;
1123 * Accept "git checkout foo" and "git checkout foo --"
1124 * as candidates for dwim.
1126 if (!(argc
== 1 && !has_dash_dash
) &&
1127 !(argc
== 2 && has_dash_dash
))
1128 recover_with_dwim
= 0;
1130 if (recover_with_dwim
) {
1131 const char *remote
= unique_tracking_name(arg
, rev
,
1132 dwim_remotes_matched
);
1134 if (could_be_checkout_paths
)
1135 die(_("'%s' could be both a local file and a tracking branch.\n"
1136 "Please use -- (and optionally --no-guess) to disambiguate"),
1140 /* DWIMmed to create local branch, case (3).(b) */
1142 recover_with_dwim
= 0;
1146 if (!recover_with_dwim
) {
1148 die(_("invalid reference: %s"), arg
);
1153 /* we can't end up being in (2) anymore, eat the argument */
1158 new_branch_info
->name
= arg
;
1159 setup_branch_path(new_branch_info
);
1161 if (!check_refname_format(new_branch_info
->path
, 0) &&
1162 !read_ref(new_branch_info
->path
, &branch_rev
))
1163 oidcpy(rev
, &branch_rev
);
1165 new_branch_info
->path
= NULL
; /* not an existing branch */
1167 new_branch_info
->commit
= lookup_commit_reference_gently(the_repository
, rev
, 1);
1168 if (!new_branch_info
->commit
) {
1170 *source_tree
= parse_tree_indirect(rev
);
1172 parse_commit_or_die(new_branch_info
->commit
);
1173 *source_tree
= get_commit_tree(new_branch_info
->commit
);
1176 if (!*source_tree
) /* case (1): want a tree */
1177 die(_("reference is not a tree: %s"), arg
);
1178 if (!has_dash_dash
) { /* case (3).(d) -> (1) */
1180 * Do not complain the most common case
1181 * git checkout branch
1182 * even if there happen to be a file called 'branch';
1183 * it would be extremely annoying.
1186 verify_non_filename(opts
->prefix
, arg
);
1196 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1199 struct strbuf branch_ref
= STRBUF_INIT
;
1201 if (!opts
->new_branch
)
1202 die(_("You are on a branch yet to be born"));
1203 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1204 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1205 strbuf_release(&branch_ref
);
1207 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1212 static int checkout_branch(struct checkout_opts
*opts
,
1213 struct branch_info
*new_branch_info
)
1215 if (opts
->pathspec
.nr
)
1216 die(_("paths cannot be used with switching branches"));
1218 if (opts
->patch_mode
)
1219 die(_("'%s' cannot be used with switching branches"),
1222 if (opts
->writeout_stage
)
1223 die(_("'%s' cannot be used with switching branches"),
1226 if (opts
->force
&& opts
->merge
)
1227 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1229 if (opts
->force_detach
&& opts
->new_branch
)
1230 die(_("'%s' cannot be used with '%s'"),
1231 "--detach", "-b/-B/--orphan");
1233 if (opts
->new_orphan_branch
) {
1234 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1235 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1236 } else if (opts
->force_detach
) {
1237 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1238 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1239 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1240 opts
->track
= git_branch_track
;
1242 if (new_branch_info
->name
&& !new_branch_info
->commit
)
1243 die(_("Cannot switch branch to a non-commit '%s'"),
1244 new_branch_info
->name
);
1246 if (new_branch_info
->path
&& !opts
->force_detach
&& !opts
->new_branch
&&
1247 !opts
->ignore_other_worktrees
) {
1249 char *head_ref
= resolve_refdup("HEAD", 0, NULL
, &flag
);
1251 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new_branch_info
->path
)))
1252 die_if_checked_out(new_branch_info
->path
, 1);
1256 if (!new_branch_info
->commit
&& opts
->new_branch
) {
1257 struct object_id rev
;
1260 if (!read_ref_full("HEAD", 0, &rev
, &flag
) &&
1261 (flag
& REF_ISSYMREF
) && is_null_oid(&rev
))
1262 return switch_unborn_to_new_branch(opts
);
1264 return switch_branches(opts
, new_branch_info
);
1267 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1269 struct checkout_opts opts
;
1270 struct branch_info new_branch_info
;
1271 char *conflict_style
= NULL
;
1272 int dwim_new_local_branch
, no_dwim_new_local_branch
= 0;
1273 int dwim_remotes_matched
= 0;
1274 struct option options
[] = {
1275 OPT__QUIET(&opts
.quiet
, N_("suppress progress reporting")),
1276 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1277 N_("create and checkout a new branch")),
1278 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1279 N_("create/reset and checkout a branch")),
1280 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1281 OPT_BOOL(0, "detach", &opts
.force_detach
, N_("detach HEAD at named commit")),
1282 OPT_SET_INT('t', "track", &opts
.track
, N_("set upstream info for new branch"),
1283 BRANCH_TRACK_EXPLICIT
),
1284 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1285 OPT_SET_INT_F('2', "ours", &opts
.writeout_stage
,
1286 N_("checkout our version for unmerged files"),
1287 2, PARSE_OPT_NONEG
),
1288 OPT_SET_INT_F('3', "theirs", &opts
.writeout_stage
,
1289 N_("checkout their version for unmerged files"),
1290 3, PARSE_OPT_NONEG
),
1291 OPT__FORCE(&opts
.force
, N_("force checkout (throw away local modifications)"),
1292 PARSE_OPT_NOCOMPLETE
),
1293 OPT_BOOL('m', "merge", &opts
.merge
, N_("perform a 3-way merge with the new branch")),
1294 OPT_BOOL_F(0, "overwrite-ignore", &opts
.overwrite_ignore
,
1295 N_("update ignored files (default)"),
1296 PARSE_OPT_NOCOMPLETE
),
1297 OPT_STRING(0, "conflict", &conflict_style
, N_("style"),
1298 N_("conflict style (merge or diff3)")),
1299 OPT_BOOL('p', "patch", &opts
.patch_mode
, N_("select hunks interactively")),
1300 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
.ignore_skipworktree
,
1301 N_("do not limit pathspecs to sparse entries only")),
1302 OPT_BOOL(0, "no-guess", &no_dwim_new_local_branch
,
1303 N_("do not second guess 'git checkout <no-such-branch>'")),
1304 OPT_BOOL(0, "ignore-other-worktrees", &opts
.ignore_other_worktrees
,
1305 N_("do not check if another worktree is holding the given ref")),
1306 { OPTION_CALLBACK
, 0, "recurse-submodules", NULL
,
1307 "checkout", "control recursive updating of submodules",
1308 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
},
1309 OPT_BOOL(0, "progress", &opts
.show_progress
, N_("force progress reporting")),
1313 memset(&opts
, 0, sizeof(opts
));
1314 memset(&new_branch_info
, 0, sizeof(new_branch_info
));
1315 opts
.overwrite_ignore
= 1;
1316 opts
.prefix
= prefix
;
1317 opts
.show_progress
= -1;
1319 git_config(git_checkout_config
, &opts
);
1321 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
1323 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
1324 PARSE_OPT_KEEP_DASHDASH
);
1326 dwim_new_local_branch
= !no_dwim_new_local_branch
;
1327 if (opts
.show_progress
< 0) {
1329 opts
.show_progress
= 0;
1331 opts
.show_progress
= isatty(2);
1334 if (conflict_style
) {
1335 opts
.merge
= 1; /* implied */
1336 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1339 if ((!!opts
.new_branch
+ !!opts
.new_branch_force
+ !!opts
.new_orphan_branch
) > 1)
1340 die(_("-b, -B and --orphan are mutually exclusive"));
1343 * From here on, new_branch will contain the branch to be checked out,
1344 * and new_branch_force and new_orphan_branch will tell us which one of
1345 * -b/-B/--orphan is being used.
1347 if (opts
.new_branch_force
)
1348 opts
.new_branch
= opts
.new_branch_force
;
1350 if (opts
.new_orphan_branch
)
1351 opts
.new_branch
= opts
.new_orphan_branch
;
1353 /* --track without -b/-B/--orphan should DWIM */
1354 if (opts
.track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
.new_branch
) {
1355 const char *argv0
= argv
[0];
1356 if (!argc
|| !strcmp(argv0
, "--"))
1357 die(_("--track needs a branch name"));
1358 skip_prefix(argv0
, "refs/", &argv0
);
1359 skip_prefix(argv0
, "remotes/", &argv0
);
1360 argv0
= strchr(argv0
, '/');
1361 if (!argv0
|| !argv0
[1])
1362 die(_("missing branch name; try -b"));
1363 opts
.new_branch
= argv0
+ 1;
1367 * Extract branch name from command line arguments, so
1368 * all that is left is pathspecs.
1372 * 1) git checkout <tree> -- [<paths>]
1373 * 2) git checkout -- [<paths>]
1374 * 3) git checkout <something> [<paths>]
1376 * including "last branch" syntax and DWIM-ery for names of
1377 * remote branches, erroring out for invalid or ambiguous cases.
1380 struct object_id rev
;
1383 dwim_new_local_branch
&&
1384 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1386 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1387 &new_branch_info
, &opts
, &rev
,
1388 &dwim_remotes_matched
);
1394 parse_pathspec(&opts
.pathspec
, 0,
1395 opts
.patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1398 if (!opts
.pathspec
.nr
)
1399 die(_("invalid path specification"));
1402 * Try to give more helpful suggestion.
1403 * new_branch && argc > 1 will be caught later.
1405 if (opts
.new_branch
&& argc
== 1)
1406 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1407 argv
[0], opts
.new_branch
);
1409 if (opts
.force_detach
)
1410 die(_("git checkout: --detach does not take a path argument '%s'"),
1413 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1414 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1415 "checking out of the index."));
1418 if (opts
.new_branch
) {
1419 struct strbuf buf
= STRBUF_INIT
;
1421 if (opts
.new_branch_force
)
1422 opts
.branch_exists
= validate_branchname(opts
.new_branch
, &buf
);
1424 opts
.branch_exists
=
1425 validate_new_branchname(opts
.new_branch
, &buf
, 0);
1426 strbuf_release(&buf
);
1430 if (opts
.patch_mode
|| opts
.pathspec
.nr
) {
1431 int ret
= checkout_paths(&opts
, new_branch_info
.name
);
1432 if (ret
&& dwim_remotes_matched
> 1 &&
1433 advice_checkout_ambiguous_remote_branch_name
)
1434 advise(_("'%s' matched more than one remote tracking branch.\n"
1435 "We found %d remotes with a reference that matched. So we fell back\n"
1436 "on trying to resolve the argument as a path, but failed there too!\n"
1438 "If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1439 "you can do so by fully qualifying the name with the --track option:\n"
1441 " git checkout --track origin/<name>\n"
1443 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1444 "one remote, e.g. the 'origin' remote, consider setting\n"
1445 "checkout.defaultRemote=origin in your config."),
1447 dwim_remotes_matched
);
1450 return checkout_branch(&opts
, &new_branch_info
);