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