tree.c: make read_tree*() take 'struct repository *'
[git/git.git] / builtin / checkout.c
CommitLineData
782c2d65 1#include "builtin.h"
b2141fc1 2#include "config.h"
7c85a87c 3#include "checkout.h"
697cc8ef 4#include "lockfile.h"
782c2d65
DB
5#include "parse-options.h"
6#include "refs.h"
cbd53a21 7#include "object-store.h"
782c2d65
DB
8#include "commit.h"
9#include "tree.h"
10#include "tree-walk.h"
b9d37a54 11#include "cache-tree.h"
782c2d65
DB
12#include "unpack-trees.h"
13#include "dir.h"
14#include "run-command.h"
15#include "merge-recursive.h"
16#include "branch.h"
17#include "diff.h"
18#include "revision.h"
79a1e6b4 19#include "remote.h"
0cf8581e
JH
20#include "blob.h"
21#include "xdiff-interface.h"
22#include "ll-merge.h"
cfc5789a 23#include "resolve-undo.h"
851e18c3 24#include "submodule-config.h"
175f6e59 25#include "submodule.h"
ad8d5104 26#include "advice.h"
782c2d65 27
fa655d84
BP
28static int checkout_optimize_new_branch;
29
782c2d65 30static const char * const checkout_usage[] = {
9c9b4f2f
AH
31 N_("git checkout [<options>] <branch>"),
32 N_("git checkout [<options>] [<branch>] -- <file>..."),
782c2d65
DB
33 NULL,
34};
35
db941099 36struct checkout_opts {
e51e3057 37 int patch_mode;
db941099
JH
38 int quiet;
39 int merge;
40 int force;
32669671 41 int force_detach;
38901a48 42 int writeout_stage;
c1d7036b 43 int overwrite_ignore;
08d595dc 44 int ignore_skipworktree;
1d0fa898 45 int ignore_other_worktrees;
870ebdb9 46 int show_progress;
fa655d84
BP
47 /*
48 * If new checkout options are added, skip_merge_working_tree
49 * should be updated accordingly.
50 */
db941099
JH
51
52 const char *new_branch;
02ac9837 53 const char *new_branch_force;
9db5ebf4 54 const char *new_orphan_branch;
db941099
JH
55 int new_branch_log;
56 enum branch_track track;
175f6e59 57 struct diff_options diff_options;
e51e3057
NTND
58
59 int branch_exists;
60 const char *prefix;
817b345a 61 struct pathspec pathspec;
e51e3057 62 struct tree *source_tree;
db941099
JH
63};
64
c8a3ea1f 65static int post_checkout_hook(struct commit *old_commit, struct commit *new_commit,
782c2d65
DB
66 int changed)
67{
15048f8a 68 return run_hook_le(NULL, "post-checkout",
c8a3ea1f
BW
69 oid_to_hex(old_commit ? &old_commit->object.oid : &null_oid),
70 oid_to_hex(new_commit ? &new_commit->object.oid : &null_oid),
15048f8a 71 changed ? "1" : "0", NULL);
c8a3ea1f 72 /* "new_commit" can be NULL when checking out from the index before
2292ce47 73 a commit exists. */
ae98a008 74
782c2d65
DB
75}
76
df46d77e 77static int update_some(const struct object_id *oid, struct strbuf *base,
671f0707 78 const char *pathname, unsigned mode, int stage, void *context)
782c2d65
DB
79{
80 int len;
81 struct cache_entry *ce;
c5326bd6 82 int pos;
782c2d65 83
782c2d65
DB
84 if (S_ISDIR(mode))
85 return READ_TREE_RECURSIVE;
86
6a0b0b6d 87 len = base->len + strlen(pathname);
a849735b 88 ce = make_empty_cache_entry(&the_index, len);
df46d77e 89 oidcpy(&ce->oid, oid);
6a0b0b6d
NTND
90 memcpy(ce->name, base->buf, base->len);
91 memcpy(ce->name + base->len, pathname, len - base->len);
b60e188c
TG
92 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
93 ce->ce_namelen = len;
782c2d65 94 ce->ce_mode = create_ce_mode(mode);
c5326bd6
JK
95
96 /*
97 * If the entry is the same as the current index, we can leave the old
98 * entry in place. Whether it is UPTODATE or not, checkout_entry will
99 * do the right thing.
100 */
101 pos = cache_name_pos(ce->name, ce->ce_namelen);
102 if (pos >= 0) {
103 struct cache_entry *old = active_cache[pos];
104 if (ce->ce_mode == old->ce_mode &&
4a7e27e9 105 oideq(&ce->oid, &old->oid)) {
c5326bd6 106 old->ce_flags |= CE_UPDATE;
a849735b 107 discard_cache_entry(ce);
c5326bd6
JK
108 return 0;
109 }
110 }
111
782c2d65
DB
112 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
113 return 0;
114}
115
18e4f405 116static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
782c2d65 117{
e092073d
NTND
118 read_tree_recursive(the_repository, tree, "", 0, 0,
119 pathspec, update_some, NULL);
782c2d65 120
782c2d65
DB
121 /* update the index with the given tree's info
122 * for all args, expanding wildcards, and exit
123 * with any non-zero return code.
124 */
125 return 0;
126}
127
9c5e6c80 128static int skip_same_name(const struct cache_entry *ce, int pos)
8fdcf312
JH
129{
130 while (++pos < active_nr &&
131 !strcmp(active_cache[pos]->name, ce->name))
132 ; /* skip */
133 return pos;
134}
135
9c5e6c80 136static int check_stage(int stage, const struct cache_entry *ce, int pos)
38901a48
JH
137{
138 while (pos < active_nr &&
139 !strcmp(active_cache[pos]->name, ce->name)) {
140 if (ce_stage(active_cache[pos]) == stage)
141 return 0;
142 pos++;
143 }
9f97ab08
ÆAB
144 if (stage == 2)
145 return error(_("path '%s' does not have our version"), ce->name);
146 else
147 return error(_("path '%s' does not have their version"), ce->name);
38901a48
JH
148}
149
9c5e6c80 150static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
0cf8581e 151{
fbbccd0a
JH
152 unsigned seen = 0;
153 const char *name = ce->name;
154
155 while (pos < active_nr) {
156 ce = active_cache[pos];
157 if (strcmp(name, ce->name))
158 break;
159 seen |= (1 << ce_stage(ce));
160 pos++;
161 }
162 if ((stages & seen) != stages)
163 return error(_("path '%s' does not have all necessary versions"),
164 name);
0cf8581e
JH
165 return 0;
166}
167
ce25e4c7
RS
168static int checkout_stage(int stage, const struct cache_entry *ce, int pos,
169 const struct checkout *state)
38901a48
JH
170{
171 while (pos < active_nr &&
172 !strcmp(active_cache[pos]->name, ce->name)) {
173 if (ce_stage(active_cache[pos]) == stage)
174 return checkout_entry(active_cache[pos], state, NULL);
175 pos++;
176 }
9f97ab08
ÆAB
177 if (stage == 2)
178 return error(_("path '%s' does not have our version"), ce->name);
179 else
180 return error(_("path '%s' does not have their version"), ce->name);
38901a48 181}
8fdcf312 182
ce25e4c7 183static int checkout_merged(int pos, const struct checkout *state)
0cf8581e
JH
184{
185 struct cache_entry *ce = active_cache[pos];
186 const char *path = ce->name;
187 mmfile_t ancestor, ours, theirs;
188 int status;
60af7691 189 struct object_id oid;
0cf8581e 190 mmbuffer_t result_buf;
60af7691 191 struct object_id threeway[3];
335c6e40 192 unsigned mode = 0;
0cf8581e 193
fbbccd0a
JH
194 memset(threeway, 0, sizeof(threeway));
195 while (pos < active_nr) {
196 int stage;
197 stage = ce_stage(ce);
198 if (!stage || strcmp(path, ce->name))
199 break;
60af7691 200 oidcpy(&threeway[stage - 1], &ce->oid);
fbbccd0a
JH
201 if (stage == 2)
202 mode = create_ce_mode(ce->ce_mode);
203 pos++;
204 ce = active_cache[pos];
205 }
60af7691 206 if (is_null_oid(&threeway[1]) || is_null_oid(&threeway[2]))
fbbccd0a 207 return error(_("path '%s' does not have necessary versions"), path);
0cf8581e 208
d449347d 209 read_mmblob(&ancestor, &threeway[0]);
210 read_mmblob(&ours, &threeway[1]);
211 read_mmblob(&theirs, &threeway[2]);
0cf8581e 212
18b037a5
JN
213 /*
214 * NEEDSWORK: re-create conflicts from merges with
215 * merge.renormalize set, too
216 */
f0531a29 217 status = ll_merge(&result_buf, path, &ancestor, "base",
32eaa468
NTND
218 &ours, "ours", &theirs, "theirs",
219 state->istate, NULL);
0cf8581e
JH
220 free(ancestor.ptr);
221 free(ours.ptr);
222 free(theirs.ptr);
223 if (status < 0 || !result_buf.ptr) {
224 free(result_buf.ptr);
e8a8a4d7 225 return error(_("path '%s': cannot merge"), path);
0cf8581e
JH
226 }
227
228 /*
229 * NEEDSWORK:
230 * There is absolutely no reason to write this as a blob object
514e8039
JS
231 * and create a phony cache entry. This hack is primarily to get
232 * to the write_entry() machinery that massages the contents to
233 * work-tree format and writes out which only allows it for a
234 * cache entry. The code in write_entry() needs to be refactored
235 * to allow us to feed a <buffer, size, mode> instead of a cache
236 * entry. Such a refactoring would help merge_recursive as well
237 * (it also writes the merge result to the object database even
238 * when it may contain conflicts).
0cf8581e 239 */
a09c985e 240 if (write_object_file(result_buf.ptr, result_buf.size, blob_type, &oid))
e8a8a4d7 241 die(_("Unable to add merge result for '%s'"), path);
443a12f3 242 free(result_buf.ptr);
a849735b 243 ce = make_transient_cache_entry(mode, &oid, path, 2);
048f2762 244 if (!ce)
e8a8a4d7 245 die(_("make_cache_entry failed for path '%s'"), path);
0cf8581e 246 status = checkout_entry(ce, state, NULL);
a849735b 247 discard_cache_entry(ce);
0cf8581e
JH
248 return status;
249}
8fdcf312 250
b6312c27
NTND
251static int checkout_paths(const struct checkout_opts *opts,
252 const char *revision)
782c2d65
DB
253{
254 int pos;
68e3d629 255 struct checkout state = CHECKOUT_INIT;
782c2d65 256 static char *ps_matched;
60af7691 257 struct object_id rev;
782c2d65 258 struct commit *head;
d2b3691b 259 int errs = 0;
837e34eb 260 struct lock_file lock_file = LOCK_INIT;
b6312c27
NTND
261
262 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
263 die(_("'%s' cannot be used with updating paths"), "--track");
264
265 if (opts->new_branch_log)
266 die(_("'%s' cannot be used with updating paths"), "-l");
267
268 if (opts->force && opts->patch_mode)
269 die(_("'%s' cannot be used with updating paths"), "-f");
270
271 if (opts->force_detach)
272 die(_("'%s' cannot be used with updating paths"), "--detach");
273
274 if (opts->merge && opts->patch_mode)
275 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
276
277 if (opts->force && opts->merge)
278 die(_("'%s' cannot be used with %s"), "-f", "-m");
279
280 if (opts->new_branch)
281 die(_("Cannot update paths and switch to branch '%s' at the same time."),
282 opts->new_branch);
283
284 if (opts->patch_mode)
285 return run_add_interactive(revision, "--patch=checkout",
480ca644 286 &opts->pathspec);
b6312c27 287
837e34eb 288 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
5ab2a2da 289 if (read_cache_preload(&opts->pathspec) < 0)
e923a8ab 290 return error(_("index file corrupt"));
75336878 291
e51e3057 292 if (opts->source_tree)
18e4f405 293 read_tree_some(opts->source_tree, &opts->pathspec);
75336878 294
8b54c234 295 ps_matched = xcalloc(opts->pathspec.nr, 1);
782c2d65 296
e721c154
NTND
297 /*
298 * Make sure all pathspecs participated in locating the paths
299 * to be checked out.
300 */
782c2d65
DB
301 for (pos = 0; pos < active_nr; pos++) {
302 struct cache_entry *ce = active_cache[pos];
e721c154 303 ce->ce_flags &= ~CE_MATCHED;
08d595dc
NTND
304 if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
305 continue;
e51e3057 306 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
e721c154
NTND
307 /*
308 * "git checkout tree-ish -- path", but this entry
309 * is in the original index; it will not be checked
310 * out to the working tree and it does not matter
311 * if pathspec matched this entry. We will not do
312 * anything to this entry at all.
313 */
0a1283bc 314 continue;
e721c154
NTND
315 /*
316 * Either this entry came from the tree-ish we are
317 * checking the paths out of, or we are checking out
318 * of the index.
319 *
320 * If it comes from the tree-ish, we already know it
321 * matches the pathspec and could just stamp
322 * CE_MATCHED to it from update_some(). But we still
323 * need ps_matched and read_tree_recursive (and
324 * eventually tree_entry_interesting) cannot fill
325 * ps_matched yet. Once it can, we can avoid calling
326 * match_pathspec() for _all_ entries when
327 * opts->source_tree != NULL.
328 */
6d2df284 329 if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched))
e721c154 330 ce->ce_flags |= CE_MATCHED;
782c2d65
DB
331 }
332
17ddc66e 333 if (report_path_error(ps_matched, &opts->pathspec, opts->prefix)) {
e721c154 334 free(ps_matched);
782c2d65 335 return 1;
e721c154
NTND
336 }
337 free(ps_matched);
782c2d65 338
4421a823
JH
339 /* "checkout -m path" to recreate conflicted state */
340 if (opts->merge)
e721c154 341 unmerge_marked_index(&the_index);
4421a823 342
8fdcf312
JH
343 /* Any unmerged paths? */
344 for (pos = 0; pos < active_nr; pos++) {
9c5e6c80 345 const struct cache_entry *ce = active_cache[pos];
e721c154 346 if (ce->ce_flags & CE_MATCHED) {
8fdcf312
JH
347 if (!ce_stage(ce))
348 continue;
db941099 349 if (opts->force) {
e8a8a4d7 350 warning(_("path '%s' is unmerged"), ce->name);
f9022075
SB
351 } else if (opts->writeout_stage) {
352 errs |= check_stage(opts->writeout_stage, ce, pos);
0cf8581e 353 } else if (opts->merge) {
fbbccd0a 354 errs |= check_stages((1<<2) | (1<<3), ce, pos);
db941099
JH
355 } else {
356 errs = 1;
e8a8a4d7 357 error(_("path '%s' is unmerged"), ce->name);
db941099 358 }
8fdcf312
JH
359 pos = skip_same_name(ce, pos) - 1;
360 }
361 }
362 if (errs)
363 return 1;
364
d2b3691b 365 /* Now we are committed to check them out */
782c2d65
DB
366 state.force = 1;
367 state.refresh_cache = 1;
d4a2024a 368 state.istate = &the_index;
2841e8f8
LS
369
370 enable_delayed_checkout(&state);
782c2d65
DB
371 for (pos = 0; pos < active_nr; pos++) {
372 struct cache_entry *ce = active_cache[pos];
e721c154 373 if (ce->ce_flags & CE_MATCHED) {
8fdcf312
JH
374 if (!ce_stage(ce)) {
375 errs |= checkout_entry(ce, &state, NULL);
376 continue;
377 }
f9022075
SB
378 if (opts->writeout_stage)
379 errs |= checkout_stage(opts->writeout_stage, ce, pos, &state);
380 else if (opts->merge)
0cf8581e 381 errs |= checkout_merged(pos, &state);
8fdcf312 382 pos = skip_same_name(ce, pos) - 1;
782c2d65
DB
383 }
384 }
2841e8f8 385 errs |= finish_delayed_checkout(&state);
782c2d65 386
837e34eb 387 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
e8a8a4d7 388 die(_("unable to write new index file"));
75336878 389
34c290a6 390 read_ref_full("HEAD", 0, &rev, NULL);
21e1ee8f 391 head = lookup_commit_reference_gently(the_repository, &rev, 1);
782c2d65 392
d2b3691b
JH
393 errs |= post_checkout_hook(head, head, 0);
394 return errs;
782c2d65
DB
395}
396
a2b4994c
NTND
397static void show_local_changes(struct object *head,
398 const struct diff_options *opts)
782c2d65
DB
399{
400 struct rev_info rev;
401 /* I think we want full paths, even if we're in a subdirectory. */
2abf3503 402 repo_init_revisions(the_repository, &rev, NULL);
175f6e59 403 rev.diffopt.flags = opts->flags;
782c2d65 404 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
28452655 405 diff_setup_done(&rev.diffopt);
782c2d65
DB
406 add_pending_object(&rev, head, NULL);
407 run_diff_index(&rev, 0);
408}
409
b3c0494a 410static void describe_detached_head(const char *msg, struct commit *commit)
782c2d65 411{
f285a2d7 412 struct strbuf sb = STRBUF_INIT;
ca69d4d5 413
3c621839
JK
414 if (!parse_commit(commit))
415 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
ca69d4d5
AR
416 if (print_sha1_ellipsis()) {
417 fprintf(stderr, "%s %s... %s\n", msg,
aab9583f 418 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
ca69d4d5
AR
419 } else {
420 fprintf(stderr, "%s %s %s\n", msg,
aab9583f 421 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
ca69d4d5 422 }
782c2d65
DB
423 strbuf_release(&sb);
424}
425
a2b4994c
NTND
426static int reset_tree(struct tree *tree, const struct checkout_opts *o,
427 int worktree, int *writeout_error)
782c2d65
DB
428{
429 struct unpack_trees_options opts;
430 struct tree_desc tree_desc;
bc052d7f 431
782c2d65
DB
432 memset(&opts, 0, sizeof(opts));
433 opts.head_idx = -1;
6286a08d
JH
434 opts.update = worktree;
435 opts.skip_unmerged = !worktree;
782c2d65
DB
436 opts.reset = 1;
437 opts.merge = 1;
438 opts.fn = oneway_merge;
870ebdb9 439 opts.verbose_update = o->show_progress;
34110cd4
LT
440 opts.src_index = &the_index;
441 opts.dst_index = &the_index;
782c2d65
DB
442 parse_tree(tree);
443 init_tree_desc(&tree_desc, tree->buffer, tree->size);
291d823e
JH
444 switch (unpack_trees(1, &tree_desc, &opts)) {
445 case -2:
a2b4994c 446 *writeout_error = 1;
291d823e
JH
447 /*
448 * We return 0 nevertheless, as the index is all right
449 * and more importantly we have made best efforts to
450 * update paths in the work tree, and we cannot revert
451 * them.
452 */
1cf01a34 453 /* fallthrough */
291d823e
JH
454 case 0:
455 return 0;
456 default:
84a5750b 457 return 128;
291d823e 458 }
782c2d65
DB
459}
460
782c2d65
DB
461struct branch_info {
462 const char *name; /* The short name used */
463 const char *path; /* The full name of a real branch */
464 struct commit *commit; /* The named commit */
5883034c
NTND
465 /*
466 * if not null the branch is detached because it's already
467 * checked out in this checkout
468 */
469 char *checkout;
782c2d65
DB
470};
471
472static void setup_branch_path(struct branch_info *branch)
473{
f285a2d7 474 struct strbuf buf = STRBUF_INIT;
ae5a6c36 475
fd4692ff 476 strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
a552de75 477 if (strcmp(buf.buf, branch->name))
ae5a6c36 478 branch->name = xstrdup(buf.buf);
a552de75 479 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
782c2d65
DB
480 branch->path = strbuf_detach(&buf, NULL);
481}
482
fa655d84
BP
483/*
484 * Skip merging the trees, updating the index and working directory if and
485 * only if we are creating a new branch via "git checkout -b <new_branch>."
486 */
487static int skip_merge_working_tree(const struct checkout_opts *opts,
488 const struct branch_info *old_branch_info,
489 const struct branch_info *new_branch_info)
490{
491 /*
492 * Do the merge if sparse checkout is on and the user has not opted in
493 * to the optimized behavior
494 */
495 if (core_apply_sparse_checkout && !checkout_optimize_new_branch)
496 return 0;
497
498 /*
499 * We must do the merge if we are actually moving to a new commit.
500 */
501 if (!old_branch_info->commit || !new_branch_info->commit ||
e43d2dcc
JK
502 !oideq(&old_branch_info->commit->object.oid,
503 &new_branch_info->commit->object.oid))
fa655d84
BP
504 return 0;
505
506 /*
507 * opts->patch_mode cannot be used with switching branches so is
508 * not tested here
509 */
510
511 /*
512 * opts->quiet only impacts output so doesn't require a merge
513 */
514
515 /*
516 * Honor the explicit request for a three-way merge or to throw away
517 * local changes
518 */
519 if (opts->merge || opts->force)
520 return 0;
521
522 /*
523 * --detach is documented as "updating the index and the files in the
524 * working tree" but this optimization skips those steps so fall through
525 * to the regular code path.
526 */
527 if (opts->force_detach)
528 return 0;
529
530 /*
531 * opts->writeout_stage cannot be used with switching branches so is
532 * not tested here
533 */
534
535 /*
536 * Honor the explicit ignore requests
537 */
538 if (!opts->overwrite_ignore || opts->ignore_skipworktree ||
539 opts->ignore_other_worktrees)
540 return 0;
541
542 /*
543 * opts->show_progress only impacts output so doesn't require a merge
544 */
545
546 /*
547 * If we aren't creating a new branch any changes or updates will
548 * happen in the existing branch. Since that could only be updating
549 * the index and working directory, we don't want to skip those steps
550 * or we've defeated any purpose in running the command.
551 */
552 if (!opts->new_branch)
553 return 0;
554
555 /*
556 * new_branch_force is defined to "create/reset and checkout a branch"
557 * so needs to go through the merge to do the reset
558 */
559 if (opts->new_branch_force)
560 return 0;
561
562 /*
563 * A new orphaned branch requrires the index and the working tree to be
564 * adjusted to <start_point>
565 */
566 if (opts->new_orphan_branch)
567 return 0;
568
569 /*
570 * Remaining variables are not checkout options but used to track state
571 */
572
573 return 1;
574}
575
a2b4994c 576static int merge_working_tree(const struct checkout_opts *opts,
c8a3ea1f
BW
577 struct branch_info *old_branch_info,
578 struct branch_info *new_branch_info,
a2b4994c 579 int *writeout_error)
782c2d65
DB
580{
581 int ret;
837e34eb 582 struct lock_file lock_file = LOCK_INIT;
b96524f8 583
837e34eb 584 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
53996fe5 585 if (read_cache_preload(NULL) < 0)
e923a8ab 586 return error(_("index file corrupt"));
782c2d65 587
cfc5789a 588 resolve_undo_clear();
782c2d65 589 if (opts->force) {
2e27bd77
DS
590 ret = reset_tree(get_commit_tree(new_branch_info->commit),
591 opts, 1, writeout_error);
782c2d65
DB
592 if (ret)
593 return ret;
594 } else {
595 struct tree_desc trees[2];
596 struct tree *tree;
597 struct unpack_trees_options topts;
bc052d7f 598
782c2d65
DB
599 memset(&topts, 0, sizeof(topts));
600 topts.head_idx = -1;
34110cd4
LT
601 topts.src_index = &the_index;
602 topts.dst_index = &the_index;
782c2d65 603
e294030f 604 setup_unpack_trees_porcelain(&topts, "checkout");
8ccba008 605
782c2d65
DB
606 refresh_cache(REFRESH_QUIET);
607
608 if (unmerged_cache()) {
e8a8a4d7 609 error(_("you need to resolve your current index first"));
04c9e11f 610 return 1;
782c2d65 611 }
04c9e11f
JH
612
613 /* 2-way merge to the new branch */
fa7b3c2f 614 topts.initial_checkout = is_cache_unborn();
04c9e11f
JH
615 topts.update = 1;
616 topts.merge = 1;
c8a3ea1f 617 topts.gently = opts->merge && old_branch_info->commit;
870ebdb9 618 topts.verbose_update = opts->show_progress;
04c9e11f 619 topts.fn = twoway_merge;
c1d7036b
NTND
620 if (opts->overwrite_ignore) {
621 topts.dir = xcalloc(1, sizeof(*topts.dir));
622 topts.dir->flags |= DIR_SHOW_IGNORED;
623 setup_standard_excludes(topts.dir);
624 }
c8a3ea1f
BW
625 tree = parse_tree_indirect(old_branch_info->commit ?
626 &old_branch_info->commit->object.oid :
eb0ccfd7 627 the_hash_algo->empty_tree);
04c9e11f 628 init_tree_desc(&trees[0], tree->buffer, tree->size);
c8a3ea1f 629 tree = parse_tree_indirect(&new_branch_info->commit->object.oid);
04c9e11f
JH
630 init_tree_desc(&trees[1], tree->buffer, tree->size);
631
291d823e 632 ret = unpack_trees(2, trees, &topts);
1c41d280 633 clear_unpack_trees_porcelain(&topts);
49d833dc 634 if (ret == -1) {
782c2d65
DB
635 /*
636 * Unpack couldn't do a trivial merge; either
637 * give up or do a real merge, depending on
638 * whether the merge flag was used.
639 */
640 struct tree *result;
641 struct tree *work;
8a2fce18 642 struct merge_options o;
782c2d65
DB
643 if (!opts->merge)
644 return 1;
64da3ae5
JH
645
646 /*
c8a3ea1f 647 * Without old_branch_info->commit, the below is the same as
64da3ae5
JH
648 * the two-tree unpack we already tried and failed.
649 */
c8a3ea1f 650 if (!old_branch_info->commit)
64da3ae5 651 return 1;
782c2d65
DB
652
653 /* Do more real merge */
654
655 /*
656 * We update the index fully, then write the
657 * tree from the index, then merge the new
658 * branch with the current tree, with the old
659 * branch as the base. Then we reset the index
660 * (but not the working tree) to the new
661 * branch, leaving the working tree as the
662 * merged version, but skipping unmerged
663 * entries in the index.
664 */
665
610d55af 666 add_files_to_cache(NULL, NULL, 0);
7610fa57
JN
667 /*
668 * NEEDSWORK: carrying over local changes
669 * when branches have different end-of-line
670 * normalization (or clean+smudge rules) is
671 * a pain; plumb in an option to set
672 * o.renormalize?
673 */
8a2fce18
MV
674 init_merge_options(&o);
675 o.verbosity = 0;
676 work = write_tree_from_memory(&o);
782c2d65 677
2e27bd77
DS
678 ret = reset_tree(get_commit_tree(new_branch_info->commit),
679 opts, 1,
a2b4994c 680 writeout_error);
782c2d65
DB
681 if (ret)
682 return ret;
c8a3ea1f
BW
683 o.ancestor = old_branch_info->name;
684 o.branch1 = new_branch_info->name;
8a2fce18 685 o.branch2 = "local";
2e27bd77
DS
686 ret = merge_trees(&o,
687 get_commit_tree(new_branch_info->commit),
688 work,
689 get_commit_tree(old_branch_info->commit),
690 &result);
f241ff0d
JS
691 if (ret < 0)
692 exit(128);
2e27bd77
DS
693 ret = reset_tree(get_commit_tree(new_branch_info->commit),
694 opts, 0,
a2b4994c 695 writeout_error);
548009c0 696 strbuf_release(&o.obuf);
84a5750b
JH
697 if (ret)
698 return ret;
782c2d65
DB
699 }
700 }
701
aecf567c
DT
702 if (!active_cache_tree)
703 active_cache_tree = cache_tree();
704
705 if (!cache_tree_fully_valid(active_cache_tree))
3fd13cbc 706 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
aecf567c 707
837e34eb 708 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
e8a8a4d7 709 die(_("unable to write new index file"));
782c2d65 710
7fe4a728 711 if (!opts->force && !opts->quiet)
c8a3ea1f 712 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
782c2d65
DB
713
714 return 0;
715}
716
c8a3ea1f 717static void report_tracking(struct branch_info *new_branch_info)
79a1e6b4 718{
6d21bf96 719 struct strbuf sb = STRBUF_INIT;
c8a3ea1f 720 struct branch *branch = branch_get(new_branch_info->name);
79a1e6b4 721
f39a757d 722 if (!format_tracking_info(branch, &sb, AHEAD_BEHIND_FULL))
79a1e6b4 723 return;
6d21bf96
JH
724 fputs(sb.buf, stdout);
725 strbuf_release(&sb);
b0030db3 726}
79a1e6b4 727
a2b4994c 728static void update_refs_for_switch(const struct checkout_opts *opts,
c8a3ea1f
BW
729 struct branch_info *old_branch_info,
730 struct branch_info *new_branch_info)
782c2d65 731{
f285a2d7 732 struct strbuf msg = STRBUF_INIT;
3bed291a 733 const char *old_desc, *reflog_msg;
782c2d65 734 if (opts->new_branch) {
3631bf77 735 if (opts->new_orphan_branch) {
341fb286
CW
736 char *refname;
737
738 refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
739 if (opts->new_branch_log &&
740 !should_autocreate_reflog(refname)) {
1a83c240 741 int ret;
a4c653df 742 struct strbuf err = STRBUF_INIT;
3631bf77 743
abd0cd3a 744 ret = safe_create_reflog(refname, 1, &err);
1a83c240 745 if (ret) {
a4c653df
DT
746 fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
747 opts->new_orphan_branch, err.buf);
748 strbuf_release(&err);
341fb286 749 free(refname);
3631bf77
EM
750 return;
751 }
abd0cd3a 752 strbuf_release(&err);
3631bf77 753 }
341fb286 754 free(refname);
3631bf77
EM
755 }
756 else
c8a3ea1f 757 create_branch(opts->new_branch, new_branch_info->name,
02ac9837 758 opts->new_branch_force ? 1 : 0,
39bd6f72 759 opts->new_branch_force ? 1 : 0,
e2bbd0cc 760 opts->new_branch_log,
f9a482e6 761 opts->quiet,
39bd6f72 762 opts->track);
c8a3ea1f
BW
763 new_branch_info->name = opts->new_branch;
764 setup_branch_path(new_branch_info);
782c2d65
DB
765 }
766
c8a3ea1f
BW
767 old_desc = old_branch_info->name;
768 if (!old_desc && old_branch_info->commit)
769 old_desc = oid_to_hex(&old_branch_info->commit->object.oid);
3bed291a
RR
770
771 reflog_msg = getenv("GIT_REFLOG_ACTION");
772 if (!reflog_msg)
773 strbuf_addf(&msg, "checkout: moving from %s to %s",
c8a3ea1f 774 old_desc ? old_desc : "(invalid)", new_branch_info->name);
3bed291a
RR
775 else
776 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
782c2d65 777
c8a3ea1f 778 if (!strcmp(new_branch_info->name, "HEAD") && !new_branch_info->path && !opts->force_detach) {
f8bd36a4 779 /* Nothing to do. */
c8a3ea1f
BW
780 } else if (opts->force_detach || !new_branch_info->path) { /* No longer on any branch. */
781 update_ref(msg.buf, "HEAD", &new_branch_info->commit->object.oid, NULL,
91774afc 782 REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
f8bd36a4 783 if (!opts->quiet) {
c8a3ea1f 784 if (old_branch_info->path &&
779b88a9 785 advice_detached_head && !opts->force_detach)
c8a3ea1f
BW
786 detach_advice(new_branch_info->name);
787 describe_detached_head(_("HEAD is now at"), new_branch_info->commit);
f8bd36a4 788 }
c8a3ea1f
BW
789 } else if (new_branch_info->path) { /* Switch branches. */
790 if (create_symref("HEAD", new_branch_info->path, msg.buf) < 0)
4636f651 791 die(_("unable to update HEAD"));
782c2d65 792 if (!opts->quiet) {
c8a3ea1f 793 if (old_branch_info->path && !strcmp(new_branch_info->path, old_branch_info->path)) {
39bd6f72
JN
794 if (opts->new_branch_force)
795 fprintf(stderr, _("Reset branch '%s'\n"),
c8a3ea1f 796 new_branch_info->name);
39bd6f72
JN
797 else
798 fprintf(stderr, _("Already on '%s'\n"),
c8a3ea1f 799 new_branch_info->name);
08eaa4be
ÆAB
800 } else if (opts->new_branch) {
801 if (opts->branch_exists)
c8a3ea1f 802 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
08eaa4be 803 else
c8a3ea1f 804 fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
08eaa4be 805 } else {
e8a8a4d7 806 fprintf(stderr, _("Switched to branch '%s'\n"),
c8a3ea1f 807 new_branch_info->name);
08eaa4be 808 }
782c2d65 809 }
c8a3ea1f
BW
810 if (old_branch_info->path && old_branch_info->name) {
811 if (!ref_exists(old_branch_info->path) && reflog_exists(old_branch_info->path))
812 delete_reflog(old_branch_info->path);
3631bf77 813 }
782c2d65
DB
814 }
815 remove_branch_state();
816 strbuf_release(&msg);
32669671 817 if (!opts->quiet &&
c8a3ea1f
BW
818 (new_branch_info->path || (!opts->force_detach && !strcmp(new_branch_info->name, "HEAD"))))
819 report_tracking(new_branch_info);
782c2d65
DB
820}
821
468224e5 822static int add_pending_uninteresting_ref(const char *refname,
fcb615f5 823 const struct object_id *oid,
468224e5 824 int flags, void *cb_data)
8e2dc6ac 825{
a58a1b01 826 add_pending_oid(cb_data, refname, oid, UNINTERESTING);
5c08dc48
JK
827 return 0;
828}
8e2dc6ac
JH
829
830static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
831{
0be240cc 832 strbuf_addstr(sb, " ");
30e677e0 833 strbuf_add_unique_abbrev(sb, &commit->object.oid, DEFAULT_ABBREV);
0be240cc 834 strbuf_addch(sb, ' ');
3c621839
JK
835 if (!parse_commit(commit))
836 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
8e2dc6ac
JH
837 strbuf_addch(sb, '\n');
838}
839
840#define ORPHAN_CUTOFF 4
841static void suggest_reattach(struct commit *commit, struct rev_info *revs)
842{
843 struct commit *c, *last = NULL;
844 struct strbuf sb = STRBUF_INIT;
845 int lost = 0;
846 while ((c = get_revision(revs)) != NULL) {
847 if (lost < ORPHAN_CUTOFF)
848 describe_one_orphan(&sb, c);
849 last = c;
850 lost++;
851 }
852 if (ORPHAN_CUTOFF < lost) {
853 int more = lost - ORPHAN_CUTOFF;
854 if (more == 1)
855 describe_one_orphan(&sb, last);
856 else
f06f08b7 857 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
8e2dc6ac
JH
858 }
859
860 fprintf(stderr,
f06f08b7
ÆAB
861 Q_(
862 /* The singular version */
863 "Warning: you are leaving %d commit behind, "
864 "not connected to\n"
865 "any of your branches:\n\n"
0faf2474 866 "%s\n",
f06f08b7
ÆAB
867 /* The plural version */
868 "Warning: you are leaving %d commits behind, "
8e2dc6ac
JH
869 "not connected to\n"
870 "any of your branches:\n\n"
f807b3dc 871 "%s\n",
f06f08b7
ÆAB
872 /* Give ngettext() the count */
873 lost),
874 lost,
f807b3dc 875 sb.buf);
8e2dc6ac 876 strbuf_release(&sb);
f807b3dc
JH
877
878 if (advice_detached_head)
879 fprintf(stderr,
fc792ca8
TS
880 Q_(
881 /* The singular version */
882 "If you want to keep it by creating a new branch, "
883 "this may be a good time\nto do so with:\n\n"
884 " git branch <new-branch-name> %s\n\n",
885 /* The plural version */
f807b3dc
JH
886 "If you want to keep them by creating a new branch, "
887 "this may be a good time\nto do so with:\n\n"
fc792ca8
TS
888 " git branch <new-branch-name> %s\n\n",
889 /* Give ngettext() the count */
890 lost),
aab9583f 891 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
8e2dc6ac
JH
892}
893
894/*
895 * We are about to leave commit that was at the tip of a detached
896 * HEAD. If it is not reachable from any ref, this is the last chance
897 * for the user to do so without resorting to reflog.
898 */
c8a3ea1f 899static void orphaned_commit_warning(struct commit *old_commit, struct commit *new_commit)
8e2dc6ac 900{
8e2dc6ac 901 struct rev_info revs;
c8a3ea1f 902 struct object *object = &old_commit->object;
8e2dc6ac 903
2abf3503 904 repo_init_revisions(the_repository, &revs, NULL);
468224e5
RS
905 setup_revisions(0, NULL, &revs, NULL);
906
907 object->flags &= ~UNINTERESTING;
f2fd0760 908 add_pending_object(&revs, object, oid_to_hex(&object->oid));
468224e5 909
fcb615f5 910 for_each_ref(add_pending_uninteresting_ref, &revs);
c8a3ea1f 911 add_pending_oid(&revs, "HEAD", &new_commit->object.oid, UNINTERESTING);
468224e5 912
8e2dc6ac 913 if (prepare_revision_walk(&revs))
6c80cd29 914 die(_("internal error in revision walk"));
c8a3ea1f
BW
915 if (!(old_commit->object.flags & UNINTERESTING))
916 suggest_reattach(old_commit, &revs);
8e2dc6ac 917 else
c8a3ea1f 918 describe_detached_head(_("Previous HEAD position was"), old_commit);
5c08dc48 919
b2ccdf7f 920 /* Clean up objects used, as they will be reused. */
a9a03fa0 921 clear_commit_marks_all(ALL_REV_FLAGS);
8e2dc6ac
JH
922}
923
e51e3057 924static int switch_branches(const struct checkout_opts *opts,
c8a3ea1f 925 struct branch_info *new_branch_info)
782c2d65
DB
926{
927 int ret = 0;
c8a3ea1f 928 struct branch_info old_branch_info;
96ec7b1e 929 void *path_to_free;
60af7691 930 struct object_id rev;
a2b4994c 931 int flag, writeout_error = 0;
c8a3ea1f
BW
932 memset(&old_branch_info, 0, sizeof(old_branch_info));
933 old_branch_info.path = path_to_free = resolve_refdup("HEAD", 0, &rev, &flag);
934 if (old_branch_info.path)
21e1ee8f 935 old_branch_info.commit = lookup_commit_reference_gently(the_repository, &rev, 1);
96ec7b1e 936 if (!(flag & REF_ISSYMREF))
c8a3ea1f 937 old_branch_info.path = NULL;
782c2d65 938
c8a3ea1f
BW
939 if (old_branch_info.path)
940 skip_prefix(old_branch_info.path, "refs/heads/", &old_branch_info.name);
782c2d65 941
c8a3ea1f
BW
942 if (!new_branch_info->name) {
943 new_branch_info->name = "HEAD";
944 new_branch_info->commit = old_branch_info.commit;
945 if (!new_branch_info->commit)
e8a8a4d7 946 die(_("You are on a branch yet to be born"));
c8a3ea1f 947 parse_commit_or_die(new_branch_info->commit);
782c2d65
DB
948 }
949
fa655d84
BP
950 /* optimize the "checkout -b <new_branch> path */
951 if (skip_merge_working_tree(opts, &old_branch_info, new_branch_info)) {
952 if (!checkout_optimize_new_branch && !opts->quiet) {
953 if (read_cache_preload(NULL) < 0)
954 return error(_("index file corrupt"));
955 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
956 }
957 } else {
958 ret = merge_working_tree(opts, &old_branch_info, new_branch_info, &writeout_error);
959 if (ret) {
960 free(path_to_free);
961 return ret;
962 }
96ec7b1e 963 }
782c2d65 964
c8a3ea1f
BW
965 if (!opts->quiet && !old_branch_info.path && old_branch_info.commit && new_branch_info->commit != old_branch_info.commit)
966 orphaned_commit_warning(old_branch_info.commit, new_branch_info->commit);
77ebd56d 967
c8a3ea1f 968 update_refs_for_switch(opts, &old_branch_info, new_branch_info);
782c2d65 969
c8a3ea1f 970 ret = post_checkout_hook(old_branch_info.commit, new_branch_info->commit, 1);
96ec7b1e 971 free(path_to_free);
a2b4994c 972 return ret || writeout_error;
782c2d65
DB
973}
974
0cf8581e
JH
975static int git_checkout_config(const char *var, const char *value, void *cb)
976{
fa655d84
BP
977 if (!strcmp(var, "checkout.optimizenewbranch")) {
978 checkout_optimize_new_branch = git_config_bool(var, value);
979 return 0;
980 }
981
175f6e59
JS
982 if (!strcmp(var, "diff.ignoresubmodules")) {
983 struct checkout_opts *opts = cb;
984 handle_ignore_submodules_arg(&opts->diff_options, value);
985 return 0;
986 }
23b4c7bc 987
59556548 988 if (starts_with(var, "submodule."))
7463e2ec 989 return git_default_submodule_config(var, value, NULL);
23b4c7bc 990
175f6e59 991 return git_xmerge_config(var, value, NULL);
0cf8581e
JH
992}
993
09ebad6f
JN
994static int parse_branchname_arg(int argc, const char **argv,
995 int dwim_new_local_branch_ok,
c8a3ea1f 996 struct branch_info *new_branch_info,
10f102be 997 struct checkout_opts *opts,
3c87aa94
ÆAB
998 struct object_id *rev,
999 int *dwim_remotes_matched)
09ebad6f 1000{
10f102be
NTND
1001 struct tree **source_tree = &opts->source_tree;
1002 const char **new_branch = &opts->new_branch;
09ebad6f 1003 int argcount = 0;
60af7691 1004 struct object_id branch_rev;
09ebad6f 1005 const char *arg;
bca39695
MM
1006 int dash_dash_pos;
1007 int has_dash_dash = 0;
1008 int i;
09ebad6f
JN
1009
1010 /*
1011 * case 1: git checkout <ref> -- [<paths>]
1012 *
1013 * <ref> must be a valid tree, everything after the '--' must be
1014 * a path.
1015 *
1016 * case 2: git checkout -- [<paths>]
1017 *
1018 * everything after the '--' must be paths.
1019 *
a047fafc 1020 * case 3: git checkout <something> [--]
09ebad6f 1021 *
a047fafc
MM
1022 * (a) If <something> is a commit, that is to
1023 * switch to the branch or detach HEAD at it. As a special case,
1024 * if <something> is A...B (missing A or B means HEAD but you can
1025 * omit at most one side), and if there is a unique merge base
1026 * between A and B, A...B names that merge base.
09ebad6f 1027 *
a047fafc 1028 * (b) If <something> is _not_ a commit, either "--" is present
01689909 1029 * or <something> is not a path, no -t or -b was given, and
a047fafc 1030 * and there is a tracking branch whose name is <something>
8d7b558b
ÆAB
1031 * in one and only one remote (or if the branch exists on the
1032 * remote named in checkout.defaultRemote), then this is a
1033 * short-hand to fork local <something> from that
1034 * remote-tracking branch.
09ebad6f 1035 *
a047fafc
MM
1036 * (c) Otherwise, if "--" is present, treat it like case (1).
1037 *
1038 * (d) Otherwise :
1039 * - if it's a reference, treat it like case (1)
1040 * - else if it's a path, treat it like case (2)
1041 * - else: fail.
1042 *
1043 * case 4: git checkout <something> <paths>
1044 *
1045 * The first argument must not be ambiguous.
09ebad6f
JN
1046 * - If it's *only* a reference, treat it like case (1).
1047 * - If it's only a path, treat it like case (2).
1048 * - else: fail.
1049 *
1050 */
1051 if (!argc)
1052 return 0;
1053
09ebad6f 1054 arg = argv[0];
bca39695
MM
1055 dash_dash_pos = -1;
1056 for (i = 0; i < argc; i++) {
1057 if (!strcmp(argv[i], "--")) {
1058 dash_dash_pos = i;
1059 break;
1060 }
1061 }
1062 if (dash_dash_pos == 0)
1063 return 1; /* case (2) */
1064 else if (dash_dash_pos == 1)
1065 has_dash_dash = 1; /* case (3) or (1) */
1066 else if (dash_dash_pos >= 2)
1067 die(_("only one reference expected, %d given."), dash_dash_pos);
09ebad6f
JN
1068
1069 if (!strcmp(arg, "-"))
1070 arg = "@{-1}";
1071
151b2911 1072 if (get_oid_mb(arg, rev)) {
a047fafc
MM
1073 /*
1074 * Either case (3) or (4), with <something> not being
1075 * a commit, or an attempt to use case (1) with an
1076 * invalid ref.
1077 *
1078 * It's likely an error, but we need to find out if
1079 * we should auto-create the branch, case (3).(b).
1080 */
1081 int recover_with_dwim = dwim_new_local_branch_ok;
1082
df714f81 1083 if (!has_dash_dash &&
b829b943 1084 (check_filename(opts->prefix, arg) || !no_wildcard(arg)))
a047fafc
MM
1085 recover_with_dwim = 0;
1086 /*
1087 * Accept "git checkout foo" and "git checkout foo --"
1088 * as candidates for dwim.
1089 */
1090 if (!(argc == 1 && !has_dash_dash) &&
1091 !(argc == 2 && has_dash_dash))
1092 recover_with_dwim = 0;
1093
1094 if (recover_with_dwim) {
3c87aa94
ÆAB
1095 const char *remote = unique_tracking_name(arg, rev,
1096 dwim_remotes_matched);
a047fafc
MM
1097 if (remote) {
1098 *new_branch = arg;
1099 arg = remote;
1100 /* DWIMmed to create local branch, case (3).(b) */
1101 } else {
1102 recover_with_dwim = 0;
1103 }
1104 }
1105
1106 if (!recover_with_dwim) {
1107 if (has_dash_dash)
1108 die(_("invalid reference: %s"), arg);
09ebad6f
JN
1109 return argcount;
1110 }
1111 }
1112
1113 /* we can't end up being in (2) anymore, eat the argument */
1114 argcount++;
1115 argv++;
1116 argc--;
1117
c8a3ea1f
BW
1118 new_branch_info->name = arg;
1119 setup_branch_path(new_branch_info);
09ebad6f 1120
c8a3ea1f
BW
1121 if (!check_refname_format(new_branch_info->path, 0) &&
1122 !read_ref(new_branch_info->path, &branch_rev))
60af7691 1123 oidcpy(rev, &branch_rev);
09ebad6f 1124 else
c8a3ea1f 1125 new_branch_info->path = NULL; /* not an existing branch */
09ebad6f 1126
21e1ee8f 1127 new_branch_info->commit = lookup_commit_reference_gently(the_repository, rev, 1);
c8a3ea1f 1128 if (!new_branch_info->commit) {
09ebad6f 1129 /* not a commit */
a9dbc179 1130 *source_tree = parse_tree_indirect(rev);
09ebad6f 1131 } else {
c8a3ea1f 1132 parse_commit_or_die(new_branch_info->commit);
2e27bd77 1133 *source_tree = get_commit_tree(new_branch_info->commit);
09ebad6f
JN
1134 }
1135
1136 if (!*source_tree) /* case (1): want a tree */
6c80cd29 1137 die(_("reference is not a tree: %s"), arg);
7f82b24e 1138 if (!has_dash_dash) { /* case (3).(d) -> (1) */
09ebad6f
JN
1139 /*
1140 * Do not complain the most common case
1141 * git checkout branch
1142 * even if there happen to be a file called 'branch';
1143 * it would be extremely annoying.
1144 */
1145 if (argc)
b829b943 1146 verify_non_filename(opts->prefix, arg);
09ebad6f
JN
1147 } else {
1148 argcount++;
1149 argv++;
1150 argc--;
1151 }
1152
1153 return argcount;
1154}
1155
a2b4994c 1156static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
abe19980
JH
1157{
1158 int status;
1159 struct strbuf branch_ref = STRBUF_INIT;
1160
8ced1aa0
CW
1161 if (!opts->new_branch)
1162 die(_("You are on a branch yet to be born"));
abe19980
JH
1163 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1164 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1165 strbuf_release(&branch_ref);
afa8c07a
JK
1166 if (!opts->quiet)
1167 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1168 opts->new_branch);
abe19980
JH
1169 return status;
1170}
1171
b6312c27 1172static int checkout_branch(struct checkout_opts *opts,
c8a3ea1f 1173 struct branch_info *new_branch_info)
b6312c27 1174{
817b345a 1175 if (opts->pathspec.nr)
b6312c27
NTND
1176 die(_("paths cannot be used with switching branches"));
1177
1178 if (opts->patch_mode)
1179 die(_("'%s' cannot be used with switching branches"),
1180 "--patch");
1181
1182 if (opts->writeout_stage)
1183 die(_("'%s' cannot be used with switching branches"),
1184 "--ours/--theirs");
1185
1186 if (opts->force && opts->merge)
1187 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1188
1189 if (opts->force_detach && opts->new_branch)
1190 die(_("'%s' cannot be used with '%s'"),
1191 "--detach", "-b/-B/--orphan");
1192
1193 if (opts->new_orphan_branch) {
1194 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1195 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1196 } else if (opts->force_detach) {
1197 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1198 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1199 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1200 opts->track = git_branch_track;
1201
c8a3ea1f 1202 if (new_branch_info->name && !new_branch_info->commit)
b6312c27 1203 die(_("Cannot switch branch to a non-commit '%s'"),
c8a3ea1f 1204 new_branch_info->name);
b6312c27 1205
c8a3ea1f 1206 if (new_branch_info->path && !opts->force_detach && !opts->new_branch &&
c265c533 1207 !opts->ignore_other_worktrees) {
e1c1ab9d 1208 int flag;
efbd4fdf 1209 char *head_ref = resolve_refdup("HEAD", 0, NULL, &flag);
e1c1ab9d 1210 if (head_ref &&
c8a3ea1f
BW
1211 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new_branch_info->path)))
1212 die_if_checked_out(new_branch_info->path, 1);
e1c1ab9d
NTND
1213 free(head_ref);
1214 }
1215
c8a3ea1f 1216 if (!new_branch_info->commit && opts->new_branch) {
60af7691 1217 struct object_id rev;
b6312c27
NTND
1218 int flag;
1219
34c290a6 1220 if (!read_ref_full("HEAD", 0, &rev, &flag) &&
60af7691 1221 (flag & REF_ISSYMREF) && is_null_oid(&rev))
b6312c27
NTND
1222 return switch_unborn_to_new_branch(opts);
1223 }
c8a3ea1f 1224 return switch_branches(opts, new_branch_info);
b6312c27
NTND
1225}
1226
782c2d65
DB
1227int cmd_checkout(int argc, const char **argv, const char *prefix)
1228{
1229 struct checkout_opts opts;
c8a3ea1f 1230 struct branch_info new_branch_info;
eac5a401 1231 char *conflict_style = NULL;
46148dd7 1232 int dwim_new_local_branch = 1;
3c87aa94 1233 int dwim_remotes_matched = 0;
782c2d65 1234 struct option options[] = {
e05a1093
NTND
1235 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
1236 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1237 N_("create and checkout a new branch")),
1238 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1239 N_("create/reset and checkout a branch")),
d5d09d47 1240 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
e923a8ab 1241 OPT_BOOL(0, "detach", &opts.force_detach, N_("detach HEAD at named commit")),
e05a1093 1242 OPT_SET_INT('t', "track", &opts.track, N_("set upstream info for new branch"),
9ed36cfa 1243 BRANCH_TRACK_EXPLICIT),
e703d711 1244 OPT_STRING(0, "orphan", &opts.new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
3fe735e7
NTND
1245 OPT_SET_INT_F('2', "ours", &opts.writeout_stage,
1246 N_("checkout our version for unmerged files"),
1247 2, PARSE_OPT_NONEG),
1248 OPT_SET_INT_F('3', "theirs", &opts.writeout_stage,
1249 N_("checkout their version for unmerged files"),
1250 3, PARSE_OPT_NONEG),
77afafb2
NTND
1251 OPT__FORCE(&opts.force, N_("force checkout (throw away local modifications)"),
1252 PARSE_OPT_NOCOMPLETE),
d5d09d47 1253 OPT_BOOL('m', "merge", &opts.merge, N_("perform a 3-way merge with the new branch")),
77afafb2
NTND
1254 OPT_BOOL_F(0, "overwrite-ignore", &opts.overwrite_ignore,
1255 N_("update ignored files (default)"),
1256 PARSE_OPT_NOCOMPLETE),
e05a1093
NTND
1257 OPT_STRING(0, "conflict", &conflict_style, N_("style"),
1258 N_("conflict style (merge or diff3)")),
d5d09d47 1259 OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
08d595dc
NTND
1260 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
1261 N_("do not limit pathspecs to sparse entries only")),
4741edd5 1262 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
9c9b4f2f 1263 N_("second guess 'git checkout <no-such-branch>'")),
1d0fa898
NTND
1264 OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
1265 N_("do not check if another worktree is holding the given ref")),
58b75bd6 1266 { OPTION_CALLBACK, 0, "recurse-submodules", NULL,
1fc458d9 1267 "checkout", "control recursive updating of submodules",
d7a3803f 1268 PARSE_OPT_OPTARG, option_parse_recurse_submodules_worktree_updater },
870ebdb9 1269 OPT_BOOL(0, "progress", &opts.show_progress, N_("force progress reporting")),
b249b552 1270 OPT_END(),
782c2d65
DB
1271 };
1272
1273 memset(&opts, 0, sizeof(opts));
c8a3ea1f 1274 memset(&new_branch_info, 0, sizeof(new_branch_info));
c1d7036b 1275 opts.overwrite_ignore = 1;
e51e3057 1276 opts.prefix = prefix;
870ebdb9 1277 opts.show_progress = -1;
782c2d65 1278
175f6e59 1279 git_config(git_checkout_config, &opts);
782c2d65 1280
9188ed89 1281 opts.track = BRANCH_TRACK_UNSPECIFIED;
782c2d65 1282
37782920 1283 argc = parse_options(argc, argv, prefix, options, checkout_usage,
f5242ebf 1284 PARSE_OPT_KEEP_DASHDASH);
859fdaba 1285
870ebdb9
ECA
1286 if (opts.show_progress < 0) {
1287 if (opts.quiet)
1288 opts.show_progress = 0;
1289 else
1290 opts.show_progress = isatty(2);
1291 }
1292
b6312c27
NTND
1293 if (conflict_style) {
1294 opts.merge = 1; /* implied */
1295 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1296 }
02ac9837 1297
b6312c27
NTND
1298 if ((!!opts.new_branch + !!opts.new_branch_force + !!opts.new_orphan_branch) > 1)
1299 die(_("-b, -B and --orphan are mutually exclusive"));
02ac9837 1300
b6312c27
NTND
1301 /*
1302 * From here on, new_branch will contain the branch to be checked out,
1303 * and new_branch_force and new_orphan_branch will tell us which one of
1304 * -b/-B/--orphan is being used.
1305 */
02ac9837
TRC
1306 if (opts.new_branch_force)
1307 opts.new_branch = opts.new_branch_force;
1308
b6312c27
NTND
1309 if (opts.new_orphan_branch)
1310 opts.new_branch = opts.new_orphan_branch;
32669671 1311
b6312c27
NTND
1312 /* --track without -b/-B/--orphan should DWIM */
1313 if (opts.track != BRANCH_TRACK_UNSPECIFIED && !opts.new_branch) {
9188ed89
AR
1314 const char *argv0 = argv[0];
1315 if (!argc || !strcmp(argv0, "--"))
1a07e59c 1316 die(_("--track needs a branch name"));
e3f1da98
RS
1317 skip_prefix(argv0, "refs/", &argv0);
1318 skip_prefix(argv0, "remotes/", &argv0);
9188ed89
AR
1319 argv0 = strchr(argv0, '/');
1320 if (!argv0 || !argv0[1])
1a07e59c 1321 die(_("missing branch name; try -b"));
9188ed89 1322 opts.new_branch = argv0 + 1;
bb0ceb62
JS
1323 }
1324
859fdaba 1325 /*
09ebad6f
JN
1326 * Extract branch name from command line arguments, so
1327 * all that is left is pathspecs.
859fdaba 1328 *
09ebad6f 1329 * Handle
70c9ac2f 1330 *
09ebad6f
JN
1331 * 1) git checkout <tree> -- [<paths>]
1332 * 2) git checkout -- [<paths>]
1333 * 3) git checkout <something> [<paths>]
859fdaba 1334 *
09ebad6f
JN
1335 * including "last branch" syntax and DWIM-ery for names of
1336 * remote branches, erroring out for invalid or ambiguous cases.
859fdaba 1337 */
782c2d65 1338 if (argc) {
60af7691 1339 struct object_id rev;
09ebad6f 1340 int dwim_ok =
e51e3057 1341 !opts.patch_mode &&
09ebad6f
JN
1342 dwim_new_local_branch &&
1343 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1344 !opts.new_branch;
f8bd36a4 1345 int n = parse_branchname_arg(argc, argv, dwim_ok,
3c87aa94
ÆAB
1346 &new_branch_info, &opts, &rev,
1347 &dwim_remotes_matched);
09ebad6f
JN
1348 argv += n;
1349 argc -= n;
782c2d65
DB
1350 }
1351
782c2d65 1352 if (argc) {
480ca644
NTND
1353 parse_pathspec(&opts.pathspec, 0,
1354 opts.patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1355 prefix, argv);
301e42ed 1356
817b345a 1357 if (!opts.pathspec.nr)
e8a8a4d7 1358 die(_("invalid path specification"));
301e42ed 1359
b6312c27
NTND
1360 /*
1361 * Try to give more helpful suggestion.
1362 * new_branch && argc > 1 will be caught later.
1363 */
1364 if (opts.new_branch && argc == 1)
6c486862
JNA
1365 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1366 argv[0], opts.new_branch);
782c2d65 1367
32669671 1368 if (opts.force_detach)
b6312c27
NTND
1369 die(_("git checkout: --detach does not take a path argument '%s'"),
1370 argv[0]);
32669671 1371
0cf8581e 1372 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
b6312c27
NTND
1373 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1374 "checking out of the index."));
782c2d65
DB
1375 }
1376
352eadc4 1377 if (opts.new_branch) {
f285a2d7 1378 struct strbuf buf = STRBUF_INIT;
55c4a673 1379
bc1c9c0e
JH
1380 if (opts.new_branch_force)
1381 opts.branch_exists = validate_branchname(opts.new_branch, &buf);
1382 else
1383 opts.branch_exists =
1384 validate_new_branchname(opts.new_branch, &buf, 0);
352eadc4
DB
1385 strbuf_release(&buf);
1386 }
1387
886e1084 1388 UNLEAK(opts);
1c550553
ÆAB
1389 if (opts.patch_mode || opts.pathspec.nr) {
1390 int ret = checkout_paths(&opts, new_branch_info.name);
ad8d5104
ÆAB
1391 if (ret && dwim_remotes_matched > 1 &&
1392 advice_checkout_ambiguous_remote_branch_name)
1393 advise(_("'%s' matched more than one remote tracking branch.\n"
1394 "We found %d remotes with a reference that matched. So we fell back\n"
1395 "on trying to resolve the argument as a path, but failed there too!\n"
1396 "\n"
1397 "If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1398 "you can do so by fully qualifying the name with the --track option:\n"
1399 "\n"
8d7b558b
ÆAB
1400 " git checkout --track origin/<name>\n"
1401 "\n"
1402 "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1403 "one remote, e.g. the 'origin' remote, consider setting\n"
1404 "checkout.defaultRemote=origin in your config."),
ad8d5104
ÆAB
1405 argv[0],
1406 dwim_remotes_matched);
1c550553
ÆAB
1407 return ret;
1408 } else {
c8a3ea1f 1409 return checkout_branch(&opts, &new_branch_info);
1c550553 1410 }
782c2d65 1411}