Update messages in preparation for i18n
[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
c8a3ea1f 57static int post_checkout_hook(struct commit *old_commit, struct commit *new_commit,
782c2d65
DB
58 int changed)
59{
15048f8a 60 return run_hook_le(NULL, "post-checkout",
c8a3ea1f
BW
61 oid_to_hex(old_commit ? &old_commit->object.oid : &null_oid),
62 oid_to_hex(new_commit ? &new_commit->object.oid : &null_oid),
15048f8a 63 changed ? "1" : "0", NULL);
c8a3ea1f 64 /* "new_commit" can be NULL when checking out from the index before
2292ce47 65 a commit exists. */
ae98a008 66
782c2d65
DB
67}
68
df46d77e 69static int update_some(const struct object_id *oid, 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));
df46d77e 81 oidcpy(&ce->oid, oid);
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 229 */
a09c985e 230 if (write_object_file(result_buf.ptr, result_buf.size, blob_type, &oid))
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
34c290a6 380 read_ref_full("HEAD", 0, &rev, 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;
ca69d4d5 403
3c621839
JK
404 if (!parse_commit(commit))
405 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
ca69d4d5
AR
406 if (print_sha1_ellipsis()) {
407 fprintf(stderr, "%s %s... %s\n", msg,
aab9583f 408 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
ca69d4d5
AR
409 } else {
410 fprintf(stderr, "%s %s %s\n", msg,
aab9583f 411 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
ca69d4d5 412 }
782c2d65
DB
413 strbuf_release(&sb);
414}
415
a2b4994c
NTND
416static int reset_tree(struct tree *tree, const struct checkout_opts *o,
417 int worktree, int *writeout_error)
782c2d65
DB
418{
419 struct unpack_trees_options opts;
420 struct tree_desc tree_desc;
bc052d7f 421
782c2d65
DB
422 memset(&opts, 0, sizeof(opts));
423 opts.head_idx = -1;
6286a08d
JH
424 opts.update = worktree;
425 opts.skip_unmerged = !worktree;
782c2d65
DB
426 opts.reset = 1;
427 opts.merge = 1;
428 opts.fn = oneway_merge;
870ebdb9 429 opts.verbose_update = o->show_progress;
34110cd4
LT
430 opts.src_index = &the_index;
431 opts.dst_index = &the_index;
782c2d65
DB
432 parse_tree(tree);
433 init_tree_desc(&tree_desc, tree->buffer, tree->size);
291d823e
JH
434 switch (unpack_trees(1, &tree_desc, &opts)) {
435 case -2:
a2b4994c 436 *writeout_error = 1;
291d823e
JH
437 /*
438 * We return 0 nevertheless, as the index is all right
439 * and more importantly we have made best efforts to
440 * update paths in the work tree, and we cannot revert
441 * them.
442 */
1cf01a34 443 /* fallthrough */
291d823e
JH
444 case 0:
445 return 0;
446 default:
84a5750b 447 return 128;
291d823e 448 }
782c2d65
DB
449}
450
782c2d65
DB
451struct branch_info {
452 const char *name; /* The short name used */
453 const char *path; /* The full name of a real branch */
454 struct commit *commit; /* The named commit */
5883034c
NTND
455 /*
456 * if not null the branch is detached because it's already
457 * checked out in this checkout
458 */
459 char *checkout;
782c2d65
DB
460};
461
462static void setup_branch_path(struct branch_info *branch)
463{
f285a2d7 464 struct strbuf buf = STRBUF_INIT;
ae5a6c36 465
fd4692ff 466 strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
a552de75 467 if (strcmp(buf.buf, branch->name))
ae5a6c36 468 branch->name = xstrdup(buf.buf);
a552de75 469 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
782c2d65
DB
470 branch->path = strbuf_detach(&buf, NULL);
471}
472
a2b4994c 473static int merge_working_tree(const struct checkout_opts *opts,
c8a3ea1f
BW
474 struct branch_info *old_branch_info,
475 struct branch_info *new_branch_info,
a2b4994c 476 int *writeout_error)
782c2d65
DB
477{
478 int ret;
837e34eb 479 struct lock_file lock_file = LOCK_INIT;
b96524f8 480
837e34eb 481 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
53996fe5 482 if (read_cache_preload(NULL) < 0)
e923a8ab 483 return error(_("index file corrupt"));
782c2d65 484
cfc5789a 485 resolve_undo_clear();
782c2d65 486 if (opts->force) {
2e27bd77
DS
487 ret = reset_tree(get_commit_tree(new_branch_info->commit),
488 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;
c8a3ea1f 514 topts.gently = opts->merge && old_branch_info->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 }
c8a3ea1f
BW
522 tree = parse_tree_indirect(old_branch_info->commit ?
523 &old_branch_info->commit->object.oid :
eb0ccfd7 524 the_hash_algo->empty_tree);
04c9e11f 525 init_tree_desc(&trees[0], tree->buffer, tree->size);
c8a3ea1f 526 tree = parse_tree_indirect(&new_branch_info->commit->object.oid);
04c9e11f
JH
527 init_tree_desc(&trees[1], tree->buffer, tree->size);
528
291d823e 529 ret = unpack_trees(2, trees, &topts);
1c41d280 530 clear_unpack_trees_porcelain(&topts);
49d833dc 531 if (ret == -1) {
782c2d65
DB
532 /*
533 * Unpack couldn't do a trivial merge; either
534 * give up or do a real merge, depending on
535 * whether the merge flag was used.
536 */
537 struct tree *result;
538 struct tree *work;
8a2fce18 539 struct merge_options o;
782c2d65
DB
540 if (!opts->merge)
541 return 1;
64da3ae5
JH
542
543 /*
c8a3ea1f 544 * Without old_branch_info->commit, the below is the same as
64da3ae5
JH
545 * the two-tree unpack we already tried and failed.
546 */
c8a3ea1f 547 if (!old_branch_info->commit)
64da3ae5 548 return 1;
782c2d65
DB
549
550 /* Do more real merge */
551
552 /*
553 * We update the index fully, then write the
554 * tree from the index, then merge the new
555 * branch with the current tree, with the old
556 * branch as the base. Then we reset the index
557 * (but not the working tree) to the new
558 * branch, leaving the working tree as the
559 * merged version, but skipping unmerged
560 * entries in the index.
561 */
562
610d55af 563 add_files_to_cache(NULL, NULL, 0);
7610fa57
JN
564 /*
565 * NEEDSWORK: carrying over local changes
566 * when branches have different end-of-line
567 * normalization (or clean+smudge rules) is
568 * a pain; plumb in an option to set
569 * o.renormalize?
570 */
8a2fce18
MV
571 init_merge_options(&o);
572 o.verbosity = 0;
573 work = write_tree_from_memory(&o);
782c2d65 574
2e27bd77
DS
575 ret = reset_tree(get_commit_tree(new_branch_info->commit),
576 opts, 1,
a2b4994c 577 writeout_error);
782c2d65
DB
578 if (ret)
579 return ret;
c8a3ea1f
BW
580 o.ancestor = old_branch_info->name;
581 o.branch1 = new_branch_info->name;
8a2fce18 582 o.branch2 = "local";
2e27bd77
DS
583 ret = merge_trees(&o,
584 get_commit_tree(new_branch_info->commit),
585 work,
586 get_commit_tree(old_branch_info->commit),
587 &result);
f241ff0d
JS
588 if (ret < 0)
589 exit(128);
2e27bd77
DS
590 ret = reset_tree(get_commit_tree(new_branch_info->commit),
591 opts, 0,
a2b4994c 592 writeout_error);
548009c0 593 strbuf_release(&o.obuf);
84a5750b
JH
594 if (ret)
595 return ret;
782c2d65
DB
596 }
597 }
598
aecf567c
DT
599 if (!active_cache_tree)
600 active_cache_tree = cache_tree();
601
602 if (!cache_tree_fully_valid(active_cache_tree))
3fd13cbc 603 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
aecf567c 604
837e34eb 605 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
e8a8a4d7 606 die(_("unable to write new index file"));
782c2d65 607
7fe4a728 608 if (!opts->force && !opts->quiet)
c8a3ea1f 609 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
782c2d65
DB
610
611 return 0;
612}
613
c8a3ea1f 614static void report_tracking(struct branch_info *new_branch_info)
79a1e6b4 615{
6d21bf96 616 struct strbuf sb = STRBUF_INIT;
c8a3ea1f 617 struct branch *branch = branch_get(new_branch_info->name);
79a1e6b4 618
f39a757d 619 if (!format_tracking_info(branch, &sb, AHEAD_BEHIND_FULL))
79a1e6b4 620 return;
6d21bf96
JH
621 fputs(sb.buf, stdout);
622 strbuf_release(&sb);
b0030db3 623}
79a1e6b4 624
a2b4994c 625static void update_refs_for_switch(const struct checkout_opts *opts,
c8a3ea1f
BW
626 struct branch_info *old_branch_info,
627 struct branch_info *new_branch_info)
782c2d65 628{
f285a2d7 629 struct strbuf msg = STRBUF_INIT;
3bed291a 630 const char *old_desc, *reflog_msg;
782c2d65 631 if (opts->new_branch) {
3631bf77 632 if (opts->new_orphan_branch) {
341fb286
CW
633 char *refname;
634
635 refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
636 if (opts->new_branch_log &&
637 !should_autocreate_reflog(refname)) {
1a83c240 638 int ret;
a4c653df 639 struct strbuf err = STRBUF_INIT;
3631bf77 640
abd0cd3a 641 ret = safe_create_reflog(refname, 1, &err);
1a83c240 642 if (ret) {
a4c653df
DT
643 fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
644 opts->new_orphan_branch, err.buf);
645 strbuf_release(&err);
341fb286 646 free(refname);
3631bf77
EM
647 return;
648 }
abd0cd3a 649 strbuf_release(&err);
3631bf77 650 }
341fb286 651 free(refname);
3631bf77
EM
652 }
653 else
c8a3ea1f 654 create_branch(opts->new_branch, new_branch_info->name,
02ac9837 655 opts->new_branch_force ? 1 : 0,
39bd6f72 656 opts->new_branch_force ? 1 : 0,
e2bbd0cc 657 opts->new_branch_log,
f9a482e6 658 opts->quiet,
39bd6f72 659 opts->track);
c8a3ea1f
BW
660 new_branch_info->name = opts->new_branch;
661 setup_branch_path(new_branch_info);
782c2d65
DB
662 }
663
c8a3ea1f
BW
664 old_desc = old_branch_info->name;
665 if (!old_desc && old_branch_info->commit)
666 old_desc = oid_to_hex(&old_branch_info->commit->object.oid);
3bed291a
RR
667
668 reflog_msg = getenv("GIT_REFLOG_ACTION");
669 if (!reflog_msg)
670 strbuf_addf(&msg, "checkout: moving from %s to %s",
c8a3ea1f 671 old_desc ? old_desc : "(invalid)", new_branch_info->name);
3bed291a
RR
672 else
673 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
782c2d65 674
c8a3ea1f 675 if (!strcmp(new_branch_info->name, "HEAD") && !new_branch_info->path && !opts->force_detach) {
f8bd36a4 676 /* Nothing to do. */
c8a3ea1f
BW
677 } else if (opts->force_detach || !new_branch_info->path) { /* No longer on any branch. */
678 update_ref(msg.buf, "HEAD", &new_branch_info->commit->object.oid, NULL,
91774afc 679 REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
f8bd36a4 680 if (!opts->quiet) {
c8a3ea1f 681 if (old_branch_info->path &&
779b88a9 682 advice_detached_head && !opts->force_detach)
c8a3ea1f
BW
683 detach_advice(new_branch_info->name);
684 describe_detached_head(_("HEAD is now at"), new_branch_info->commit);
f8bd36a4 685 }
c8a3ea1f
BW
686 } else if (new_branch_info->path) { /* Switch branches. */
687 if (create_symref("HEAD", new_branch_info->path, msg.buf) < 0)
4636f651 688 die(_("unable to update HEAD"));
782c2d65 689 if (!opts->quiet) {
c8a3ea1f 690 if (old_branch_info->path && !strcmp(new_branch_info->path, old_branch_info->path)) {
39bd6f72
JN
691 if (opts->new_branch_force)
692 fprintf(stderr, _("Reset branch '%s'\n"),
c8a3ea1f 693 new_branch_info->name);
39bd6f72
JN
694 else
695 fprintf(stderr, _("Already on '%s'\n"),
c8a3ea1f 696 new_branch_info->name);
08eaa4be
ÆAB
697 } else if (opts->new_branch) {
698 if (opts->branch_exists)
c8a3ea1f 699 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
08eaa4be 700 else
c8a3ea1f 701 fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
08eaa4be 702 } else {
e8a8a4d7 703 fprintf(stderr, _("Switched to branch '%s'\n"),
c8a3ea1f 704 new_branch_info->name);
08eaa4be 705 }
782c2d65 706 }
c8a3ea1f
BW
707 if (old_branch_info->path && old_branch_info->name) {
708 if (!ref_exists(old_branch_info->path) && reflog_exists(old_branch_info->path))
709 delete_reflog(old_branch_info->path);
3631bf77 710 }
782c2d65
DB
711 }
712 remove_branch_state();
713 strbuf_release(&msg);
32669671 714 if (!opts->quiet &&
c8a3ea1f
BW
715 (new_branch_info->path || (!opts->force_detach && !strcmp(new_branch_info->name, "HEAD"))))
716 report_tracking(new_branch_info);
782c2d65
DB
717}
718
468224e5 719static int add_pending_uninteresting_ref(const char *refname,
fcb615f5 720 const struct object_id *oid,
468224e5 721 int flags, void *cb_data)
8e2dc6ac 722{
a58a1b01 723 add_pending_oid(cb_data, refname, oid, UNINTERESTING);
5c08dc48
JK
724 return 0;
725}
8e2dc6ac
JH
726
727static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
728{
0be240cc 729 strbuf_addstr(sb, " ");
30e677e0 730 strbuf_add_unique_abbrev(sb, &commit->object.oid, DEFAULT_ABBREV);
0be240cc 731 strbuf_addch(sb, ' ');
3c621839
JK
732 if (!parse_commit(commit))
733 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
8e2dc6ac
JH
734 strbuf_addch(sb, '\n');
735}
736
737#define ORPHAN_CUTOFF 4
738static void suggest_reattach(struct commit *commit, struct rev_info *revs)
739{
740 struct commit *c, *last = NULL;
741 struct strbuf sb = STRBUF_INIT;
742 int lost = 0;
743 while ((c = get_revision(revs)) != NULL) {
744 if (lost < ORPHAN_CUTOFF)
745 describe_one_orphan(&sb, c);
746 last = c;
747 lost++;
748 }
749 if (ORPHAN_CUTOFF < lost) {
750 int more = lost - ORPHAN_CUTOFF;
751 if (more == 1)
752 describe_one_orphan(&sb, last);
753 else
f06f08b7 754 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
8e2dc6ac
JH
755 }
756
757 fprintf(stderr,
f06f08b7
ÆAB
758 Q_(
759 /* The singular version */
760 "Warning: you are leaving %d commit behind, "
761 "not connected to\n"
762 "any of your branches:\n\n"
0faf2474 763 "%s\n",
f06f08b7
ÆAB
764 /* The plural version */
765 "Warning: you are leaving %d commits behind, "
8e2dc6ac
JH
766 "not connected to\n"
767 "any of your branches:\n\n"
f807b3dc 768 "%s\n",
f06f08b7
ÆAB
769 /* Give ngettext() the count */
770 lost),
771 lost,
f807b3dc 772 sb.buf);
8e2dc6ac 773 strbuf_release(&sb);
f807b3dc
JH
774
775 if (advice_detached_head)
776 fprintf(stderr,
fc792ca8
TS
777 Q_(
778 /* The singular version */
779 "If you want to keep it by creating a new branch, "
780 "this may be a good time\nto do so with:\n\n"
781 " git branch <new-branch-name> %s\n\n",
782 /* The plural version */
f807b3dc
JH
783 "If you want to keep them by creating a new branch, "
784 "this may be a good time\nto do so with:\n\n"
fc792ca8
TS
785 " git branch <new-branch-name> %s\n\n",
786 /* Give ngettext() the count */
787 lost),
aab9583f 788 find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
8e2dc6ac
JH
789}
790
791/*
792 * We are about to leave commit that was at the tip of a detached
793 * HEAD. If it is not reachable from any ref, this is the last chance
794 * for the user to do so without resorting to reflog.
795 */
c8a3ea1f 796static void orphaned_commit_warning(struct commit *old_commit, struct commit *new_commit)
8e2dc6ac 797{
8e2dc6ac 798 struct rev_info revs;
c8a3ea1f 799 struct object *object = &old_commit->object;
8e2dc6ac
JH
800
801 init_revisions(&revs, NULL);
468224e5
RS
802 setup_revisions(0, NULL, &revs, NULL);
803
804 object->flags &= ~UNINTERESTING;
f2fd0760 805 add_pending_object(&revs, object, oid_to_hex(&object->oid));
468224e5 806
fcb615f5 807 for_each_ref(add_pending_uninteresting_ref, &revs);
c8a3ea1f 808 add_pending_oid(&revs, "HEAD", &new_commit->object.oid, UNINTERESTING);
468224e5 809
8e2dc6ac 810 if (prepare_revision_walk(&revs))
6c80cd29 811 die(_("internal error in revision walk"));
c8a3ea1f
BW
812 if (!(old_commit->object.flags & UNINTERESTING))
813 suggest_reattach(old_commit, &revs);
8e2dc6ac 814 else
c8a3ea1f 815 describe_detached_head(_("Previous HEAD position was"), old_commit);
5c08dc48 816
b2ccdf7f 817 /* Clean up objects used, as they will be reused. */
a9a03fa0 818 clear_commit_marks_all(ALL_REV_FLAGS);
8e2dc6ac
JH
819}
820
e51e3057 821static int switch_branches(const struct checkout_opts *opts,
c8a3ea1f 822 struct branch_info *new_branch_info)
782c2d65
DB
823{
824 int ret = 0;
c8a3ea1f 825 struct branch_info old_branch_info;
96ec7b1e 826 void *path_to_free;
60af7691 827 struct object_id rev;
a2b4994c 828 int flag, writeout_error = 0;
c8a3ea1f
BW
829 memset(&old_branch_info, 0, sizeof(old_branch_info));
830 old_branch_info.path = path_to_free = resolve_refdup("HEAD", 0, &rev, &flag);
831 if (old_branch_info.path)
832 old_branch_info.commit = lookup_commit_reference_gently(&rev, 1);
96ec7b1e 833 if (!(flag & REF_ISSYMREF))
c8a3ea1f 834 old_branch_info.path = NULL;
782c2d65 835
c8a3ea1f
BW
836 if (old_branch_info.path)
837 skip_prefix(old_branch_info.path, "refs/heads/", &old_branch_info.name);
782c2d65 838
c8a3ea1f
BW
839 if (!new_branch_info->name) {
840 new_branch_info->name = "HEAD";
841 new_branch_info->commit = old_branch_info.commit;
842 if (!new_branch_info->commit)
e8a8a4d7 843 die(_("You are on a branch yet to be born"));
c8a3ea1f 844 parse_commit_or_die(new_branch_info->commit);
782c2d65
DB
845 }
846
c8a3ea1f 847 ret = merge_working_tree(opts, &old_branch_info, new_branch_info, &writeout_error);
96ec7b1e
NTND
848 if (ret) {
849 free(path_to_free);
782c2d65 850 return ret;
96ec7b1e 851 }
782c2d65 852
c8a3ea1f
BW
853 if (!opts->quiet && !old_branch_info.path && old_branch_info.commit && new_branch_info->commit != old_branch_info.commit)
854 orphaned_commit_warning(old_branch_info.commit, new_branch_info->commit);
77ebd56d 855
c8a3ea1f 856 update_refs_for_switch(opts, &old_branch_info, new_branch_info);
782c2d65 857
c8a3ea1f 858 ret = post_checkout_hook(old_branch_info.commit, new_branch_info->commit, 1);
96ec7b1e 859 free(path_to_free);
a2b4994c 860 return ret || writeout_error;
782c2d65
DB
861}
862
0cf8581e
JH
863static int git_checkout_config(const char *var, const char *value, void *cb)
864{
175f6e59
JS
865 if (!strcmp(var, "diff.ignoresubmodules")) {
866 struct checkout_opts *opts = cb;
867 handle_ignore_submodules_arg(&opts->diff_options, value);
868 return 0;
869 }
23b4c7bc 870
59556548 871 if (starts_with(var, "submodule."))
7463e2ec 872 return git_default_submodule_config(var, value, NULL);
23b4c7bc 873
175f6e59 874 return git_xmerge_config(var, value, NULL);
0cf8581e
JH
875}
876
09ebad6f
JN
877static int parse_branchname_arg(int argc, const char **argv,
878 int dwim_new_local_branch_ok,
c8a3ea1f 879 struct branch_info *new_branch_info,
10f102be 880 struct checkout_opts *opts,
60af7691 881 struct object_id *rev)
09ebad6f 882{
10f102be
NTND
883 struct tree **source_tree = &opts->source_tree;
884 const char **new_branch = &opts->new_branch;
09ebad6f 885 int argcount = 0;
60af7691 886 struct object_id branch_rev;
09ebad6f 887 const char *arg;
bca39695
MM
888 int dash_dash_pos;
889 int has_dash_dash = 0;
890 int i;
09ebad6f
JN
891
892 /*
893 * case 1: git checkout <ref> -- [<paths>]
894 *
895 * <ref> must be a valid tree, everything after the '--' must be
896 * a path.
897 *
898 * case 2: git checkout -- [<paths>]
899 *
900 * everything after the '--' must be paths.
901 *
a047fafc 902 * case 3: git checkout <something> [--]
09ebad6f 903 *
a047fafc
MM
904 * (a) If <something> is a commit, that is to
905 * switch to the branch or detach HEAD at it. As a special case,
906 * if <something> is A...B (missing A or B means HEAD but you can
907 * omit at most one side), and if there is a unique merge base
908 * between A and B, A...B names that merge base.
09ebad6f 909 *
a047fafc 910 * (b) If <something> is _not_ a commit, either "--" is present
01689909 911 * or <something> is not a path, no -t or -b was given, and
a047fafc
MM
912 * and there is a tracking branch whose name is <something>
913 * in one and only one remote, then this is a short-hand to
914 * fork local <something> from that remote-tracking branch.
09ebad6f 915 *
a047fafc
MM
916 * (c) Otherwise, if "--" is present, treat it like case (1).
917 *
918 * (d) Otherwise :
919 * - if it's a reference, treat it like case (1)
920 * - else if it's a path, treat it like case (2)
921 * - else: fail.
922 *
923 * case 4: git checkout <something> <paths>
924 *
925 * The first argument must not be ambiguous.
09ebad6f
JN
926 * - If it's *only* a reference, treat it like case (1).
927 * - If it's only a path, treat it like case (2).
928 * - else: fail.
929 *
930 */
931 if (!argc)
932 return 0;
933
09ebad6f 934 arg = argv[0];
bca39695
MM
935 dash_dash_pos = -1;
936 for (i = 0; i < argc; i++) {
937 if (!strcmp(argv[i], "--")) {
938 dash_dash_pos = i;
939 break;
940 }
941 }
942 if (dash_dash_pos == 0)
943 return 1; /* case (2) */
944 else if (dash_dash_pos == 1)
945 has_dash_dash = 1; /* case (3) or (1) */
946 else if (dash_dash_pos >= 2)
947 die(_("only one reference expected, %d given."), dash_dash_pos);
09ebad6f
JN
948
949 if (!strcmp(arg, "-"))
950 arg = "@{-1}";
951
151b2911 952 if (get_oid_mb(arg, rev)) {
a047fafc
MM
953 /*
954 * Either case (3) or (4), with <something> not being
955 * a commit, or an attempt to use case (1) with an
956 * invalid ref.
957 *
958 * It's likely an error, but we need to find out if
959 * we should auto-create the branch, case (3).(b).
960 */
961 int recover_with_dwim = dwim_new_local_branch_ok;
962
df714f81 963 if (!has_dash_dash &&
b829b943 964 (check_filename(opts->prefix, arg) || !no_wildcard(arg)))
a047fafc
MM
965 recover_with_dwim = 0;
966 /*
967 * Accept "git checkout foo" and "git checkout foo --"
968 * as candidates for dwim.
969 */
970 if (!(argc == 1 && !has_dash_dash) &&
971 !(argc == 2 && has_dash_dash))
972 recover_with_dwim = 0;
973
974 if (recover_with_dwim) {
fa83a33b 975 const char *remote = unique_tracking_name(arg, rev);
a047fafc
MM
976 if (remote) {
977 *new_branch = arg;
978 arg = remote;
979 /* DWIMmed to create local branch, case (3).(b) */
980 } else {
981 recover_with_dwim = 0;
982 }
983 }
984
985 if (!recover_with_dwim) {
986 if (has_dash_dash)
987 die(_("invalid reference: %s"), arg);
09ebad6f
JN
988 return argcount;
989 }
990 }
991
992 /* we can't end up being in (2) anymore, eat the argument */
993 argcount++;
994 argv++;
995 argc--;
996
c8a3ea1f
BW
997 new_branch_info->name = arg;
998 setup_branch_path(new_branch_info);
09ebad6f 999
c8a3ea1f
BW
1000 if (!check_refname_format(new_branch_info->path, 0) &&
1001 !read_ref(new_branch_info->path, &branch_rev))
60af7691 1002 oidcpy(rev, &branch_rev);
09ebad6f 1003 else
c8a3ea1f 1004 new_branch_info->path = NULL; /* not an existing branch */
09ebad6f 1005
c8a3ea1f
BW
1006 new_branch_info->commit = lookup_commit_reference_gently(rev, 1);
1007 if (!new_branch_info->commit) {
09ebad6f 1008 /* not a commit */
a9dbc179 1009 *source_tree = parse_tree_indirect(rev);
09ebad6f 1010 } else {
c8a3ea1f 1011 parse_commit_or_die(new_branch_info->commit);
2e27bd77 1012 *source_tree = get_commit_tree(new_branch_info->commit);
09ebad6f
JN
1013 }
1014
1015 if (!*source_tree) /* case (1): want a tree */
6c80cd29 1016 die(_("reference is not a tree: %s"), arg);
7f82b24e 1017 if (!has_dash_dash) { /* case (3).(d) -> (1) */
09ebad6f
JN
1018 /*
1019 * Do not complain the most common case
1020 * git checkout branch
1021 * even if there happen to be a file called 'branch';
1022 * it would be extremely annoying.
1023 */
1024 if (argc)
b829b943 1025 verify_non_filename(opts->prefix, arg);
09ebad6f
JN
1026 } else {
1027 argcount++;
1028 argv++;
1029 argc--;
1030 }
1031
1032 return argcount;
1033}
1034
a2b4994c 1035static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
abe19980
JH
1036{
1037 int status;
1038 struct strbuf branch_ref = STRBUF_INIT;
1039
8ced1aa0
CW
1040 if (!opts->new_branch)
1041 die(_("You are on a branch yet to be born"));
abe19980
JH
1042 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1043 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1044 strbuf_release(&branch_ref);
afa8c07a
JK
1045 if (!opts->quiet)
1046 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1047 opts->new_branch);
abe19980
JH
1048 return status;
1049}
1050
b6312c27 1051static int checkout_branch(struct checkout_opts *opts,
c8a3ea1f 1052 struct branch_info *new_branch_info)
b6312c27 1053{
817b345a 1054 if (opts->pathspec.nr)
b6312c27
NTND
1055 die(_("paths cannot be used with switching branches"));
1056
1057 if (opts->patch_mode)
1058 die(_("'%s' cannot be used with switching branches"),
1059 "--patch");
1060
1061 if (opts->writeout_stage)
1062 die(_("'%s' cannot be used with switching branches"),
1063 "--ours/--theirs");
1064
1065 if (opts->force && opts->merge)
1066 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1067
1068 if (opts->force_detach && opts->new_branch)
1069 die(_("'%s' cannot be used with '%s'"),
1070 "--detach", "-b/-B/--orphan");
1071
1072 if (opts->new_orphan_branch) {
1073 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1074 die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1075 } else if (opts->force_detach) {
1076 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1077 die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1078 } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1079 opts->track = git_branch_track;
1080
c8a3ea1f 1081 if (new_branch_info->name && !new_branch_info->commit)
b6312c27 1082 die(_("Cannot switch branch to a non-commit '%s'"),
c8a3ea1f 1083 new_branch_info->name);
b6312c27 1084
c8a3ea1f 1085 if (new_branch_info->path && !opts->force_detach && !opts->new_branch &&
c265c533 1086 !opts->ignore_other_worktrees) {
e1c1ab9d 1087 int flag;
efbd4fdf 1088 char *head_ref = resolve_refdup("HEAD", 0, NULL, &flag);
e1c1ab9d 1089 if (head_ref &&
c8a3ea1f
BW
1090 (!(flag & REF_ISSYMREF) || strcmp(head_ref, new_branch_info->path)))
1091 die_if_checked_out(new_branch_info->path, 1);
e1c1ab9d
NTND
1092 free(head_ref);
1093 }
1094
c8a3ea1f 1095 if (!new_branch_info->commit && opts->new_branch) {
60af7691 1096 struct object_id rev;
b6312c27
NTND
1097 int flag;
1098
34c290a6 1099 if (!read_ref_full("HEAD", 0, &rev, &flag) &&
60af7691 1100 (flag & REF_ISSYMREF) && is_null_oid(&rev))
b6312c27
NTND
1101 return switch_unborn_to_new_branch(opts);
1102 }
c8a3ea1f 1103 return switch_branches(opts, new_branch_info);
b6312c27
NTND
1104}
1105
782c2d65
DB
1106int cmd_checkout(int argc, const char **argv, const char *prefix)
1107{
1108 struct checkout_opts opts;
c8a3ea1f 1109 struct branch_info new_branch_info;
eac5a401 1110 char *conflict_style = NULL;
46148dd7 1111 int dwim_new_local_branch = 1;
782c2d65 1112 struct option options[] = {
e05a1093
NTND
1113 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
1114 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1115 N_("create and checkout a new branch")),
1116 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1117 N_("create/reset and checkout a branch")),
d5d09d47 1118 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
e923a8ab 1119 OPT_BOOL(0, "detach", &opts.force_detach, N_("detach HEAD at named commit")),
e05a1093 1120 OPT_SET_INT('t', "track", &opts.track, N_("set upstream info for new branch"),
9ed36cfa 1121 BRANCH_TRACK_EXPLICIT),
e703d711 1122 OPT_STRING(0, "orphan", &opts.new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
3fe735e7
NTND
1123 OPT_SET_INT_F('2', "ours", &opts.writeout_stage,
1124 N_("checkout our version for unmerged files"),
1125 2, PARSE_OPT_NONEG),
1126 OPT_SET_INT_F('3', "theirs", &opts.writeout_stage,
1127 N_("checkout their version for unmerged files"),
1128 3, PARSE_OPT_NONEG),
77afafb2
NTND
1129 OPT__FORCE(&opts.force, N_("force checkout (throw away local modifications)"),
1130 PARSE_OPT_NOCOMPLETE),
d5d09d47 1131 OPT_BOOL('m', "merge", &opts.merge, N_("perform a 3-way merge with the new branch")),
77afafb2
NTND
1132 OPT_BOOL_F(0, "overwrite-ignore", &opts.overwrite_ignore,
1133 N_("update ignored files (default)"),
1134 PARSE_OPT_NOCOMPLETE),
e05a1093
NTND
1135 OPT_STRING(0, "conflict", &conflict_style, N_("style"),
1136 N_("conflict style (merge or diff3)")),
d5d09d47 1137 OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
08d595dc
NTND
1138 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
1139 N_("do not limit pathspecs to sparse entries only")),
4741edd5 1140 OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
9c9b4f2f 1141 N_("second guess 'git checkout <no-such-branch>'")),
1d0fa898
NTND
1142 OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
1143 N_("do not check if another worktree is holding the given ref")),
58b75bd6 1144 { OPTION_CALLBACK, 0, "recurse-submodules", NULL,
1fc458d9 1145 "checkout", "control recursive updating of submodules",
d7a3803f 1146 PARSE_OPT_OPTARG, option_parse_recurse_submodules_worktree_updater },
870ebdb9 1147 OPT_BOOL(0, "progress", &opts.show_progress, N_("force progress reporting")),
b249b552 1148 OPT_END(),
782c2d65
DB
1149 };
1150
1151 memset(&opts, 0, sizeof(opts));
c8a3ea1f 1152 memset(&new_branch_info, 0, sizeof(new_branch_info));
c1d7036b 1153 opts.overwrite_ignore = 1;
e51e3057 1154 opts.prefix = prefix;
870ebdb9 1155 opts.show_progress = -1;
782c2d65 1156
175f6e59 1157 git_config(git_checkout_config, &opts);
782c2d65 1158
9188ed89 1159 opts.track = BRANCH_TRACK_UNSPECIFIED;
782c2d65 1160
37782920 1161 argc = parse_options(argc, argv, prefix, options, checkout_usage,
f5242ebf 1162 PARSE_OPT_KEEP_DASHDASH);
859fdaba 1163
870ebdb9
ECA
1164 if (opts.show_progress < 0) {
1165 if (opts.quiet)
1166 opts.show_progress = 0;
1167 else
1168 opts.show_progress = isatty(2);
1169 }
1170
b6312c27
NTND
1171 if (conflict_style) {
1172 opts.merge = 1; /* implied */
1173 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1174 }
02ac9837 1175
b6312c27
NTND
1176 if ((!!opts.new_branch + !!opts.new_branch_force + !!opts.new_orphan_branch) > 1)
1177 die(_("-b, -B and --orphan are mutually exclusive"));
02ac9837 1178
b6312c27
NTND
1179 /*
1180 * From here on, new_branch will contain the branch to be checked out,
1181 * and new_branch_force and new_orphan_branch will tell us which one of
1182 * -b/-B/--orphan is being used.
1183 */
02ac9837
TRC
1184 if (opts.new_branch_force)
1185 opts.new_branch = opts.new_branch_force;
1186
b6312c27
NTND
1187 if (opts.new_orphan_branch)
1188 opts.new_branch = opts.new_orphan_branch;
32669671 1189
b6312c27
NTND
1190 /* --track without -b/-B/--orphan should DWIM */
1191 if (opts.track != BRANCH_TRACK_UNSPECIFIED && !opts.new_branch) {
9188ed89
AR
1192 const char *argv0 = argv[0];
1193 if (!argc || !strcmp(argv0, "--"))
1a07e59c 1194 die(_("--track needs a branch name"));
e3f1da98
RS
1195 skip_prefix(argv0, "refs/", &argv0);
1196 skip_prefix(argv0, "remotes/", &argv0);
9188ed89
AR
1197 argv0 = strchr(argv0, '/');
1198 if (!argv0 || !argv0[1])
1a07e59c 1199 die(_("missing branch name; try -b"));
9188ed89 1200 opts.new_branch = argv0 + 1;
bb0ceb62
JS
1201 }
1202
859fdaba 1203 /*
09ebad6f
JN
1204 * Extract branch name from command line arguments, so
1205 * all that is left is pathspecs.
859fdaba 1206 *
09ebad6f 1207 * Handle
70c9ac2f 1208 *
09ebad6f
JN
1209 * 1) git checkout <tree> -- [<paths>]
1210 * 2) git checkout -- [<paths>]
1211 * 3) git checkout <something> [<paths>]
859fdaba 1212 *
09ebad6f
JN
1213 * including "last branch" syntax and DWIM-ery for names of
1214 * remote branches, erroring out for invalid or ambiguous cases.
859fdaba 1215 */
782c2d65 1216 if (argc) {
60af7691 1217 struct object_id rev;
09ebad6f 1218 int dwim_ok =
e51e3057 1219 !opts.patch_mode &&
09ebad6f
JN
1220 dwim_new_local_branch &&
1221 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1222 !opts.new_branch;
f8bd36a4 1223 int n = parse_branchname_arg(argc, argv, dwim_ok,
c8a3ea1f 1224 &new_branch_info, &opts, &rev);
09ebad6f
JN
1225 argv += n;
1226 argc -= n;
782c2d65
DB
1227 }
1228
782c2d65 1229 if (argc) {
480ca644
NTND
1230 parse_pathspec(&opts.pathspec, 0,
1231 opts.patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1232 prefix, argv);
301e42ed 1233
817b345a 1234 if (!opts.pathspec.nr)
e8a8a4d7 1235 die(_("invalid path specification"));
301e42ed 1236
b6312c27
NTND
1237 /*
1238 * Try to give more helpful suggestion.
1239 * new_branch && argc > 1 will be caught later.
1240 */
1241 if (opts.new_branch && argc == 1)
6c486862
JNA
1242 die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1243 argv[0], opts.new_branch);
782c2d65 1244
32669671 1245 if (opts.force_detach)
b6312c27
NTND
1246 die(_("git checkout: --detach does not take a path argument '%s'"),
1247 argv[0]);
32669671 1248
0cf8581e 1249 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
b6312c27
NTND
1250 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1251 "checking out of the index."));
782c2d65
DB
1252 }
1253
352eadc4 1254 if (opts.new_branch) {
f285a2d7 1255 struct strbuf buf = STRBUF_INIT;
55c4a673 1256
bc1c9c0e
JH
1257 if (opts.new_branch_force)
1258 opts.branch_exists = validate_branchname(opts.new_branch, &buf);
1259 else
1260 opts.branch_exists =
1261 validate_new_branchname(opts.new_branch, &buf, 0);
352eadc4
DB
1262 strbuf_release(&buf);
1263 }
1264
886e1084 1265 UNLEAK(opts);
817b345a 1266 if (opts.patch_mode || opts.pathspec.nr)
c8a3ea1f 1267 return checkout_paths(&opts, new_branch_info.name);
b6312c27 1268 else
c8a3ea1f 1269 return checkout_branch(&opts, &new_branch_info);
782c2d65 1270}