5 #include "parse-options.h"
7 #include "object-store.h"
10 #include "tree-walk.h"
11 #include "cache-tree.h"
12 #include "unpack-trees.h"
14 #include "run-command.h"
15 #include "merge-recursive.h"
21 #include "xdiff-interface.h"
23 #include "resolve-undo.h"
24 #include "submodule-config.h"
25 #include "submodule.h"
27 static const char * const checkout_usage
[] = {
28 N_("git checkout [<options>] <branch>"),
29 N_("git checkout [<options>] [<branch>] -- <file>..."),
33 struct checkout_opts
{
41 int ignore_skipworktree
;
42 int ignore_other_worktrees
;
45 const char *new_branch
;
46 const char *new_branch_force
;
47 const char *new_orphan_branch
;
49 enum branch_track track
;
50 struct diff_options diff_options
;
54 struct pathspec pathspec
;
55 struct tree
*source_tree
;
58 static int post_checkout_hook(struct commit
*old_commit
, struct commit
*new_commit
,
61 return run_hook_le(NULL
, "post-checkout",
62 oid_to_hex(old_commit
? &old_commit
->object
.oid
: &null_oid
),
63 oid_to_hex(new_commit
? &new_commit
->object
.oid
: &null_oid
),
64 changed
? "1" : "0", NULL
);
65 /* "new_commit" can be NULL when checking out from the index before
70 static int update_some(const struct object_id
*oid
, struct strbuf
*base
,
71 const char *pathname
, unsigned mode
, int stage
, void *context
)
74 struct cache_entry
*ce
;
78 return READ_TREE_RECURSIVE
;
80 len
= base
->len
+ strlen(pathname
);
81 ce
= xcalloc(1, cache_entry_size(len
));
82 oidcpy(&ce
->oid
, oid
);
83 memcpy(ce
->name
, base
->buf
, base
->len
);
84 memcpy(ce
->name
+ base
->len
, pathname
, len
- base
->len
);
85 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
87 ce
->ce_mode
= create_ce_mode(mode
);
90 * If the entry is the same as the current index, we can leave the old
91 * entry in place. Whether it is UPTODATE or not, checkout_entry will
94 pos
= cache_name_pos(ce
->name
, ce
->ce_namelen
);
96 struct cache_entry
*old
= active_cache
[pos
];
97 if (ce
->ce_mode
== old
->ce_mode
&&
98 !oidcmp(&ce
->oid
, &old
->oid
)) {
99 old
->ce_flags
|= CE_UPDATE
;
105 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
109 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
111 read_tree_recursive(tree
, "", 0, 0, pathspec
, update_some
, NULL
);
113 /* update the index with the given tree's info
114 * for all args, expanding wildcards, and exit
115 * with any non-zero return code.
120 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
122 while (++pos
< active_nr
&&
123 !strcmp(active_cache
[pos
]->name
, ce
->name
))
128 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
)
130 while (pos
< active_nr
&&
131 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
132 if (ce_stage(active_cache
[pos
]) == stage
)
137 return error(_("path '%s' does not have our version"), ce
->name
);
139 return error(_("path '%s' does not have their version"), ce
->name
);
142 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
145 const char *name
= ce
->name
;
147 while (pos
< active_nr
) {
148 ce
= active_cache
[pos
];
149 if (strcmp(name
, ce
->name
))
151 seen
|= (1 << ce_stage(ce
));
154 if ((stages
& seen
) != stages
)
155 return error(_("path '%s' does not have all necessary versions"),
160 static int checkout_stage(int stage
, const struct cache_entry
*ce
, int pos
,
161 const struct checkout
*state
)
163 while (pos
< active_nr
&&
164 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
165 if (ce_stage(active_cache
[pos
]) == stage
)
166 return checkout_entry(active_cache
[pos
], state
, NULL
);
170 return error(_("path '%s' does not have our version"), ce
->name
);
172 return error(_("path '%s' does not have their version"), ce
->name
);
175 static int checkout_merged(int pos
, const struct checkout
*state
)
177 struct cache_entry
*ce
= active_cache
[pos
];
178 const char *path
= ce
->name
;
179 mmfile_t ancestor
, ours
, theirs
;
181 struct object_id oid
;
182 mmbuffer_t result_buf
;
183 struct object_id threeway
[3];
186 memset(threeway
, 0, sizeof(threeway
));
187 while (pos
< active_nr
) {
189 stage
= ce_stage(ce
);
190 if (!stage
|| strcmp(path
, ce
->name
))
192 oidcpy(&threeway
[stage
- 1], &ce
->oid
);
194 mode
= create_ce_mode(ce
->ce_mode
);
196 ce
= active_cache
[pos
];
198 if (is_null_oid(&threeway
[1]) || is_null_oid(&threeway
[2]))
199 return error(_("path '%s' does not have necessary versions"), path
);
201 read_mmblob(&ancestor
, &threeway
[0]);
202 read_mmblob(&ours
, &threeway
[1]);
203 read_mmblob(&theirs
, &threeway
[2]);
206 * NEEDSWORK: re-create conflicts from merges with
207 * merge.renormalize set, too
209 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
210 &ours
, "ours", &theirs
, "theirs", NULL
);
214 if (status
< 0 || !result_buf
.ptr
) {
215 free(result_buf
.ptr
);
216 return error(_("path '%s': cannot merge"), path
);
221 * There is absolutely no reason to write this as a blob object
222 * and create a phony cache entry. This hack is primarily to get
223 * to the write_entry() machinery that massages the contents to
224 * work-tree format and writes out which only allows it for a
225 * cache entry. The code in write_entry() needs to be refactored
226 * to allow us to feed a <buffer, size, mode> instead of a cache
227 * entry. Such a refactoring would help merge_recursive as well
228 * (it also writes the merge result to the object database even
229 * when it may contain conflicts).
231 if (write_object_file(result_buf
.ptr
, result_buf
.size
, blob_type
, &oid
))
232 die(_("Unable to add merge result for '%s'"), path
);
233 free(result_buf
.ptr
);
234 ce
= make_cache_entry(mode
, oid
.hash
, path
, 2, 0);
236 die(_("make_cache_entry failed for path '%s'"), path
);
237 status
= checkout_entry(ce
, state
, NULL
);
242 static int checkout_paths(const struct checkout_opts
*opts
,
243 const char *revision
)
246 struct checkout state
= CHECKOUT_INIT
;
247 static char *ps_matched
;
248 struct object_id rev
;
251 struct lock_file lock_file
= LOCK_INIT
;
253 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
254 die(_("'%s' cannot be used with updating paths"), "--track");
256 if (opts
->new_branch_log
)
257 die(_("'%s' cannot be used with updating paths"), "-l");
259 if (opts
->force
&& opts
->patch_mode
)
260 die(_("'%s' cannot be used with updating paths"), "-f");
262 if (opts
->force_detach
)
263 die(_("'%s' cannot be used with updating paths"), "--detach");
265 if (opts
->merge
&& opts
->patch_mode
)
266 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
268 if (opts
->force
&& opts
->merge
)
269 die(_("'%s' cannot be used with %s"), "-f", "-m");
271 if (opts
->new_branch
)
272 die(_("Cannot update paths and switch to branch '%s' at the same time."),
275 if (opts
->patch_mode
)
276 return run_add_interactive(revision
, "--patch=checkout",
279 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
280 if (read_cache_preload(&opts
->pathspec
) < 0)
281 return error(_("index file corrupt"));
283 if (opts
->source_tree
)
284 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
286 ps_matched
= xcalloc(opts
->pathspec
.nr
, 1);
289 * Make sure all pathspecs participated in locating the paths
292 for (pos
= 0; pos
< active_nr
; pos
++) {
293 struct cache_entry
*ce
= active_cache
[pos
];
294 ce
->ce_flags
&= ~CE_MATCHED
;
295 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
297 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
299 * "git checkout tree-ish -- path", but this entry
300 * is in the original index; it will not be checked
301 * out to the working tree and it does not matter
302 * if pathspec matched this entry. We will not do
303 * anything to this entry at all.
307 * Either this entry came from the tree-ish we are
308 * checking the paths out of, or we are checking out
311 * If it comes from the tree-ish, we already know it
312 * matches the pathspec and could just stamp
313 * CE_MATCHED to it from update_some(). But we still
314 * need ps_matched and read_tree_recursive (and
315 * eventually tree_entry_interesting) cannot fill
316 * ps_matched yet. Once it can, we can avoid calling
317 * match_pathspec() for _all_ entries when
318 * opts->source_tree != NULL.
320 if (ce_path_match(ce
, &opts
->pathspec
, ps_matched
))
321 ce
->ce_flags
|= CE_MATCHED
;
324 if (report_path_error(ps_matched
, &opts
->pathspec
, opts
->prefix
)) {
330 /* "checkout -m path" to recreate conflicted state */
332 unmerge_marked_index(&the_index
);
334 /* Any unmerged paths? */
335 for (pos
= 0; pos
< active_nr
; pos
++) {
336 const struct cache_entry
*ce
= active_cache
[pos
];
337 if (ce
->ce_flags
& CE_MATCHED
) {
341 warning(_("path '%s' is unmerged"), ce
->name
);
342 } else if (opts
->writeout_stage
) {
343 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
);
344 } else if (opts
->merge
) {
345 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
348 error(_("path '%s' is unmerged"), ce
->name
);
350 pos
= skip_same_name(ce
, pos
) - 1;
356 /* Now we are committed to check them out */
358 state
.refresh_cache
= 1;
359 state
.istate
= &the_index
;
361 enable_delayed_checkout(&state
);
362 for (pos
= 0; pos
< active_nr
; pos
++) {
363 struct cache_entry
*ce
= active_cache
[pos
];
364 if (ce
->ce_flags
& CE_MATCHED
) {
366 errs
|= checkout_entry(ce
, &state
, NULL
);
369 if (opts
->writeout_stage
)
370 errs
|= checkout_stage(opts
->writeout_stage
, ce
, pos
, &state
);
371 else if (opts
->merge
)
372 errs
|= checkout_merged(pos
, &state
);
373 pos
= skip_same_name(ce
, pos
) - 1;
376 errs
|= finish_delayed_checkout(&state
);
378 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
379 die(_("unable to write new index file"));
381 read_ref_full("HEAD", 0, &rev
, NULL
);
382 head
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
384 errs
|= post_checkout_hook(head
, head
, 0);
388 static void show_local_changes(struct object
*head
,
389 const struct diff_options
*opts
)
392 /* I think we want full paths, even if we're in a subdirectory. */
393 init_revisions(&rev
, NULL
);
394 rev
.diffopt
.flags
= opts
->flags
;
395 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
396 diff_setup_done(&rev
.diffopt
);
397 add_pending_object(&rev
, head
, NULL
);
398 run_diff_index(&rev
, 0);
401 static void describe_detached_head(const char *msg
, struct commit
*commit
)
403 struct strbuf sb
= STRBUF_INIT
;
405 if (!parse_commit(commit
))
406 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
407 if (print_sha1_ellipsis()) {
408 fprintf(stderr
, "%s %s... %s\n", msg
,
409 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
411 fprintf(stderr
, "%s %s %s\n", msg
,
412 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
), sb
.buf
);
417 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
418 int worktree
, int *writeout_error
)
420 struct unpack_trees_options opts
;
421 struct tree_desc tree_desc
;
423 memset(&opts
, 0, sizeof(opts
));
425 opts
.update
= worktree
;
426 opts
.skip_unmerged
= !worktree
;
429 opts
.fn
= oneway_merge
;
430 opts
.verbose_update
= o
->show_progress
;
431 opts
.src_index
= &the_index
;
432 opts
.dst_index
= &the_index
;
434 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
435 switch (unpack_trees(1, &tree_desc
, &opts
)) {
439 * We return 0 nevertheless, as the index is all right
440 * and more importantly we have made best efforts to
441 * update paths in the work tree, and we cannot revert
453 const char *name
; /* The short name used */
454 const char *path
; /* The full name of a real branch */
455 struct commit
*commit
; /* The named commit */
457 * if not null the branch is detached because it's already
458 * checked out in this checkout
463 static void setup_branch_path(struct branch_info
*branch
)
465 struct strbuf buf
= STRBUF_INIT
;
467 strbuf_branchname(&buf
, branch
->name
, INTERPRET_BRANCH_LOCAL
);
468 if (strcmp(buf
.buf
, branch
->name
))
469 branch
->name
= xstrdup(buf
.buf
);
470 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
471 branch
->path
= strbuf_detach(&buf
, NULL
);
474 static int merge_working_tree(const struct checkout_opts
*opts
,
475 struct branch_info
*old_branch_info
,
476 struct branch_info
*new_branch_info
,
480 struct lock_file lock_file
= LOCK_INIT
;
482 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
483 if (read_cache_preload(NULL
) < 0)
484 return error(_("index file corrupt"));
486 resolve_undo_clear();
488 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
489 opts
, 1, writeout_error
);
493 struct tree_desc trees
[2];
495 struct unpack_trees_options topts
;
497 memset(&topts
, 0, sizeof(topts
));
499 topts
.src_index
= &the_index
;
500 topts
.dst_index
= &the_index
;
502 setup_unpack_trees_porcelain(&topts
, "checkout");
504 refresh_cache(REFRESH_QUIET
);
506 if (unmerged_cache()) {
507 error(_("you need to resolve your current index first"));
511 /* 2-way merge to the new branch */
512 topts
.initial_checkout
= is_cache_unborn();
515 topts
.gently
= opts
->merge
&& old_branch_info
->commit
;
516 topts
.verbose_update
= opts
->show_progress
;
517 topts
.fn
= twoway_merge
;
518 if (opts
->overwrite_ignore
) {
519 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
520 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
521 setup_standard_excludes(topts
.dir
);
523 tree
= parse_tree_indirect(old_branch_info
->commit
?
524 &old_branch_info
->commit
->object
.oid
:
525 the_hash_algo
->empty_tree
);
526 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
527 tree
= parse_tree_indirect(&new_branch_info
->commit
->object
.oid
);
528 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
530 ret
= unpack_trees(2, trees
, &topts
);
531 clear_unpack_trees_porcelain(&topts
);
534 * Unpack couldn't do a trivial merge; either
535 * give up or do a real merge, depending on
536 * whether the merge flag was used.
540 struct merge_options o
;
545 * Without old_branch_info->commit, the below is the same as
546 * the two-tree unpack we already tried and failed.
548 if (!old_branch_info
->commit
)
551 /* Do more real merge */
554 * We update the index fully, then write the
555 * tree from the index, then merge the new
556 * branch with the current tree, with the old
557 * branch as the base. Then we reset the index
558 * (but not the working tree) to the new
559 * branch, leaving the working tree as the
560 * merged version, but skipping unmerged
561 * entries in the index.
564 add_files_to_cache(NULL
, NULL
, 0);
566 * NEEDSWORK: carrying over local changes
567 * when branches have different end-of-line
568 * normalization (or clean+smudge rules) is
569 * a pain; plumb in an option to set
572 init_merge_options(&o
);
574 work
= write_tree_from_memory(&o
);
576 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
581 o
.ancestor
= old_branch_info
->name
;
582 o
.branch1
= new_branch_info
->name
;
584 ret
= merge_trees(&o
,
585 get_commit_tree(new_branch_info
->commit
),
587 get_commit_tree(old_branch_info
->commit
),
591 ret
= reset_tree(get_commit_tree(new_branch_info
->commit
),
594 strbuf_release(&o
.obuf
);
600 if (!active_cache_tree
)
601 active_cache_tree
= cache_tree();
603 if (!cache_tree_fully_valid(active_cache_tree
))
604 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
606 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
607 die(_("unable to write new index file"));
609 if (!opts
->force
&& !opts
->quiet
)
610 show_local_changes(&new_branch_info
->commit
->object
, &opts
->diff_options
);
615 static void report_tracking(struct branch_info
*new_branch_info
)
617 struct strbuf sb
= STRBUF_INIT
;
618 struct branch
*branch
= branch_get(new_branch_info
->name
);
620 if (!format_tracking_info(branch
, &sb
, AHEAD_BEHIND_FULL
))
622 fputs(sb
.buf
, stdout
);
626 static void update_refs_for_switch(const struct checkout_opts
*opts
,
627 struct branch_info
*old_branch_info
,
628 struct branch_info
*new_branch_info
)
630 struct strbuf msg
= STRBUF_INIT
;
631 const char *old_desc
, *reflog_msg
;
632 if (opts
->new_branch
) {
633 if (opts
->new_orphan_branch
) {
636 refname
= mkpathdup("refs/heads/%s", opts
->new_orphan_branch
);
637 if (opts
->new_branch_log
&&
638 !should_autocreate_reflog(refname
)) {
640 struct strbuf err
= STRBUF_INIT
;
642 ret
= safe_create_reflog(refname
, 1, &err
);
644 fprintf(stderr
, _("Can not do reflog for '%s': %s\n"),
645 opts
->new_orphan_branch
, err
.buf
);
646 strbuf_release(&err
);
650 strbuf_release(&err
);
655 create_branch(opts
->new_branch
, new_branch_info
->name
,
656 opts
->new_branch_force
? 1 : 0,
657 opts
->new_branch_force
? 1 : 0,
658 opts
->new_branch_log
,
661 new_branch_info
->name
= opts
->new_branch
;
662 setup_branch_path(new_branch_info
);
665 old_desc
= old_branch_info
->name
;
666 if (!old_desc
&& old_branch_info
->commit
)
667 old_desc
= oid_to_hex(&old_branch_info
->commit
->object
.oid
);
669 reflog_msg
= getenv("GIT_REFLOG_ACTION");
671 strbuf_addf(&msg
, "checkout: moving from %s to %s",
672 old_desc
? old_desc
: "(invalid)", new_branch_info
->name
);
674 strbuf_insert(&msg
, 0, reflog_msg
, strlen(reflog_msg
));
676 if (!strcmp(new_branch_info
->name
, "HEAD") && !new_branch_info
->path
&& !opts
->force_detach
) {
678 } else if (opts
->force_detach
|| !new_branch_info
->path
) { /* No longer on any branch. */
679 update_ref(msg
.buf
, "HEAD", &new_branch_info
->commit
->object
.oid
, NULL
,
680 REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
682 if (old_branch_info
->path
&&
683 advice_detached_head
&& !opts
->force_detach
)
684 detach_advice(new_branch_info
->name
);
685 describe_detached_head(_("HEAD is now at"), new_branch_info
->commit
);
687 } else if (new_branch_info
->path
) { /* Switch branches. */
688 if (create_symref("HEAD", new_branch_info
->path
, msg
.buf
) < 0)
689 die(_("unable to update HEAD"));
691 if (old_branch_info
->path
&& !strcmp(new_branch_info
->path
, old_branch_info
->path
)) {
692 if (opts
->new_branch_force
)
693 fprintf(stderr
, _("Reset branch '%s'\n"),
694 new_branch_info
->name
);
696 fprintf(stderr
, _("Already on '%s'\n"),
697 new_branch_info
->name
);
698 } else if (opts
->new_branch
) {
699 if (opts
->branch_exists
)
700 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new_branch_info
->name
);
702 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new_branch_info
->name
);
704 fprintf(stderr
, _("Switched to branch '%s'\n"),
705 new_branch_info
->name
);
708 if (old_branch_info
->path
&& old_branch_info
->name
) {
709 if (!ref_exists(old_branch_info
->path
) && reflog_exists(old_branch_info
->path
))
710 delete_reflog(old_branch_info
->path
);
713 remove_branch_state();
714 strbuf_release(&msg
);
716 (new_branch_info
->path
|| (!opts
->force_detach
&& !strcmp(new_branch_info
->name
, "HEAD"))))
717 report_tracking(new_branch_info
);
720 static int add_pending_uninteresting_ref(const char *refname
,
721 const struct object_id
*oid
,
722 int flags
, void *cb_data
)
724 add_pending_oid(cb_data
, refname
, oid
, UNINTERESTING
);
728 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
730 strbuf_addstr(sb
, " ");
731 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
, DEFAULT_ABBREV
);
732 strbuf_addch(sb
, ' ');
733 if (!parse_commit(commit
))
734 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
735 strbuf_addch(sb
, '\n');
738 #define ORPHAN_CUTOFF 4
739 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
741 struct commit
*c
, *last
= NULL
;
742 struct strbuf sb
= STRBUF_INIT
;
744 while ((c
= get_revision(revs
)) != NULL
) {
745 if (lost
< ORPHAN_CUTOFF
)
746 describe_one_orphan(&sb
, c
);
750 if (ORPHAN_CUTOFF
< lost
) {
751 int more
= lost
- ORPHAN_CUTOFF
;
753 describe_one_orphan(&sb
, last
);
755 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
760 /* The singular version */
761 "Warning: you are leaving %d commit behind, "
763 "any of your branches:\n\n"
765 /* The plural version */
766 "Warning: you are leaving %d commits behind, "
768 "any of your branches:\n\n"
770 /* Give ngettext() the count */
776 if (advice_detached_head
)
779 /* The singular version */
780 "If you want to keep it by creating a new branch, "
781 "this may be a good time\nto do so with:\n\n"
782 " git branch <new-branch-name> %s\n\n",
783 /* The plural version */
784 "If you want to keep them by creating a new branch, "
785 "this may be a good time\nto do so with:\n\n"
786 " git branch <new-branch-name> %s\n\n",
787 /* Give ngettext() the count */
789 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
793 * We are about to leave commit that was at the tip of a detached
794 * HEAD. If it is not reachable from any ref, this is the last chance
795 * for the user to do so without resorting to reflog.
797 static void orphaned_commit_warning(struct commit
*old_commit
, struct commit
*new_commit
)
799 struct rev_info revs
;
800 struct object
*object
= &old_commit
->object
;
802 init_revisions(&revs
, NULL
);
803 setup_revisions(0, NULL
, &revs
, NULL
);
805 object
->flags
&= ~UNINTERESTING
;
806 add_pending_object(&revs
, object
, oid_to_hex(&object
->oid
));
808 for_each_ref(add_pending_uninteresting_ref
, &revs
);
809 add_pending_oid(&revs
, "HEAD", &new_commit
->object
.oid
, UNINTERESTING
);
811 if (prepare_revision_walk(&revs
))
812 die(_("internal error in revision walk"));
813 if (!(old_commit
->object
.flags
& UNINTERESTING
))
814 suggest_reattach(old_commit
, &revs
);
816 describe_detached_head(_("Previous HEAD position was"), old_commit
);
818 /* Clean up objects used, as they will be reused. */
819 clear_commit_marks_all(ALL_REV_FLAGS
);
822 static int switch_branches(const struct checkout_opts
*opts
,
823 struct branch_info
*new_branch_info
)
826 struct branch_info old_branch_info
;
828 struct object_id rev
;
829 int flag
, writeout_error
= 0;
830 memset(&old_branch_info
, 0, sizeof(old_branch_info
));
831 old_branch_info
.path
= path_to_free
= resolve_refdup("HEAD", 0, &rev
, &flag
);
832 if (old_branch_info
.path
)
833 old_branch_info
.commit
= lookup_commit_reference_gently(the_repository
, &rev
, 1);
834 if (!(flag
& REF_ISSYMREF
))
835 old_branch_info
.path
= NULL
;
837 if (old_branch_info
.path
)
838 skip_prefix(old_branch_info
.path
, "refs/heads/", &old_branch_info
.name
);
840 if (!new_branch_info
->name
) {
841 new_branch_info
->name
= "HEAD";
842 new_branch_info
->commit
= old_branch_info
.commit
;
843 if (!new_branch_info
->commit
)
844 die(_("You are on a branch yet to be born"));
845 parse_commit_or_die(new_branch_info
->commit
);
848 ret
= merge_working_tree(opts
, &old_branch_info
, new_branch_info
, &writeout_error
);
854 if (!opts
->quiet
&& !old_branch_info
.path
&& old_branch_info
.commit
&& new_branch_info
->commit
!= old_branch_info
.commit
)
855 orphaned_commit_warning(old_branch_info
.commit
, new_branch_info
->commit
);
857 update_refs_for_switch(opts
, &old_branch_info
, new_branch_info
);
859 ret
= post_checkout_hook(old_branch_info
.commit
, new_branch_info
->commit
, 1);
861 return ret
|| writeout_error
;
864 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
866 if (!strcmp(var
, "diff.ignoresubmodules")) {
867 struct checkout_opts
*opts
= cb
;
868 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
872 if (starts_with(var
, "submodule."))
873 return git_default_submodule_config(var
, value
, NULL
);
875 return git_xmerge_config(var
, value
, NULL
);
878 static int parse_branchname_arg(int argc
, const char **argv
,
879 int dwim_new_local_branch_ok
,
880 struct branch_info
*new_branch_info
,
881 struct checkout_opts
*opts
,
882 struct object_id
*rev
)
884 struct tree
**source_tree
= &opts
->source_tree
;
885 const char **new_branch
= &opts
->new_branch
;
887 struct object_id branch_rev
;
890 int has_dash_dash
= 0;
894 * case 1: git checkout <ref> -- [<paths>]
896 * <ref> must be a valid tree, everything after the '--' must be
899 * case 2: git checkout -- [<paths>]
901 * everything after the '--' must be paths.
903 * case 3: git checkout <something> [--]
905 * (a) If <something> is a commit, that is to
906 * switch to the branch or detach HEAD at it. As a special case,
907 * if <something> is A...B (missing A or B means HEAD but you can
908 * omit at most one side), and if there is a unique merge base
909 * between A and B, A...B names that merge base.
911 * (b) If <something> is _not_ a commit, either "--" is present
912 * or <something> is not a path, no -t or -b was given, and
913 * and there is a tracking branch whose name is <something>
914 * in one and only one remote, then this is a short-hand to
915 * fork local <something> from that remote-tracking branch.
917 * (c) Otherwise, if "--" is present, treat it like case (1).
920 * - if it's a reference, treat it like case (1)
921 * - else if it's a path, treat it like case (2)
924 * case 4: git checkout <something> <paths>
926 * The first argument must not be ambiguous.
927 * - If it's *only* a reference, treat it like case (1).
928 * - If it's only a path, treat it like case (2).
937 for (i
= 0; i
< argc
; i
++) {
938 if (!strcmp(argv
[i
], "--")) {
943 if (dash_dash_pos
== 0)
944 return 1; /* case (2) */
945 else if (dash_dash_pos
== 1)
946 has_dash_dash
= 1; /* case (3) or (1) */
947 else if (dash_dash_pos
>= 2)
948 die(_("only one reference expected, %d given."), dash_dash_pos
);
950 if (!strcmp(arg
, "-"))
953 if (get_oid_mb(arg
, rev
)) {
955 * Either case (3) or (4), with <something> not being
956 * a commit, or an attempt to use case (1) with an
959 * It's likely an error, but we need to find out if
960 * we should auto-create the branch, case (3).(b).
962 int recover_with_dwim
= dwim_new_local_branch_ok
;
964 if (!has_dash_dash
&&
965 (check_filename(opts
->prefix
, arg
) || !no_wildcard(arg
)))
966 recover_with_dwim
= 0;
968 * Accept "git checkout foo" and "git checkout foo --"
969 * as candidates for dwim.
971 if (!(argc
== 1 && !has_dash_dash
) &&
972 !(argc
== 2 && has_dash_dash
))
973 recover_with_dwim
= 0;
975 if (recover_with_dwim
) {
976 const char *remote
= unique_tracking_name(arg
, rev
);
980 /* DWIMmed to create local branch, case (3).(b) */
982 recover_with_dwim
= 0;
986 if (!recover_with_dwim
) {
988 die(_("invalid reference: %s"), arg
);
993 /* we can't end up being in (2) anymore, eat the argument */
998 new_branch_info
->name
= arg
;
999 setup_branch_path(new_branch_info
);
1001 if (!check_refname_format(new_branch_info
->path
, 0) &&
1002 !read_ref(new_branch_info
->path
, &branch_rev
))
1003 oidcpy(rev
, &branch_rev
);
1005 new_branch_info
->path
= NULL
; /* not an existing branch */
1007 new_branch_info
->commit
= lookup_commit_reference_gently(the_repository
, rev
, 1);
1008 if (!new_branch_info
->commit
) {
1010 *source_tree
= parse_tree_indirect(rev
);
1012 parse_commit_or_die(new_branch_info
->commit
);
1013 *source_tree
= get_commit_tree(new_branch_info
->commit
);
1016 if (!*source_tree
) /* case (1): want a tree */
1017 die(_("reference is not a tree: %s"), arg
);
1018 if (!has_dash_dash
) { /* case (3).(d) -> (1) */
1020 * Do not complain the most common case
1021 * git checkout branch
1022 * even if there happen to be a file called 'branch';
1023 * it would be extremely annoying.
1026 verify_non_filename(opts
->prefix
, arg
);
1036 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1039 struct strbuf branch_ref
= STRBUF_INIT
;
1041 if (!opts
->new_branch
)
1042 die(_("You are on a branch yet to be born"));
1043 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1044 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1045 strbuf_release(&branch_ref
);
1047 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1052 static int checkout_branch(struct checkout_opts
*opts
,
1053 struct branch_info
*new_branch_info
)
1055 if (opts
->pathspec
.nr
)
1056 die(_("paths cannot be used with switching branches"));
1058 if (opts
->patch_mode
)
1059 die(_("'%s' cannot be used with switching branches"),
1062 if (opts
->writeout_stage
)
1063 die(_("'%s' cannot be used with switching branches"),
1066 if (opts
->force
&& opts
->merge
)
1067 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1069 if (opts
->force_detach
&& opts
->new_branch
)
1070 die(_("'%s' cannot be used with '%s'"),
1071 "--detach", "-b/-B/--orphan");
1073 if (opts
->new_orphan_branch
) {
1074 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1075 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1076 } else if (opts
->force_detach
) {
1077 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1078 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1079 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1080 opts
->track
= git_branch_track
;
1082 if (new_branch_info
->name
&& !new_branch_info
->commit
)
1083 die(_("Cannot switch branch to a non-commit '%s'"),
1084 new_branch_info
->name
);
1086 if (new_branch_info
->path
&& !opts
->force_detach
&& !opts
->new_branch
&&
1087 !opts
->ignore_other_worktrees
) {
1089 char *head_ref
= resolve_refdup("HEAD", 0, NULL
, &flag
);
1091 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new_branch_info
->path
)))
1092 die_if_checked_out(new_branch_info
->path
, 1);
1096 if (!new_branch_info
->commit
&& opts
->new_branch
) {
1097 struct object_id rev
;
1100 if (!read_ref_full("HEAD", 0, &rev
, &flag
) &&
1101 (flag
& REF_ISSYMREF
) && is_null_oid(&rev
))
1102 return switch_unborn_to_new_branch(opts
);
1104 return switch_branches(opts
, new_branch_info
);
1107 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1109 struct checkout_opts opts
;
1110 struct branch_info new_branch_info
;
1111 char *conflict_style
= NULL
;
1112 int dwim_new_local_branch
= 1;
1113 struct option options
[] = {
1114 OPT__QUIET(&opts
.quiet
, N_("suppress progress reporting")),
1115 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1116 N_("create and checkout a new branch")),
1117 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1118 N_("create/reset and checkout a branch")),
1119 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1120 OPT_BOOL(0, "detach", &opts
.force_detach
, N_("detach HEAD at named commit")),
1121 OPT_SET_INT('t', "track", &opts
.track
, N_("set upstream info for new branch"),
1122 BRANCH_TRACK_EXPLICIT
),
1123 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1124 OPT_SET_INT_F('2', "ours", &opts
.writeout_stage
,
1125 N_("checkout our version for unmerged files"),
1126 2, PARSE_OPT_NONEG
),
1127 OPT_SET_INT_F('3', "theirs", &opts
.writeout_stage
,
1128 N_("checkout their version for unmerged files"),
1129 3, PARSE_OPT_NONEG
),
1130 OPT__FORCE(&opts
.force
, N_("force checkout (throw away local modifications)"),
1131 PARSE_OPT_NOCOMPLETE
),
1132 OPT_BOOL('m', "merge", &opts
.merge
, N_("perform a 3-way merge with the new branch")),
1133 OPT_BOOL_F(0, "overwrite-ignore", &opts
.overwrite_ignore
,
1134 N_("update ignored files (default)"),
1135 PARSE_OPT_NOCOMPLETE
),
1136 OPT_STRING(0, "conflict", &conflict_style
, N_("style"),
1137 N_("conflict style (merge or diff3)")),
1138 OPT_BOOL('p', "patch", &opts
.patch_mode
, N_("select hunks interactively")),
1139 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
.ignore_skipworktree
,
1140 N_("do not limit pathspecs to sparse entries only")),
1141 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch
,
1142 N_("second guess 'git checkout <no-such-branch>'")),
1143 OPT_BOOL(0, "ignore-other-worktrees", &opts
.ignore_other_worktrees
,
1144 N_("do not check if another worktree is holding the given ref")),
1145 { OPTION_CALLBACK
, 0, "recurse-submodules", NULL
,
1146 "checkout", "control recursive updating of submodules",
1147 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
},
1148 OPT_BOOL(0, "progress", &opts
.show_progress
, N_("force progress reporting")),
1152 memset(&opts
, 0, sizeof(opts
));
1153 memset(&new_branch_info
, 0, sizeof(new_branch_info
));
1154 opts
.overwrite_ignore
= 1;
1155 opts
.prefix
= prefix
;
1156 opts
.show_progress
= -1;
1158 git_config(git_checkout_config
, &opts
);
1160 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
1162 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
1163 PARSE_OPT_KEEP_DASHDASH
);
1165 if (opts
.show_progress
< 0) {
1167 opts
.show_progress
= 0;
1169 opts
.show_progress
= isatty(2);
1172 if (conflict_style
) {
1173 opts
.merge
= 1; /* implied */
1174 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1177 if ((!!opts
.new_branch
+ !!opts
.new_branch_force
+ !!opts
.new_orphan_branch
) > 1)
1178 die(_("-b, -B and --orphan are mutually exclusive"));
1181 * From here on, new_branch will contain the branch to be checked out,
1182 * and new_branch_force and new_orphan_branch will tell us which one of
1183 * -b/-B/--orphan is being used.
1185 if (opts
.new_branch_force
)
1186 opts
.new_branch
= opts
.new_branch_force
;
1188 if (opts
.new_orphan_branch
)
1189 opts
.new_branch
= opts
.new_orphan_branch
;
1191 /* --track without -b/-B/--orphan should DWIM */
1192 if (opts
.track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
.new_branch
) {
1193 const char *argv0
= argv
[0];
1194 if (!argc
|| !strcmp(argv0
, "--"))
1195 die (_("--track needs a branch name"));
1196 skip_prefix(argv0
, "refs/", &argv0
);
1197 skip_prefix(argv0
, "remotes/", &argv0
);
1198 argv0
= strchr(argv0
, '/');
1199 if (!argv0
|| !argv0
[1])
1200 die (_("Missing branch name; try -b"));
1201 opts
.new_branch
= argv0
+ 1;
1205 * Extract branch name from command line arguments, so
1206 * all that is left is pathspecs.
1210 * 1) git checkout <tree> -- [<paths>]
1211 * 2) git checkout -- [<paths>]
1212 * 3) git checkout <something> [<paths>]
1214 * including "last branch" syntax and DWIM-ery for names of
1215 * remote branches, erroring out for invalid or ambiguous cases.
1218 struct object_id rev
;
1221 dwim_new_local_branch
&&
1222 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1224 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1225 &new_branch_info
, &opts
, &rev
);
1231 parse_pathspec(&opts
.pathspec
, 0,
1232 opts
.patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1235 if (!opts
.pathspec
.nr
)
1236 die(_("invalid path specification"));
1239 * Try to give more helpful suggestion.
1240 * new_branch && argc > 1 will be caught later.
1242 if (opts
.new_branch
&& argc
== 1)
1243 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1244 argv
[0], opts
.new_branch
);
1246 if (opts
.force_detach
)
1247 die(_("git checkout: --detach does not take a path argument '%s'"),
1250 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1251 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1252 "checking out of the index."));
1255 if (opts
.new_branch
) {
1256 struct strbuf buf
= STRBUF_INIT
;
1258 if (opts
.new_branch_force
)
1259 opts
.branch_exists
= validate_branchname(opts
.new_branch
, &buf
);
1261 opts
.branch_exists
=
1262 validate_new_branchname(opts
.new_branch
, &buf
, 0);
1263 strbuf_release(&buf
);
1267 if (opts
.patch_mode
|| opts
.pathspec
.nr
)
1268 return checkout_paths(&opts
, new_branch_info
.name
);
1270 return checkout_branch(&opts
, &new_branch_info
);