git.oblomov.eu Git - git/blob - builtin/checkout.c

   1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   2 #include "builtin.h"
   3 #include "advice.h"
   4 #include "blob.h"
   5 #include "branch.h"
   6 #include "cache-tree.h"
   7 #include "checkout.h"
   8 #include "commit.h"
   9 #include "config.h"
  10 #include "diff.h"
  11 #include "dir.h"
  12 #include "ll-merge.h"
  13 #include "lockfile.h"
  14 #include "merge-recursive.h"
  15 #include "object-store.h"
  16 #include "parse-options.h"
  17 #include "refs.h"
  18 #include "remote.h"
  19 #include "resolve-undo.h"
  20 #include "revision.h"
  21 #include "run-command.h"
  22 #include "submodule.h"
  23 #include "submodule-config.h"
  24 #include "tree.h"
  25 #include "tree-walk.h"
  26 #include "unpack-trees.h"
  27 #include "wt-status.h"
  28 #include "xdiff-interface.h"
  29
  30 static const char * const checkout_usage[] = {
  31         N_("git checkout [<options>] <branch>"),
  32         N_("git checkout [<options>] [<branch>] -- <file>..."),
  33         NULL,
  34 };
  35
  36 static const char * const switch_branch_usage[] = {
  37         N_("git switch [<options>] [<branch>]"),
  38         NULL,
  39 };
  40
  41 static const char * const restore_usage[] = {
  42         N_("git restore [<options>] [--source=<branch>] <file>..."),
  43         NULL,
  44 };
  45
  46 struct checkout_opts {
  47         int patch_mode;
  48         int quiet;
  49         int merge;
  50         int force;
  51         int force_detach;
  52         int implicit_detach;
  53         int writeout_stage;
  54         int overwrite_ignore;
  55         int ignore_skipworktree;
  56         int ignore_other_worktrees;
  57         int show_progress;
  58         int count_checkout_paths;
  59         int overlay_mode;
  60         int dwim_new_local_branch;
  61         int discard_changes;
  62         int accept_ref;
  63         int accept_pathspec;
  64         int switch_branch_doing_nothing_is_ok;
  65         int only_merge_on_switching_branches;
  66         int can_switch_when_in_progress;
  67         int orphan_from_empty_tree;
  68         int empty_pathspec_ok;
  69         int checkout_index;
  70         int checkout_worktree;
  71         const char *ignore_unmerged_opt;
  72         int ignore_unmerged;
  73
  74         const char *new_branch;
  75         const char *new_branch_force;
  76         const char *new_orphan_branch;
  77         int new_branch_log;
  78         enum branch_track track;
  79         struct diff_options diff_options;
  80         char *conflict_style;
  81
  82         int branch_exists;
  83         const char *prefix;
  84         struct pathspec pathspec;
  85         const char *from_treeish;
  86         struct tree *source_tree;
  87 };
  88
  89 static int post_checkout_hook(struct commit *old_commit, struct commit *new_commit,
  90                               int changed)
  91 {
  92         return run_hook_le(NULL, "post-checkout",
  93                            oid_to_hex(old_commit ? &old_commit->object.oid : &null_oid),
  94                            oid_to_hex(new_commit ? &new_commit->object.oid : &null_oid),
  95                            changed ? "1" : "0", NULL);
  96         /* "new_commit" can be NULL when checking out from the index before
  97            a commit exists. */
  98
  99 }
 100
 101 static int update_some(const struct object_id *oid, struct strbuf *base,
 102                 const char *pathname, unsigned mode, int stage, void *context)
 103 {
 104         int len;
 105         struct cache_entry *ce;
 106         int pos;
 107
 108         if (S_ISDIR(mode))
 109                 return READ_TREE_RECURSIVE;
 110
 111         len = base->len + strlen(pathname);
 112         ce = make_empty_cache_entry(&the_index, len);
 113         oidcpy(&ce->oid, oid);
 114         memcpy(ce->name, base->buf, base->len);
 115         memcpy(ce->name + base->len, pathname, len - base->len);
 116         ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
 117         ce->ce_namelen = len;
 118         ce->ce_mode = create_ce_mode(mode);
 119
 120         /*
 121          * If the entry is the same as the current index, we can leave the old
 122          * entry in place. Whether it is UPTODATE or not, checkout_entry will
 123          * do the right thing.
 124          */
 125         pos = cache_name_pos(ce->name, ce->ce_namelen);
 126         if (pos >= 0) {
 127                 struct cache_entry *old = active_cache[pos];
 128                 if (ce->ce_mode == old->ce_mode &&
 129                     oideq(&ce->oid, &old->oid)) {
 130                         old->ce_flags |= CE_UPDATE;
 131                         discard_cache_entry(ce);
 132                         return 0;
 133                 }
 134         }
 135
 136         add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
 137         return 0;
 138 }
 139
 140 static int read_tree_some(struct tree *tree, const struct pathspec *pathspec)
 141 {
 142         read_tree_recursive(the_repository, tree, "", 0, 0,
 143                             pathspec, update_some, NULL);
 144
 145         /* update the index with the given tree's info
 146          * for all args, expanding wildcards, and exit
 147          * with any non-zero return code.
 148          */
 149         return 0;
 150 }
 151
 152 static int skip_same_name(const struct cache_entry *ce, int pos)
 153 {
 154         while (++pos < active_nr &&
 155                !strcmp(active_cache[pos]->name, ce->name))
 156                 ; /* skip */
 157         return pos;
 158 }
 159
 160 static int check_stage(int stage, const struct cache_entry *ce, int pos,
 161                        int overlay_mode)
 162 {
 163         while (pos < active_nr &&
 164                !strcmp(active_cache[pos]->name, ce->name)) {
 165                 if (ce_stage(active_cache[pos]) == stage)
 166                         return 0;
 167                 pos++;
 168         }
 169         if (!overlay_mode)
 170                 return 0;
 171         if (stage == 2)
 172                 return error(_("path '%s' does not have our version"), ce->name);
 173         else
 174                 return error(_("path '%s' does not have their version"), ce->name);
 175 }
 176
 177 static int check_stages(unsigned stages, const struct cache_entry *ce, int pos)
 178 {
 179         unsigned seen = 0;
 180         const char *name = ce->name;
 181
 182         while (pos < active_nr) {
 183                 ce = active_cache[pos];
 184                 if (strcmp(name, ce->name))
 185                         break;
 186                 seen |= (1 << ce_stage(ce));
 187                 pos++;
 188         }
 189         if ((stages & seen) != stages)
 190                 return error(_("path '%s' does not have all necessary versions"),
 191                              name);
 192         return 0;
 193 }
 194
 195 static int checkout_stage(int stage, const struct cache_entry *ce, int pos,
 196                           const struct checkout *state, int *nr_checkouts,
 197                           int overlay_mode)
 198 {
 199         while (pos < active_nr &&
 200                !strcmp(active_cache[pos]->name, ce->name)) {
 201                 if (ce_stage(active_cache[pos]) == stage)
 202                         return checkout_entry(active_cache[pos], state,
 203                                               NULL, nr_checkouts);
 204                 pos++;
 205         }
 206         if (!overlay_mode) {
 207                 unlink_entry(ce);
 208                 return 0;
 209         }
 210         if (stage == 2)
 211                 return error(_("path '%s' does not have our version"), ce->name);
 212         else
 213                 return error(_("path '%s' does not have their version"), ce->name);
 214 }
 215
 216 static int checkout_merged(int pos, const struct checkout *state, int *nr_checkouts)
 217 {
 218         struct cache_entry *ce = active_cache[pos];
 219         const char *path = ce->name;
 220         mmfile_t ancestor, ours, theirs;
 221         int status;
 222         struct object_id oid;
 223         mmbuffer_t result_buf;
 224         struct object_id threeway[3];
 225         unsigned mode = 0;
 226
 227         memset(threeway, 0, sizeof(threeway));
 228         while (pos < active_nr) {
 229                 int stage;
 230                 stage = ce_stage(ce);
 231                 if (!stage || strcmp(path, ce->name))
 232                         break;
 233                 oidcpy(&threeway[stage - 1], &ce->oid);
 234                 if (stage == 2)
 235                         mode = create_ce_mode(ce->ce_mode);
 236                 pos++;
 237                 ce = active_cache[pos];
 238         }
 239         if (is_null_oid(&threeway[1]) || is_null_oid(&threeway[2]))
 240                 return error(_("path '%s' does not have necessary versions"), path);
 241
 242         read_mmblob(&ancestor, &threeway[0]);
 243         read_mmblob(&ours, &threeway[1]);
 244         read_mmblob(&theirs, &threeway[2]);
 245
 246         /*
 247          * NEEDSWORK: re-create conflicts from merges with
 248          * merge.renormalize set, too
 249          */
 250         status = ll_merge(&result_buf, path, &ancestor, "base",
 251                           &ours, "ours", &theirs, "theirs",
 252                           state->istate, NULL);
 253         free(ancestor.ptr);
 254         free(ours.ptr);
 255         free(theirs.ptr);
 256         if (status < 0 || !result_buf.ptr) {
 257                 free(result_buf.ptr);
 258                 return error(_("path '%s': cannot merge"), path);
 259         }
 260
 261         /*
 262          * NEEDSWORK:
 263          * There is absolutely no reason to write this as a blob object
 264          * and create a phony cache entry.  This hack is primarily to get
 265          * to the write_entry() machinery that massages the contents to
 266          * work-tree format and writes out which only allows it for a
 267          * cache entry.  The code in write_entry() needs to be refactored
 268          * to allow us to feed a <buffer, size, mode> instead of a cache
 269          * entry.  Such a refactoring would help merge_recursive as well
 270          * (it also writes the merge result to the object database even
 271          * when it may contain conflicts).
 272          */
 273         if (write_object_file(result_buf.ptr, result_buf.size, blob_type, &oid))
 274                 die(_("Unable to add merge result for '%s'"), path);
 275         free(result_buf.ptr);
 276         ce = make_transient_cache_entry(mode, &oid, path, 2);
 277         if (!ce)
 278                 die(_("make_cache_entry failed for path '%s'"), path);
 279         status = checkout_entry(ce, state, NULL, nr_checkouts);
 280         discard_cache_entry(ce);
 281         return status;
 282 }
 283
 284 static void mark_ce_for_checkout_overlay(struct cache_entry *ce,
 285                                          char *ps_matched,
 286                                          const struct checkout_opts *opts)
 287 {
 288         ce->ce_flags &= ~CE_MATCHED;
 289         if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
 290                 return;
 291         if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
 292                 /*
 293                  * "git checkout tree-ish -- path", but this entry
 294                  * is in the original index but is not in tree-ish
 295                  * or does not match the pathspec; it will not be
 296                  * checked out to the working tree.  We will not do
 297                  * anything to this entry at all.
 298                  */
 299                 return;
 300         /*
 301          * Either this entry came from the tree-ish we are
 302          * checking the paths out of, or we are checking out
 303          * of the index.
 304          *
 305          * If it comes from the tree-ish, we already know it
 306          * matches the pathspec and could just stamp
 307          * CE_MATCHED to it from update_some(). But we still
 308          * need ps_matched and read_tree_recursive (and
 309          * eventually tree_entry_interesting) cannot fill
 310          * ps_matched yet. Once it can, we can avoid calling
 311          * match_pathspec() for _all_ entries when
 312          * opts->source_tree != NULL.
 313          */
 314         if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched))
 315                 ce->ce_flags |= CE_MATCHED;
 316 }
 317
 318 static void mark_ce_for_checkout_no_overlay(struct cache_entry *ce,
 319                                             char *ps_matched,
 320                                             const struct checkout_opts *opts)
 321 {
 322         ce->ce_flags &= ~CE_MATCHED;
 323         if (!opts->ignore_skipworktree && ce_skip_worktree(ce))
 324                 return;
 325         if (ce_path_match(&the_index, ce, &opts->pathspec, ps_matched)) {
 326                 ce->ce_flags |= CE_MATCHED;
 327                 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
 328                         /*
 329                          * In overlay mode, but the path is not in
 330                          * tree-ish, which means we should remove it
 331                          * from the index and the working tree.
 332                          */
 333                         ce->ce_flags |= CE_REMOVE | CE_WT_REMOVE;
 334         }
 335 }
 336
 337 static int checkout_worktree(const struct checkout_opts *opts)
 338 {
 339         struct checkout state = CHECKOUT_INIT;
 340         int nr_checkouts = 0, nr_unmerged = 0;
 341         int errs = 0;
 342         int pos;
 343
 344         state.force = 1;
 345         state.refresh_cache = 1;
 346         state.istate = &the_index;
 347
 348         enable_delayed_checkout(&state);
 349         for (pos = 0; pos < active_nr; pos++) {
 350                 struct cache_entry *ce = active_cache[pos];
 351                 if (ce->ce_flags & CE_MATCHED) {
 352                         if (!ce_stage(ce)) {
 353                                 errs |= checkout_entry(ce, &state,
 354                                                        NULL, &nr_checkouts);
 355                                 continue;
 356                         }
 357                         if (opts->writeout_stage)
 358                                 errs |= checkout_stage(opts->writeout_stage,
 359                                                        ce, pos,
 360                                                        &state,
 361                                                        &nr_checkouts, opts->overlay_mode);
 362                         else if (opts->merge)
 363                                 errs |= checkout_merged(pos, &state,
 364                                                         &nr_unmerged);
 365                         pos = skip_same_name(ce, pos) - 1;
 366                 }
 367         }
 368         remove_marked_cache_entries(&the_index, 1);
 369         remove_scheduled_dirs();
 370         errs |= finish_delayed_checkout(&state, &nr_checkouts);
 371
 372         if (opts->count_checkout_paths) {
 373                 if (nr_unmerged)
 374                         fprintf_ln(stderr, Q_("Recreated %d merge conflict",
 375                                               "Recreated %d merge conflicts",
 376                                               nr_unmerged),
 377                                    nr_unmerged);
 378                 if (opts->source_tree)
 379                         fprintf_ln(stderr, Q_("Updated %d path from %s",
 380                                               "Updated %d paths from %s",
 381                                               nr_checkouts),
 382                                    nr_checkouts,
 383                                    find_unique_abbrev(&opts->source_tree->object.oid,
 384                                                       DEFAULT_ABBREV));
 385                 else if (!nr_unmerged || nr_checkouts)
 386                         fprintf_ln(stderr, Q_("Updated %d path from the index",
 387                                               "Updated %d paths from the index",
 388                                               nr_checkouts),
 389                                    nr_checkouts);
 390         }
 391
 392         return errs;
 393 }
 394
 395 static int checkout_paths(const struct checkout_opts *opts,
 396                           const char *revision)
 397 {
 398         int pos;
 399         static char *ps_matched;
 400         struct object_id rev;
 401         struct commit *head;
 402         int errs = 0;
 403         struct lock_file lock_file = LOCK_INIT;
 404         int checkout_index;
 405
 406         trace2_cmd_mode(opts->patch_mode ? "patch" : "path");
 407
 408         if (opts->track != BRANCH_TRACK_UNSPECIFIED)
 409                 die(_("'%s' cannot be used with updating paths"), "--track");
 410
 411         if (opts->new_branch_log)
 412                 die(_("'%s' cannot be used with updating paths"), "-l");
 413
 414         if (opts->ignore_unmerged && opts->patch_mode)
 415                 die(_("'%s' cannot be used with updating paths"),
 416                     opts->ignore_unmerged_opt);
 417
 418         if (opts->force_detach)
 419                 die(_("'%s' cannot be used with updating paths"), "--detach");
 420
 421         if (opts->merge && opts->patch_mode)
 422                 die(_("'%s' cannot be used with %s"), "--merge", "--patch");
 423
 424         if (opts->ignore_unmerged && opts->merge)
 425                 die(_("'%s' cannot be used with %s"),
 426                     opts->ignore_unmerged_opt, "-m");
 427
 428         if (opts->new_branch)
 429                 die(_("Cannot update paths and switch to branch '%s' at the same time."),
 430                     opts->new_branch);
 431
 432         if (!opts->checkout_worktree && !opts->checkout_index)
 433                 die(_("neither '%s' or '%s' is specified"),
 434                     "--staged", "--worktree");
 435
 436         if (!opts->checkout_worktree && !opts->from_treeish)
 437                 die(_("'%s' must be used when '%s' is not specified"),
 438                     "--worktree", "--source");
 439
 440         if (opts->checkout_index && !opts->checkout_worktree &&
 441             opts->writeout_stage)
 442                 die(_("'%s' or '%s' cannot be used with %s"),
 443                     "--ours", "--theirs", "--staged");
 444
 445         if (opts->checkout_index && !opts->checkout_worktree &&
 446             opts->merge)
 447                 die(_("'%s' or '%s' cannot be used with %s"),
 448                     "--merge", "--conflict", "--staged");
 449
 450         if (opts->patch_mode) {
 451                 const char *patch_mode;
 452
 453                 if (opts->checkout_index && opts->checkout_worktree)
 454                         patch_mode = "--patch=checkout";
 455                 else if (opts->checkout_index && !opts->checkout_worktree)
 456                         patch_mode = "--patch=reset";
 457                 else if (!opts->checkout_index && opts->checkout_worktree)
 458                         patch_mode = "--patch=worktree";
 459                 else
 460                         BUG("either flag must have been set, worktree=%d, index=%d",
 461                             opts->checkout_worktree, opts->checkout_index);
 462                 return run_add_interactive(revision, patch_mode, &opts->pathspec);
 463         }
 464
 465         repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
 466         if (read_cache_preload(&opts->pathspec) < 0)
 467                 return error(_("index file corrupt"));
 468
 469         if (opts->source_tree)
 470                 read_tree_some(opts->source_tree, &opts->pathspec);
 471
 472         ps_matched = xcalloc(opts->pathspec.nr, 1);
 473
 474         /*
 475          * Make sure all pathspecs participated in locating the paths
 476          * to be checked out.
 477          */
 478         for (pos = 0; pos < active_nr; pos++)
 479                 if (opts->overlay_mode)
 480                         mark_ce_for_checkout_overlay(active_cache[pos],
 481                                                      ps_matched,
 482                                                      opts);
 483                 else
 484                         mark_ce_for_checkout_no_overlay(active_cache[pos],
 485                                                         ps_matched,
 486                                                         opts);
 487
 488         if (report_path_error(ps_matched, &opts->pathspec)) {
 489                 free(ps_matched);
 490                 return 1;
 491         }
 492         free(ps_matched);
 493
 494         /* "checkout -m path" to recreate conflicted state */
 495         if (opts->merge)
 496                 unmerge_marked_index(&the_index);
 497
 498         /* Any unmerged paths? */
 499         for (pos = 0; pos < active_nr; pos++) {
 500                 const struct cache_entry *ce = active_cache[pos];
 501                 if (ce->ce_flags & CE_MATCHED) {
 502                         if (!ce_stage(ce))
 503                                 continue;
 504                         if (opts->ignore_unmerged) {
 505                                 if (!opts->quiet)
 506                                         warning(_("path '%s' is unmerged"), ce->name);
 507                         } else if (opts->writeout_stage) {
 508                                 errs |= check_stage(opts->writeout_stage, ce, pos, opts->overlay_mode);
 509                         } else if (opts->merge) {
 510                                 errs |= check_stages((1<<2) | (1<<3), ce, pos);
 511                         } else {
 512                                 errs = 1;
 513                                 error(_("path '%s' is unmerged"), ce->name);
 514                         }
 515                         pos = skip_same_name(ce, pos) - 1;
 516                 }
 517         }
 518         if (errs)
 519                 return 1;
 520
 521         /* Now we are committed to check them out */
 522         if (opts->checkout_worktree)
 523                 errs |= checkout_worktree(opts);
 524
 525         /*
 526          * Allow updating the index when checking out from the index.
 527          * This is to save new stat info.
 528          */
 529         if (opts->checkout_worktree && !opts->checkout_index && !opts->source_tree)
 530                 checkout_index = 1;
 531         else
 532                 checkout_index = opts->checkout_index;
 533
 534         if (checkout_index) {
 535                 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
 536                         die(_("unable to write new index file"));
 537         } else {
 538                 /*
 539                  * NEEDSWORK: if --worktree is not specified, we
 540                  * should save stat info of checked out files in the
 541                  * index to avoid the next (potentially costly)
 542                  * refresh. But it's a bit tricker to do...
 543                  */
 544                 rollback_lock_file(&lock_file);
 545         }
 546
 547         read_ref_full("HEAD", 0, &rev, NULL);
 548         head = lookup_commit_reference_gently(the_repository, &rev, 1);
 549
 550         errs |= post_checkout_hook(head, head, 0);
 551         return errs;
 552 }
 553
 554 static void show_local_changes(struct object *head,
 555                                const struct diff_options *opts)
 556 {
 557         struct rev_info rev;
 558         /* I think we want full paths, even if we're in a subdirectory. */
 559         repo_init_revisions(the_repository, &rev, NULL);
 560         rev.diffopt.flags = opts->flags;
 561         rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
 562         diff_setup_done(&rev.diffopt);
 563         add_pending_object(&rev, head, NULL);
 564         run_diff_index(&rev, 0);
 565 }
 566
 567 static void describe_detached_head(const char *msg, struct commit *commit)
 568 {
 569         struct strbuf sb = STRBUF_INIT;
 570
 571         if (!parse_commit(commit))
 572                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
 573         if (print_sha1_ellipsis()) {
 574                 fprintf(stderr, "%s %s... %s\n", msg,
 575                         find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
 576         } else {
 577                 fprintf(stderr, "%s %s %s\n", msg,
 578                         find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV), sb.buf);
 579         }
 580         strbuf_release(&sb);
 581 }
 582
 583 static int reset_tree(struct tree *tree, const struct checkout_opts *o,
 584                       int worktree, int *writeout_error)
 585 {
 586         struct unpack_trees_options opts;
 587         struct tree_desc tree_desc;
 588
 589         memset(&opts, 0, sizeof(opts));
 590         opts.head_idx = -1;
 591         opts.update = worktree;
 592         opts.skip_unmerged = !worktree;
 593         opts.reset = 1;
 594         opts.merge = 1;
 595         opts.fn = oneway_merge;
 596         opts.verbose_update = o->show_progress;
 597         opts.src_index = &the_index;
 598         opts.dst_index = &the_index;
 599         parse_tree(tree);
 600         init_tree_desc(&tree_desc, tree->buffer, tree->size);
 601         switch (unpack_trees(1, &tree_desc, &opts)) {
 602         case -2:
 603                 *writeout_error = 1;
 604                 /*
 605                  * We return 0 nevertheless, as the index is all right
 606                  * and more importantly we have made best efforts to
 607                  * update paths in the work tree, and we cannot revert
 608                  * them.
 609                  */
 610                 /* fallthrough */
 611         case 0:
 612                 return 0;
 613         default:
 614                 return 128;
 615         }
 616 }
 617
 618 struct branch_info {
 619         const char *name; /* The short name used */
 620         const char *path; /* The full name of a real branch */
 621         struct commit *commit; /* The named commit */
 622         /*
 623          * if not null the branch is detached because it's already
 624          * checked out in this checkout
 625          */
 626         char *checkout;
 627 };
 628
 629 static void setup_branch_path(struct branch_info *branch)
 630 {
 631         struct strbuf buf = STRBUF_INIT;
 632
 633         strbuf_branchname(&buf, branch->name, INTERPRET_BRANCH_LOCAL);
 634         if (strcmp(buf.buf, branch->name))
 635                 branch->name = xstrdup(buf.buf);
 636         strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
 637         branch->path = strbuf_detach(&buf, NULL);
 638 }
 639
 640 static int merge_working_tree(const struct checkout_opts *opts,
 641                               struct branch_info *old_branch_info,
 642                               struct branch_info *new_branch_info,
 643                               int *writeout_error)
 644 {
 645         int ret;
 646         struct lock_file lock_file = LOCK_INIT;
 647         struct tree *new_tree;
 648
 649         hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
 650         if (read_cache_preload(NULL) < 0)
 651                 return error(_("index file corrupt"));
 652
 653         resolve_undo_clear();
 654         if (opts->new_orphan_branch && opts->orphan_from_empty_tree) {
 655                 if (new_branch_info->commit)
 656                         BUG("'switch --orphan' should never accept a commit as starting point");
 657                 new_tree = parse_tree_indirect(the_hash_algo->empty_tree);
 658         } else
 659                 new_tree = get_commit_tree(new_branch_info->commit);
 660         if (opts->discard_changes) {
 661                 ret = reset_tree(new_tree, opts, 1, writeout_error);
 662                 if (ret)
 663                         return ret;
 664         } else {
 665                 struct tree_desc trees[2];
 666                 struct tree *tree;
 667                 struct unpack_trees_options topts;
 668
 669                 memset(&topts, 0, sizeof(topts));
 670                 topts.head_idx = -1;
 671                 topts.src_index = &the_index;
 672                 topts.dst_index = &the_index;
 673
 674                 setup_unpack_trees_porcelain(&topts, "checkout");
 675
 676                 refresh_cache(REFRESH_QUIET);
 677
 678                 if (unmerged_cache()) {
 679                         error(_("you need to resolve your current index first"));
 680                         return 1;
 681                 }
 682
 683                 /* 2-way merge to the new branch */
 684                 topts.initial_checkout = is_cache_unborn();
 685                 topts.update = 1;
 686                 topts.merge = 1;
 687                 topts.quiet = opts->merge && old_branch_info->commit;
 688                 topts.verbose_update = opts->show_progress;
 689                 topts.fn = twoway_merge;
 690                 if (opts->overwrite_ignore) {
 691                         topts.dir = xcalloc(1, sizeof(*topts.dir));
 692                         topts.dir->flags |= DIR_SHOW_IGNORED;
 693                         setup_standard_excludes(topts.dir);
 694                 }
 695                 tree = parse_tree_indirect(old_branch_info->commit ?
 696                                            &old_branch_info->commit->object.oid :
 697                                            the_hash_algo->empty_tree);
 698                 init_tree_desc(&trees[0], tree->buffer, tree->size);
 699                 parse_tree(new_tree);
 700                 tree = new_tree;
 701                 init_tree_desc(&trees[1], tree->buffer, tree->size);
 702
 703                 ret = unpack_trees(2, trees, &topts);
 704                 clear_unpack_trees_porcelain(&topts);
 705                 if (ret == -1) {
 706                         /*
 707                          * Unpack couldn't do a trivial merge; either
 708                          * give up or do a real merge, depending on
 709                          * whether the merge flag was used.
 710                          */
 711                         struct tree *result;
 712                         struct tree *work;
 713                         struct tree *old_tree;
 714                         struct merge_options o;
 715                         struct strbuf sb = STRBUF_INIT;
 716                         struct strbuf old_commit_shortname = STRBUF_INIT;
 717
 718                         if (!opts->merge)
 719                                 return 1;
 720
 721                         /*
 722                          * Without old_branch_info->commit, the below is the same as
 723                          * the two-tree unpack we already tried and failed.
 724                          */
 725                         if (!old_branch_info->commit)
 726                                 return 1;
 727                         old_tree = get_commit_tree(old_branch_info->commit);
 728
 729                         if (repo_index_has_changes(the_repository, old_tree, &sb))
 730                                 die(_("cannot continue with staged changes in "
 731                                       "the following files:\n%s"), sb.buf);
 732                         strbuf_release(&sb);
 733
 734                         if (repo_index_has_changes(the_repository,
 735                                                    get_commit_tree(old_branch_info->commit),
 736                                                    &sb))
 737                                 warning(_("staged changes in the following files may be lost: %s"),
 738                                         sb.buf);
 739                         strbuf_release(&sb);
 740
 741                         /* Do more real merge */
 742
 743                         /*
 744                          * We update the index fully, then write the
 745                          * tree from the index, then merge the new
 746                          * branch with the current tree, with the old
 747                          * branch as the base. Then we reset the index
 748                          * (but not the working tree) to the new
 749                          * branch, leaving the working tree as the
 750                          * merged version, but skipping unmerged
 751                          * entries in the index.
 752                          */
 753
 754                         add_files_to_cache(NULL, NULL, 0);
 755                         /*
 756                          * NEEDSWORK: carrying over local changes
 757                          * when branches have different end-of-line
 758                          * normalization (or clean+smudge rules) is
 759                          * a pain; plumb in an option to set
 760                          * o.renormalize?
 761                          */
 762                         init_merge_options(&o, the_repository);
 763                         o.verbosity = 0;
 764                         work = write_tree_from_memory(&o);
 765
 766                         ret = reset_tree(new_tree,
 767                                          opts, 1,
 768                                          writeout_error);
 769                         if (ret)
 770                                 return ret;
 771                         o.ancestor = old_branch_info->name;
 772                         if (old_branch_info->name == NULL) {
 773                                 strbuf_add_unique_abbrev(&old_commit_shortname,
 774                                                          &old_branch_info->commit->object.oid,
 775                                                          DEFAULT_ABBREV);
 776                                 o.ancestor = old_commit_shortname.buf;
 777                         }
 778                         o.branch1 = new_branch_info->name;
 779                         o.branch2 = "local";
 780                         ret = merge_trees(&o,
 781                                           new_tree,
 782                                           work,
 783                                           old_tree,
 784                                           &result);
 785                         if (ret < 0)
 786                                 exit(128);
 787                         ret = reset_tree(new_tree,
 788                                          opts, 0,
 789                                          writeout_error);
 790                         strbuf_release(&o.obuf);
 791                         strbuf_release(&old_commit_shortname);
 792                         if (ret)
 793                                 return ret;
 794                 }
 795         }
 796
 797         if (!active_cache_tree)
 798                 active_cache_tree = cache_tree();
 799
 800         if (!cache_tree_fully_valid(active_cache_tree))
 801                 cache_tree_update(&the_index, WRITE_TREE_SILENT | WRITE_TREE_REPAIR);
 802
 803         if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
 804                 die(_("unable to write new index file"));
 805
 806         if (!opts->discard_changes && !opts->quiet && new_branch_info->commit)
 807                 show_local_changes(&new_branch_info->commit->object, &opts->diff_options);
 808
 809         return 0;
 810 }
 811
 812 static void report_tracking(struct branch_info *new_branch_info)
 813 {
 814         struct strbuf sb = STRBUF_INIT;
 815         struct branch *branch = branch_get(new_branch_info->name);
 816
 817         if (!format_tracking_info(branch, &sb, AHEAD_BEHIND_FULL))
 818                 return;
 819         fputs(sb.buf, stdout);
 820         strbuf_release(&sb);
 821 }
 822
 823 static void update_refs_for_switch(const struct checkout_opts *opts,
 824                                    struct branch_info *old_branch_info,
 825                                    struct branch_info *new_branch_info)
 826 {
 827         struct strbuf msg = STRBUF_INIT;
 828         const char *old_desc, *reflog_msg;
 829         if (opts->new_branch) {
 830                 if (opts->new_orphan_branch) {
 831                         char *refname;
 832
 833                         refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
 834                         if (opts->new_branch_log &&
 835                             !should_autocreate_reflog(refname)) {
 836                                 int ret;
 837                                 struct strbuf err = STRBUF_INIT;
 838
 839                                 ret = safe_create_reflog(refname, 1, &err);
 840                                 if (ret) {
 841                                         fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
 842                                                 opts->new_orphan_branch, err.buf);
 843                                         strbuf_release(&err);
 844                                         free(refname);
 845                                         return;
 846                                 }
 847                                 strbuf_release(&err);
 848                         }
 849                         free(refname);
 850                 }
 851                 else
 852                         create_branch(the_repository,
 853                                       opts->new_branch, new_branch_info->name,
 854                                       opts->new_branch_force ? 1 : 0,
 855                                       opts->new_branch_force ? 1 : 0,
 856                                       opts->new_branch_log,
 857                                       opts->quiet,
 858                                       opts->track);
 859                 new_branch_info->name = opts->new_branch;
 860                 setup_branch_path(new_branch_info);
 861         }
 862
 863         old_desc = old_branch_info->name;
 864         if (!old_desc && old_branch_info->commit)
 865                 old_desc = oid_to_hex(&old_branch_info->commit->object.oid);
 866
 867         reflog_msg = getenv("GIT_REFLOG_ACTION");
 868         if (!reflog_msg)
 869                 strbuf_addf(&msg, "checkout: moving from %s to %s",
 870                         old_desc ? old_desc : "(invalid)", new_branch_info->name);
 871         else
 872                 strbuf_insert(&msg, 0, reflog_msg, strlen(reflog_msg));
 873
 874         if (!strcmp(new_branch_info->name, "HEAD") && !new_branch_info->path && !opts->force_detach) {
 875                 /* Nothing to do. */
 876         } else if (opts->force_detach || !new_branch_info->path) {      /* No longer on any branch. */
 877                 update_ref(msg.buf, "HEAD", &new_branch_info->commit->object.oid, NULL,
 878                            REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
 879                 if (!opts->quiet) {
 880                         if (old_branch_info->path &&
 881                             advice_detached_head && !opts->force_detach)
 882                                 detach_advice(new_branch_info->name);
 883                         describe_detached_head(_("HEAD is now at"), new_branch_info->commit);
 884                 }
 885         } else if (new_branch_info->path) {     /* Switch branches. */
 886                 if (create_symref("HEAD", new_branch_info->path, msg.buf) < 0)
 887                         die(_("unable to update HEAD"));
 888                 if (!opts->quiet) {
 889                         if (old_branch_info->path && !strcmp(new_branch_info->path, old_branch_info->path)) {
 890                                 if (opts->new_branch_force)
 891                                         fprintf(stderr, _("Reset branch '%s'\n"),
 892                                                 new_branch_info->name);
 893                                 else
 894                                         fprintf(stderr, _("Already on '%s'\n"),
 895                                                 new_branch_info->name);
 896                         } else if (opts->new_branch) {
 897                                 if (opts->branch_exists)
 898                                         fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
 899                                 else
 900                                         fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
 901                         } else {
 902                                 fprintf(stderr, _("Switched to branch '%s'\n"),
 903                                         new_branch_info->name);
 904                         }
 905                 }
 906                 if (old_branch_info->path && old_branch_info->name) {
 907                         if (!ref_exists(old_branch_info->path) && reflog_exists(old_branch_info->path))
 908                                 delete_reflog(old_branch_info->path);
 909                 }
 910         }
 911         remove_branch_state(the_repository, !opts->quiet);
 912         strbuf_release(&msg);
 913         if (!opts->quiet &&
 914             (new_branch_info->path || (!opts->force_detach && !strcmp(new_branch_info->name, "HEAD"))))
 915                 report_tracking(new_branch_info);
 916 }
 917
 918 static int add_pending_uninteresting_ref(const char *refname,
 919                                          const struct object_id *oid,
 920                                          int flags, void *cb_data)
 921 {
 922         add_pending_oid(cb_data, refname, oid, UNINTERESTING);
 923         return 0;
 924 }
 925
 926 static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
 927 {
 928         strbuf_addstr(sb, "  ");
 929         strbuf_add_unique_abbrev(sb, &commit->object.oid, DEFAULT_ABBREV);
 930         strbuf_addch(sb, ' ');
 931         if (!parse_commit(commit))
 932                 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
 933         strbuf_addch(sb, '\n');
 934 }
 935
 936 #define ORPHAN_CUTOFF 4
 937 static void suggest_reattach(struct commit *commit, struct rev_info *revs)
 938 {
 939         struct commit *c, *last = NULL;
 940         struct strbuf sb = STRBUF_INIT;
 941         int lost = 0;
 942         while ((c = get_revision(revs)) != NULL) {
 943                 if (lost < ORPHAN_CUTOFF)
 944                         describe_one_orphan(&sb, c);
 945                 last = c;
 946                 lost++;
 947         }
 948         if (ORPHAN_CUTOFF < lost) {
 949                 int more = lost - ORPHAN_CUTOFF;
 950                 if (more == 1)
 951                         describe_one_orphan(&sb, last);
 952                 else
 953                         strbuf_addf(&sb, _(" ... and %d more.\n"), more);
 954         }
 955
 956         fprintf(stderr,
 957                 Q_(
 958                 /* The singular version */
 959                 "Warning: you are leaving %d commit behind, "
 960                 "not connected to\n"
 961                 "any of your branches:\n\n"
 962                 "%s\n",
 963                 /* The plural version */
 964                 "Warning: you are leaving %d commits behind, "
 965                 "not connected to\n"
 966                 "any of your branches:\n\n"
 967                 "%s\n",
 968                 /* Give ngettext() the count */
 969                 lost),
 970                 lost,
 971                 sb.buf);
 972         strbuf_release(&sb);
 973
 974         if (advice_detached_head)
 975                 fprintf(stderr,
 976                         Q_(
 977                         /* The singular version */
 978                         "If you want to keep it by creating a new branch, "
 979                         "this may be a good time\nto do so with:\n\n"
 980                         " git branch <new-branch-name> %s\n\n",
 981                         /* The plural version */
 982                         "If you want to keep them by creating a new branch, "
 983                         "this may be a good time\nto do so with:\n\n"
 984                         " git branch <new-branch-name> %s\n\n",
 985                         /* Give ngettext() the count */
 986                         lost),
 987                         find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 988 }
 989
 990 /*
 991  * We are about to leave commit that was at the tip of a detached
 992  * HEAD.  If it is not reachable from any ref, this is the last chance
 993  * for the user to do so without resorting to reflog.
 994  */
 995 static void orphaned_commit_warning(struct commit *old_commit, struct commit *new_commit)
 996 {
 997         struct rev_info revs;
 998         struct object *object = &old_commit->object;
 999
1000         repo_init_revisions(the_repository, &revs, NULL);
1001         setup_revisions(0, NULL, &revs, NULL);
1002
1003         object->flags &= ~UNINTERESTING;
1004         add_pending_object(&revs, object, oid_to_hex(&object->oid));
1005
1006         for_each_ref(add_pending_uninteresting_ref, &revs);
1007         if (new_commit)
1008                 add_pending_oid(&revs, "HEAD",
1009                                 &new_commit->object.oid,
1010                                 UNINTERESTING);
1011
1012         if (prepare_revision_walk(&revs))
1013                 die(_("internal error in revision walk"));
1014         if (!(old_commit->object.flags & UNINTERESTING))
1015                 suggest_reattach(old_commit, &revs);
1016         else
1017                 describe_detached_head(_("Previous HEAD position was"), old_commit);
1018
1019         /* Clean up objects used, as they will be reused. */
1020         clear_commit_marks_all(ALL_REV_FLAGS);
1021 }
1022
1023 static int switch_branches(const struct checkout_opts *opts,
1024                            struct branch_info *new_branch_info)
1025 {
1026         int ret = 0;
1027         struct branch_info old_branch_info;
1028         void *path_to_free;
1029         struct object_id rev;
1030         int flag, writeout_error = 0;
1031         int do_merge = 1;
1032
1033         trace2_cmd_mode("branch");
1034
1035         memset(&old_branch_info, 0, sizeof(old_branch_info));
1036         old_branch_info.path = path_to_free = resolve_refdup("HEAD", 0, &rev, &flag);
1037         if (old_branch_info.path)
1038                 old_branch_info.commit = lookup_commit_reference_gently(the_repository, &rev, 1);
1039         if (!(flag & REF_ISSYMREF))
1040                 old_branch_info.path = NULL;
1041
1042         if (old_branch_info.path)
1043                 skip_prefix(old_branch_info.path, "refs/heads/", &old_branch_info.name);
1044
1045         if (opts->new_orphan_branch && opts->orphan_from_empty_tree) {
1046                 if (new_branch_info->name)
1047                         BUG("'switch --orphan' should never accept a commit as starting point");
1048                 new_branch_info->commit = NULL;
1049                 new_branch_info->name = "(empty)";
1050                 do_merge = 1;
1051         }
1052
1053         if (!new_branch_info->name) {
1054                 new_branch_info->name = "HEAD";
1055                 new_branch_info->commit = old_branch_info.commit;
1056                 if (!new_branch_info->commit)
1057                         die(_("You are on a branch yet to be born"));
1058                 parse_commit_or_die(new_branch_info->commit);
1059
1060                 if (opts->only_merge_on_switching_branches)
1061                         do_merge = 0;
1062         }
1063
1064         if (do_merge) {
1065                 ret = merge_working_tree(opts, &old_branch_info, new_branch_info, &writeout_error);
1066                 if (ret) {
1067                         free(path_to_free);
1068                         return ret;
1069                 }
1070         }
1071
1072         if (!opts->quiet && !old_branch_info.path && old_branch_info.commit && new_branch_info->commit != old_branch_info.commit)
1073                 orphaned_commit_warning(old_branch_info.commit, new_branch_info->commit);
1074
1075         update_refs_for_switch(opts, &old_branch_info, new_branch_info);
1076
1077         ret = post_checkout_hook(old_branch_info.commit, new_branch_info->commit, 1);
1078         free(path_to_free);
1079         return ret || writeout_error;
1080 }
1081
1082 static int git_checkout_config(const char *var, const char *value, void *cb)
1083 {
1084         if (!strcmp(var, "diff.ignoresubmodules")) {
1085                 struct checkout_opts *opts = cb;
1086                 handle_ignore_submodules_arg(&opts->diff_options, value);
1087                 return 0;
1088         }
1089
1090         if (starts_with(var, "submodule."))
1091                 return git_default_submodule_config(var, value, NULL);
1092
1093         return git_xmerge_config(var, value, NULL);
1094 }
1095
1096 static void setup_new_branch_info_and_source_tree(
1097         struct branch_info *new_branch_info,
1098         struct checkout_opts *opts,
1099         struct object_id *rev,
1100         const char *arg)
1101 {
1102         struct tree **source_tree = &opts->source_tree;
1103         struct object_id branch_rev;
1104
1105         new_branch_info->name = arg;
1106         setup_branch_path(new_branch_info);
1107
1108         if (!check_refname_format(new_branch_info->path, 0) &&
1109             !read_ref(new_branch_info->path, &branch_rev))
1110                 oidcpy(rev, &branch_rev);
1111         else
1112                 new_branch_info->path = NULL; /* not an existing branch */
1113
1114         new_branch_info->commit = lookup_commit_reference_gently(the_repository, rev, 1);
1115         if (!new_branch_info->commit) {
1116                 /* not a commit */
1117                 *source_tree = parse_tree_indirect(rev);
1118         } else {
1119                 parse_commit_or_die(new_branch_info->commit);
1120                 *source_tree = get_commit_tree(new_branch_info->commit);
1121         }
1122 }
1123
1124 static int parse_branchname_arg(int argc, const char **argv,
1125                                 int dwim_new_local_branch_ok,
1126                                 struct branch_info *new_branch_info,
1127                                 struct checkout_opts *opts,
1128                                 struct object_id *rev,
1129                                 int *dwim_remotes_matched)
1130 {
1131         const char **new_branch = &opts->new_branch;
1132         int argcount = 0;
1133         const char *arg;
1134         int dash_dash_pos;
1135         int has_dash_dash = 0;
1136         int i;
1137
1138         /*
1139          * case 1: git checkout <ref> -- [<paths>]
1140          *
1141          *   <ref> must be a valid tree, everything after the '--' must be
1142          *   a path.
1143          *
1144          * case 2: git checkout -- [<paths>]
1145          *
1146          *   everything after the '--' must be paths.
1147          *
1148          * case 3: git checkout <something> [--]
1149          *
1150          *   (a) If <something> is a commit, that is to
1151          *       switch to the branch or detach HEAD at it.  As a special case,
1152          *       if <something> is A...B (missing A or B means HEAD but you can
1153          *       omit at most one side), and if there is a unique merge base
1154          *       between A and B, A...B names that merge base.
1155          *
1156          *   (b) If <something> is _not_ a commit, either "--" is present
1157          *       or <something> is not a path, no -t or -b was given, and
1158          *       and there is a tracking branch whose name is <something>
1159          *       in one and only one remote (or if the branch exists on the
1160          *       remote named in checkout.defaultRemote), then this is a
1161          *       short-hand to fork local <something> from that
1162          *       remote-tracking branch.
1163          *
1164          *   (c) Otherwise, if "--" is present, treat it like case (1).
1165          *
1166          *   (d) Otherwise :
1167          *       - if it's a reference, treat it like case (1)
1168          *       - else if it's a path, treat it like case (2)
1169          *       - else: fail.
1170          *
1171          * case 4: git checkout <something> <paths>
1172          *
1173          *   The first argument must not be ambiguous.
1174          *   - If it's *only* a reference, treat it like case (1).
1175          *   - If it's only a path, treat it like case (2).
1176          *   - else: fail.
1177          *
1178          */
1179         if (!argc)
1180                 return 0;
1181
1182         if (!opts->accept_pathspec) {
1183                 if (argc > 1)
1184                         die(_("only one reference expected"));
1185                 has_dash_dash = 1; /* helps disambiguate */
1186         }
1187
1188         arg = argv[0];
1189         dash_dash_pos = -1;
1190         for (i = 0; i < argc; i++) {
1191                 if (opts->accept_pathspec && !strcmp(argv[i], "--")) {
1192                         dash_dash_pos = i;
1193                         break;
1194                 }
1195         }
1196         if (dash_dash_pos == 0)
1197                 return 1; /* case (2) */
1198         else if (dash_dash_pos == 1)
1199                 has_dash_dash = 1; /* case (3) or (1) */
1200         else if (dash_dash_pos >= 2)
1201                 die(_("only one reference expected, %d given."), dash_dash_pos);
1202         opts->count_checkout_paths = !opts->quiet && !has_dash_dash;
1203
1204         if (!strcmp(arg, "-"))
1205                 arg = "@{-1}";
1206
1207         if (get_oid_mb(arg, rev)) {
1208                 /*
1209                  * Either case (3) or (4), with <something> not being
1210                  * a commit, or an attempt to use case (1) with an
1211                  * invalid ref.
1212                  *
1213                  * It's likely an error, but we need to find out if
1214                  * we should auto-create the branch, case (3).(b).
1215                  */
1216                 int recover_with_dwim = dwim_new_local_branch_ok;
1217
1218                 int could_be_checkout_paths = !has_dash_dash &&
1219                         check_filename(opts->prefix, arg);
1220
1221                 if (!has_dash_dash && !no_wildcard(arg))
1222                         recover_with_dwim = 0;
1223
1224                 /*
1225                  * Accept "git checkout foo", "git checkout foo --"
1226                  * and "git switch foo" as candidates for dwim.
1227                  */
1228                 if (!(argc == 1 && !has_dash_dash) &&
1229                     !(argc == 2 && has_dash_dash) &&
1230                     opts->accept_pathspec)
1231                         recover_with_dwim = 0;
1232
1233                 if (recover_with_dwim) {
1234                         const char *remote = unique_tracking_name(arg, rev,
1235                                                                   dwim_remotes_matched);
1236                         if (remote) {
1237                                 if (could_be_checkout_paths)
1238                                         die(_("'%s' could be both a local file and a tracking branch.\n"
1239                                               "Please use -- (and optionally --no-guess) to disambiguate"),
1240                                             arg);
1241                                 *new_branch = arg;
1242                                 arg = remote;
1243                                 /* DWIMmed to create local branch, case (3).(b) */
1244                         } else {
1245                                 recover_with_dwim = 0;
1246                         }
1247                 }
1248
1249                 if (!recover_with_dwim) {
1250                         if (has_dash_dash)
1251                                 die(_("invalid reference: %s"), arg);
1252                         return argcount;
1253                 }
1254         }
1255
1256         /* we can't end up being in (2) anymore, eat the argument */
1257         argcount++;
1258         argv++;
1259         argc--;
1260
1261         setup_new_branch_info_and_source_tree(new_branch_info, opts, rev, arg);
1262
1263         if (!opts->source_tree)                   /* case (1): want a tree */
1264                 die(_("reference is not a tree: %s"), arg);
1265
1266         if (!has_dash_dash) {   /* case (3).(d) -> (1) */
1267                 /*
1268                  * Do not complain the most common case
1269                  *      git checkout branch
1270                  * even if there happen to be a file called 'branch';
1271                  * it would be extremely annoying.
1272                  */
1273                 if (argc)
1274                         verify_non_filename(opts->prefix, arg);
1275         } else if (opts->accept_pathspec) {
1276                 argcount++;
1277                 argv++;
1278                 argc--;
1279         }
1280
1281         return argcount;
1282 }
1283
1284 static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
1285 {
1286         int status;
1287         struct strbuf branch_ref = STRBUF_INIT;
1288
1289         trace2_cmd_mode("unborn");
1290
1291         if (!opts->new_branch)
1292                 die(_("You are on a branch yet to be born"));
1293         strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
1294         status = create_symref("HEAD", branch_ref.buf, "checkout -b");
1295         strbuf_release(&branch_ref);
1296         if (!opts->quiet)
1297                 fprintf(stderr, _("Switched to a new branch '%s'\n"),
1298                         opts->new_branch);
1299         return status;
1300 }
1301
1302 static void die_expecting_a_branch(const struct branch_info *branch_info)
1303 {
1304         struct object_id oid;
1305         char *to_free;
1306
1307         if (dwim_ref(branch_info->name, strlen(branch_info->name), &oid, &to_free) == 1) {
1308                 const char *ref = to_free;
1309
1310                 if (skip_prefix(ref, "refs/tags/", &ref))
1311                         die(_("a branch is expected, got tag '%s'"), ref);
1312                 if (skip_prefix(ref, "refs/remotes/", &ref))
1313                         die(_("a branch is expected, got remote branch '%s'"), ref);
1314                 die(_("a branch is expected, got '%s'"), ref);
1315         }
1316         if (branch_info->commit)
1317                 die(_("a branch is expected, got commit '%s'"), branch_info->name);
1318         /*
1319          * This case should never happen because we already die() on
1320          * non-commit, but just in case.
1321          */
1322         die(_("a branch is expected, got '%s'"), branch_info->name);
1323 }
1324
1325 static void die_if_some_operation_in_progress(void)
1326 {
1327         struct wt_status_state state;
1328
1329         memset(&state, 0, sizeof(state));
1330         wt_status_get_state(the_repository, &state, 0);
1331
1332         if (state.merge_in_progress)
1333                 die(_("cannot switch branch while merging\n"
1334                       "Consider \"git merge --quit\" "
1335                       "or \"git worktree add\"."));
1336         if (state.am_in_progress)
1337                 die(_("cannot switch branch in the middle of an am session\n"
1338                       "Consider \"git am --quit\" "
1339                       "or \"git worktree add\"."));
1340         if (state.rebase_interactive_in_progress || state.rebase_in_progress)
1341                 die(_("cannot switch branch while rebasing\n"
1342                       "Consider \"git rebase --quit\" "
1343                       "or \"git worktree add\"."));
1344         if (state.cherry_pick_in_progress)
1345                 die(_("cannot switch branch while cherry-picking\n"
1346                       "Consider \"git cherry-pick --quit\" "
1347                       "or \"git worktree add\"."));
1348         if (state.revert_in_progress)
1349                 die(_("cannot switch branch while reverting\n"
1350                       "Consider \"git revert --quit\" "
1351                       "or \"git worktree add\"."));
1352         if (state.bisect_in_progress)
1353                 warning(_("you are switching branch while bisecting"));
1354 }
1355
1356 static int checkout_branch(struct checkout_opts *opts,
1357                            struct branch_info *new_branch_info)
1358 {
1359         if (opts->pathspec.nr)
1360                 die(_("paths cannot be used with switching branches"));
1361
1362         if (opts->patch_mode)
1363                 die(_("'%s' cannot be used with switching branches"),
1364                     "--patch");
1365
1366         if (opts->overlay_mode != -1)
1367                 die(_("'%s' cannot be used with switching branches"),
1368                     "--[no]-overlay");
1369
1370         if (opts->writeout_stage)
1371                 die(_("'%s' cannot be used with switching branches"),
1372                     "--ours/--theirs");
1373
1374         if (opts->force && opts->merge)
1375                 die(_("'%s' cannot be used with '%s'"), "-f", "-m");
1376
1377         if (opts->discard_changes && opts->merge)
1378                 die(_("'%s' cannot be used with '%s'"), "--discard-changes", "--merge");
1379
1380         if (opts->force_detach && opts->new_branch)
1381                 die(_("'%s' cannot be used with '%s'"),
1382                     "--detach", "-b/-B/--orphan");
1383
1384         if (opts->new_orphan_branch) {
1385                 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1386                         die(_("'%s' cannot be used with '%s'"), "--orphan", "-t");
1387                 if (opts->orphan_from_empty_tree && new_branch_info->name)
1388                         die(_("'%s' cannot take <start-point>"), "--orphan");
1389         } else if (opts->force_detach) {
1390                 if (opts->track != BRANCH_TRACK_UNSPECIFIED)
1391                         die(_("'%s' cannot be used with '%s'"), "--detach", "-t");
1392         } else if (opts->track == BRANCH_TRACK_UNSPECIFIED)
1393                 opts->track = git_branch_track;
1394
1395         if (new_branch_info->name && !new_branch_info->commit)
1396                 die(_("Cannot switch branch to a non-commit '%s'"),
1397                     new_branch_info->name);
1398
1399         if (!opts->switch_branch_doing_nothing_is_ok &&
1400             !new_branch_info->name &&
1401             !opts->new_branch &&
1402             !opts->force_detach)
1403                 die(_("missing branch or commit argument"));
1404
1405         if (!opts->implicit_detach &&
1406             !opts->force_detach &&
1407             !opts->new_branch &&
1408             !opts->new_branch_force &&
1409             new_branch_info->name &&
1410             !new_branch_info->path)
1411                 die_expecting_a_branch(new_branch_info);
1412
1413         if (!opts->can_switch_when_in_progress)
1414                 die_if_some_operation_in_progress();
1415
1416         if (new_branch_info->path && !opts->force_detach && !opts->new_branch &&
1417             !opts->ignore_other_worktrees) {
1418                 int flag;
1419                 char *head_ref = resolve_refdup("HEAD", 0, NULL, &flag);
1420                 if (head_ref &&
1421                     (!(flag & REF_ISSYMREF) || strcmp(head_ref, new_branch_info->path)))
1422                         die_if_checked_out(new_branch_info->path, 1);
1423                 free(head_ref);
1424         }
1425
1426         if (!new_branch_info->commit && opts->new_branch) {
1427                 struct object_id rev;
1428                 int flag;
1429
1430                 if (!read_ref_full("HEAD", 0, &rev, &flag) &&
1431                     (flag & REF_ISSYMREF) && is_null_oid(&rev))
1432                         return switch_unborn_to_new_branch(opts);
1433         }
1434         return switch_branches(opts, new_branch_info);
1435 }
1436
1437 static struct option *add_common_options(struct checkout_opts *opts,
1438                                          struct option *prevopts)
1439 {
1440         struct option options[] = {
1441                 OPT__QUIET(&opts->quiet, N_("suppress progress reporting")),
1442                 { OPTION_CALLBACK, 0, "recurse-submodules", NULL,
1443                             "checkout", "control recursive updating of submodules",
1444                             PARSE_OPT_OPTARG, option_parse_recurse_submodules_worktree_updater },
1445                 OPT_BOOL(0, "progress", &opts->show_progress, N_("force progress reporting")),
1446                 OPT_BOOL('m', "merge", &opts->merge, N_("perform a 3-way merge with the new branch")),
1447                 OPT_STRING(0, "conflict", &opts->conflict_style, N_("style"),
1448                            N_("conflict style (merge or diff3)")),
1449                 OPT_END()
1450         };
1451         struct option *newopts = parse_options_concat(prevopts, options);
1452         free(prevopts);
1453         return newopts;
1454 }
1455
1456 static struct option *add_common_switch_branch_options(
1457         struct checkout_opts *opts, struct option *prevopts)
1458 {
1459         struct option options[] = {
1460                 OPT_BOOL('d', "detach", &opts->force_detach, N_("detach HEAD at named commit")),
1461                 OPT_SET_INT('t', "track",  &opts->track, N_("set upstream info for new branch"),
1462                         BRANCH_TRACK_EXPLICIT),
1463                 OPT__FORCE(&opts->force, N_("force checkout (throw away local modifications)"),
1464                            PARSE_OPT_NOCOMPLETE),
1465                 OPT_STRING(0, "orphan", &opts->new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
1466                 OPT_BOOL_F(0, "overwrite-ignore", &opts->overwrite_ignore,
1467                            N_("update ignored files (default)"),
1468                            PARSE_OPT_NOCOMPLETE),
1469                 OPT_BOOL(0, "ignore-other-worktrees", &opts->ignore_other_worktrees,
1470                          N_("do not check if another worktree is holding the given ref")),
1471                 OPT_END()
1472         };
1473         struct option *newopts = parse_options_concat(prevopts, options);
1474         free(prevopts);
1475         return newopts;
1476 }
1477
1478 static struct option *add_checkout_path_options(struct checkout_opts *opts,
1479                                                 struct option *prevopts)
1480 {
1481         struct option options[] = {
1482                 OPT_SET_INT_F('2', "ours", &opts->writeout_stage,
1483                               N_("checkout our version for unmerged files"),
1484                               2, PARSE_OPT_NONEG),
1485                 OPT_SET_INT_F('3', "theirs", &opts->writeout_stage,
1486                               N_("checkout their version for unmerged files"),
1487                               3, PARSE_OPT_NONEG),
1488                 OPT_BOOL('p', "patch", &opts->patch_mode, N_("select hunks interactively")),
1489                 OPT_BOOL(0, "ignore-skip-worktree-bits", &opts->ignore_skipworktree,
1490                          N_("do not limit pathspecs to sparse entries only")),
1491                 OPT_END()
1492         };
1493         struct option *newopts = parse_options_concat(prevopts, options);
1494         free(prevopts);
1495         return newopts;
1496 }
1497
1498 static int checkout_main(int argc, const char **argv, const char *prefix,
1499                          struct checkout_opts *opts, struct option *options,
1500                          const char * const usagestr[])
1501 {
1502         struct branch_info new_branch_info;
1503         int dwim_remotes_matched = 0;
1504         int parseopt_flags = 0;
1505
1506         memset(&new_branch_info, 0, sizeof(new_branch_info));
1507         opts->overwrite_ignore = 1;
1508         opts->prefix = prefix;
1509         opts->show_progress = -1;
1510
1511         git_config(git_checkout_config, opts);
1512
1513         opts->track = BRANCH_TRACK_UNSPECIFIED;
1514
1515         if (!opts->accept_pathspec && !opts->accept_ref)
1516                 BUG("make up your mind, you need to take _something_");
1517         if (opts->accept_pathspec && opts->accept_ref)
1518                 parseopt_flags = PARSE_OPT_KEEP_DASHDASH;
1519
1520         argc = parse_options(argc, argv, prefix, options,
1521                              usagestr, parseopt_flags);
1522
1523         if (opts->show_progress < 0) {
1524                 if (opts->quiet)
1525                         opts->show_progress = 0;
1526                 else
1527                         opts->show_progress = isatty(2);
1528         }
1529
1530         if (opts->conflict_style) {
1531                 opts->merge = 1; /* implied */
1532                 git_xmerge_config("merge.conflictstyle", opts->conflict_style, NULL);
1533         }
1534         if (opts->force) {
1535                 opts->discard_changes = 1;
1536                 opts->ignore_unmerged_opt = "--force";
1537                 opts->ignore_unmerged = 1;
1538         }
1539
1540         if ((!!opts->new_branch + !!opts->new_branch_force + !!opts->new_orphan_branch) > 1)
1541                 die(_("-b, -B and --orphan are mutually exclusive"));
1542
1543         if (opts->overlay_mode == 1 && opts->patch_mode)
1544                 die(_("-p and --overlay are mutually exclusive"));
1545
1546         if (opts->checkout_index >= 0 || opts->checkout_worktree >= 0) {
1547                 if (opts->checkout_index < 0)
1548                         opts->checkout_index = 0;
1549                 if (opts->checkout_worktree < 0)
1550                         opts->checkout_worktree = 0;
1551         } else {
1552                 if (opts->checkout_index < 0)
1553                         opts->checkout_index = -opts->checkout_index - 1;
1554                 if (opts->checkout_worktree < 0)
1555                         opts->checkout_worktree = -opts->checkout_worktree - 1;
1556         }
1557         if (opts->checkout_index < 0 || opts->checkout_worktree < 0)
1558                 BUG("these flags should be non-negative by now");
1559         /*
1560          * convenient shortcut: "git restore --staged" equals
1561          * "git restore --staged --source HEAD"
1562          */
1563         if (!opts->from_treeish && opts->checkout_index && !opts->checkout_worktree)
1564                 opts->from_treeish = "HEAD";
1565
1566         /*
1567          * From here on, new_branch will contain the branch to be checked out,
1568          * and new_branch_force and new_orphan_branch will tell us which one of
1569          * -b/-B/--orphan is being used.
1570          */
1571         if (opts->new_branch_force)
1572                 opts->new_branch = opts->new_branch_force;
1573
1574         if (opts->new_orphan_branch)
1575                 opts->new_branch = opts->new_orphan_branch;
1576
1577         /* --track without -b/-B/--orphan should DWIM */
1578         if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch) {
1579                 const char *argv0 = argv[0];
1580                 if (!argc || !strcmp(argv0, "--"))
1581                         die(_("--track needs a branch name"));
1582                 skip_prefix(argv0, "refs/", &argv0);
1583                 skip_prefix(argv0, "remotes/", &argv0);
1584                 argv0 = strchr(argv0, '/');
1585                 if (!argv0 || !argv0[1])
1586                         die(_("missing branch name; try -b"));
1587                 opts->new_branch = argv0 + 1;
1588         }
1589
1590         /*
1591          * Extract branch name from command line arguments, so
1592          * all that is left is pathspecs.
1593          *
1594          * Handle
1595          *
1596          *  1) git checkout <tree> -- [<paths>]
1597          *  2) git checkout -- [<paths>]
1598          *  3) git checkout <something> [<paths>]
1599          *
1600          * including "last branch" syntax and DWIM-ery for names of
1601          * remote branches, erroring out for invalid or ambiguous cases.
1602          */
1603         if (argc && opts->accept_ref) {
1604                 struct object_id rev;
1605                 int dwim_ok =
1606                         !opts->patch_mode &&
1607                         opts->dwim_new_local_branch &&
1608                         opts->track == BRANCH_TRACK_UNSPECIFIED &&
1609                         !opts->new_branch;
1610                 int n = parse_branchname_arg(argc, argv, dwim_ok,
1611                                              &new_branch_info, opts, &rev,
1612                                              &dwim_remotes_matched);
1613                 argv += n;
1614                 argc -= n;
1615         } else if (!opts->accept_ref && opts->from_treeish) {
1616                 struct object_id rev;
1617
1618                 if (get_oid_mb(opts->from_treeish, &rev))
1619                         die(_("could not resolve %s"), opts->from_treeish);
1620
1621                 setup_new_branch_info_and_source_tree(&new_branch_info,
1622                                                       opts, &rev,
1623                                                       opts->from_treeish);
1624
1625                 if (!opts->source_tree)
1626                         die(_("reference is not a tree: %s"), opts->from_treeish);
1627         }
1628
1629         if (opts->accept_pathspec && !opts->empty_pathspec_ok && !argc &&
1630             !opts->patch_mode)  /* patch mode is special */
1631                 die(_("you must specify path(s) to restore"));
1632
1633         if (argc) {
1634                 parse_pathspec(&opts->pathspec, 0,
1635                                opts->patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
1636                                prefix, argv);
1637
1638                 if (!opts->pathspec.nr)
1639                         die(_("invalid path specification"));
1640
1641                 /*
1642                  * Try to give more helpful suggestion.
1643                  * new_branch && argc > 1 will be caught later.
1644                  */
1645                 if (opts->new_branch && argc == 1)
1646                         die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
1647                                 argv[0], opts->new_branch);
1648
1649                 if (opts->force_detach)
1650                         die(_("git checkout: --detach does not take a path argument '%s'"),
1651                             argv[0]);
1652
1653                 if (1 < !!opts->writeout_stage + !!opts->force + !!opts->merge)
1654                         die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\n"
1655                               "checking out of the index."));
1656         }
1657
1658         if (opts->new_branch) {
1659                 struct strbuf buf = STRBUF_INIT;
1660
1661                 if (opts->new_branch_force)
1662                         opts->branch_exists = validate_branchname(opts->new_branch, &buf);
1663                 else
1664                         opts->branch_exists =
1665                                 validate_new_branchname(opts->new_branch, &buf, 0);
1666                 strbuf_release(&buf);
1667         }
1668
1669         UNLEAK(opts);
1670         if (opts->patch_mode || opts->pathspec.nr) {
1671                 int ret = checkout_paths(opts, new_branch_info.name);
1672                 if (ret && dwim_remotes_matched > 1 &&
1673                     advice_checkout_ambiguous_remote_branch_name)
1674                         advise(_("'%s' matched more than one remote tracking branch.\n"
1675                                  "We found %d remotes with a reference that matched. So we fell back\n"
1676                                  "on trying to resolve the argument as a path, but failed there too!\n"
1677                                  "\n"
1678                                  "If you meant to check out a remote tracking branch on, e.g. 'origin',\n"
1679                                  "you can do so by fully qualifying the name with the --track option:\n"
1680                                  "\n"
1681                                  "    git checkout --track origin/<name>\n"
1682                                  "\n"
1683                                  "If you'd like to always have checkouts of an ambiguous <name> prefer\n"
1684                                  "one remote, e.g. the 'origin' remote, consider setting\n"
1685                                  "checkout.defaultRemote=origin in your config."),
1686                                argv[0],
1687                                dwim_remotes_matched);
1688                 return ret;
1689         } else {
1690                 return checkout_branch(opts, &new_branch_info);
1691         }
1692 }
1693
1694 int cmd_checkout(int argc, const char **argv, const char *prefix)
1695 {
1696         struct checkout_opts opts;
1697         struct option *options;
1698         struct option checkout_options[] = {
1699                 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
1700                            N_("create and checkout a new branch")),
1701                 OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
1702                            N_("create/reset and checkout a branch")),
1703                 OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
1704                 OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
1705                          N_("second guess 'git checkout <no-such-branch>' (default)")),
1706                 OPT_BOOL(0, "overlay", &opts.overlay_mode, N_("use overlay mode (default)")),
1707                 OPT_END()
1708         };
1709         int ret;
1710
1711         memset(&opts, 0, sizeof(opts));
1712         opts.dwim_new_local_branch = 1;
1713         opts.switch_branch_doing_nothing_is_ok = 1;
1714         opts.only_merge_on_switching_branches = 0;
1715         opts.accept_ref = 1;
1716         opts.accept_pathspec = 1;
1717         opts.implicit_detach = 1;
1718         opts.can_switch_when_in_progress = 1;
1719         opts.orphan_from_empty_tree = 0;
1720         opts.empty_pathspec_ok = 1;
1721         opts.overlay_mode = -1;
1722         opts.checkout_index = -2;    /* default on */
1723         opts.checkout_worktree = -2; /* default on */
1724
1725         options = parse_options_dup(checkout_options);
1726         options = add_common_options(&opts, options);
1727         options = add_common_switch_branch_options(&opts, options);
1728         options = add_checkout_path_options(&opts, options);
1729
1730         ret = checkout_main(argc, argv, prefix, &opts,
1731                             options, checkout_usage);
1732         FREE_AND_NULL(options);
1733         return ret;
1734 }
1735
1736 int cmd_switch(int argc, const char **argv, const char *prefix)
1737 {
1738         struct checkout_opts opts;
1739         struct option *options = NULL;
1740         struct option switch_options[] = {
1741                 OPT_STRING('c', "create", &opts.new_branch, N_("branch"),
1742                            N_("create and switch to a new branch")),
1743                 OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"),
1744                            N_("create/reset and switch to a branch")),
1745                 OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
1746                          N_("second guess 'git switch <no-such-branch>'")),
1747                 OPT_BOOL(0, "discard-changes", &opts.discard_changes,
1748                          N_("throw away local modifications")),
1749                 OPT_END()
1750         };
1751         int ret;
1752
1753         memset(&opts, 0, sizeof(opts));
1754         opts.dwim_new_local_branch = 1;
1755         opts.accept_ref = 1;
1756         opts.accept_pathspec = 0;
1757         opts.switch_branch_doing_nothing_is_ok = 0;
1758         opts.only_merge_on_switching_branches = 1;
1759         opts.implicit_detach = 0;
1760         opts.can_switch_when_in_progress = 0;
1761         opts.orphan_from_empty_tree = 1;
1762         opts.overlay_mode = -1;
1763
1764         options = parse_options_dup(switch_options);
1765         options = add_common_options(&opts, options);
1766         options = add_common_switch_branch_options(&opts, options);
1767
1768         ret = checkout_main(argc, argv, prefix, &opts,
1769                             options, switch_branch_usage);
1770         FREE_AND_NULL(options);
1771         return ret;
1772 }
1773
1774 int cmd_restore(int argc, const char **argv, const char *prefix)
1775 {
1776         struct checkout_opts opts;
1777         struct option *options;
1778         struct option restore_options[] = {
1779                 OPT_STRING('s', "source", &opts.from_treeish, "<tree-ish>",
1780                            N_("which tree-ish to checkout from")),
1781                 OPT_BOOL('S', "staged", &opts.checkout_index,
1782                            N_("restore the index")),
1783                 OPT_BOOL('W', "worktree", &opts.checkout_worktree,
1784                            N_("restore the working tree (default)")),
1785                 OPT_BOOL(0, "ignore-unmerged", &opts.ignore_unmerged,
1786                          N_("ignore unmerged entries")),
1787                 OPT_BOOL(0, "overlay", &opts.overlay_mode, N_("use overlay mode")),
1788                 OPT_END()
1789         };
1790         int ret;
1791
1792         memset(&opts, 0, sizeof(opts));
1793         opts.accept_ref = 0;
1794         opts.accept_pathspec = 1;
1795         opts.empty_pathspec_ok = 0;
1796         opts.overlay_mode = 0;
1797         opts.checkout_index = -1;    /* default off */
1798         opts.checkout_worktree = -2; /* default on */
1799         opts.ignore_unmerged_opt = "--ignore-unmerged";
1800
1801         options = parse_options_dup(restore_options);
1802         options = add_common_options(&opts, options);
1803         options = add_checkout_path_options(&opts, options);
1804
1805         ret = checkout_main(argc, argv, prefix, &opts,
1806                             options, restore_usage);
1807         FREE_AND_NULL(options);
1808         return ret;
1809 }