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