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"
25 static const char * const checkout_usage
[] = {
26 N_("git checkout [options] <branch>"),
27 N_("git checkout [options] [<branch>] -- <file>..."),
31 struct checkout_opts
{
39 int ignore_skipworktree
;
41 const char *new_branch
;
42 const char *new_branch_force
;
43 const char *new_orphan_branch
;
45 enum branch_track track
;
46 struct diff_options diff_options
;
50 struct pathspec pathspec
;
51 struct tree
*source_tree
;
53 const char *new_worktree
;
54 const char **saved_argv
;
55 int new_worktree_mode
;
58 static int post_checkout_hook(struct commit
*old
, struct commit
*new,
61 return run_hook_le(NULL
, "post-checkout",
62 sha1_to_hex(old
? old
->object
.sha1
: null_sha1
),
63 sha1_to_hex(new ? new->object
.sha1
: null_sha1
),
64 changed
? "1" : "0", NULL
);
65 /* "new" can be NULL when checking out from the index before
70 static int update_some(const unsigned char *sha1
, const char *base
, int baselen
,
71 const char *pathname
, unsigned mode
, int stage
, void *context
)
74 struct cache_entry
*ce
;
77 return READ_TREE_RECURSIVE
;
79 len
= baselen
+ strlen(pathname
);
80 ce
= xcalloc(1, cache_entry_size(len
));
81 hashcpy(ce
->sha1
, sha1
);
82 memcpy(ce
->name
, base
, baselen
);
83 memcpy(ce
->name
+ baselen
, pathname
, len
- baselen
);
84 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
86 ce
->ce_mode
= create_ce_mode(mode
);
87 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
91 static int read_tree_some(struct tree
*tree
, const struct pathspec
*pathspec
)
93 read_tree_recursive(tree
, "", 0, 0, pathspec
, update_some
, NULL
);
95 /* update the index with the given tree's info
96 * for all args, expanding wildcards, and exit
97 * with any non-zero return code.
102 static int skip_same_name(const struct cache_entry
*ce
, int pos
)
104 while (++pos
< active_nr
&&
105 !strcmp(active_cache
[pos
]->name
, ce
->name
))
110 static int check_stage(int stage
, const struct cache_entry
*ce
, int pos
)
112 while (pos
< active_nr
&&
113 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
114 if (ce_stage(active_cache
[pos
]) == stage
)
119 return error(_("path '%s' does not have our version"), ce
->name
);
121 return error(_("path '%s' does not have their version"), ce
->name
);
124 static int check_stages(unsigned stages
, const struct cache_entry
*ce
, int pos
)
127 const char *name
= ce
->name
;
129 while (pos
< active_nr
) {
130 ce
= active_cache
[pos
];
131 if (strcmp(name
, ce
->name
))
133 seen
|= (1 << ce_stage(ce
));
136 if ((stages
& seen
) != stages
)
137 return error(_("path '%s' does not have all necessary versions"),
142 static int checkout_stage(int stage
, struct cache_entry
*ce
, int pos
,
143 struct checkout
*state
)
145 while (pos
< active_nr
&&
146 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
147 if (ce_stage(active_cache
[pos
]) == stage
)
148 return checkout_entry(active_cache
[pos
], state
, NULL
);
152 return error(_("path '%s' does not have our version"), ce
->name
);
154 return error(_("path '%s' does not have their version"), ce
->name
);
157 static int checkout_merged(int pos
, struct checkout
*state
)
159 struct cache_entry
*ce
= active_cache
[pos
];
160 const char *path
= ce
->name
;
161 mmfile_t ancestor
, ours
, theirs
;
163 unsigned char sha1
[20];
164 mmbuffer_t result_buf
;
165 unsigned char threeway
[3][20];
168 memset(threeway
, 0, sizeof(threeway
));
169 while (pos
< active_nr
) {
171 stage
= ce_stage(ce
);
172 if (!stage
|| strcmp(path
, ce
->name
))
174 hashcpy(threeway
[stage
- 1], ce
->sha1
);
176 mode
= create_ce_mode(ce
->ce_mode
);
178 ce
= active_cache
[pos
];
180 if (is_null_sha1(threeway
[1]) || is_null_sha1(threeway
[2]))
181 return error(_("path '%s' does not have necessary versions"), path
);
183 read_mmblob(&ancestor
, threeway
[0]);
184 read_mmblob(&ours
, threeway
[1]);
185 read_mmblob(&theirs
, threeway
[2]);
188 * NEEDSWORK: re-create conflicts from merges with
189 * merge.renormalize set, too
191 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
192 &ours
, "ours", &theirs
, "theirs", NULL
);
196 if (status
< 0 || !result_buf
.ptr
) {
197 free(result_buf
.ptr
);
198 return error(_("path '%s': cannot merge"), path
);
203 * There is absolutely no reason to write this as a blob object
204 * and create a phony cache entry just to leak. This hack is
205 * primarily to get to the write_entry() machinery that massages
206 * the contents to work-tree format and writes out which only
207 * allows it for a cache entry. The code in write_entry() needs
208 * to be refactored to allow us to feed a <buffer, size, mode>
209 * instead of a cache entry. Such a refactoring would help
210 * merge_recursive as well (it also writes the merge result to the
211 * object database even when it may contain conflicts).
213 if (write_sha1_file(result_buf
.ptr
, result_buf
.size
,
215 die(_("Unable to add merge result for '%s'"), path
);
216 ce
= make_cache_entry(mode
, sha1
, path
, 2, 0);
218 die(_("make_cache_entry failed for path '%s'"), path
);
219 status
= checkout_entry(ce
, state
, NULL
);
223 static int checkout_paths(const struct checkout_opts
*opts
,
224 const char *revision
)
227 struct checkout state
;
228 static char *ps_matched
;
229 unsigned char rev
[20];
234 struct lock_file
*lock_file
;
236 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
237 die(_("'%s' cannot be used with updating paths"), "--track");
239 if (opts
->new_branch_log
)
240 die(_("'%s' cannot be used with updating paths"), "-l");
242 if (opts
->force
&& opts
->patch_mode
)
243 die(_("'%s' cannot be used with updating paths"), "-f");
245 if (opts
->force_detach
)
246 die(_("'%s' cannot be used with updating paths"), "--detach");
248 if (opts
->merge
&& opts
->patch_mode
)
249 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
251 if (opts
->force
&& opts
->merge
)
252 die(_("'%s' cannot be used with %s"), "-f", "-m");
254 if (opts
->new_branch
)
255 die(_("Cannot update paths and switch to branch '%s' at the same time."),
258 if (opts
->new_worktree
)
259 die(_("'%s' cannot be used with updating paths"), "--to");
261 if (opts
->patch_mode
)
262 return run_add_interactive(revision
, "--patch=checkout",
265 lock_file
= xcalloc(1, sizeof(struct lock_file
));
267 newfd
= hold_locked_index(lock_file
, 1);
268 if (read_cache_preload(&opts
->pathspec
) < 0)
269 return error(_("corrupt index file"));
271 if (opts
->source_tree
)
272 read_tree_some(opts
->source_tree
, &opts
->pathspec
);
274 ps_matched
= xcalloc(1, opts
->pathspec
.nr
);
277 * Make sure all pathspecs participated in locating the paths
280 for (pos
= 0; pos
< active_nr
; pos
++) {
281 struct cache_entry
*ce
= active_cache
[pos
];
282 ce
->ce_flags
&= ~CE_MATCHED
;
283 if (!opts
->ignore_skipworktree
&& ce_skip_worktree(ce
))
285 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
287 * "git checkout tree-ish -- path", but this entry
288 * is in the original index; it will not be checked
289 * out to the working tree and it does not matter
290 * if pathspec matched this entry. We will not do
291 * anything to this entry at all.
295 * Either this entry came from the tree-ish we are
296 * checking the paths out of, or we are checking out
299 * If it comes from the tree-ish, we already know it
300 * matches the pathspec and could just stamp
301 * CE_MATCHED to it from update_some(). But we still
302 * need ps_matched and read_tree_recursive (and
303 * eventually tree_entry_interesting) cannot fill
304 * ps_matched yet. Once it can, we can avoid calling
305 * match_pathspec() for _all_ entries when
306 * opts->source_tree != NULL.
308 if (ce_path_match(ce
, &opts
->pathspec
, ps_matched
))
309 ce
->ce_flags
|= CE_MATCHED
;
312 if (report_path_error(ps_matched
, &opts
->pathspec
, opts
->prefix
)) {
318 /* "checkout -m path" to recreate conflicted state */
320 unmerge_marked_index(&the_index
);
322 /* Any unmerged paths? */
323 for (pos
= 0; pos
< active_nr
; pos
++) {
324 const struct cache_entry
*ce
= active_cache
[pos
];
325 if (ce
->ce_flags
& CE_MATCHED
) {
329 warning(_("path '%s' is unmerged"), ce
->name
);
330 } else if (opts
->writeout_stage
) {
331 errs
|= check_stage(opts
->writeout_stage
, ce
, pos
);
332 } else if (opts
->merge
) {
333 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
336 error(_("path '%s' is unmerged"), ce
->name
);
338 pos
= skip_same_name(ce
, pos
) - 1;
344 /* Now we are committed to check them out */
345 memset(&state
, 0, sizeof(state
));
347 state
.refresh_cache
= 1;
348 for (pos
= 0; pos
< active_nr
; pos
++) {
349 struct cache_entry
*ce
= active_cache
[pos
];
350 if (ce
->ce_flags
& CE_MATCHED
) {
352 errs
|= checkout_entry(ce
, &state
, NULL
);
355 if (opts
->writeout_stage
)
356 errs
|= checkout_stage(opts
->writeout_stage
, ce
, pos
, &state
);
357 else if (opts
->merge
)
358 errs
|= checkout_merged(pos
, &state
);
359 pos
= skip_same_name(ce
, pos
) - 1;
363 if (write_cache(newfd
, active_cache
, active_nr
) ||
364 commit_locked_index(lock_file
))
365 die(_("unable to write new index file"));
367 read_ref_full("HEAD", rev
, 0, &flag
);
368 head
= lookup_commit_reference_gently(rev
, 1);
370 errs
|= post_checkout_hook(head
, head
, 0);
374 static void show_local_changes(struct object
*head
,
375 const struct diff_options
*opts
)
378 /* I think we want full paths, even if we're in a subdirectory. */
379 init_revisions(&rev
, NULL
);
380 rev
.diffopt
.flags
= opts
->flags
;
381 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
382 diff_setup_done(&rev
.diffopt
);
383 add_pending_object(&rev
, head
, NULL
);
384 run_diff_index(&rev
, 0);
387 static void describe_detached_head(const char *msg
, struct commit
*commit
)
389 struct strbuf sb
= STRBUF_INIT
;
390 if (!parse_commit(commit
))
391 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
392 fprintf(stderr
, "%s %s... %s\n", msg
,
393 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
), sb
.buf
);
397 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
398 int worktree
, int *writeout_error
)
400 struct unpack_trees_options opts
;
401 struct tree_desc tree_desc
;
403 memset(&opts
, 0, sizeof(opts
));
405 opts
.update
= worktree
;
406 opts
.skip_unmerged
= !worktree
;
409 opts
.fn
= oneway_merge
;
410 opts
.verbose_update
= !o
->quiet
&& isatty(2);
411 opts
.src_index
= &the_index
;
412 opts
.dst_index
= &the_index
;
414 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
415 switch (unpack_trees(1, &tree_desc
, &opts
)) {
419 * We return 0 nevertheless, as the index is all right
420 * and more importantly we have made best efforts to
421 * update paths in the work tree, and we cannot revert
432 const char *name
; /* The short name used */
433 const char *path
; /* The full name of a real branch */
434 struct commit
*commit
; /* The named commit */
436 * if not null the branch is detached because it's already
437 * checked out in this checkout
442 static void setup_branch_path(struct branch_info
*branch
)
444 struct strbuf buf
= STRBUF_INIT
;
446 strbuf_branchname(&buf
, branch
->name
);
447 if (strcmp(buf
.buf
, branch
->name
))
448 branch
->name
= xstrdup(buf
.buf
);
449 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
450 branch
->path
= strbuf_detach(&buf
, NULL
);
453 static int merge_working_tree(const struct checkout_opts
*opts
,
454 struct branch_info
*old
,
455 struct branch_info
*new,
459 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
460 int newfd
= hold_locked_index(lock_file
, 1);
462 if (read_cache_preload(NULL
) < 0)
463 return error(_("corrupt index file"));
465 resolve_undo_clear();
467 ret
= reset_tree(new->commit
->tree
, opts
, 1, writeout_error
);
471 struct tree_desc trees
[2];
473 struct unpack_trees_options topts
;
475 memset(&topts
, 0, sizeof(topts
));
477 topts
.src_index
= &the_index
;
478 topts
.dst_index
= &the_index
;
480 setup_unpack_trees_porcelain(&topts
, "checkout");
482 refresh_cache(REFRESH_QUIET
);
484 if (unmerged_cache()) {
485 error(_("you need to resolve your current index first"));
489 /* 2-way merge to the new branch */
490 topts
.initial_checkout
= is_cache_unborn();
493 topts
.gently
= opts
->merge
&& old
->commit
;
494 topts
.verbose_update
= !opts
->quiet
&& isatty(2);
495 topts
.fn
= twoway_merge
;
496 if (opts
->overwrite_ignore
) {
497 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
498 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
499 setup_standard_excludes(topts
.dir
);
501 tree
= parse_tree_indirect(old
->commit
&& !opts
->new_worktree_mode
?
502 old
->commit
->object
.sha1
:
503 EMPTY_TREE_SHA1_BIN
);
504 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
505 tree
= parse_tree_indirect(new->commit
->object
.sha1
);
506 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
508 ret
= unpack_trees(2, trees
, &topts
);
511 * Unpack couldn't do a trivial merge; either
512 * give up or do a real merge, depending on
513 * whether the merge flag was used.
517 struct merge_options o
;
522 * Without old->commit, the below is the same as
523 * the two-tree unpack we already tried and failed.
528 /* Do more real merge */
531 * We update the index fully, then write the
532 * tree from the index, then merge the new
533 * branch with the current tree, with the old
534 * branch as the base. Then we reset the index
535 * (but not the working tree) to the new
536 * branch, leaving the working tree as the
537 * merged version, but skipping unmerged
538 * entries in the index.
541 add_files_to_cache(NULL
, NULL
, 0);
543 * NEEDSWORK: carrying over local changes
544 * when branches have different end-of-line
545 * normalization (or clean+smudge rules) is
546 * a pain; plumb in an option to set
549 init_merge_options(&o
);
551 work
= write_tree_from_memory(&o
);
553 ret
= reset_tree(new->commit
->tree
, opts
, 1,
557 o
.ancestor
= old
->name
;
558 o
.branch1
= new->name
;
560 merge_trees(&o
, new->commit
->tree
, work
,
561 old
->commit
->tree
, &result
);
562 ret
= reset_tree(new->commit
->tree
, opts
, 0,
569 if (write_cache(newfd
, active_cache
, active_nr
) ||
570 commit_locked_index(lock_file
))
571 die(_("unable to write new index file"));
573 if (!opts
->force
&& !opts
->quiet
)
574 show_local_changes(&new->commit
->object
, &opts
->diff_options
);
579 static void report_tracking(struct branch_info
*new)
581 struct strbuf sb
= STRBUF_INIT
;
582 struct branch
*branch
= branch_get(new->name
);
584 if (!format_tracking_info(branch
, &sb
))
586 fputs(sb
.buf
, stdout
);
590 static void update_refs_for_switch(const struct checkout_opts
*opts
,
591 struct branch_info
*old
,
592 struct branch_info
*new)
594 struct strbuf msg
= STRBUF_INIT
;
595 const char *old_desc
, *reflog_msg
;
596 if (opts
->new_branch
) {
597 if (opts
->new_orphan_branch
) {
598 if (opts
->new_branch_log
&& !log_all_ref_updates
) {
600 struct strbuf log_file
= STRBUF_INIT
;
602 const char *ref_name
;
604 ref_name
= mkpath("refs/heads/%s", opts
->new_orphan_branch
);
605 temp
= log_all_ref_updates
;
606 log_all_ref_updates
= 1;
607 ret
= log_ref_setup(ref_name
, &log_file
);
608 log_all_ref_updates
= temp
;
609 strbuf_release(&log_file
);
611 fprintf(stderr
, _("Can not do reflog for '%s'\n"),
612 opts
->new_orphan_branch
);
618 create_branch(old
->name
, opts
->new_branch
, new->name
,
619 opts
->new_branch_force
? 1 : 0,
620 opts
->new_branch_log
,
621 opts
->new_branch_force
? 1 : 0,
624 new->name
= opts
->new_branch
;
625 setup_branch_path(new);
628 old_desc
= old
->name
;
629 if (!old_desc
&& old
->commit
)
630 old_desc
= sha1_to_hex(old
->commit
->object
.sha1
);
632 reflog_msg
= getenv("GIT_REFLOG_ACTION");
634 strbuf_addf(&msg
, "checkout: moving from %s to %s",
635 old_desc
? old_desc
: "(invalid)", new->name
);
637 strbuf_insert(&msg
, 0, reflog_msg
, strlen(reflog_msg
));
639 if (!strcmp(new->name
, "HEAD") && !new->path
&& !opts
->force_detach
) {
641 } else if (opts
->force_detach
|| !new->path
) { /* No longer on any branch. */
642 update_ref(msg
.buf
, "HEAD", new->commit
->object
.sha1
, NULL
,
643 REF_NODEREF
, UPDATE_REFS_DIE_ON_ERR
);
645 if (old
->path
&& advice_detached_head
)
646 detach_advice(new->name
);
647 describe_detached_head(_("HEAD is now at"), new->commit
);
649 } else if (new->path
) { /* Switch branches. */
650 create_symref("HEAD", new->path
, msg
.buf
);
652 if (old
->path
&& !strcmp(new->path
, old
->path
)) {
653 if (opts
->new_branch_force
)
654 fprintf(stderr
, _("Reset branch '%s'\n"),
657 fprintf(stderr
, _("Already on '%s'\n"),
659 } else if (opts
->new_branch
) {
660 if (opts
->branch_exists
)
661 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new->name
);
663 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new->name
);
665 fprintf(stderr
, _("Switched to branch '%s'\n"),
669 if (old
->path
&& old
->name
) {
670 if (!ref_exists(old
->path
) && reflog_exists(old
->path
))
671 delete_reflog(old
->path
);
674 remove_branch_state();
675 strbuf_release(&msg
);
677 (new->path
|| (!opts
->force_detach
&& !strcmp(new->name
, "HEAD"))))
678 report_tracking(new);
681 static int add_pending_uninteresting_ref(const char *refname
,
682 const unsigned char *sha1
,
683 int flags
, void *cb_data
)
685 add_pending_sha1(cb_data
, refname
, sha1
, UNINTERESTING
);
689 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
691 strbuf_addstr(sb
, " ");
693 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
694 strbuf_addch(sb
, ' ');
695 if (!parse_commit(commit
))
696 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
697 strbuf_addch(sb
, '\n');
700 #define ORPHAN_CUTOFF 4
701 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
703 struct commit
*c
, *last
= NULL
;
704 struct strbuf sb
= STRBUF_INIT
;
706 while ((c
= get_revision(revs
)) != NULL
) {
707 if (lost
< ORPHAN_CUTOFF
)
708 describe_one_orphan(&sb
, c
);
712 if (ORPHAN_CUTOFF
< lost
) {
713 int more
= lost
- ORPHAN_CUTOFF
;
715 describe_one_orphan(&sb
, last
);
717 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
722 /* The singular version */
723 "Warning: you are leaving %d commit behind, "
725 "any of your branches:\n\n"
727 /* The plural version */
728 "Warning: you are leaving %d commits behind, "
730 "any of your branches:\n\n"
732 /* Give ngettext() the count */
738 if (advice_detached_head
)
741 "If you want to keep them by creating a new branch, "
742 "this may be a good time\nto do so with:\n\n"
743 " git branch new_branch_name %s\n\n"),
744 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
748 * We are about to leave commit that was at the tip of a detached
749 * HEAD. If it is not reachable from any ref, this is the last chance
750 * for the user to do so without resorting to reflog.
752 static void orphaned_commit_warning(struct commit
*old
, struct commit
*new)
754 struct rev_info revs
;
755 struct object
*object
= &old
->object
;
756 struct object_array refs
;
758 init_revisions(&revs
, NULL
);
759 setup_revisions(0, NULL
, &revs
, NULL
);
761 object
->flags
&= ~UNINTERESTING
;
762 add_pending_object(&revs
, object
, sha1_to_hex(object
->sha1
));
764 for_each_ref(add_pending_uninteresting_ref
, &revs
);
765 add_pending_sha1(&revs
, "HEAD", new->object
.sha1
, UNINTERESTING
);
768 revs
.leak_pending
= 1;
770 if (prepare_revision_walk(&revs
))
771 die(_("internal error in revision walk"));
772 if (!(old
->object
.flags
& UNINTERESTING
))
773 suggest_reattach(old
, &revs
);
775 describe_detached_head(_("Previous HEAD position was"), old
);
777 clear_commit_marks_for_object_array(&refs
, ALL_REV_FLAGS
);
781 static int switch_branches(const struct checkout_opts
*opts
,
782 struct branch_info
*new)
785 struct branch_info old
;
787 unsigned char rev
[20];
788 int flag
, writeout_error
= 0;
789 memset(&old
, 0, sizeof(old
));
790 old
.path
= path_to_free
= resolve_refdup("HEAD", rev
, 0, &flag
);
791 old
.commit
= lookup_commit_reference_gently(rev
, 1);
792 if (!(flag
& REF_ISSYMREF
))
796 skip_prefix(old
.path
, "refs/heads/", &old
.name
);
800 new->commit
= old
.commit
;
802 die(_("You are on a branch yet to be born"));
803 parse_commit_or_die(new->commit
);
806 ret
= merge_working_tree(opts
, &old
, new, &writeout_error
);
812 if (!opts
->quiet
&& !old
.path
&& old
.commit
&&
813 new->commit
!= old
.commit
&& !opts
->new_worktree_mode
)
814 orphaned_commit_warning(old
.commit
, new->commit
);
816 update_refs_for_switch(opts
, &old
, new);
818 ret
= post_checkout_hook(old
.commit
, new->commit
, 1);
820 return ret
|| writeout_error
;
823 static const char *junk_work_tree
;
824 static const char *junk_git_dir
;
826 static pid_t junk_pid
;
828 static void remove_junk(void)
830 struct strbuf sb
= STRBUF_INIT
;
831 if (!is_junk
|| getpid() != junk_pid
)
834 strbuf_addstr(&sb
, junk_git_dir
);
835 remove_dir_recursively(&sb
, 0);
838 if (junk_work_tree
) {
839 strbuf_addstr(&sb
, junk_work_tree
);
840 remove_dir_recursively(&sb
, 0);
845 static void remove_junk_on_signal(int signo
)
852 static int prepare_linked_checkout(const struct checkout_opts
*opts
,
853 struct branch_info
*new)
855 struct strbuf sb_git
= STRBUF_INIT
, sb_repo
= STRBUF_INIT
;
856 struct strbuf sb
= STRBUF_INIT
;
857 const char *path
= opts
->new_worktree
, *name
;
859 struct child_process cp
;
860 int counter
= 0, len
, ret
;
863 die(_("no branch specified"));
866 while (len
&& is_dir_sep(path
[len
- 1]))
869 for (name
= path
+ len
- 1; name
> path
; name
--)
870 if (is_dir_sep(*name
)) {
874 strbuf_addstr(&sb_repo
,
875 git_path("repos/%.*s", (int)(path
+ len
- name
), name
));
877 if (safe_create_leading_directories_const(sb_repo
.buf
))
878 die_errno(_("could not create leading directories of '%s'"),
880 while (!stat(sb_repo
.buf
, &st
)) {
882 strbuf_setlen(&sb_repo
, len
);
883 strbuf_addf(&sb_repo
, "%d", counter
);
885 name
= strrchr(sb_repo
.buf
, '/') + 1;
889 sigchain_push_common(remove_junk_on_signal
);
891 if (mkdir(sb_repo
.buf
, 0777))
892 die_errno(_("could not create directory of '%s'"), sb_repo
.buf
);
893 junk_git_dir
= sb_repo
.buf
;
897 * lock the incomplete repo so prune won't delete it, unlock
898 * after the preparation is over.
900 strbuf_addf(&sb
, "%s/locked", sb_repo
.buf
);
901 write_file(sb
.buf
, 1, "initializing\n");
903 strbuf_addf(&sb_git
, "%s/.git", path
);
904 if (safe_create_leading_directories_const(sb_git
.buf
))
905 die_errno(_("could not create leading directories of '%s'"),
907 junk_work_tree
= path
;
910 strbuf_addf(&sb
, "%s/gitdir", sb_repo
.buf
);
911 write_file(sb
.buf
, 1, "%s\n", real_path(sb_git
.buf
));
912 write_file(sb_git
.buf
, 1, "gitdir: %s/repos/%s\n",
913 real_path(get_git_common_dir()), name
);
915 * This is to keep resolve_ref() happy. We need a valid HEAD
916 * or is_git_directory() will reject the directory. Any valid
917 * value would do because this value will be ignored and
918 * replaced at the next (real) checkout.
921 strbuf_addf(&sb
, "%s/HEAD", sb_repo
.buf
);
922 write_file(sb
.buf
, 1, "%s\n", sha1_to_hex(new->commit
->object
.sha1
));
924 strbuf_addf(&sb
, "%s/commondir", sb_repo
.buf
);
925 write_file(sb
.buf
, 1, "../..\n");
928 fprintf_ln(stderr
, _("Enter %s (identifier %s)"), path
, name
);
930 setenv("GIT_CHECKOUT_NEW_WORKTREE", "1", 1);
931 setenv(GIT_DIR_ENVIRONMENT
, sb_git
.buf
, 1);
932 setenv(GIT_WORK_TREE_ENVIRONMENT
, path
, 1);
933 memset(&cp
, 0, sizeof(cp
));
935 cp
.argv
= opts
->saved_argv
;
936 ret
= run_command(&cp
);
940 strbuf_addf(&sb
, "%s/locked", sb_repo
.buf
);
941 unlink_or_warn(sb
.buf
);
943 strbuf_release(&sb_repo
);
944 strbuf_release(&sb_git
);
949 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
951 if (!strcmp(var
, "diff.ignoresubmodules")) {
952 struct checkout_opts
*opts
= cb
;
953 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
957 if (starts_with(var
, "submodule."))
958 return parse_submodule_config_option(var
, value
);
960 return git_xmerge_config(var
, value
, NULL
);
963 struct tracking_name_data
{
964 /* const */ char *src_ref
;
966 unsigned char *dst_sha1
;
970 static int check_tracking_name(struct remote
*remote
, void *cb_data
)
972 struct tracking_name_data
*cb
= cb_data
;
973 struct refspec query
;
974 memset(&query
, 0, sizeof(struct refspec
));
975 query
.src
= cb
->src_ref
;
976 if (remote_find_tracking(remote
, &query
) ||
977 get_sha1(query
.dst
, cb
->dst_sha1
)) {
986 cb
->dst_ref
= query
.dst
;
990 static const char *unique_tracking_name(const char *name
, unsigned char *sha1
)
992 struct tracking_name_data cb_data
= { NULL
, NULL
, NULL
, 1 };
993 char src_ref
[PATH_MAX
];
994 snprintf(src_ref
, PATH_MAX
, "refs/heads/%s", name
);
995 cb_data
.src_ref
= src_ref
;
996 cb_data
.dst_sha1
= sha1
;
997 for_each_remote(check_tracking_name
, &cb_data
);
999 return cb_data
.dst_ref
;
1000 free(cb_data
.dst_ref
);
1004 static void check_linked_checkout(struct branch_info
*new, const char *id
)
1006 struct strbuf sb
= STRBUF_INIT
;
1007 struct strbuf path
= STRBUF_INIT
;
1008 struct strbuf gitdir
= STRBUF_INIT
;
1009 const char *start
, *end
;
1012 strbuf_addf(&path
, "%s/repos/%s/HEAD", get_git_common_dir(), id
);
1014 strbuf_addf(&path
, "%s/HEAD", get_git_common_dir());
1016 if (strbuf_read_file(&sb
, path
.buf
, 0) < 0 ||
1017 !skip_prefix(sb
.buf
, "ref:", &start
))
1019 while (isspace(*start
))
1022 while (*end
&& !isspace(*end
))
1024 if (strncmp(start
, new->path
, end
- start
) || new->path
[end
- start
] != '\0')
1027 strbuf_reset(&path
);
1028 strbuf_addf(&path
, "%s/repos/%s/gitdir", get_git_common_dir(), id
);
1029 if (strbuf_read_file(&gitdir
, path
.buf
, 0) <= 0)
1031 strbuf_rtrim(&gitdir
);
1033 strbuf_addstr(&gitdir
, get_git_common_dir());
1034 if (advice_checkout_locked
)
1035 die(_("'%s' is already checked out at %s\n"
1036 "Either go there and continue working, or detach HEAD using\n"
1037 " git checkout --detach [more options] %s\n"
1038 "or create a new branch based off '%s' using\n"
1039 " git checkout -b <branch name> [more options] %s\n"
1040 "or switch to another branch at the other checkout and retry."),
1041 new->name
, gitdir
.buf
, new->name
, new->name
, new->name
);
1043 die(_("'%s' is already checked out at %s"), new->name
, gitdir
.buf
);
1045 strbuf_release(&path
);
1046 strbuf_release(&sb
);
1047 strbuf_release(&gitdir
);
1050 static void check_linked_checkouts(struct branch_info
*new)
1052 struct strbuf path
= STRBUF_INIT
;
1056 strbuf_addf(&path
, "%s/repos", get_git_common_dir());
1057 if ((dir
= opendir(path
.buf
)) == NULL
) {
1058 strbuf_release(&path
);
1063 * $GIT_COMMON_DIR/HEAD is practically outside
1064 * $GIT_DIR so resolve_ref_unsafe() won't work (it
1065 * uses git_path). Parse the ref ourselves.
1067 check_linked_checkout(new, NULL
);
1069 while ((d
= readdir(dir
)) != NULL
) {
1070 if (!strcmp(d
->d_name
, ".") || !strcmp(d
->d_name
, ".."))
1072 check_linked_checkout(new, d
->d_name
);
1074 strbuf_release(&path
);
1078 static int parse_branchname_arg(int argc
, const char **argv
,
1079 int dwim_new_local_branch_ok
,
1080 struct branch_info
*new,
1081 struct tree
**source_tree
,
1082 unsigned char rev
[20],
1083 const char **new_branch
,
1087 unsigned char branch_rev
[20];
1090 int has_dash_dash
= 0;
1094 * case 1: git checkout <ref> -- [<paths>]
1096 * <ref> must be a valid tree, everything after the '--' must be
1099 * case 2: git checkout -- [<paths>]
1101 * everything after the '--' must be paths.
1103 * case 3: git checkout <something> [--]
1105 * (a) If <something> is a commit, that is to
1106 * switch to the branch or detach HEAD at it. As a special case,
1107 * if <something> is A...B (missing A or B means HEAD but you can
1108 * omit at most one side), and if there is a unique merge base
1109 * between A and B, A...B names that merge base.
1111 * (b) If <something> is _not_ a commit, either "--" is present
1112 * or <something> is not a path, no -t or -b was given, and
1113 * and there is a tracking branch whose name is <something>
1114 * in one and only one remote, then this is a short-hand to
1115 * fork local <something> from that remote-tracking branch.
1117 * (c) Otherwise, if "--" is present, treat it like case (1).
1120 * - if it's a reference, treat it like case (1)
1121 * - else if it's a path, treat it like case (2)
1124 * case 4: git checkout <something> <paths>
1126 * The first argument must not be ambiguous.
1127 * - If it's *only* a reference, treat it like case (1).
1128 * - If it's only a path, treat it like case (2).
1137 for (i
= 0; i
< argc
; i
++) {
1138 if (!strcmp(argv
[i
], "--")) {
1143 if (dash_dash_pos
== 0)
1144 return 1; /* case (2) */
1145 else if (dash_dash_pos
== 1)
1146 has_dash_dash
= 1; /* case (3) or (1) */
1147 else if (dash_dash_pos
>= 2)
1148 die(_("only one reference expected, %d given."), dash_dash_pos
);
1150 if (!strcmp(arg
, "-"))
1153 if (get_sha1_mb(arg
, rev
)) {
1155 * Either case (3) or (4), with <something> not being
1156 * a commit, or an attempt to use case (1) with an
1159 * It's likely an error, but we need to find out if
1160 * we should auto-create the branch, case (3).(b).
1162 int recover_with_dwim
= dwim_new_local_branch_ok
;
1164 if (check_filename(NULL
, arg
) && !has_dash_dash
)
1165 recover_with_dwim
= 0;
1167 * Accept "git checkout foo" and "git checkout foo --"
1168 * as candidates for dwim.
1170 if (!(argc
== 1 && !has_dash_dash
) &&
1171 !(argc
== 2 && has_dash_dash
))
1172 recover_with_dwim
= 0;
1174 if (recover_with_dwim
) {
1175 const char *remote
= unique_tracking_name(arg
, rev
);
1179 /* DWIMmed to create local branch, case (3).(b) */
1181 recover_with_dwim
= 0;
1185 if (!recover_with_dwim
) {
1187 die(_("invalid reference: %s"), arg
);
1192 /* we can't end up being in (2) anymore, eat the argument */
1198 setup_branch_path(new);
1200 if (!check_refname_format(new->path
, 0) &&
1201 !read_ref(new->path
, branch_rev
))
1202 hashcpy(rev
, branch_rev
);
1204 new->path
= NULL
; /* not an existing branch */
1206 if (new->path
&& !force_detach
&& !*new_branch
) {
1207 unsigned char sha1
[20];
1209 char *head_ref
= resolve_refdup("HEAD", sha1
, 0, &flag
);
1211 (!(flag
& REF_ISSYMREF
) || strcmp(head_ref
, new->path
)))
1212 check_linked_checkouts(new);
1216 new->commit
= lookup_commit_reference_gently(rev
, 1);
1219 *source_tree
= parse_tree_indirect(rev
);
1221 parse_commit_or_die(new->commit
);
1222 *source_tree
= new->commit
->tree
;
1225 if (!*source_tree
) /* case (1): want a tree */
1226 die(_("reference is not a tree: %s"), arg
);
1227 if (!has_dash_dash
) {/* case (3).(d) -> (1) */
1229 * Do not complain the most common case
1230 * git checkout branch
1231 * even if there happen to be a file called 'branch';
1232 * it would be extremely annoying.
1235 verify_non_filename(NULL
, arg
);
1245 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
1248 struct strbuf branch_ref
= STRBUF_INIT
;
1250 if (!opts
->new_branch
)
1251 die(_("You are on a branch yet to be born"));
1252 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
1253 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
1254 strbuf_release(&branch_ref
);
1256 fprintf(stderr
, _("Switched to a new branch '%s'\n"),
1261 static int checkout_branch(struct checkout_opts
*opts
,
1262 struct branch_info
*new)
1264 if (opts
->pathspec
.nr
)
1265 die(_("paths cannot be used with switching branches"));
1267 if (opts
->patch_mode
)
1268 die(_("'%s' cannot be used with switching branches"),
1271 if (opts
->writeout_stage
)
1272 die(_("'%s' cannot be used with switching branches"),
1275 if (opts
->force
&& opts
->merge
)
1276 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1278 if (opts
->force_detach
&& opts
->new_branch
)
1279 die(_("'%s' cannot be used with '%s'"),
1280 "--detach", "-b/-B/--orphan");
1282 if (opts
->new_orphan_branch
) {
1283 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1284 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1285 } else if (opts
->force_detach
) {
1286 if (opts
->track
!= BRANCH_TRACK_UNSPECIFIED
)
1287 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1288 } else if (opts
->track
== BRANCH_TRACK_UNSPECIFIED
)
1289 opts
->track
= git_branch_track
;
1291 if (new->name
&& !new->commit
)
1292 die(_("Cannot switch branch to a non-commit '%s'"),
1295 if (opts
->new_worktree
)
1296 return prepare_linked_checkout(opts
, new);
1298 if (!new->commit
&& opts
->new_branch
) {
1299 unsigned char rev
[20];
1302 if (!read_ref_full("HEAD", rev
, 0, &flag
) &&
1303 (flag
& REF_ISSYMREF
) && is_null_sha1(rev
))
1304 return switch_unborn_to_new_branch(opts
);
1306 return switch_branches(opts
, new);
1309 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
1311 struct checkout_opts opts
;
1312 struct branch_info
new;
1313 char *conflict_style
= NULL
;
1314 int dwim_new_local_branch
= 1;
1315 struct option options
[] = {
1316 OPT__QUIET(&opts
.quiet
, N_("suppress progress reporting")),
1317 OPT_STRING('b', NULL
, &opts
.new_branch
, N_("branch"),
1318 N_("create and checkout a new branch")),
1319 OPT_STRING('B', NULL
, &opts
.new_branch_force
, N_("branch"),
1320 N_("create/reset and checkout a branch")),
1321 OPT_BOOL('l', NULL
, &opts
.new_branch_log
, N_("create reflog for new branch")),
1322 OPT_BOOL(0, "detach", &opts
.force_detach
, N_("detach the HEAD at named commit")),
1323 OPT_SET_INT('t', "track", &opts
.track
, N_("set upstream info for new branch"),
1324 BRANCH_TRACK_EXPLICIT
),
1325 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, N_("new-branch"), N_("new unparented branch")),
1326 OPT_SET_INT('2', "ours", &opts
.writeout_stage
, N_("checkout our version for unmerged files"),
1328 OPT_SET_INT('3', "theirs", &opts
.writeout_stage
, N_("checkout their version for unmerged files"),
1330 OPT__FORCE(&opts
.force
, N_("force checkout (throw away local modifications)")),
1331 OPT_BOOL('m', "merge", &opts
.merge
, N_("perform a 3-way merge with the new branch")),
1332 OPT_BOOL(0, "overwrite-ignore", &opts
.overwrite_ignore
, N_("update ignored files (default)")),
1333 OPT_STRING(0, "conflict", &conflict_style
, N_("style"),
1334 N_("conflict style (merge or diff3)")),
1335 OPT_BOOL('p', "patch", &opts
.patch_mode
, N_("select hunks interactively")),
1336 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts
.ignore_skipworktree
,
1337 N_("do not limit pathspecs to sparse entries only")),
1338 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch
,
1339 N_("second guess 'git checkout no-such-branch'")),
1340 OPT_STRING(0, "to", &opts
.new_worktree
, N_("path"),
1341 N_("check a branch out in a separate working directory")),
1345 memset(&opts
, 0, sizeof(opts
));
1346 memset(&new, 0, sizeof(new));
1347 opts
.overwrite_ignore
= 1;
1348 opts
.prefix
= prefix
;
1350 opts
.saved_argv
= xmalloc(sizeof(const char *) * (argc
+ 2));
1351 memcpy(opts
.saved_argv
, argv
, sizeof(const char *) * (argc
+ 1));
1353 gitmodules_config();
1354 git_config(git_checkout_config
, &opts
);
1356 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
1358 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
1359 PARSE_OPT_KEEP_DASHDASH
);
1361 /* recursive execution from checkout_new_worktree() */
1362 opts
.new_worktree_mode
= getenv("GIT_CHECKOUT_NEW_WORKTREE") != NULL
;
1363 if (opts
.new_worktree_mode
)
1364 opts
.new_worktree
= NULL
;
1366 if (!opts
.new_worktree
)
1369 if (conflict_style
) {
1370 opts
.merge
= 1; /* implied */
1371 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1374 if ((!!opts
.new_branch
+ !!opts
.new_branch_force
+ !!opts
.new_orphan_branch
) > 1)
1375 die(_("-b, -B and --orphan are mutually exclusive"));
1378 * From here on, new_branch will contain the branch to be checked out,
1379 * and new_branch_force and new_orphan_branch will tell us which one of
1380 * -b/-B/--orphan is being used.
1382 if (opts
.new_branch_force
)
1383 opts
.new_branch
= opts
.new_branch_force
;
1385 if (opts
.new_orphan_branch
)
1386 opts
.new_branch
= opts
.new_orphan_branch
;
1388 /* --track without -b/-B/--orphan should DWIM */
1389 if (opts
.track
!= BRANCH_TRACK_UNSPECIFIED
&& !opts
.new_branch
) {
1390 const char *argv0
= argv
[0];
1391 if (!argc
|| !strcmp(argv0
, "--"))
1392 die (_("--track needs a branch name"));
1393 if (starts_with(argv0
, "refs/"))
1395 if (starts_with(argv0
, "remotes/"))
1397 argv0
= strchr(argv0
, '/');
1398 if (!argv0
|| !argv0
[1])
1399 die (_("Missing branch name; try -b"));
1400 opts
.new_branch
= argv0
+ 1;
1404 * Extract branch name from command line arguments, so
1405 * all that is left is pathspecs.
1409 * 1) git checkout <tree> -- [<paths>]
1410 * 2) git checkout -- [<paths>]
1411 * 3) git checkout <something> [<paths>]
1413 * including "last branch" syntax and DWIM-ery for names of
1414 * remote branches, erroring out for invalid or ambiguous cases.
1417 unsigned char rev
[20];
1420 dwim_new_local_branch
&&
1421 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1423 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1424 &new, &opts
.source_tree
,
1425 rev
, &opts
.new_branch
,
1432 parse_pathspec(&opts
.pathspec
, 0,
1433 opts
.patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0,
1436 if (!opts
.pathspec
.nr
)
1437 die(_("invalid path specification"));
1440 * Try to give more helpful suggestion.
1441 * new_branch && argc > 1 will be caught later.
1443 if (opts
.new_branch
&& argc
== 1)
1444 die(_("Cannot update paths and switch to branch '%s' at the same time.\n"
1445 "Did you intend to checkout '%s' which can not be resolved as commit?"),
1446 opts
.new_branch
, argv
[0]);
1448 if (opts
.force_detach
)
1449 die(_("git checkout: --detach does not take a path argument '%s'"),
1452 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1453 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1454 "checking out of the index."));
1457 if (opts
.new_branch
) {
1458 struct strbuf buf
= STRBUF_INIT
;
1460 opts
.branch_exists
=
1461 validate_new_branchname(opts
.new_branch
, &buf
,
1462 !!opts
.new_branch_force
,
1463 !!opts
.new_branch_force
);
1465 strbuf_release(&buf
);
1468 if (opts
.patch_mode
|| opts
.pathspec
.nr
)
1469 return checkout_paths(&opts
, new.name
);
1471 return checkout_branch(&opts
, &new);