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