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 /* not set by parse_options */
42 const char *new_branch
;
43 const char *new_branch_force
;
44 const char *new_orphan_branch
;
46 enum branch_track track
;
47 struct diff_options diff_options
;
50 static int post_checkout_hook(struct commit
*old
, struct commit
*new,
53 return run_hook(NULL
, "post-checkout",
54 sha1_to_hex(old
? old
->object
.sha1
: null_sha1
),
55 sha1_to_hex(new ? new->object
.sha1
: null_sha1
),
56 changed
? "1" : "0", NULL
);
57 /* "new" can be NULL when checking out from the index before
62 static int update_some(const unsigned char *sha1
, const char *base
, int baselen
,
63 const char *pathname
, unsigned mode
, int stage
, void *context
)
66 struct cache_entry
*ce
;
69 return READ_TREE_RECURSIVE
;
71 len
= baselen
+ strlen(pathname
);
72 ce
= xcalloc(1, cache_entry_size(len
));
73 hashcpy(ce
->sha1
, sha1
);
74 memcpy(ce
->name
, base
, baselen
);
75 memcpy(ce
->name
+ baselen
, pathname
, len
- baselen
);
76 ce
->ce_flags
= create_ce_flags(len
, 0) | CE_UPDATE
;
77 ce
->ce_mode
= create_ce_mode(mode
);
78 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
82 static int read_tree_some(struct tree
*tree
, const char **pathspec
)
85 init_pathspec(&ps
, pathspec
);
86 read_tree_recursive(tree
, "", 0, 0, &ps
, update_some
, NULL
);
89 /* update the index with the given tree's info
90 * for all args, expanding wildcards, and exit
91 * with any non-zero return code.
96 static int skip_same_name(struct cache_entry
*ce
, int pos
)
98 while (++pos
< active_nr
&&
99 !strcmp(active_cache
[pos
]->name
, ce
->name
))
104 static int check_stage(int stage
, struct cache_entry
*ce
, int pos
)
106 while (pos
< active_nr
&&
107 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
108 if (ce_stage(active_cache
[pos
]) == stage
)
113 return error(_("path '%s' does not have our version"), ce
->name
);
115 return error(_("path '%s' does not have their version"), ce
->name
);
118 static int check_stages(unsigned stages
, struct cache_entry
*ce
, int pos
)
121 const char *name
= ce
->name
;
123 while (pos
< active_nr
) {
124 ce
= active_cache
[pos
];
125 if (strcmp(name
, ce
->name
))
127 seen
|= (1 << ce_stage(ce
));
130 if ((stages
& seen
) != stages
)
131 return error(_("path '%s' does not have all necessary versions"),
136 static int checkout_stage(int stage
, struct cache_entry
*ce
, int pos
,
137 struct checkout
*state
)
139 while (pos
< active_nr
&&
140 !strcmp(active_cache
[pos
]->name
, ce
->name
)) {
141 if (ce_stage(active_cache
[pos
]) == stage
)
142 return checkout_entry(active_cache
[pos
], state
, NULL
);
146 return error(_("path '%s' does not have our version"), ce
->name
);
148 return error(_("path '%s' does not have their version"), ce
->name
);
151 static int checkout_merged(int pos
, struct checkout
*state
)
153 struct cache_entry
*ce
= active_cache
[pos
];
154 const char *path
= ce
->name
;
155 mmfile_t ancestor
, ours
, theirs
;
157 unsigned char sha1
[20];
158 mmbuffer_t result_buf
;
159 unsigned char threeway
[3][20];
162 memset(threeway
, 0, sizeof(threeway
));
163 while (pos
< active_nr
) {
165 stage
= ce_stage(ce
);
166 if (!stage
|| strcmp(path
, ce
->name
))
168 hashcpy(threeway
[stage
- 1], ce
->sha1
);
170 mode
= create_ce_mode(ce
->ce_mode
);
172 ce
= active_cache
[pos
];
174 if (is_null_sha1(threeway
[1]) || is_null_sha1(threeway
[2]))
175 return error(_("path '%s' does not have necessary versions"), path
);
177 read_mmblob(&ancestor
, threeway
[0]);
178 read_mmblob(&ours
, threeway
[1]);
179 read_mmblob(&theirs
, threeway
[2]);
182 * NEEDSWORK: re-create conflicts from merges with
183 * merge.renormalize set, too
185 status
= ll_merge(&result_buf
, path
, &ancestor
, "base",
186 &ours
, "ours", &theirs
, "theirs", NULL
);
190 if (status
< 0 || !result_buf
.ptr
) {
191 free(result_buf
.ptr
);
192 return error(_("path '%s': cannot merge"), path
);
197 * There is absolutely no reason to write this as a blob object
198 * and create a phony cache entry just to leak. This hack is
199 * primarily to get to the write_entry() machinery that massages
200 * the contents to work-tree format and writes out which only
201 * allows it for a cache entry. The code in write_entry() needs
202 * to be refactored to allow us to feed a <buffer, size, mode>
203 * instead of a cache entry. Such a refactoring would help
204 * merge_recursive as well (it also writes the merge result to the
205 * object database even when it may contain conflicts).
207 if (write_sha1_file(result_buf
.ptr
, result_buf
.size
,
209 die(_("Unable to add merge result for '%s'"), path
);
210 ce
= make_cache_entry(mode
, sha1
, path
, 2, 0);
212 die(_("make_cache_entry failed for path '%s'"), path
);
213 status
= checkout_entry(ce
, state
, NULL
);
217 static int checkout_paths(struct tree
*source_tree
, const char **pathspec
,
218 const char *prefix
, struct checkout_opts
*opts
)
221 struct checkout state
;
222 static char *ps_matched
;
223 unsigned char rev
[20];
227 int stage
= opts
->writeout_stage
;
228 int merge
= opts
->merge
;
230 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
232 newfd
= hold_locked_index(lock_file
, 1);
233 if (read_cache_preload(pathspec
) < 0)
234 return error(_("corrupt index file"));
237 read_tree_some(source_tree
, pathspec
);
239 for (pos
= 0; pathspec
[pos
]; pos
++)
241 ps_matched
= xcalloc(1, pos
);
243 for (pos
= 0; pos
< active_nr
; pos
++) {
244 struct cache_entry
*ce
= active_cache
[pos
];
245 if (source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
247 match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
), 0, ps_matched
);
250 if (report_path_error(ps_matched
, pathspec
, prefix
))
253 /* "checkout -m path" to recreate conflicted state */
255 unmerge_cache(pathspec
);
257 /* Any unmerged paths? */
258 for (pos
= 0; pos
< active_nr
; pos
++) {
259 struct cache_entry
*ce
= active_cache
[pos
];
260 if (match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
), 0, NULL
)) {
264 warning(_("path '%s' is unmerged"), ce
->name
);
266 errs
|= check_stage(stage
, ce
, pos
);
267 } else if (opts
->merge
) {
268 errs
|= check_stages((1<<2) | (1<<3), ce
, pos
);
271 error(_("path '%s' is unmerged"), ce
->name
);
273 pos
= skip_same_name(ce
, pos
) - 1;
279 /* Now we are committed to check them out */
280 memset(&state
, 0, sizeof(state
));
282 state
.refresh_cache
= 1;
283 for (pos
= 0; pos
< active_nr
; pos
++) {
284 struct cache_entry
*ce
= active_cache
[pos
];
285 if (source_tree
&& !(ce
->ce_flags
& CE_UPDATE
))
287 if (match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
), 0, NULL
)) {
289 errs
|= checkout_entry(ce
, &state
, NULL
);
293 errs
|= checkout_stage(stage
, ce
, pos
, &state
);
295 errs
|= checkout_merged(pos
, &state
);
296 pos
= skip_same_name(ce
, pos
) - 1;
300 if (write_cache(newfd
, active_cache
, active_nr
) ||
301 commit_locked_index(lock_file
))
302 die(_("unable to write new index file"));
304 read_ref_full("HEAD", rev
, 0, &flag
);
305 head
= lookup_commit_reference_gently(rev
, 1);
307 errs
|= post_checkout_hook(head
, head
, 0);
311 static void show_local_changes(struct object
*head
, struct diff_options
*opts
)
314 /* I think we want full paths, even if we're in a subdirectory. */
315 init_revisions(&rev
, NULL
);
316 rev
.diffopt
.flags
= opts
->flags
;
317 rev
.diffopt
.output_format
|= DIFF_FORMAT_NAME_STATUS
;
318 if (diff_setup_done(&rev
.diffopt
) < 0)
319 die(_("diff_setup_done failed"));
320 add_pending_object(&rev
, head
, NULL
);
321 run_diff_index(&rev
, 0);
324 static void describe_detached_head(const char *msg
, struct commit
*commit
)
326 struct strbuf sb
= STRBUF_INIT
;
327 parse_commit(commit
);
328 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &sb
);
329 fprintf(stderr
, "%s %s... %s\n", msg
,
330 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
), sb
.buf
);
334 static int reset_tree(struct tree
*tree
, struct checkout_opts
*o
, int worktree
)
336 struct unpack_trees_options opts
;
337 struct tree_desc tree_desc
;
339 memset(&opts
, 0, sizeof(opts
));
341 opts
.update
= worktree
;
342 opts
.skip_unmerged
= !worktree
;
345 opts
.fn
= oneway_merge
;
346 opts
.verbose_update
= !o
->quiet
;
347 opts
.src_index
= &the_index
;
348 opts
.dst_index
= &the_index
;
350 init_tree_desc(&tree_desc
, tree
->buffer
, tree
->size
);
351 switch (unpack_trees(1, &tree_desc
, &opts
)) {
353 o
->writeout_error
= 1;
355 * We return 0 nevertheless, as the index is all right
356 * and more importantly we have made best efforts to
357 * update paths in the work tree, and we cannot revert
368 const char *name
; /* The short name used */
369 const char *path
; /* The full name of a real branch */
370 struct commit
*commit
; /* The named commit */
373 static void setup_branch_path(struct branch_info
*branch
)
375 struct strbuf buf
= STRBUF_INIT
;
377 strbuf_branchname(&buf
, branch
->name
);
378 if (strcmp(buf
.buf
, branch
->name
))
379 branch
->name
= xstrdup(buf
.buf
);
380 strbuf_splice(&buf
, 0, 0, "refs/heads/", 11);
381 branch
->path
= strbuf_detach(&buf
, NULL
);
384 static int merge_working_tree(struct checkout_opts
*opts
,
385 struct branch_info
*old
, struct branch_info
*new)
388 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
389 int newfd
= hold_locked_index(lock_file
, 1);
391 if (read_cache_preload(NULL
) < 0)
392 return error(_("corrupt index file"));
394 resolve_undo_clear();
396 ret
= reset_tree(new->commit
->tree
, opts
, 1);
400 struct tree_desc trees
[2];
402 struct unpack_trees_options topts
;
404 memset(&topts
, 0, sizeof(topts
));
406 topts
.src_index
= &the_index
;
407 topts
.dst_index
= &the_index
;
409 setup_unpack_trees_porcelain(&topts
, "checkout");
411 refresh_cache(REFRESH_QUIET
);
413 if (unmerged_cache()) {
414 error(_("you need to resolve your current index first"));
418 /* 2-way merge to the new branch */
419 topts
.initial_checkout
= is_cache_unborn();
422 topts
.gently
= opts
->merge
&& old
->commit
;
423 topts
.verbose_update
= !opts
->quiet
;
424 topts
.fn
= twoway_merge
;
425 if (opts
->overwrite_ignore
) {
426 topts
.dir
= xcalloc(1, sizeof(*topts
.dir
));
427 topts
.dir
->flags
|= DIR_SHOW_IGNORED
;
428 setup_standard_excludes(topts
.dir
);
430 tree
= parse_tree_indirect(old
->commit
?
431 old
->commit
->object
.sha1
:
432 EMPTY_TREE_SHA1_BIN
);
433 init_tree_desc(&trees
[0], tree
->buffer
, tree
->size
);
434 tree
= parse_tree_indirect(new->commit
->object
.sha1
);
435 init_tree_desc(&trees
[1], tree
->buffer
, tree
->size
);
437 ret
= unpack_trees(2, trees
, &topts
);
440 * Unpack couldn't do a trivial merge; either
441 * give up or do a real merge, depending on
442 * whether the merge flag was used.
446 struct merge_options o
;
451 * Without old->commit, the below is the same as
452 * the two-tree unpack we already tried and failed.
457 /* Do more real merge */
460 * We update the index fully, then write the
461 * tree from the index, then merge the new
462 * branch with the current tree, with the old
463 * branch as the base. Then we reset the index
464 * (but not the working tree) to the new
465 * branch, leaving the working tree as the
466 * merged version, but skipping unmerged
467 * entries in the index.
470 add_files_to_cache(NULL
, NULL
, 0);
472 * NEEDSWORK: carrying over local changes
473 * when branches have different end-of-line
474 * normalization (or clean+smudge rules) is
475 * a pain; plumb in an option to set
478 init_merge_options(&o
);
480 work
= write_tree_from_memory(&o
);
482 ret
= reset_tree(new->commit
->tree
, opts
, 1);
485 o
.ancestor
= old
->name
;
486 o
.branch1
= new->name
;
488 merge_trees(&o
, new->commit
->tree
, work
,
489 old
->commit
->tree
, &result
);
490 ret
= reset_tree(new->commit
->tree
, opts
, 0);
496 if (write_cache(newfd
, active_cache
, active_nr
) ||
497 commit_locked_index(lock_file
))
498 die(_("unable to write new index file"));
500 if (!opts
->force
&& !opts
->quiet
)
501 show_local_changes(&new->commit
->object
, &opts
->diff_options
);
506 static void report_tracking(struct branch_info
*new)
508 struct strbuf sb
= STRBUF_INIT
;
509 struct branch
*branch
= branch_get(new->name
);
511 if (!format_tracking_info(branch
, &sb
))
513 fputs(sb
.buf
, stdout
);
517 static void update_refs_for_switch(struct checkout_opts
*opts
,
518 struct branch_info
*old
,
519 struct branch_info
*new)
521 struct strbuf msg
= STRBUF_INIT
;
522 const char *old_desc
;
523 if (opts
->new_branch
) {
524 if (opts
->new_orphan_branch
) {
525 if (opts
->new_branch_log
&& !log_all_ref_updates
) {
527 char log_file
[PATH_MAX
];
528 char *ref_name
= mkpath("refs/heads/%s", opts
->new_orphan_branch
);
530 temp
= log_all_ref_updates
;
531 log_all_ref_updates
= 1;
532 if (log_ref_setup(ref_name
, log_file
, sizeof(log_file
))) {
533 fprintf(stderr
, _("Can not do reflog for '%s'\n"),
534 opts
->new_orphan_branch
);
535 log_all_ref_updates
= temp
;
538 log_all_ref_updates
= temp
;
542 create_branch(old
->name
, opts
->new_branch
, new->name
,
543 opts
->new_branch_force
? 1 : 0,
544 opts
->new_branch_log
,
545 opts
->new_branch_force
? 1 : 0,
547 new->name
= opts
->new_branch
;
548 setup_branch_path(new);
551 old_desc
= old
->name
;
552 if (!old_desc
&& old
->commit
)
553 old_desc
= sha1_to_hex(old
->commit
->object
.sha1
);
554 strbuf_addf(&msg
, "checkout: moving from %s to %s",
555 old_desc
? old_desc
: "(invalid)", new->name
);
557 if (!strcmp(new->name
, "HEAD") && !new->path
&& !opts
->force_detach
) {
559 } else if (opts
->force_detach
|| !new->path
) { /* No longer on any branch. */
560 update_ref(msg
.buf
, "HEAD", new->commit
->object
.sha1
, NULL
,
561 REF_NODEREF
, DIE_ON_ERR
);
563 if (old
->path
&& advice_detached_head
)
564 detach_advice(new->name
);
565 describe_detached_head(_("HEAD is now at"), new->commit
);
567 } else if (new->path
) { /* Switch branches. */
568 create_symref("HEAD", new->path
, msg
.buf
);
570 if (old
->path
&& !strcmp(new->path
, old
->path
)) {
571 if (opts
->new_branch_force
)
572 fprintf(stderr
, _("Reset branch '%s'\n"),
575 fprintf(stderr
, _("Already on '%s'\n"),
577 } else if (opts
->new_branch
) {
578 if (opts
->branch_exists
)
579 fprintf(stderr
, _("Switched to and reset branch '%s'\n"), new->name
);
581 fprintf(stderr
, _("Switched to a new branch '%s'\n"), new->name
);
583 fprintf(stderr
, _("Switched to branch '%s'\n"),
587 if (old
->path
&& old
->name
) {
588 char log_file
[PATH_MAX
], ref_file
[PATH_MAX
];
590 git_snpath(log_file
, sizeof(log_file
), "logs/%s", old
->path
);
591 git_snpath(ref_file
, sizeof(ref_file
), "%s", old
->path
);
592 if (!file_exists(ref_file
) && file_exists(log_file
))
593 remove_path(log_file
);
596 remove_branch_state();
597 strbuf_release(&msg
);
599 (new->path
|| (!opts
->force_detach
&& !strcmp(new->name
, "HEAD"))))
600 report_tracking(new);
603 static int add_pending_uninteresting_ref(const char *refname
,
604 const unsigned char *sha1
,
605 int flags
, void *cb_data
)
607 add_pending_sha1(cb_data
, refname
, sha1
, flags
| UNINTERESTING
);
611 static void describe_one_orphan(struct strbuf
*sb
, struct commit
*commit
)
613 parse_commit(commit
);
614 strbuf_addstr(sb
, " ");
616 find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
617 strbuf_addch(sb
, ' ');
618 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, sb
);
619 strbuf_addch(sb
, '\n');
622 #define ORPHAN_CUTOFF 4
623 static void suggest_reattach(struct commit
*commit
, struct rev_info
*revs
)
625 struct commit
*c
, *last
= NULL
;
626 struct strbuf sb
= STRBUF_INIT
;
628 while ((c
= get_revision(revs
)) != NULL
) {
629 if (lost
< ORPHAN_CUTOFF
)
630 describe_one_orphan(&sb
, c
);
634 if (ORPHAN_CUTOFF
< lost
) {
635 int more
= lost
- ORPHAN_CUTOFF
;
637 describe_one_orphan(&sb
, last
);
639 strbuf_addf(&sb
, _(" ... and %d more.\n"), more
);
644 /* The singular version */
645 "Warning: you are leaving %d commit behind, "
647 "any of your branches:\n\n"
649 /* The plural version */
650 "Warning: you are leaving %d commits behind, "
652 "any of your branches:\n\n"
654 /* Give ngettext() the count */
660 if (advice_detached_head
)
663 "If you want to keep them by creating a new branch, "
664 "this may be a good time\nto do so with:\n\n"
665 " git branch new_branch_name %s\n\n"),
666 sha1_to_hex(commit
->object
.sha1
));
670 * We are about to leave commit that was at the tip of a detached
671 * HEAD. If it is not reachable from any ref, this is the last chance
672 * for the user to do so without resorting to reflog.
674 static void orphaned_commit_warning(struct commit
*old
, struct commit
*new)
676 struct rev_info revs
;
677 struct object
*object
= &old
->object
;
678 struct object_array refs
;
680 init_revisions(&revs
, NULL
);
681 setup_revisions(0, NULL
, &revs
, NULL
);
683 object
->flags
&= ~UNINTERESTING
;
684 add_pending_object(&revs
, object
, sha1_to_hex(object
->sha1
));
686 for_each_ref(add_pending_uninteresting_ref
, &revs
);
687 add_pending_sha1(&revs
, "HEAD", new->object
.sha1
, UNINTERESTING
);
690 revs
.leak_pending
= 1;
692 if (prepare_revision_walk(&revs
))
693 die(_("internal error in revision walk"));
694 if (!(old
->object
.flags
& UNINTERESTING
))
695 suggest_reattach(old
, &revs
);
697 describe_detached_head(_("Previous HEAD position was"), old
);
699 clear_commit_marks_for_object_array(&refs
, ALL_REV_FLAGS
);
703 static int switch_branches(struct checkout_opts
*opts
, struct branch_info
*new)
706 struct branch_info old
;
708 unsigned char rev
[20];
710 memset(&old
, 0, sizeof(old
));
711 old
.path
= path_to_free
= resolve_refdup("HEAD", rev
, 0, &flag
);
712 old
.commit
= lookup_commit_reference_gently(rev
, 1);
713 if (!(flag
& REF_ISSYMREF
))
716 if (old
.path
&& !prefixcmp(old
.path
, "refs/heads/"))
717 old
.name
= old
.path
+ strlen("refs/heads/");
721 new->commit
= old
.commit
;
723 die(_("You are on a branch yet to be born"));
724 parse_commit(new->commit
);
727 ret
= merge_working_tree(opts
, &old
, new);
733 if (!opts
->quiet
&& !old
.path
&& old
.commit
&& new->commit
!= old
.commit
)
734 orphaned_commit_warning(old
.commit
, new->commit
);
736 update_refs_for_switch(opts
, &old
, new);
738 ret
= post_checkout_hook(old
.commit
, new->commit
, 1);
740 return ret
|| opts
->writeout_error
;
743 static int git_checkout_config(const char *var
, const char *value
, void *cb
)
745 if (!strcmp(var
, "diff.ignoresubmodules")) {
746 struct checkout_opts
*opts
= cb
;
747 handle_ignore_submodules_arg(&opts
->diff_options
, value
);
751 if (!prefixcmp(var
, "submodule."))
752 return parse_submodule_config_option(var
, value
);
754 return git_xmerge_config(var
, value
, NULL
);
757 static int interactive_checkout(const char *revision
, const char **pathspec
,
758 struct checkout_opts
*opts
)
760 return run_add_interactive(revision
, "--patch=checkout", pathspec
);
763 struct tracking_name_data
{
769 static int check_tracking_name(const char *refname
, const unsigned char *sha1
,
770 int flags
, void *cb_data
)
772 struct tracking_name_data
*cb
= cb_data
;
775 if (prefixcmp(refname
, "refs/remotes/"))
777 slash
= strchr(refname
+ 13, '/');
778 if (!slash
|| strcmp(slash
+ 1, cb
->name
))
784 cb
->remote
= xstrdup(refname
);
788 static const char *unique_tracking_name(const char *name
)
790 struct tracking_name_data cb_data
= { NULL
, NULL
, 1 };
792 for_each_ref(check_tracking_name
, &cb_data
);
794 return cb_data
.remote
;
795 free(cb_data
.remote
);
799 static int parse_branchname_arg(int argc
, const char **argv
,
800 int dwim_new_local_branch_ok
,
801 struct branch_info
*new,
802 struct tree
**source_tree
,
803 unsigned char rev
[20],
804 const char **new_branch
)
807 unsigned char branch_rev
[20];
812 * case 1: git checkout <ref> -- [<paths>]
814 * <ref> must be a valid tree, everything after the '--' must be
817 * case 2: git checkout -- [<paths>]
819 * everything after the '--' must be paths.
821 * case 3: git checkout <something> [<paths>]
823 * With no paths, if <something> is a commit, that is to
824 * switch to the branch or detach HEAD at it. As a special case,
825 * if <something> is A...B (missing A or B means HEAD but you can
826 * omit at most one side), and if there is a unique merge base
827 * between A and B, A...B names that merge base.
829 * With no paths, if <something> is _not_ a commit, no -t nor -b
830 * was given, and there is a tracking branch whose name is
831 * <something> in one and only one remote, then this is a short-hand
832 * to fork local <something> from that remote-tracking branch.
834 * Otherwise <something> shall not be ambiguous.
835 * - If it's *only* a reference, treat it like case (1).
836 * - If it's only a path, treat it like case (2).
843 if (!strcmp(argv
[0], "--")) /* case (2) */
847 has_dash_dash
= (argc
> 1) && !strcmp(argv
[1], "--");
849 if (!strcmp(arg
, "-"))
852 if (get_sha1_mb(arg
, rev
)) {
853 if (has_dash_dash
) /* case (1) */
854 die(_("invalid reference: %s"), arg
);
855 if (dwim_new_local_branch_ok
&&
856 !check_filename(NULL
, arg
) &&
858 const char *remote
= unique_tracking_name(arg
);
859 if (!remote
|| get_sha1(remote
, rev
))
863 /* DWIMmed to create local branch */
869 /* we can't end up being in (2) anymore, eat the argument */
875 setup_branch_path(new);
877 if (!check_refname_format(new->path
, 0) &&
878 !read_ref(new->path
, branch_rev
))
879 hashcpy(rev
, branch_rev
);
881 new->path
= NULL
; /* not an existing branch */
883 new->commit
= lookup_commit_reference_gently(rev
, 1);
886 *source_tree
= parse_tree_indirect(rev
);
888 parse_commit(new->commit
);
889 *source_tree
= new->commit
->tree
;
892 if (!*source_tree
) /* case (1): want a tree */
893 die(_("reference is not a tree: %s"), arg
);
894 if (!has_dash_dash
) {/* case (3 -> 1) */
896 * Do not complain the most common case
897 * git checkout branch
898 * even if there happen to be a file called 'branch';
899 * it would be extremely annoying.
902 verify_non_filename(NULL
, arg
);
912 static int switch_unborn_to_new_branch(struct checkout_opts
*opts
)
915 struct strbuf branch_ref
= STRBUF_INIT
;
917 strbuf_addf(&branch_ref
, "refs/heads/%s", opts
->new_branch
);
918 status
= create_symref("HEAD", branch_ref
.buf
, "checkout -b");
919 strbuf_release(&branch_ref
);
923 int cmd_checkout(int argc
, const char **argv
, const char *prefix
)
925 struct checkout_opts opts
;
926 unsigned char rev
[20];
927 struct branch_info
new;
928 struct tree
*source_tree
= NULL
;
929 char *conflict_style
= NULL
;
931 int dwim_new_local_branch
= 1;
932 struct option options
[] = {
933 OPT__QUIET(&opts
.quiet
, "suppress progress reporting"),
934 OPT_STRING('b', NULL
, &opts
.new_branch
, "branch",
935 "create and checkout a new branch"),
936 OPT_STRING('B', NULL
, &opts
.new_branch_force
, "branch",
937 "create/reset and checkout a branch"),
938 OPT_BOOLEAN('l', NULL
, &opts
.new_branch_log
, "create reflog for new branch"),
939 OPT_BOOLEAN(0, "detach", &opts
.force_detach
, "detach the HEAD at named commit"),
940 OPT_SET_INT('t', "track", &opts
.track
, "set upstream info for new branch",
941 BRANCH_TRACK_EXPLICIT
),
942 OPT_STRING(0, "orphan", &opts
.new_orphan_branch
, "new branch", "new unparented branch"),
943 OPT_SET_INT('2', "ours", &opts
.writeout_stage
, "checkout our version for unmerged files",
945 OPT_SET_INT('3', "theirs", &opts
.writeout_stage
, "checkout their version for unmerged files",
947 OPT__FORCE(&opts
.force
, "force checkout (throw away local modifications)"),
948 OPT_BOOLEAN('m', "merge", &opts
.merge
, "perform a 3-way merge with the new branch"),
949 OPT_BOOLEAN(0, "overwrite-ignore", &opts
.overwrite_ignore
, "update ignored files (default)"),
950 OPT_STRING(0, "conflict", &conflict_style
, "style",
951 "conflict style (merge or diff3)"),
952 OPT_BOOLEAN('p', "patch", &patch_mode
, "select hunks interactively"),
953 { OPTION_BOOLEAN
, 0, "guess", &dwim_new_local_branch
, NULL
,
954 "second guess 'git checkout no-such-branch'",
955 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
},
959 memset(&opts
, 0, sizeof(opts
));
960 memset(&new, 0, sizeof(new));
961 opts
.overwrite_ignore
= 1;
964 git_config(git_checkout_config
, &opts
);
966 opts
.track
= BRANCH_TRACK_UNSPECIFIED
;
968 argc
= parse_options(argc
, argv
, prefix
, options
, checkout_usage
,
969 PARSE_OPT_KEEP_DASHDASH
);
971 /* we can assume from now on new_branch = !new_branch_force */
972 if (opts
.new_branch
&& opts
.new_branch_force
)
973 die(_("-B cannot be used with -b"));
975 /* copy -B over to -b, so that we can just check the latter */
976 if (opts
.new_branch_force
)
977 opts
.new_branch
= opts
.new_branch_force
;
979 if (patch_mode
&& (opts
.track
> 0 || opts
.new_branch
980 || opts
.new_branch_log
|| opts
.merge
|| opts
.force
981 || opts
.force_detach
))
982 die (_("--patch is incompatible with all other options"));
984 if (opts
.force_detach
&& (opts
.new_branch
|| opts
.new_orphan_branch
))
985 die(_("--detach cannot be used with -b/-B/--orphan"));
986 if (opts
.force_detach
&& 0 < opts
.track
)
987 die(_("--detach cannot be used with -t"));
989 /* --track without -b should DWIM */
990 if (0 < opts
.track
&& !opts
.new_branch
) {
991 const char *argv0
= argv
[0];
992 if (!argc
|| !strcmp(argv0
, "--"))
993 die (_("--track needs a branch name"));
994 if (!prefixcmp(argv0
, "refs/"))
996 if (!prefixcmp(argv0
, "remotes/"))
998 argv0
= strchr(argv0
, '/');
999 if (!argv0
|| !argv0
[1])
1000 die (_("Missing branch name; try -b"));
1001 opts
.new_branch
= argv0
+ 1;
1004 if (opts
.new_orphan_branch
) {
1005 if (opts
.new_branch
)
1006 die(_("--orphan and -b|-B are mutually exclusive"));
1008 die(_("--orphan cannot be used with -t"));
1009 opts
.new_branch
= opts
.new_orphan_branch
;
1012 if (conflict_style
) {
1013 opts
.merge
= 1; /* implied */
1014 git_xmerge_config("merge.conflictstyle", conflict_style
, NULL
);
1017 if (opts
.force
&& opts
.merge
)
1018 die(_("git checkout: -f and -m are incompatible"));
1021 * Extract branch name from command line arguments, so
1022 * all that is left is pathspecs.
1026 * 1) git checkout <tree> -- [<paths>]
1027 * 2) git checkout -- [<paths>]
1028 * 3) git checkout <something> [<paths>]
1030 * including "last branch" syntax and DWIM-ery for names of
1031 * remote branches, erroring out for invalid or ambiguous cases.
1036 dwim_new_local_branch
&&
1037 opts
.track
== BRANCH_TRACK_UNSPECIFIED
&&
1039 int n
= parse_branchname_arg(argc
, argv
, dwim_ok
,
1040 &new, &source_tree
, rev
, &opts
.new_branch
);
1045 if (opts
.track
== BRANCH_TRACK_UNSPECIFIED
)
1046 opts
.track
= git_branch_track
;
1049 const char **pathspec
= get_pathspec(prefix
, argv
);
1052 die(_("invalid path specification"));
1055 return interactive_checkout(new.name
, pathspec
, &opts
);
1057 /* Checkout paths */
1058 if (opts
.new_branch
) {
1060 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]);
1062 die(_("git checkout: updating paths is incompatible with switching branches."));
1066 if (opts
.force_detach
)
1067 die(_("git checkout: --detach does not take a path argument"));
1069 if (1 < !!opts
.writeout_stage
+ !!opts
.force
+ !!opts
.merge
)
1070 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\nchecking out of the index."));
1072 return checkout_paths(source_tree
, pathspec
, prefix
, &opts
);
1076 return interactive_checkout(new.name
, NULL
, &opts
);
1078 if (opts
.new_branch
) {
1079 struct strbuf buf
= STRBUF_INIT
;
1081 opts
.branch_exists
= validate_new_branchname(opts
.new_branch
, &buf
,
1082 !!opts
.new_branch_force
,
1083 !!opts
.new_branch_force
);
1085 strbuf_release(&buf
);
1088 if (new.name
&& !new.commit
) {
1089 die(_("Cannot switch branch to a non-commit."));
1091 if (opts
.writeout_stage
)
1092 die(_("--ours/--theirs is incompatible with switching branches."));
1095 unsigned char rev
[20];
1098 if (!read_ref_full("HEAD", rev
, 0, &flag
) &&
1099 (flag
& REF_ISSYMREF
) && is_null_sha1(rev
))
1100 return switch_unborn_to_new_branch(&opts
);
1102 return switch_branches(&opts
, &new);