3 #include "parse-options.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
11 #include "run-command.h"
12 #include "merge-recursive.h"
18 #include "xdiff-interface.h"
20 #include "resolve-undo.h"
21 #include "submodule.h"
22 #include "argv-array.h"
24 static const char * const checkout_usage
[] = {
25 N_("git checkout [options] <branch>"),
26 N_("git checkout [options] [<branch>] -- <file>..."),
30 struct checkout_opts
{
38 int ignore_skipworktree
;
40 const char *new_branch
;
41 const char *new_branch_force
;
42 const char *new_orphan_branch
;
44 enum branch_track track
;
45 struct diff_options diff_options
;
49 struct pathspec pathspec
;
50 struct tree
*source_tree
;
52 const char *new_worktree
;
53 const char **saved_argv
;
54 int new_worktree_mode
;
57 static int post_checkout_hook(struct commit
*old
, struct commit
*new,
60 return run_hook_le(NULL
, "post-checkout",
61 sha1_to_hex(old
? old
->object
.sha1
: null_sha1
),
62 sha1_to_hex(new ? new->object
.sha1
: null_sha1
),
63 changed
? "1" : "0", NULL
);
64 /* "new" can be NULL when checking out from the index before
69 static int update_some(const unsigned char *sha1
, const char *base
, int baselen
,
70 const char *pathname
, unsigned mode
, int stage
, void *context
)
73 struct cache_entry
*ce
;
76 return READ_TREE_RECURSIVE
;
78 len
= baselen
+ strlen(pathname
);
79 ce
= xcalloc(1, cache_entry_size(len
));
80 hashcpy(ce
->sha1
, sha1
);
81 memcpy(ce
->name
, base
, baselen
);
82 memcpy(ce
->name
+ baselen
, pathname
, len
- baselen
);
83 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
85 ce
->ce_mode
= create_ce_mode(mode
);
86 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
90 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
92 read_tree_recursive(tree
, "", 0, 0, pathspec
, update_some
, NULL
);
94 /* update the index with the given tree's info
95 * for all args, expanding wildcards, and exit
96 * with any non-zero return code.
101 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
103 while (++pos
< active_nr
&&
104 !strcmp(active_cache
[pos
]->name
, ce
->name
))
109 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
)
111 while (pos
< active_nr
&&
112 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
113 if (ce_stage(active_cache
[pos
]) == stage
)
118 return error(_("path '%s' does not have our version"), ce
->name
);
120 return error(_("path '%s' does not have their version"), ce
->name
);
123 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
126 const char *name
= ce
->name
;
128 while (pos
< active_nr
) {
129 ce
= active_cache
[pos
];
130 if (strcmp(name
, ce
->name
))
132 seen
|= (1 << ce_stage(ce
));
135 if ((stages
& seen
) != stages
)
136 return error(_("path '%s' does not have all necessary versions"),
141 static int checkout_stage(int stage
, struct cache_entry
*ce
, int pos
,
142 struct checkout
*state
)
144 while (pos
< active_nr
&&
145 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
146 if (ce_stage(active_cache
[pos
]) == stage
)
147 return checkout_entry(active_cache
[pos
], state
, NULL
);
151 return error(_("path '%s' does not have our version"), ce
->name
);
153 return error(_("path '%s' does not have their version"), ce
->name
);
156 static int checkout_merged(int pos
, struct checkout
*state
)
158 struct cache_entry
*ce
= active_cache
[pos
];
159 const char *path
= ce
->name
;
160 mmfile_t ancestor
, ours
, theirs
;
162 unsigned char sha1
[20];
163 mmbuffer_t result_buf
;
164 unsigned char threeway
[3][20];
167 memset(threeway
, 0, sizeof(threeway
));
168 while (pos
< active_nr
) {
170 stage
= ce_stage(ce
);
171 if (!stage
|| strcmp(path
, ce
->name
))
173 hashcpy(threeway
[stage
- 1], ce
->sha1
);
175 mode
= create_ce_mode(ce
->ce_mode
);
177 ce
= active_cache
[pos
];
179 if (is_null_sha1(threeway
[1]) || is_null_sha1(threeway
[2]))
180 return error(_("path '%s' does not have necessary versions"), path
);
182 read_mmblob(&ancestor
, threeway
[0]);
183 read_mmblob(&ours
, threeway
[1]);
184 read_mmblob(&theirs
, threeway
[2]);
187 * NEEDSWORK: re-create conflicts from merges with
188 * merge.renormalize set, too
190 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
191 &ours
, "ours", &theirs
, "theirs", NULL
);
195 if (status
< 0 || !result_buf
.ptr
) {
196 free(result_buf
.ptr
);
197 return error(_("path '%s': cannot merge"), path
);
202 * There is absolutely no reason to write this as a blob object
203 * and create a phony cache entry just to leak. This hack is
204 * primarily to get to the write_entry() machinery that massages
205 * the contents to work-tree format and writes out which only
206 * allows it for a cache entry. The code in write_entry() needs
207 * to be refactored to allow us to feed a <buffer, size, mode>
208 * instead of a cache entry. Such a refactoring would help
209 * merge_recursive as well (it also writes the merge result to the
210 * object database even when it may contain conflicts).
212 if (write_sha1_file(result_buf
.ptr
, result_buf
.size
,
214 die(_("Unable to add merge result for '%s'"), path
);
215 ce
= make_cache_entry(mode
, sha1
, path
, 2, 0);
217 die(_("make_cache_entry failed for path '%s'"), path
);
218 status
= checkout_entry(ce
, state
, NULL
);
222 static int checkout_paths(const struct checkout_opts
*opts
,
223 const char *revision
)
226 struct checkout state
;
227 static char *ps_matched
;
228 unsigned char rev
[20];
232 struct lock_file
*lock_file
;
234 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
235 die(_("'%s' cannot be used with updating paths"), "--track");
237 if (opts
->new_branch_log
)
238 die(_("'%s' cannot be used with updating paths"), "-l");
240 if (opts
->force
&& opts
->patch_mode
)
241 die(_("'%s' cannot be used with updating paths"), "-f");
243 if (opts
->force_detach
)
244 die(_("'%s' cannot be used with updating paths"), "--detach");
246 if (opts
->merge
&& opts
->patch_mode
)
247 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
249 if (opts
->force
&& opts
->merge
)
250 die(_("'%s' cannot be used with %s"), "-f", "-m");
252 if (opts
->new_branch
)
253 die(_("Cannot update paths and switch to branch '%s' at the same time."),
256 if (opts
->new_worktree
)
257 die(_("'%s' cannot be used with updating paths"), "--to");
259 if (opts
->patch_mode
)
260 return run_add_interactive(revision
, "--patch=checkout",
263 lock_file
= xcalloc(1, sizeof(struct lock_file
));
265 hold_locked_index(lock_file
, 1);
266 if (read_cache_preload(&opts
->pathspec
) < 0)
267 return error(_("corrupt index file"));
269 if (opts
->source_tree
)
270 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
272 ps_matched
= xcalloc(1, opts
->pathspec
.nr
);
275 * Make sure all pathspecs participated in locating the paths
278 for (pos
= 0; pos
< active_nr
; pos
++) {
279 struct cache_entry
*ce
= active_cache
[pos
];
280 ce
->ce_flags
&= ~CE_MATCHED
;
281 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
283 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
285 * "git checkout tree-ish -- path", but this entry
286 * is in the original index; it will not be checked
287 * out to the working tree and it does not matter
288 * if pathspec matched this entry. We will not do
289 * anything to this entry at all.
293 * Either this entry came from the tree-ish we are
294 * checking the paths out of, or we are checking out
297 * If it comes from the tree-ish, we already know it
298 * matches the pathspec and could just stamp
299 * CE_MATCHED to it from update_some(). But we still
300 * need ps_matched and read_tree_recursive (and
301 * eventually tree_entry_interesting) cannot fill
302 * ps_matched yet. Once it can, we can avoid calling
303 * match_pathspec() for _all_ entries when
304 * opts->source_tree != NULL.
306 if (ce_path_match(ce
, &opts
->pathspec
, ps_matched
))
307 ce
->ce_flags
|= CE_MATCHED
;
310 if (report_path_error(ps_matched
, &opts
->pathspec
, opts
->prefix
)) {
316 /* "checkout -m path" to recreate conflicted state */
318 unmerge_marked_index(&the_index
);
320 /* Any unmerged paths? */
321 for (pos
= 0; pos
< active_nr
; pos
++) {
322 const struct cache_entry
*ce
= active_cache
[pos
];
323 if (ce
->ce_flags
& CE_MATCHED
) {
327 warning(_("path '%s' is unmerged"), ce
->name
);
328 } else if (opts
->writeout_stage
) {
329 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
);
330 } else if (opts
->merge
) {
331 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
334 error(_("path '%s' is unmerged"), ce
->name
);
336 pos
= skip_same_name(ce
, pos
) - 1;
342 /* Now we are committed to check them out */
343 memset(&state
, 0, sizeof(state
));
345 state
.refresh_cache
= 1;
346 state
.istate
= &the_index
;
347 for (pos
= 0; pos
< active_nr
; pos
++) {
348 struct cache_entry
*ce
= active_cache
[pos
];
349 if (ce
->ce_flags
& CE_MATCHED
) {
351 errs
|= checkout_entry(ce
, &state
, NULL
);
354 if (opts
->writeout_stage
)
355 errs
|= checkout_stage(opts
->writeout_stage
, ce
, pos
, &state
);
356 else if (opts
->merge
)
357 errs
|= checkout_merged(pos
, &state
);
358 pos
= skip_same_name(ce
, pos
) - 1;
362 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
363 die(_("unable to write new index file"));
365 read_ref_full("HEAD", 0, rev
, &flag
);
366 head
= lookup_commit_reference_gently(rev
, 1);
368 errs
|= post_checkout_hook(head
, head
, 0);
372 static void show_local_changes(struct object
*head
,
373 const struct diff_options
*opts
)
376 /* I think we want full paths, even if we're in a subdirectory. */
377 init_revisions(&rev
, NULL
);
378 rev
.diffopt
.flags
= opts
->flags
;
379 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
380 diff_setup_done(&rev
.diffopt
);
381 add_pending_object(&rev
, head
, NULL
);
382 run_diff_index(&rev
, 0);
385 static void describe_detached_head(const char *msg
, struct commit
*commit
)
387 struct strbuf sb
= STRBUF_INIT
;
388 if (!parse_commit(commit
))
389 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
390 fprintf(stderr
, "%s %s... %s\n", msg
,
391 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
), sb
.buf
);
395 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
396 int worktree
, int *writeout_error
)
398 struct unpack_trees_options opts
;
399 struct tree_desc tree_desc
;
401 memset(&opts
, 0, sizeof(opts
));
403 opts
.update
= worktree
;
404 opts
.skip_unmerged
= !worktree
;
407 opts
.fn
= oneway_merge
;
408 opts
.verbose_update
= !o
->quiet
&& isatty(2);
409 opts
.src_index
= &the_index
;
410 opts
.dst_index
= &the_index
;
412 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
413 switch (unpack_trees(1, &tree_desc
, &opts
)) {
417 * We return 0 nevertheless, as the index is all right
418 * and more importantly we have made best efforts to
419 * update paths in the work tree, and we cannot revert
430 const char *name
; /* The short name used */
431 const char *path
; /* The full name of a real branch */
432 struct commit
*commit
; /* The named commit */
435 static void setup_branch_path(struct branch_info
*branch
)
437 struct strbuf buf
= STRBUF_INIT
;
439 strbuf_branchname(&buf
, branch
->name
);
440 if (strcmp(buf
.buf
, branch
->name
))
441 branch
->name
= xstrdup(buf
.buf
);
442 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
443 branch
->path
= strbuf_detach(&buf
, NULL
);
446 static int merge_working_tree(const struct checkout_opts
*opts
,
447 struct branch_info
*old
,
448 struct branch_info
*new,
452 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
454 hold_locked_index(lock_file
, 1);
455 if (read_cache_preload(NULL
) < 0)
456 return error(_("corrupt index file"));
458 resolve_undo_clear();
460 ret
= reset_tree(new->commit
->tree
, opts
, 1, writeout_error
);
464 struct tree_desc trees
[2];
466 struct unpack_trees_options topts
;
468 memset(&topts
, 0, sizeof(topts
));
470 topts
.src_index
= &the_index
;
471 topts
.dst_index
= &the_index
;
473 setup_unpack_trees_porcelain(&topts
, "checkout");
475 refresh_cache(REFRESH_QUIET
);
477 if (unmerged_cache()) {
478 error(_("you need to resolve your current index first"));
482 /* 2-way merge to the new branch */
483 topts
.initial_checkout
= is_cache_unborn();
486 topts
.gently
= opts
->merge
&& old
->commit
;
487 topts
.verbose_update
= !opts
->quiet
&& isatty(2);
488 topts
.fn
= twoway_merge
;
489 if (opts
->overwrite_ignore
) {
490 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
491 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
492 setup_standard_excludes(topts
.dir
);
494 tree
= parse_tree_indirect(old
->commit
&& !opts
->new_worktree_mode
?
495 old
->commit
->object
.sha1
:
496 EMPTY_TREE_SHA1_BIN
);
497 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
498 tree
= parse_tree_indirect(new->commit
->object
.sha1
);
499 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
501 ret
= unpack_trees(2, trees
, &topts
);
504 * Unpack couldn't do a trivial merge; either
505 * give up or do a real merge, depending on
506 * whether the merge flag was used.
510 struct merge_options o
;
515 * Without old->commit, the below is the same as
516 * the two-tree unpack we already tried and failed.
521 /* Do more real merge */
524 * We update the index fully, then write the
525 * tree from the index, then merge the new
526 * branch with the current tree, with the old
527 * branch as the base. Then we reset the index
528 * (but not the working tree) to the new
529 * branch, leaving the working tree as the
530 * merged version, but skipping unmerged
531 * entries in the index.
534 add_files_to_cache(NULL
, NULL
, 0);
536 * NEEDSWORK: carrying over local changes
537 * when branches have different end-of-line
538 * normalization (or clean+smudge rules) is
539 * a pain; plumb in an option to set
542 init_merge_options(&o
);
544 work
= write_tree_from_memory(&o
);
546 ret
= reset_tree(new->commit
->tree
, opts
, 1,
550 o
.ancestor
= old
->name
;
551 o
.branch1
= new->name
;
553 merge_trees(&o
, new->commit
->tree
, work
,
554 old
->commit
->tree
, &result
);
555 ret
= reset_tree(new->commit
->tree
, opts
, 0,
562 if (!active_cache_tree
)
563 active_cache_tree
= cache_tree();
565 if (!cache_tree_fully_valid(active_cache_tree
))
566 cache_tree_update(&the_index
, WRITE_TREE_SILENT
| WRITE_TREE_REPAIR
);
568 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
569 die(_("unable to write new index file"));
571 if (!opts
->force
&& !opts
->quiet
)
572 show_local_changes(&new->commit
->object
, &opts
->diff_options
);
577 static void report_tracking(struct branch_info
*new)
579 struct strbuf sb
= STRBUF_INIT
;
580 struct branch
*branch
= branch_get(new->name
);
582 if (!format_tracking_info(branch
, &sb
))
584 fputs(sb
.buf
, stdout
);
588 static void update_refs_for_switch(const struct checkout_opts
*opts
,
589 struct branch_info
*old
,
590 struct branch_info
*new)
592 struct strbuf msg
= STRBUF_INIT
;
593 const char *old_desc
, *reflog_msg
;
594 if (opts
->new_branch
) {
595 if (opts
->new_orphan_branch
) {
596 if (opts
->new_branch_log
&& !log_all_ref_updates
) {
598 struct strbuf log_file
= STRBUF_INIT
;
600 const char *ref_name
;
602 ref_name
= mkpath("refs/heads/%s", opts
->new_orphan_branch
);
603 temp
= log_all_ref_updates
;
604 log_all_ref_updates
= 1;
605 ret
= log_ref_setup(ref_name
, &log_file
);
606 log_all_ref_updates
= temp
;
607 strbuf_release(&log_file
);
609 fprintf(stderr
, _("Can not do reflog for '%s'\n"),
610 opts
->new_orphan_branch
);
616 create_branch(old
->name
, opts
->new_branch
, new->name
,
617 opts
->new_branch_force
? 1 : 0,
618 opts
->new_branch_log
,
619 opts
->new_branch_force
? 1 : 0,
622 new->name
= opts
->new_branch
;
623 setup_branch_path(new);
626 old_desc
= old
->name
;
627 if (!old_desc
&& old
->commit
)
628 old_desc
= sha1_to_hex(old
->commit
->object
.sha1
);
630 reflog_msg
= getenv("GIT_REFLOG_ACTION");
632 strbuf_addf(&msg
, "checkout: moving from %s to %s",
633 old_desc
? old_desc
: "(invalid)", new->name
);
635 strbuf_insert(&msg
, 0, reflog_msg
, strlen(reflog_msg
));
637 if (!strcmp(new->name
, "HEAD") && !new->path
&& !opts
->force_detach
) {
639 } else if (opts
->force_detach
|| !new->path
) { /* No longer on any branch. */
640 update_ref(msg
.buf
, "HEAD", new->commit
->object
.sha1
, NULL
,
641 REF_NODEREF
, UPDATE_REFS_DIE_ON_ERR
);
643 if (old
->path
&& advice_detached_head
)
644 detach_advice(new->name
);
645 describe_detached_head(_("HEAD is now at"), new->commit
);
647 } else if (new->path
) { /* Switch branches. */
648 create_symref("HEAD", new->path
, msg
.buf
);
650 if (old
->path
&& !strcmp(new->path
, old
->path
)) {
651 if (opts
->new_branch_force
)
652 fprintf(stderr
, _("Reset branch '%s'\n"),
655 fprintf(stderr
, _("Already on '%s'\n"),
657 } else if (opts
->new_branch
) {
658 if (opts
->branch_exists
)
659 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new->name
);
661 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new->name
);
663 fprintf(stderr
, _("Switched to branch '%s'\n"),
667 if (old
->path
&& old
->name
) {
668 if (!ref_exists(old
->path
) && reflog_exists(old
->path
))
669 delete_reflog(old
->path
);
672 remove_branch_state();
673 strbuf_release(&msg
);
675 (new->path
|| (!opts
->force_detach
&& !strcmp(new->name
, "HEAD"))))
676 report_tracking(new);
679 static int add_pending_uninteresting_ref(const char *refname
,
680 const unsigned char *sha1
,
681 int flags
, void *cb_data
)
683 add_pending_sha1(cb_data
, refname
, sha1
, UNINTERESTING
);
687 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
689 strbuf_addstr(sb
, " ");
691 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
692 strbuf_addch(sb
, ' ');
693 if (!parse_commit(commit
))
694 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
695 strbuf_addch(sb
, '\n');
698 #define ORPHAN_CUTOFF 4
699 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
701 struct commit
*c
, *last
= NULL
;
702 struct strbuf sb
= STRBUF_INIT
;
704 while ((c
= get_revision(revs
)) != NULL
) {
705 if (lost
< ORPHAN_CUTOFF
)
706 describe_one_orphan(&sb
, c
);
710 if (ORPHAN_CUTOFF
< lost
) {
711 int more
= lost
- ORPHAN_CUTOFF
;
713 describe_one_orphan(&sb
, last
);
715 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
720 /* The singular version */
721 "Warning: you are leaving %d commit behind, "
723 "any of your branches:\n\n"
725 /* The plural version */
726 "Warning: you are leaving %d commits behind, "
728 "any of your branches:\n\n"
730 /* Give ngettext() the count */
736 if (advice_detached_head
)
739 "If you want to keep them by creating a new branch, "
740 "this may be a good time\nto do so with:\n\n"
741 " git branch new_branch_name %s\n\n"),
742 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
746 * We are about to leave commit that was at the tip of a detached
747 * HEAD. If it is not reachable from any ref, this is the last chance
748 * for the user to do so without resorting to reflog.
750 static void orphaned_commit_warning(struct commit
*old
, struct commit
*new)
752 struct rev_info revs
;
753 struct object
*object
= &old
->object
;
754 struct object_array refs
;
756 init_revisions(&revs
, NULL
);
757 setup_revisions(0, NULL
, &revs
, NULL
);
759 object
->flags
&= ~UNINTERESTING
;
760 add_pending_object(&revs
, object
, sha1_to_hex(object
->sha1
));
762 for_each_ref(add_pending_uninteresting_ref
, &revs
);
763 add_pending_sha1(&revs
, "HEAD", new->object
.sha1
, UNINTERESTING
);
766 revs
.leak_pending
= 1;
768 if (prepare_revision_walk(&revs
))
769 die(_("internal error in revision walk"));
770 if (!(old
->object
.flags
& UNINTERESTING
))
771 suggest_reattach(old
, &revs
);
773 describe_detached_head(_("Previous HEAD position was"), old
);
775 clear_commit_marks_for_object_array(&refs
, ALL_REV_FLAGS
);
779 static int switch_branches(const struct checkout_opts
*opts
,
780 struct branch_info
*new)
783 struct branch_info old
;
785 unsigned char rev
[20];
786 int flag
, writeout_error
= 0;
787 memset(&old
, 0, sizeof(old
));
788 old
.path
= path_to_free
= resolve_refdup("HEAD", 0, rev
, &flag
);
789 old
.commit
= lookup_commit_reference_gently(rev
, 1);
790 if (!(flag
& REF_ISSYMREF
))
794 skip_prefix(old
.path
, "refs/heads/", &old
.name
);
798 new->commit
= old
.commit
;
800 die(_("You are on a branch yet to be born"));
801 parse_commit_or_die(new->commit
);
804 ret
= merge_working_tree(opts
, &old
, new, &writeout_error
);
810 if (!opts
->quiet
&& !old
.path
&& old
.commit
&&
811 new->commit
!= old
.commit
&& !opts
->new_worktree_mode
)
812 orphaned_commit_warning(old
.commit
, new->commit
);
814 update_refs_for_switch(opts
, &old
, new);
816 ret
= post_checkout_hook(old
.commit
, new->commit
, 1);
818 return ret
|| writeout_error
;
821 static int prepare_linked_checkout(const struct checkout_opts
*opts
,
822 struct branch_info
*new)
824 struct strbuf sb_git
= STRBUF_INIT
, sb_repo
= STRBUF_INIT
;
825 struct strbuf sb
= STRBUF_INIT
;
826 const char *path
= opts
->new_worktree
, *name
;
828 struct child_process cp
;
829 int counter
= 0, len
;
832 die(_("no branch specified"));
833 if (file_exists(path
))
834 die(_("'%s' already exists"), path
);
837 while (len
&& is_dir_sep(path
[len
- 1]))
840 for (name
= path
+ len
- 1; name
> path
; name
--)
841 if (is_dir_sep(*name
)) {
845 strbuf_addstr(&sb_repo
,
846 git_path("worktrees/%.*s", (int)(path
+ len
- name
), name
));
848 if (safe_create_leading_directories_const(sb_repo
.buf
))
849 die_errno(_("could not create leading directories of '%s'"),
851 while (!stat(sb_repo
.buf
, &st
)) {
853 strbuf_setlen(&sb_repo
, len
);
854 strbuf_addf(&sb_repo
, "%d", counter
);
856 name
= strrchr(sb_repo
.buf
, '/') + 1;
857 if (mkdir(sb_repo
.buf
, 0777))
858 die_errno(_("could not create directory of '%s'"), sb_repo
.buf
);
860 strbuf_addf(&sb_git
, "%s/.git", path
);
861 if (safe_create_leading_directories_const(sb_git
.buf
))
862 die_errno(_("could not create leading directories of '%s'"),
865 write_file(sb_git
.buf
, 1, "gitdir: %s/worktrees/%s\n",
866 real_path(get_git_common_dir()), name
);
868 * This is to keep resolve_ref() happy. We need a valid HEAD
869 * or is_git_directory() will reject the directory. Any valid
870 * value would do because this value will be ignored and
871 * replaced at the next (real) checkout.
873 strbuf_addf(&sb
, "%s/HEAD", sb_repo
.buf
);
874 write_file(sb
.buf
, 1, "%s\n", sha1_to_hex(new->commit
->object
.sha1
));
876 strbuf_addf(&sb
, "%s/commondir", sb_repo
.buf
);
877 write_file(sb
.buf
, 1, "../..\n");
880 fprintf_ln(stderr
, _("Enter %s (identifier %s)"), path
, name
);
882 setenv("GIT_CHECKOUT_NEW_WORKTREE", "1", 1);
883 setenv(GIT_DIR_ENVIRONMENT
, sb_git
.buf
, 1);
884 setenv(GIT_WORK_TREE_ENVIRONMENT
, path
, 1);
885 memset(&cp
, 0, sizeof(cp
));
887 cp
.argv
= opts
->saved_argv
;
888 return run_command(&cp
);
891 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
893 if (!strcmp(var
, "diff.ignoresubmodules")) {
894 struct checkout_opts
*opts
= cb
;
895 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
899 if (starts_with(var
, "submodule."))
900 return parse_submodule_config_option(var
, value
);
902 return git_xmerge_config(var
, value
, NULL
);
905 struct tracking_name_data
{
906 /* const */ char *src_ref
;
908 unsigned char *dst_sha1
;
912 static int check_tracking_name(struct remote
*remote
, void *cb_data
)
914 struct tracking_name_data
*cb
= cb_data
;
915 struct refspec query
;
916 memset(&query
, 0, sizeof(struct refspec
));
917 query
.src
= cb
->src_ref
;
918 if (remote_find_tracking(remote
, &query
) ||
919 get_sha1(query
.dst
, cb
->dst_sha1
)) {
928 cb
->dst_ref
= query
.dst
;
932 static const char *unique_tracking_name(const char *name
, unsigned char *sha1
)
934 struct tracking_name_data cb_data
= { NULL
, NULL
, NULL
, 1 };
935 char src_ref
[PATH_MAX
];
936 snprintf(src_ref
, PATH_MAX
, "refs/heads/%s", name
);
937 cb_data
.src_ref
= src_ref
;
938 cb_data
.dst_sha1
= sha1
;
939 for_each_remote(check_tracking_name
, &cb_data
);
941 return cb_data
.dst_ref
;
942 free(cb_data
.dst_ref
);
946 static int parse_branchname_arg(int argc
, const char **argv
,
947 int dwim_new_local_branch_ok
,
948 struct branch_info
*new,
949 struct tree
**source_tree
,
950 unsigned char rev
[20],
951 const char **new_branch
)
954 unsigned char branch_rev
[20];
957 int has_dash_dash
= 0;
961 * case 1: git checkout <ref> -- [<paths>]
963 * <ref> must be a valid tree, everything after the '--' must be
966 * case 2: git checkout -- [<paths>]
968 * everything after the '--' must be paths.
970 * case 3: git checkout <something> [--]
972 * (a) If <something> is a commit, that is to
973 * switch to the branch or detach HEAD at it. As a special case,
974 * if <something> is A...B (missing A or B means HEAD but you can
975 * omit at most one side), and if there is a unique merge base
976 * between A and B, A...B names that merge base.
978 * (b) If <something> is _not_ a commit, either "--" is present
979 * or <something> is not a path, no -t or -b was given, and
980 * and there is a tracking branch whose name is <something>
981 * in one and only one remote, then this is a short-hand to
982 * fork local <something> from that remote-tracking branch.
984 * (c) Otherwise, if "--" is present, treat it like case (1).
987 * - if it's a reference, treat it like case (1)
988 * - else if it's a path, treat it like case (2)
991 * case 4: git checkout <something> <paths>
993 * The first argument must not be ambiguous.
994 * - If it's *only* a reference, treat it like case (1).
995 * - If it's only a path, treat it like case (2).
1004 for (i
= 0; i
< argc
; i
++) {
1005 if (!strcmp(argv
[i
], "--")) {
1010 if (dash_dash_pos
== 0)
1011 return 1; /* case (2) */
1012 else if (dash_dash_pos
== 1)
1013 has_dash_dash
= 1; /* case (3) or (1) */
1014 else if (dash_dash_pos
>= 2)
1015 die(_("only one reference expected, %d given."), dash_dash_pos
);
1017 if (!strcmp(arg
, "-"))
1020 if (get_sha1_mb(arg
, rev
)) {
1022 * Either case (3) or (4), with <something> not being
1023 * a commit, or an attempt to use case (1) with an
1026 * It's likely an error, but we need to find out if
1027 * we should auto-create the branch, case (3).(b).
1029 int recover_with_dwim
= dwim_new_local_branch_ok
;
1031 if (check_filename(NULL
, arg
) && !has_dash_dash
)
1032 recover_with_dwim
= 0;
1034 * Accept "git checkout foo" and "git checkout foo --"
1035 * as candidates for dwim.
1037 if (!(argc
== 1 && !has_dash_dash
) &&
1038 !(argc
== 2 && has_dash_dash
))
1039 recover_with_dwim
= 0;
1041 if (recover_with_dwim
) {
1042 const char *remote
= unique_tracking_name(arg
, rev
);
1046 /* DWIMmed to create local branch, case (3).(b) */
1048 recover_with_dwim
= 0;
1052 if (!recover_with_dwim
) {
1054 die(_("invalid reference: %s"), arg
);
1059 /* we can't end up being in (2) anymore, eat the argument */
1065 setup_branch_path(new);
1067 if (!check_refname_format(new->path
, 0) &&
1068 !read_ref(new->path
, branch_rev
))
1069 hashcpy(rev
, branch_rev
);
1071 new->path
= NULL
; /* not an existing branch */
1073 new->commit
= lookup_commit_reference_gently(rev
, 1);
1076 *source_tree
= parse_tree_indirect(rev
);
1078 parse_commit_or_die(new->commit
);
1079 *source_tree
= new->commit
->tree
;
1082 if (!*source_tree
) /* case (1): want a tree */
1083 die(_("reference is not a tree: %s"), arg
);
1084 if (!has_dash_dash
) {/* case (3).(d) -> (1) */
1086 * Do not complain the most common case
1087 * git checkout branch
1088 * even if there happen to be a file called 'branch';
1089 * it would be extremely annoying.
1092 verify_non_filename(NULL
, arg
);
1102 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1105 struct strbuf branch_ref
= STRBUF_INIT
;
1107 if (!opts
->new_branch
)
1108 die(_("You are on a branch yet to be born"));
1109 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1110 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1111 strbuf_release(&branch_ref
);
1113 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1118 static int checkout_branch(struct checkout_opts
*opts
,
1119 struct branch_info
*new)
1121 if (opts
->pathspec
.nr
)
1122 die(_("paths cannot be used with switching branches"));
1124 if (opts
->patch_mode
)
1125 die(_("'%s' cannot be used with switching branches"),
1128 if (opts
->writeout_stage
)
1129 die(_("'%s' cannot be used with switching branches"),
1132 if (opts
->force
&& opts
->merge
)
1133 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1135 if (opts
->force_detach
&& opts
->new_branch
)
1136 die(_("'%s' cannot be used with '%s'"),
1137 "--detach", "-b/-B/--orphan");
1139 if (opts
->new_orphan_branch
) {
1140 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1141 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1142 } else if (opts
->force_detach
) {
1143 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1144 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1145 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1146 opts
->track
= git_branch_track
;
1148 if (new->name
&& !new->commit
)
1149 die(_("Cannot switch branch to a non-commit '%s'"),
1152 if (opts
->new_worktree
)
1153 return prepare_linked_checkout(opts
, new);
1155 if (!new->commit
&& opts
->new_branch
) {
1156 unsigned char rev
[20];
1159 if (!read_ref_full("HEAD", 0, rev
, &flag
) &&
1160 (flag
& REF_ISSYMREF
) && is_null_sha1(rev
))
1161 return switch_unborn_to_new_branch(opts
);
1163 return switch_branches(opts
, new);
1166 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1168 struct checkout_opts opts
;
1169 struct branch_info
new;
1170 char *conflict_style
= NULL
;
1171 int dwim_new_local_branch
= 1;
1172 struct option options
[] = {
1173 OPT__QUIET(&opts
.quiet
, N_("suppress progress reporting")),
1174 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1175 N_("create and checkout a new branch")),
1176 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1177 N_("create/reset and checkout a branch")),
1178 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1179 OPT_BOOL(0, "detach", &opts
.force_detach
, N_("detach the HEAD at named commit")),
1180 OPT_SET_INT('t', "track", &opts
.track
, N_("set upstream info for new branch"),
1181 BRANCH_TRACK_EXPLICIT
),
1182 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1183 OPT_SET_INT('2', "ours", &opts
.writeout_stage
, N_("checkout our version for unmerged files"),
1185 OPT_SET_INT('3', "theirs", &opts
.writeout_stage
, N_("checkout their version for unmerged files"),
1187 OPT__FORCE(&opts
.force
, N_("force checkout (throw away local modifications)")),
1188 OPT_BOOL('m', "merge", &opts
.merge
, N_("perform a 3-way merge with the new branch")),
1189 OPT_BOOL(0, "overwrite-ignore", &opts
.overwrite_ignore
, N_("update ignored files (default)")),
1190 OPT_STRING(0, "conflict", &conflict_style
, N_("style"),
1191 N_("conflict style (merge or diff3)")),
1192 OPT_BOOL('p', "patch", &opts
.patch_mode
, N_("select hunks interactively")),
1193 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
.ignore_skipworktree
,
1194 N_("do not limit pathspecs to sparse entries only")),
1195 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch
,
1196 N_("second guess 'git checkout no-such-branch'")),
1197 OPT_FILENAME(0, "to", &opts
.new_worktree
,
1198 N_("check a branch out in a separate working directory")),
1202 memset(&opts
, 0, sizeof(opts
));
1203 memset(&new, 0, sizeof(new));
1204 opts
.overwrite_ignore
= 1;
1205 opts
.prefix
= prefix
;
1207 opts
.saved_argv
= xmalloc(sizeof(const char *) * (argc
+ 2));
1208 memcpy(opts
.saved_argv
, argv
, sizeof(const char *) * (argc
+ 1));
1210 gitmodules_config();
1211 git_config(git_checkout_config
, &opts
);
1213 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
1215 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
1216 PARSE_OPT_KEEP_DASHDASH
);
1218 /* recursive execution from checkout_new_worktree() */
1219 opts
.new_worktree_mode
= getenv("GIT_CHECKOUT_NEW_WORKTREE") != NULL
;
1220 if (opts
.new_worktree_mode
)
1221 opts
.new_worktree
= NULL
;
1223 if (conflict_style
) {
1224 opts
.merge
= 1; /* implied */
1225 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1228 if ((!!opts
.new_branch
+ !!opts
.new_branch_force
+ !!opts
.new_orphan_branch
) > 1)
1229 die(_("-b, -B and --orphan are mutually exclusive"));
1232 * From here on, new_branch will contain the branch to be checked out,
1233 * and new_branch_force and new_orphan_branch will tell us which one of
1234 * -b/-B/--orphan is being used.
1236 if (opts
.new_branch_force
)
1237 opts
.new_branch
= opts
.new_branch_force
;
1239 if (opts
.new_orphan_branch
)
1240 opts
.new_branch
= opts
.new_orphan_branch
;
1242 /* --track without -b/-B/--orphan should DWIM */
1243 if (opts
.track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
.new_branch
) {
1244 const char *argv0
= argv
[0];
1245 if (!argc
|| !strcmp(argv0
, "--"))
1246 die (_("--track needs a branch name"));
1247 skip_prefix(argv0
, "refs/", &argv0
);
1248 skip_prefix(argv0
, "remotes/", &argv0
);
1249 argv0
= strchr(argv0
, '/');
1250 if (!argv0
|| !argv0
[1])
1251 die (_("Missing branch name; try -b"));
1252 opts
.new_branch
= argv0
+ 1;
1256 * Extract branch name from command line arguments, so
1257 * all that is left is pathspecs.
1261 * 1) git checkout <tree> -- [<paths>]
1262 * 2) git checkout -- [<paths>]
1263 * 3) git checkout <something> [<paths>]
1265 * including "last branch" syntax and DWIM-ery for names of
1266 * remote branches, erroring out for invalid or ambiguous cases.
1269 unsigned char rev
[20];
1272 dwim_new_local_branch
&&
1273 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1275 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1276 &new, &opts
.source_tree
,
1277 rev
, &opts
.new_branch
);
1283 parse_pathspec(&opts
.pathspec
, 0,
1284 opts
.patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1287 if (!opts
.pathspec
.nr
)
1288 die(_("invalid path specification"));
1291 * Try to give more helpful suggestion.
1292 * new_branch && argc > 1 will be caught later.
1294 if (opts
.new_branch
&& argc
== 1)
1295 die(_("Cannot update paths and switch to branch '%s' at the same time.\n"
1296 "Did you intend to checkout '%s' which can not be resolved as commit?"),
1297 opts
.new_branch
, argv
[0]);
1299 if (opts
.force_detach
)
1300 die(_("git checkout: --detach does not take a path argument '%s'"),
1303 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1304 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1305 "checking out of the index."));
1308 if (opts
.new_branch
) {
1309 struct strbuf buf
= STRBUF_INIT
;
1311 opts
.branch_exists
=
1312 validate_new_branchname(opts
.new_branch
, &buf
,
1313 !!opts
.new_branch_force
,
1314 !!opts
.new_branch_force
);
1316 strbuf_release(&buf
);
1319 if (opts
.patch_mode
|| opts
.pathspec
.nr
)
1320 return checkout_paths(&opts
, new.name
);
1322 return checkout_branch(&opts
, &new);