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