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 "git checkout [options] <branch>",
26 "git checkout [options] [<branch>] -- <file>...",
30 struct checkout_opts
{
39 const char *new_branch
;
40 const char *new_branch_force
;
41 const char *new_orphan_branch
;
43 enum branch_track track
;
44 struct diff_options diff_options
;
48 const char **pathspec
;
49 struct tree
*source_tree
;
52 static int post_checkout_hook(struct commit
*old
, struct commit
*new,
55 return run_hook(NULL
, "post-checkout",
56 sha1_to_hex(old
? old
->object
.sha1
: null_sha1
),
57 sha1_to_hex(new ? new->object
.sha1
: null_sha1
),
58 changed
? "1" : "0", NULL
);
59 /* "new" can be NULL when checking out from the index before
64 static int update_some(const unsigned char *sha1
, const char *base
, int baselen
,
65 const char *pathname
, unsigned mode
, int stage
, void *context
)
68 struct cache_entry
*ce
;
71 return READ_TREE_RECURSIVE
;
73 len
= baselen
+ strlen(pathname
);
74 ce
= xcalloc(1, cache_entry_size(len
));
75 hashcpy(ce
->sha1
, sha1
);
76 memcpy(ce
->name
, base
, baselen
);
77 memcpy(ce
->name
+ baselen
, pathname
, len
- baselen
);
78 ce
->ce_flags
= create_ce_flags(0) | CE_UPDATE
;
80 ce
->ce_mode
= create_ce_mode(mode
);
81 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
85 static int read_tree_some(struct tree
*tree
, const char **pathspec
)
88 init_pathspec(&ps
, pathspec
);
89 read_tree_recursive(tree
, "", 0, 0, &ps
, update_some
, NULL
);
92 /* update the index with the given tree's info
93 * for all args, expanding wildcards, and exit
94 * with any non-zero return code.
99 static int skip_same_name(struct cache_entry
*ce
, int pos
)
101 while (++pos
< active_nr
&&
102 !strcmp(active_cache
[pos
]->name
, ce
->name
))
107 static int check_stage(int stage
, struct cache_entry
*ce
, int pos
)
109 while (pos
< active_nr
&&
110 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
111 if (ce_stage(active_cache
[pos
]) == stage
)
116 return error(_("path '%s' does not have our version"), ce
->name
);
118 return error(_("path '%s' does not have their version"), ce
->name
);
121 static int check_stages(unsigned stages
, struct cache_entry
*ce
, int pos
)
124 const char *name
= ce
->name
;
126 while (pos
< active_nr
) {
127 ce
= active_cache
[pos
];
128 if (strcmp(name
, ce
->name
))
130 seen
|= (1 << ce_stage(ce
));
133 if ((stages
& seen
) != stages
)
134 return error(_("path '%s' does not have all necessary versions"),
139 static int checkout_stage(int stage
, struct cache_entry
*ce
, int pos
,
140 struct checkout
*state
)
142 while (pos
< active_nr
&&
143 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
144 if (ce_stage(active_cache
[pos
]) == stage
)
145 return checkout_entry(active_cache
[pos
], state
, NULL
);
149 return error(_("path '%s' does not have our version"), ce
->name
);
151 return error(_("path '%s' does not have their version"), ce
->name
);
154 static int checkout_merged(int pos
, struct checkout
*state
)
156 struct cache_entry
*ce
= active_cache
[pos
];
157 const char *path
= ce
->name
;
158 mmfile_t ancestor
, ours
, theirs
;
160 unsigned char sha1
[20];
161 mmbuffer_t result_buf
;
162 unsigned char threeway
[3][20];
165 memset(threeway
, 0, sizeof(threeway
));
166 while (pos
< active_nr
) {
168 stage
= ce_stage(ce
);
169 if (!stage
|| strcmp(path
, ce
->name
))
171 hashcpy(threeway
[stage
- 1], ce
->sha1
);
173 mode
= create_ce_mode(ce
->ce_mode
);
175 ce
= active_cache
[pos
];
177 if (is_null_sha1(threeway
[1]) || is_null_sha1(threeway
[2]))
178 return error(_("path '%s' does not have necessary versions"), path
);
180 read_mmblob(&ancestor
, threeway
[0]);
181 read_mmblob(&ours
, threeway
[1]);
182 read_mmblob(&theirs
, threeway
[2]);
185 * NEEDSWORK: re-create conflicts from merges with
186 * merge.renormalize set, too
188 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
189 &ours
, "ours", &theirs
, "theirs", NULL
);
193 if (status
< 0 || !result_buf
.ptr
) {
194 free(result_buf
.ptr
);
195 return error(_("path '%s': cannot merge"), path
);
200 * There is absolutely no reason to write this as a blob object
201 * and create a phony cache entry just to leak. This hack is
202 * primarily to get to the write_entry() machinery that massages
203 * the contents to work-tree format and writes out which only
204 * allows it for a cache entry. The code in write_entry() needs
205 * to be refactored to allow us to feed a <buffer, size, mode>
206 * instead of a cache entry. Such a refactoring would help
207 * merge_recursive as well (it also writes the merge result to the
208 * object database even when it may contain conflicts).
210 if (write_sha1_file(result_buf
.ptr
, result_buf
.size
,
212 die(_("Unable to add merge result for '%s'"), path
);
213 ce
= make_cache_entry(mode
, sha1
, path
, 2, 0);
215 die(_("make_cache_entry failed for path '%s'"), path
);
216 status
= checkout_entry(ce
, state
, NULL
);
220 static int checkout_paths(const struct checkout_opts
*opts
)
223 struct checkout state
;
224 static char *ps_matched
;
225 unsigned char rev
[20];
229 int stage
= opts
->writeout_stage
;
230 int merge
= opts
->merge
;
232 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
234 newfd
= hold_locked_index(lock_file
, 1);
235 if (read_cache_preload(opts
->pathspec
) < 0)
236 return error(_("corrupt index file"));
238 if (opts
->source_tree
)
239 read_tree_some(opts
->source_tree
, opts
->pathspec
);
241 for (pos
= 0; opts
->pathspec
[pos
]; pos
++)
243 ps_matched
= xcalloc(1, pos
);
245 for (pos
= 0; pos
< active_nr
; pos
++) {
246 struct cache_entry
*ce
= active_cache
[pos
];
247 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
249 match_pathspec(opts
->pathspec
, ce
->name
, ce_namelen(ce
), 0, ps_matched
);
252 if (report_path_error(ps_matched
, opts
->pathspec
, opts
->prefix
))
255 /* "checkout -m path" to recreate conflicted state */
257 unmerge_cache(opts
->pathspec
);
259 /* Any unmerged paths? */
260 for (pos
= 0; pos
< active_nr
; pos
++) {
261 struct cache_entry
*ce
= active_cache
[pos
];
262 if (match_pathspec(opts
->pathspec
, ce
->name
, ce_namelen(ce
), 0, NULL
)) {
266 warning(_("path '%s' is unmerged"), ce
->name
);
268 errs
|= check_stage(stage
, ce
, pos
);
269 } else if (opts
->merge
) {
270 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
273 error(_("path '%s' is unmerged"), ce
->name
);
275 pos
= skip_same_name(ce
, pos
) - 1;
281 /* Now we are committed to check them out */
282 memset(&state
, 0, sizeof(state
));
284 state
.refresh_cache
= 1;
285 for (pos
= 0; pos
< active_nr
; pos
++) {
286 struct cache_entry
*ce
= active_cache
[pos
];
287 if (opts
->source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
289 if (match_pathspec(opts
->pathspec
, ce
->name
, ce_namelen(ce
), 0, NULL
)) {
291 errs
|= checkout_entry(ce
, &state
, NULL
);
295 errs
|= checkout_stage(stage
, ce
, pos
, &state
);
297 errs
|= checkout_merged(pos
, &state
);
298 pos
= skip_same_name(ce
, pos
) - 1;
302 if (write_cache(newfd
, active_cache
, active_nr
) ||
303 commit_locked_index(lock_file
))
304 die(_("unable to write new index file"));
306 read_ref_full("HEAD", rev
, 0, &flag
);
307 head
= lookup_commit_reference_gently(rev
, 1);
309 errs
|= post_checkout_hook(head
, head
, 0);
313 static void show_local_changes(struct object
*head
,
314 const struct diff_options
*opts
)
317 /* I think we want full paths, even if we're in a subdirectory. */
318 init_revisions(&rev
, NULL
);
319 rev
.diffopt
.flags
= opts
->flags
;
320 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
321 diff_setup_done(&rev
.diffopt
);
322 add_pending_object(&rev
, head
, NULL
);
323 run_diff_index(&rev
, 0);
326 static void describe_detached_head(const char *msg
, struct commit
*commit
)
328 struct strbuf sb
= STRBUF_INIT
;
329 parse_commit(commit
);
330 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
331 fprintf(stderr
, "%s %s... %s\n", msg
,
332 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
), sb
.buf
);
336 static int reset_tree(struct tree
*tree
, const struct checkout_opts
*o
,
337 int worktree
, int *writeout_error
)
339 struct unpack_trees_options opts
;
340 struct tree_desc tree_desc
;
342 memset(&opts
, 0, sizeof(opts
));
344 opts
.update
= worktree
;
345 opts
.skip_unmerged
= !worktree
;
348 opts
.fn
= oneway_merge
;
349 opts
.verbose_update
= !o
->quiet
&& isatty(2);
350 opts
.src_index
= &the_index
;
351 opts
.dst_index
= &the_index
;
353 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
354 switch (unpack_trees(1, &tree_desc
, &opts
)) {
358 * We return 0 nevertheless, as the index is all right
359 * and more importantly we have made best efforts to
360 * update paths in the work tree, and we cannot revert
371 const char *name
; /* The short name used */
372 const char *path
; /* The full name of a real branch */
373 struct commit
*commit
; /* The named commit */
376 static void setup_branch_path(struct branch_info
*branch
)
378 struct strbuf buf
= STRBUF_INIT
;
380 strbuf_branchname(&buf
, branch
->name
);
381 if (strcmp(buf
.buf
, branch
->name
))
382 branch
->name
= xstrdup(buf
.buf
);
383 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
384 branch
->path
= strbuf_detach(&buf
, NULL
);
387 static int merge_working_tree(const struct checkout_opts
*opts
,
388 struct branch_info
*old
,
389 struct branch_info
*new,
393 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
394 int newfd
= hold_locked_index(lock_file
, 1);
396 if (read_cache_preload(NULL
) < 0)
397 return error(_("corrupt index file"));
399 resolve_undo_clear();
401 ret
= reset_tree(new->commit
->tree
, opts
, 1, writeout_error
);
405 struct tree_desc trees
[2];
407 struct unpack_trees_options topts
;
409 memset(&topts
, 0, sizeof(topts
));
411 topts
.src_index
= &the_index
;
412 topts
.dst_index
= &the_index
;
414 setup_unpack_trees_porcelain(&topts
, "checkout");
416 refresh_cache(REFRESH_QUIET
);
418 if (unmerged_cache()) {
419 error(_("you need to resolve your current index first"));
423 /* 2-way merge to the new branch */
424 topts
.initial_checkout
= is_cache_unborn();
427 topts
.gently
= opts
->merge
&& old
->commit
;
428 topts
.verbose_update
= !opts
->quiet
&& isatty(2);
429 topts
.fn
= twoway_merge
;
430 if (opts
->overwrite_ignore
) {
431 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
432 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
433 setup_standard_excludes(topts
.dir
);
435 tree
= parse_tree_indirect(old
->commit
?
436 old
->commit
->object
.sha1
:
437 EMPTY_TREE_SHA1_BIN
);
438 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
439 tree
= parse_tree_indirect(new->commit
->object
.sha1
);
440 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
442 ret
= unpack_trees(2, trees
, &topts
);
445 * Unpack couldn't do a trivial merge; either
446 * give up or do a real merge, depending on
447 * whether the merge flag was used.
451 struct merge_options o
;
456 * Without old->commit, the below is the same as
457 * the two-tree unpack we already tried and failed.
462 /* Do more real merge */
465 * We update the index fully, then write the
466 * tree from the index, then merge the new
467 * branch with the current tree, with the old
468 * branch as the base. Then we reset the index
469 * (but not the working tree) to the new
470 * branch, leaving the working tree as the
471 * merged version, but skipping unmerged
472 * entries in the index.
475 add_files_to_cache(NULL
, NULL
, 0);
477 * NEEDSWORK: carrying over local changes
478 * when branches have different end-of-line
479 * normalization (or clean+smudge rules) is
480 * a pain; plumb in an option to set
483 init_merge_options(&o
);
485 work
= write_tree_from_memory(&o
);
487 ret
= reset_tree(new->commit
->tree
, opts
, 1,
491 o
.ancestor
= old
->name
;
492 o
.branch1
= new->name
;
494 merge_trees(&o
, new->commit
->tree
, work
,
495 old
->commit
->tree
, &result
);
496 ret
= reset_tree(new->commit
->tree
, opts
, 0,
503 if (write_cache(newfd
, active_cache
, active_nr
) ||
504 commit_locked_index(lock_file
))
505 die(_("unable to write new index file"));
507 if (!opts
->force
&& !opts
->quiet
)
508 show_local_changes(&new->commit
->object
, &opts
->diff_options
);
513 static void report_tracking(struct branch_info
*new)
515 struct strbuf sb
= STRBUF_INIT
;
516 struct branch
*branch
= branch_get(new->name
);
518 if (!format_tracking_info(branch
, &sb
))
520 fputs(sb
.buf
, stdout
);
524 static void update_refs_for_switch(const struct checkout_opts
*opts
,
525 struct branch_info
*old
,
526 struct branch_info
*new)
528 struct strbuf msg
= STRBUF_INIT
;
529 const char *old_desc
;
530 if (opts
->new_branch
) {
531 if (opts
->new_orphan_branch
) {
532 if (opts
->new_branch_log
&& !log_all_ref_updates
) {
534 char log_file
[PATH_MAX
];
535 char *ref_name
= mkpath("refs/heads/%s", opts
->new_orphan_branch
);
537 temp
= log_all_ref_updates
;
538 log_all_ref_updates
= 1;
539 if (log_ref_setup(ref_name
, log_file
, sizeof(log_file
))) {
540 fprintf(stderr
, _("Can not do reflog for '%s'\n"),
541 opts
->new_orphan_branch
);
542 log_all_ref_updates
= temp
;
545 log_all_ref_updates
= temp
;
549 create_branch(old
->name
, opts
->new_branch
, new->name
,
550 opts
->new_branch_force
? 1 : 0,
551 opts
->new_branch_log
,
552 opts
->new_branch_force
? 1 : 0,
555 new->name
= opts
->new_branch
;
556 setup_branch_path(new);
559 old_desc
= old
->name
;
560 if (!old_desc
&& old
->commit
)
561 old_desc
= sha1_to_hex(old
->commit
->object
.sha1
);
562 strbuf_addf(&msg
, "checkout: moving from %s to %s",
563 old_desc
? old_desc
: "(invalid)", new->name
);
565 if (!strcmp(new->name
, "HEAD") && !new->path
&& !opts
->force_detach
) {
567 } else if (opts
->force_detach
|| !new->path
) { /* No longer on any branch. */
568 update_ref(msg
.buf
, "HEAD", new->commit
->object
.sha1
, NULL
,
569 REF_NODEREF
, DIE_ON_ERR
);
571 if (old
->path
&& advice_detached_head
)
572 detach_advice(new->name
);
573 describe_detached_head(_("HEAD is now at"), new->commit
);
575 } else if (new->path
) { /* Switch branches. */
576 create_symref("HEAD", new->path
, msg
.buf
);
578 if (old
->path
&& !strcmp(new->path
, old
->path
)) {
579 if (opts
->new_branch_force
)
580 fprintf(stderr
, _("Reset branch '%s'\n"),
583 fprintf(stderr
, _("Already on '%s'\n"),
585 } else if (opts
->new_branch
) {
586 if (opts
->branch_exists
)
587 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new->name
);
589 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new->name
);
591 fprintf(stderr
, _("Switched to branch '%s'\n"),
595 if (old
->path
&& old
->name
) {
596 char log_file
[PATH_MAX
], ref_file
[PATH_MAX
];
598 git_snpath(log_file
, sizeof(log_file
), "logs/%s", old
->path
);
599 git_snpath(ref_file
, sizeof(ref_file
), "%s", old
->path
);
600 if (!file_exists(ref_file
) && file_exists(log_file
))
601 remove_path(log_file
);
604 remove_branch_state();
605 strbuf_release(&msg
);
607 (new->path
|| (!opts
->force_detach
&& !strcmp(new->name
, "HEAD"))))
608 report_tracking(new);
611 static int add_pending_uninteresting_ref(const char *refname
,
612 const unsigned char *sha1
,
613 int flags
, void *cb_data
)
615 add_pending_sha1(cb_data
, refname
, sha1
, UNINTERESTING
);
619 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
621 parse_commit(commit
);
622 strbuf_addstr(sb
, " ");
624 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
625 strbuf_addch(sb
, ' ');
626 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
627 strbuf_addch(sb
, '\n');
630 #define ORPHAN_CUTOFF 4
631 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
633 struct commit
*c
, *last
= NULL
;
634 struct strbuf sb
= STRBUF_INIT
;
636 while ((c
= get_revision(revs
)) != NULL
) {
637 if (lost
< ORPHAN_CUTOFF
)
638 describe_one_orphan(&sb
, c
);
642 if (ORPHAN_CUTOFF
< lost
) {
643 int more
= lost
- ORPHAN_CUTOFF
;
645 describe_one_orphan(&sb
, last
);
647 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
652 /* The singular version */
653 "Warning: you are leaving %d commit behind, "
655 "any of your branches:\n\n"
657 /* The plural version */
658 "Warning: you are leaving %d commits behind, "
660 "any of your branches:\n\n"
662 /* Give ngettext() the count */
668 if (advice_detached_head
)
671 "If you want to keep them by creating a new branch, "
672 "this may be a good time\nto do so with:\n\n"
673 " git branch new_branch_name %s\n\n"),
674 sha1_to_hex(commit
->object
.sha1
));
678 * We are about to leave commit that was at the tip of a detached
679 * HEAD. If it is not reachable from any ref, this is the last chance
680 * for the user to do so without resorting to reflog.
682 static void orphaned_commit_warning(struct commit
*old
, struct commit
*new)
684 struct rev_info revs
;
685 struct object
*object
= &old
->object
;
686 struct object_array refs
;
688 init_revisions(&revs
, NULL
);
689 setup_revisions(0, NULL
, &revs
, NULL
);
691 object
->flags
&= ~UNINTERESTING
;
692 add_pending_object(&revs
, object
, sha1_to_hex(object
->sha1
));
694 for_each_ref(add_pending_uninteresting_ref
, &revs
);
695 add_pending_sha1(&revs
, "HEAD", new->object
.sha1
, UNINTERESTING
);
698 revs
.leak_pending
= 1;
700 if (prepare_revision_walk(&revs
))
701 die(_("internal error in revision walk"));
702 if (!(old
->object
.flags
& UNINTERESTING
))
703 suggest_reattach(old
, &revs
);
705 describe_detached_head(_("Previous HEAD position was"), old
);
707 clear_commit_marks_for_object_array(&refs
, ALL_REV_FLAGS
);
711 static int switch_branches(const struct checkout_opts
*opts
,
712 struct branch_info
*new)
715 struct branch_info old
;
717 unsigned char rev
[20];
718 int flag
, writeout_error
= 0;
719 memset(&old
, 0, sizeof(old
));
720 old
.path
= path_to_free
= resolve_refdup("HEAD", rev
, 0, &flag
);
721 old
.commit
= lookup_commit_reference_gently(rev
, 1);
722 if (!(flag
& REF_ISSYMREF
))
725 if (old
.path
&& !prefixcmp(old
.path
, "refs/heads/"))
726 old
.name
= old
.path
+ strlen("refs/heads/");
730 new->commit
= old
.commit
;
732 die(_("You are on a branch yet to be born"));
733 parse_commit(new->commit
);
736 ret
= merge_working_tree(opts
, &old
, new, &writeout_error
);
742 if (!opts
->quiet
&& !old
.path
&& old
.commit
&& new->commit
!= old
.commit
)
743 orphaned_commit_warning(old
.commit
, new->commit
);
745 update_refs_for_switch(opts
, &old
, new);
747 ret
= post_checkout_hook(old
.commit
, new->commit
, 1);
749 return ret
|| writeout_error
;
752 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
754 if (!strcmp(var
, "diff.ignoresubmodules")) {
755 struct checkout_opts
*opts
= cb
;
756 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
760 if (!prefixcmp(var
, "submodule."))
761 return parse_submodule_config_option(var
, value
);
763 return git_xmerge_config(var
, value
, NULL
);
766 static int interactive_checkout(const char *revision
, const char **pathspec
)
768 return run_add_interactive(revision
, "--patch=checkout", pathspec
);
771 struct tracking_name_data
{
777 static int check_tracking_name(const char *refname
, const unsigned char *sha1
,
778 int flags
, void *cb_data
)
780 struct tracking_name_data
*cb
= cb_data
;
783 if (prefixcmp(refname
, "refs/remotes/"))
785 slash
= strchr(refname
+ 13, '/');
786 if (!slash
|| strcmp(slash
+ 1, cb
->name
))
792 cb
->remote
= xstrdup(refname
);
796 static const char *unique_tracking_name(const char *name
)
798 struct tracking_name_data cb_data
= { NULL
, NULL
, 1 };
800 for_each_ref(check_tracking_name
, &cb_data
);
802 return cb_data
.remote
;
803 free(cb_data
.remote
);
807 static int parse_branchname_arg(int argc
, const char **argv
,
808 int dwim_new_local_branch_ok
,
809 struct branch_info
*new,
810 struct tree
**source_tree
,
811 unsigned char rev
[20],
812 const char **new_branch
)
815 unsigned char branch_rev
[20];
820 * case 1: git checkout <ref> -- [<paths>]
822 * <ref> must be a valid tree, everything after the '--' must be
825 * case 2: git checkout -- [<paths>]
827 * everything after the '--' must be paths.
829 * case 3: git checkout <something> [<paths>]
831 * With no paths, if <something> is a commit, that is to
832 * switch to the branch or detach HEAD at it. As a special case,
833 * if <something> is A...B (missing A or B means HEAD but you can
834 * omit at most one side), and if there is a unique merge base
835 * between A and B, A...B names that merge base.
837 * With no paths, if <something> is _not_ a commit, no -t nor -b
838 * was given, and there is a tracking branch whose name is
839 * <something> in one and only one remote, then this is a short-hand
840 * to fork local <something> from that remote-tracking branch.
842 * Otherwise <something> shall not be ambiguous.
843 * - If it's *only* a reference, treat it like case (1).
844 * - If it's only a path, treat it like case (2).
851 if (!strcmp(argv
[0], "--")) /* case (2) */
855 has_dash_dash
= (argc
> 1) && !strcmp(argv
[1], "--");
857 if (!strcmp(arg
, "-"))
860 if (get_sha1_mb(arg
, rev
)) {
861 if (has_dash_dash
) /* case (1) */
862 die(_("invalid reference: %s"), arg
);
863 if (dwim_new_local_branch_ok
&&
864 !check_filename(NULL
, arg
) &&
866 const char *remote
= unique_tracking_name(arg
);
867 if (!remote
|| get_sha1(remote
, rev
))
871 /* DWIMmed to create local branch */
877 /* we can't end up being in (2) anymore, eat the argument */
883 setup_branch_path(new);
885 if (!check_refname_format(new->path
, 0) &&
886 !read_ref(new->path
, branch_rev
))
887 hashcpy(rev
, branch_rev
);
889 new->path
= NULL
; /* not an existing branch */
891 new->commit
= lookup_commit_reference_gently(rev
, 1);
894 *source_tree
= parse_tree_indirect(rev
);
896 parse_commit(new->commit
);
897 *source_tree
= new->commit
->tree
;
900 if (!*source_tree
) /* case (1): want a tree */
901 die(_("reference is not a tree: %s"), arg
);
902 if (!has_dash_dash
) {/* case (3 -> 1) */
904 * Do not complain the most common case
905 * git checkout branch
906 * even if there happen to be a file called 'branch';
907 * it would be extremely annoying.
910 verify_non_filename(NULL
, arg
);
920 static int switch_unborn_to_new_branch(const struct checkout_opts
*opts
)
923 struct strbuf branch_ref
= STRBUF_INIT
;
925 if (!opts
->new_branch
)
926 die(_("You are on a branch yet to be born"));
927 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
928 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
929 strbuf_release(&branch_ref
);
933 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
935 struct checkout_opts opts
;
936 struct branch_info
new;
937 char *conflict_style
= NULL
;
938 int dwim_new_local_branch
= 1;
939 struct option options
[] = {
940 OPT__QUIET(&opts
.quiet
, "suppress progress reporting"),
941 OPT_STRING('b', NULL
, &opts
.new_branch
, "branch",
942 "create and checkout a new branch"),
943 OPT_STRING('B', NULL
, &opts
.new_branch_force
, "branch",
944 "create/reset and checkout a branch"),
945 OPT_BOOLEAN('l', NULL
, &opts
.new_branch_log
, "create reflog for new branch"),
946 OPT_BOOLEAN(0, "detach", &opts
.force_detach
, "detach the HEAD at named commit"),
947 OPT_SET_INT('t', "track", &opts
.track
, "set upstream info for new branch",
948 BRANCH_TRACK_EXPLICIT
),
949 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, "new branch", "new unparented branch"),
950 OPT_SET_INT('2', "ours", &opts
.writeout_stage
, "checkout our version for unmerged files",
952 OPT_SET_INT('3', "theirs", &opts
.writeout_stage
, "checkout their version for unmerged files",
954 OPT__FORCE(&opts
.force
, "force checkout (throw away local modifications)"),
955 OPT_BOOLEAN('m', "merge", &opts
.merge
, "perform a 3-way merge with the new branch"),
956 OPT_BOOLEAN(0, "overwrite-ignore", &opts
.overwrite_ignore
, "update ignored files (default)"),
957 OPT_STRING(0, "conflict", &conflict_style
, "style",
958 "conflict style (merge or diff3)"),
959 OPT_BOOLEAN('p', "patch", &opts
.patch_mode
, "select hunks interactively"),
960 { OPTION_BOOLEAN
, 0, "guess", &dwim_new_local_branch
, NULL
,
961 "second guess 'git checkout no-such-branch'",
962 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
},
966 memset(&opts
, 0, sizeof(opts
));
967 memset(&new, 0, sizeof(new));
968 opts
.overwrite_ignore
= 1;
969 opts
.prefix
= prefix
;
972 git_config(git_checkout_config
, &opts
);
974 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
976 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
977 PARSE_OPT_KEEP_DASHDASH
);
979 /* we can assume from now on new_branch = !new_branch_force */
980 if (opts
.new_branch
&& opts
.new_branch_force
)
981 die(_("-B cannot be used with -b"));
983 /* copy -B over to -b, so that we can just check the latter */
984 if (opts
.new_branch_force
)
985 opts
.new_branch
= opts
.new_branch_force
;
987 if (opts
.patch_mode
&& (opts
.track
> 0 || opts
.new_branch
988 || opts
.new_branch_log
|| opts
.merge
|| opts
.force
989 || opts
.force_detach
))
990 die (_("--patch is incompatible with all other options"));
992 if (opts
.force_detach
&& (opts
.new_branch
|| opts
.new_orphan_branch
))
993 die(_("--detach cannot be used with -b/-B/--orphan"));
994 if (opts
.force_detach
&& 0 < opts
.track
)
995 die(_("--detach cannot be used with -t"));
997 /* --track without -b should DWIM */
998 if (0 < opts
.track
&& !opts
.new_branch
) {
999 const char *argv0
= argv
[0];
1000 if (!argc
|| !strcmp(argv0
, "--"))
1001 die (_("--track needs a branch name"));
1002 if (!prefixcmp(argv0
, "refs/"))
1004 if (!prefixcmp(argv0
, "remotes/"))
1006 argv0
= strchr(argv0
, '/');
1007 if (!argv0
|| !argv0
[1])
1008 die (_("Missing branch name; try -b"));
1009 opts
.new_branch
= argv0
+ 1;
1012 if (opts
.new_orphan_branch
) {
1013 if (opts
.new_branch
)
1014 die(_("--orphan and -b|-B are mutually exclusive"));
1016 die(_("--orphan cannot be used with -t"));
1017 opts
.new_branch
= opts
.new_orphan_branch
;
1020 if (conflict_style
) {
1021 opts
.merge
= 1; /* implied */
1022 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1025 if (opts
.force
&& opts
.merge
)
1026 die(_("git checkout: -f and -m are incompatible"));
1029 * Extract branch name from command line arguments, so
1030 * all that is left is pathspecs.
1034 * 1) git checkout <tree> -- [<paths>]
1035 * 2) git checkout -- [<paths>]
1036 * 3) git checkout <something> [<paths>]
1038 * including "last branch" syntax and DWIM-ery for names of
1039 * remote branches, erroring out for invalid or ambiguous cases.
1042 unsigned char rev
[20];
1045 dwim_new_local_branch
&&
1046 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1048 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1049 &new, &opts
.source_tree
,
1050 rev
, &opts
.new_branch
);
1055 if (opts
.track
== BRANCH_TRACK_UNSPECIFIED
)
1056 opts
.track
= git_branch_track
;
1059 opts
.pathspec
= get_pathspec(prefix
, argv
);
1062 die(_("invalid path specification"));
1064 if (opts
.patch_mode
)
1065 return interactive_checkout(new.name
, opts
.pathspec
);
1067 /* Checkout paths */
1068 if (opts
.new_branch
) {
1070 die(_("git checkout: updating paths is incompatible with switching branches.\nDid you intend to checkout '%s' which can not be resolved as commit?"), argv
[0]);
1072 die(_("git checkout: updating paths is incompatible with switching branches."));
1076 if (opts
.force_detach
)
1077 die(_("git checkout: --detach does not take a path argument"));
1079 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1080 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\nchecking out of the index."));
1082 return checkout_paths(&opts
);
1085 if (opts
.patch_mode
)
1086 return interactive_checkout(new.name
, NULL
);
1088 if (opts
.new_branch
) {
1089 struct strbuf buf
= STRBUF_INIT
;
1091 opts
.branch_exists
= validate_new_branchname(opts
.new_branch
, &buf
,
1092 !!opts
.new_branch_force
,
1093 !!opts
.new_branch_force
);
1095 strbuf_release(&buf
);
1098 if (new.name
&& !new.commit
) {
1099 die(_("Cannot switch branch to a non-commit."));
1101 if (opts
.writeout_stage
)
1102 die(_("--ours/--theirs is incompatible with switching branches."));
1104 if (!new.commit
&& opts
.new_branch
) {
1105 unsigned char rev
[20];
1108 if (!read_ref_full("HEAD", rev
, 0, &flag
) &&
1109 (flag
& REF_ISSYMREF
) && is_null_sha1(rev
))
1110 return switch_unborn_to_new_branch(&opts
);
1112 return switch_branches(&opts
, &new);