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