builtin / branch.con commit sequencer: fix cleanup with --signoff and -x (d74f3e5)
   1/*
   2 * Builtin "git branch"
   3 *
   4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
   5 * Based on git-branch.sh by Junio C Hamano.
   6 */
   7
   8#include "cache.h"
   9#include "config.h"
  10#include "color.h"
  11#include "refs.h"
  12#include "commit.h"
  13#include "builtin.h"
  14#include "remote.h"
  15#include "parse-options.h"
  16#include "branch.h"
  17#include "diff.h"
  18#include "revision.h"
  19#include "string-list.h"
  20#include "column.h"
  21#include "utf8.h"
  22#include "wt-status.h"
  23#include "ref-filter.h"
  24#include "worktree.h"
  25#include "help.h"
  26#include "commit-reach.h"
  27
  28static const char * const builtin_branch_usage[] = {
  29        N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
  30        N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
  31        N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
  32        N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
  33        N_("git branch [<options>] (-c | -C) [<old-branch>] <new-branch>"),
  34        N_("git branch [<options>] [-r | -a] [--points-at]"),
  35        N_("git branch [<options>] [-r | -a] [--format]"),
  36        NULL
  37};
  38
  39static const char *head;
  40static struct object_id head_oid;
  41
  42static int branch_use_color = -1;
  43static char branch_colors[][COLOR_MAXLEN] = {
  44        GIT_COLOR_RESET,
  45        GIT_COLOR_NORMAL,       /* PLAIN */
  46        GIT_COLOR_RED,          /* REMOTE */
  47        GIT_COLOR_NORMAL,       /* LOCAL */
  48        GIT_COLOR_GREEN,        /* CURRENT */
  49        GIT_COLOR_BLUE,         /* UPSTREAM */
  50};
  51enum color_branch {
  52        BRANCH_COLOR_RESET = 0,
  53        BRANCH_COLOR_PLAIN = 1,
  54        BRANCH_COLOR_REMOTE = 2,
  55        BRANCH_COLOR_LOCAL = 3,
  56        BRANCH_COLOR_CURRENT = 4,
  57        BRANCH_COLOR_UPSTREAM = 5
  58};
  59
  60static const char *color_branch_slots[] = {
  61        [BRANCH_COLOR_RESET]    = "reset",
  62        [BRANCH_COLOR_PLAIN]    = "plain",
  63        [BRANCH_COLOR_REMOTE]   = "remote",
  64        [BRANCH_COLOR_LOCAL]    = "local",
  65        [BRANCH_COLOR_CURRENT]  = "current",
  66        [BRANCH_COLOR_UPSTREAM] = "upstream",
  67};
  68
  69static struct string_list output = STRING_LIST_INIT_DUP;
  70static unsigned int colopts;
  71
  72define_list_config_array(color_branch_slots);
  73
  74static int git_branch_config(const char *var, const char *value, void *cb)
  75{
  76        const char *slot_name;
  77        struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
  78
  79        if (!strcmp(var, "branch.sort")) {
  80                if (!value)
  81                        return config_error_nonbool(var);
  82                parse_ref_sorting(sorting_tail, value);
  83                return 0;
  84        }
  85
  86        if (starts_with(var, "column."))
  87                return git_column_config(var, value, "branch", &colopts);
  88        if (!strcmp(var, "color.branch")) {
  89                branch_use_color = git_config_colorbool(var, value);
  90                return 0;
  91        }
  92        if (skip_prefix(var, "color.branch.", &slot_name)) {
  93                int slot = LOOKUP_CONFIG(color_branch_slots, slot_name);
  94                if (slot < 0)
  95                        return 0;
  96                if (!value)
  97                        return config_error_nonbool(var);
  98                return color_parse(value, branch_colors[slot]);
  99        }
 100        return git_color_default_config(var, value, cb);
 101}
 102
 103static const char *branch_get_color(enum color_branch ix)
 104{
 105        if (want_color(branch_use_color))
 106                return branch_colors[ix];
 107        return "";
 108}
 109
 110static int branch_merged(int kind, const char *name,
 111                         struct commit *rev, struct commit *head_rev)
 112{
 113        /*
 114         * This checks whether the merge bases of branch and HEAD (or
 115         * the other branch this branch builds upon) contains the
 116         * branch, which means that the branch has already been merged
 117         * safely to HEAD (or the other branch).
 118         */
 119        struct commit *reference_rev = NULL;
 120        const char *reference_name = NULL;
 121        void *reference_name_to_free = NULL;
 122        int merged;
 123
 124        if (kind == FILTER_REFS_BRANCHES) {
 125                struct branch *branch = branch_get(name);
 126                const char *upstream = branch_get_upstream(branch, NULL);
 127                struct object_id oid;
 128
 129                if (upstream &&
 130                    (reference_name = reference_name_to_free =
 131                     resolve_refdup(upstream, RESOLVE_REF_READING,
 132                                    &oid, NULL)) != NULL)
 133                        reference_rev = lookup_commit_reference(the_repository,
 134                                                                &oid);
 135        }
 136        if (!reference_rev)
 137                reference_rev = head_rev;
 138
 139        merged = in_merge_bases(rev, reference_rev);
 140
 141        /*
 142         * After the safety valve is fully redefined to "check with
 143         * upstream, if any, otherwise with HEAD", we should just
 144         * return the result of the in_merge_bases() above without
 145         * any of the following code, but during the transition period,
 146         * a gentle reminder is in order.
 147         */
 148        if ((head_rev != reference_rev) &&
 149            in_merge_bases(rev, head_rev) != merged) {
 150                if (merged)
 151                        warning(_("deleting branch '%s' that has been merged to\n"
 152                                "         '%s', but not yet merged to HEAD."),
 153                                name, reference_name);
 154                else
 155                        warning(_("not deleting branch '%s' that is not yet merged to\n"
 156                                "         '%s', even though it is merged to HEAD."),
 157                                name, reference_name);
 158        }
 159        free(reference_name_to_free);
 160        return merged;
 161}
 162
 163static int check_branch_commit(const char *branchname, const char *refname,
 164                               const struct object_id *oid, struct commit *head_rev,
 165                               int kinds, int force)
 166{
 167        struct commit *rev = lookup_commit_reference(the_repository, oid);
 168        if (!rev) {
 169                error(_("Couldn't look up commit object for '%s'"), refname);
 170                return -1;
 171        }
 172        if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
 173                error(_("The branch '%s' is not fully merged.\n"
 174                      "If you are sure you want to delete it, "
 175                      "run 'git branch -D %s'."), branchname, branchname);
 176                return -1;
 177        }
 178        return 0;
 179}
 180
 181static void delete_branch_config(const char *branchname)
 182{
 183        struct strbuf buf = STRBUF_INIT;
 184        strbuf_addf(&buf, "branch.%s", branchname);
 185        if (git_config_rename_section(buf.buf, NULL) < 0)
 186                warning(_("Update of config-file failed"));
 187        strbuf_release(&buf);
 188}
 189
 190static int delete_branches(int argc, const char **argv, int force, int kinds,
 191                           int quiet)
 192{
 193        struct commit *head_rev = NULL;
 194        struct object_id oid;
 195        char *name = NULL;
 196        const char *fmt;
 197        int i;
 198        int ret = 0;
 199        int remote_branch = 0;
 200        struct strbuf bname = STRBUF_INIT;
 201        unsigned allowed_interpret;
 202
 203        switch (kinds) {
 204        case FILTER_REFS_REMOTES:
 205                fmt = "refs/remotes/%s";
 206                /* For subsequent UI messages */
 207                remote_branch = 1;
 208                allowed_interpret = INTERPRET_BRANCH_REMOTE;
 209
 210                force = 1;
 211                break;
 212        case FILTER_REFS_BRANCHES:
 213                fmt = "refs/heads/%s";
 214                allowed_interpret = INTERPRET_BRANCH_LOCAL;
 215                break;
 216        default:
 217                die(_("cannot use -a with -d"));
 218        }
 219
 220        if (!force) {
 221                head_rev = lookup_commit_reference(the_repository, &head_oid);
 222                if (!head_rev)
 223                        die(_("Couldn't look up commit object for HEAD"));
 224        }
 225        for (i = 0; i < argc; i++, strbuf_reset(&bname)) {
 226                char *target = NULL;
 227                int flags = 0;
 228
 229                strbuf_branchname(&bname, argv[i], allowed_interpret);
 230                free(name);
 231                name = mkpathdup(fmt, bname.buf);
 232
 233                if (kinds == FILTER_REFS_BRANCHES) {
 234                        const struct worktree *wt =
 235                                find_shared_symref("HEAD", name);
 236                        if (wt) {
 237                                error(_("Cannot delete branch '%s' "
 238                                        "checked out at '%s'"),
 239                                      bname.buf, wt->path);
 240                                ret = 1;
 241                                continue;
 242                        }
 243                }
 244
 245                target = resolve_refdup(name,
 246                                        RESOLVE_REF_READING
 247                                        | RESOLVE_REF_NO_RECURSE
 248                                        | RESOLVE_REF_ALLOW_BAD_NAME,
 249                                        &oid, &flags);
 250                if (!target) {
 251                        error(remote_branch
 252                              ? _("remote-tracking branch '%s' not found.")
 253                              : _("branch '%s' not found."), bname.buf);
 254                        ret = 1;
 255                        continue;
 256                }
 257
 258                if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
 259                    check_branch_commit(bname.buf, name, &oid, head_rev, kinds,
 260                                        force)) {
 261                        ret = 1;
 262                        goto next;
 263                }
 264
 265                if (delete_ref(NULL, name, is_null_oid(&oid) ? NULL : &oid,
 266                               REF_NO_DEREF)) {
 267                        error(remote_branch
 268                              ? _("Error deleting remote-tracking branch '%s'")
 269                              : _("Error deleting branch '%s'"),
 270                              bname.buf);
 271                        ret = 1;
 272                        goto next;
 273                }
 274                if (!quiet) {
 275                        printf(remote_branch
 276                               ? _("Deleted remote-tracking branch %s (was %s).\n")
 277                               : _("Deleted branch %s (was %s).\n"),
 278                               bname.buf,
 279                               (flags & REF_ISBROKEN) ? "broken"
 280                               : (flags & REF_ISSYMREF) ? target
 281                               : find_unique_abbrev(&oid, DEFAULT_ABBREV));
 282                }
 283                delete_branch_config(bname.buf);
 284
 285        next:
 286                free(target);
 287        }
 288
 289        free(name);
 290        strbuf_release(&bname);
 291
 292        return ret;
 293}
 294
 295static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
 296{
 297        int i, max = 0;
 298        for (i = 0; i < refs->nr; i++) {
 299                struct ref_array_item *it = refs->items[i];
 300                const char *desc = it->refname;
 301                int w;
 302
 303                skip_prefix(it->refname, "refs/heads/", &desc);
 304                skip_prefix(it->refname, "refs/remotes/", &desc);
 305                if (it->kind == FILTER_REFS_DETACHED_HEAD) {
 306                        char *head_desc = get_head_description();
 307                        w = utf8_strwidth(head_desc);
 308                        free(head_desc);
 309                } else
 310                        w = utf8_strwidth(desc);
 311
 312                if (it->kind == FILTER_REFS_REMOTES)
 313                        w += remote_bonus;
 314                if (w > max)
 315                        max = w;
 316        }
 317        return max;
 318}
 319
 320static const char *quote_literal_for_format(const char *s)
 321{
 322        static struct strbuf buf = STRBUF_INIT;
 323
 324        strbuf_reset(&buf);
 325        while (*s) {
 326                const char *ep = strchrnul(s, '%');
 327                if (s < ep)
 328                        strbuf_add(&buf, s, ep - s);
 329                if (*ep == '%') {
 330                        strbuf_addstr(&buf, "%%");
 331                        s = ep + 1;
 332                } else {
 333                        s = ep;
 334                }
 335        }
 336        return buf.buf;
 337}
 338
 339static char *build_format(struct ref_filter *filter, int maxwidth, const char *remote_prefix)
 340{
 341        struct strbuf fmt = STRBUF_INIT;
 342        struct strbuf local = STRBUF_INIT;
 343        struct strbuf remote = STRBUF_INIT;
 344
 345        strbuf_addf(&local, "%%(if)%%(HEAD)%%(then)* %s%%(else)  %s%%(end)",
 346                    branch_get_color(BRANCH_COLOR_CURRENT),
 347                    branch_get_color(BRANCH_COLOR_LOCAL));
 348        strbuf_addf(&remote, "  %s",
 349                    branch_get_color(BRANCH_COLOR_REMOTE));
 350
 351        if (filter->verbose) {
 352                struct strbuf obname = STRBUF_INIT;
 353
 354                if (filter->abbrev < 0)
 355                        strbuf_addf(&obname, "%%(objectname:short)");
 356                else if (!filter->abbrev)
 357                        strbuf_addf(&obname, "%%(objectname)");
 358                else
 359                        strbuf_addf(&obname, "%%(objectname:short=%d)", filter->abbrev);
 360
 361                strbuf_addf(&local, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth);
 362                strbuf_addstr(&local, branch_get_color(BRANCH_COLOR_RESET));
 363                strbuf_addf(&local, " %s ", obname.buf);
 364
 365                if (filter->verbose > 1)
 366                        strbuf_addf(&local, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
 367                                    "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
 368                                    branch_get_color(BRANCH_COLOR_UPSTREAM), branch_get_color(BRANCH_COLOR_RESET));
 369                else
 370                        strbuf_addf(&local, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
 371
 372                strbuf_addf(&remote, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
 373                            "%%(if)%%(symref)%%(then) -> %%(symref:short)"
 374                            "%%(else) %s %%(contents:subject)%%(end)",
 375                            maxwidth, quote_literal_for_format(remote_prefix),
 376                            branch_get_color(BRANCH_COLOR_RESET), obname.buf);
 377                strbuf_release(&obname);
 378        } else {
 379                strbuf_addf(&local, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
 380                            branch_get_color(BRANCH_COLOR_RESET));
 381                strbuf_addf(&remote, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
 382                            quote_literal_for_format(remote_prefix),
 383                            branch_get_color(BRANCH_COLOR_RESET));
 384        }
 385
 386        strbuf_addf(&fmt, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local.buf, remote.buf);
 387
 388        strbuf_release(&local);
 389        strbuf_release(&remote);
 390        return strbuf_detach(&fmt, NULL);
 391}
 392
 393static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting, struct ref_format *format)
 394{
 395        int i;
 396        struct ref_array array;
 397        int maxwidth = 0;
 398        const char *remote_prefix = "";
 399        char *to_free = NULL;
 400
 401        /*
 402         * If we are listing more than just remote branches,
 403         * then remote branches will have a "remotes/" prefix.
 404         * We need to account for this in the width.
 405         */
 406        if (filter->kind != FILTER_REFS_REMOTES)
 407                remote_prefix = "remotes/";
 408
 409        memset(&array, 0, sizeof(array));
 410
 411        filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
 412
 413        if (filter->verbose)
 414                maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
 415
 416        if (!format->format)
 417                format->format = to_free = build_format(filter, maxwidth, remote_prefix);
 418        format->use_color = branch_use_color;
 419
 420        if (verify_ref_format(format))
 421                die(_("unable to parse format string"));
 422
 423        ref_array_sort(sorting, &array);
 424
 425        for (i = 0; i < array.nr; i++) {
 426                struct strbuf out = STRBUF_INIT;
 427                struct strbuf err = STRBUF_INIT;
 428                if (format_ref_array_item(array.items[i], format, &out, &err))
 429                        die("%s", err.buf);
 430                if (column_active(colopts)) {
 431                        assert(!filter->verbose && "--column and --verbose are incompatible");
 432                         /* format to a string_list to let print_columns() do its job */
 433                        string_list_append(&output, out.buf);
 434                } else {
 435                        fwrite(out.buf, 1, out.len, stdout);
 436                        putchar('\n');
 437                }
 438                strbuf_release(&err);
 439                strbuf_release(&out);
 440        }
 441
 442        ref_array_clear(&array);
 443        free(to_free);
 444}
 445
 446static void print_current_branch_name(void)
 447{
 448        int flags;
 449        const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
 450        const char *shortname;
 451        if (!refname)
 452                die(_("could not resolve HEAD"));
 453        else if (!(flags & REF_ISSYMREF))
 454                return;
 455        else if (skip_prefix(refname, "refs/heads/", &shortname))
 456                puts(shortname);
 457        else
 458                die(_("HEAD (%s) points outside of refs/heads/"), refname);
 459}
 460
 461static void reject_rebase_or_bisect_branch(const char *target)
 462{
 463        struct worktree **worktrees = get_worktrees(0);
 464        int i;
 465
 466        for (i = 0; worktrees[i]; i++) {
 467                struct worktree *wt = worktrees[i];
 468
 469                if (!wt->is_detached)
 470                        continue;
 471
 472                if (is_worktree_being_rebased(wt, target))
 473                        die(_("Branch %s is being rebased at %s"),
 474                            target, wt->path);
 475
 476                if (is_worktree_being_bisected(wt, target))
 477                        die(_("Branch %s is being bisected at %s"),
 478                            target, wt->path);
 479        }
 480
 481        free_worktrees(worktrees);
 482}
 483
 484static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
 485{
 486        struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 487        struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 488        const char *interpreted_oldname = NULL;
 489        const char *interpreted_newname = NULL;
 490        int recovery = 0;
 491
 492        if (!oldname) {
 493                if (copy)
 494                        die(_("cannot copy the current branch while not on any."));
 495                else
 496                        die(_("cannot rename the current branch while not on any."));
 497        }
 498
 499        if (strbuf_check_branch_ref(&oldref, oldname)) {
 500                /*
 501                 * Bad name --- this could be an attempt to rename a
 502                 * ref that we used to allow to be created by accident.
 503                 */
 504                if (ref_exists(oldref.buf))
 505                        recovery = 1;
 506                else
 507                        die(_("Invalid branch name: '%s'"), oldname);
 508        }
 509
 510        /*
 511         * A command like "git branch -M currentbranch currentbranch" cannot
 512         * cause the worktree to become inconsistent with HEAD, so allow it.
 513         */
 514        if (!strcmp(oldname, newname))
 515                validate_branchname(newname, &newref);
 516        else
 517                validate_new_branchname(newname, &newref, force);
 518
 519        reject_rebase_or_bisect_branch(oldref.buf);
 520
 521        if (!skip_prefix(oldref.buf, "refs/heads/", &interpreted_oldname) ||
 522            !skip_prefix(newref.buf, "refs/heads/", &interpreted_newname)) {
 523                BUG("expected prefix missing for refs");
 524        }
 525
 526        if (copy)
 527                strbuf_addf(&logmsg, "Branch: copied %s to %s",
 528                            oldref.buf, newref.buf);
 529        else
 530                strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 531                            oldref.buf, newref.buf);
 532
 533        if (!copy && rename_ref(oldref.buf, newref.buf, logmsg.buf))
 534                die(_("Branch rename failed"));
 535        if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
 536                die(_("Branch copy failed"));
 537
 538        if (recovery) {
 539                if (copy)
 540                        warning(_("Created a copy of a misnamed branch '%s'"),
 541                                interpreted_oldname);
 542                else
 543                        warning(_("Renamed a misnamed branch '%s' away"),
 544                                interpreted_oldname);
 545        }
 546
 547        if (!copy &&
 548            replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
 549                die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 550
 551        strbuf_release(&logmsg);
 552
 553        strbuf_addf(&oldsection, "branch.%s", interpreted_oldname);
 554        strbuf_release(&oldref);
 555        strbuf_addf(&newsection, "branch.%s", interpreted_newname);
 556        strbuf_release(&newref);
 557        if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 558                die(_("Branch is renamed, but update of config-file failed"));
 559        if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
 560                die(_("Branch is copied, but update of config-file failed"));
 561        strbuf_release(&oldsection);
 562        strbuf_release(&newsection);
 563}
 564
 565static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
 566
 567static int edit_branch_description(const char *branch_name)
 568{
 569        struct strbuf buf = STRBUF_INIT;
 570        struct strbuf name = STRBUF_INIT;
 571
 572        read_branch_desc(&buf, branch_name);
 573        if (!buf.len || buf.buf[buf.len-1] != '\n')
 574                strbuf_addch(&buf, '\n');
 575        strbuf_commented_addf(&buf,
 576                    _("Please edit the description for the branch\n"
 577                      "  %s\n"
 578                      "Lines starting with '%c' will be stripped.\n"),
 579                    branch_name, comment_line_char);
 580        write_file_buf(edit_description(), buf.buf, buf.len);
 581        strbuf_reset(&buf);
 582        if (launch_editor(edit_description(), &buf, NULL)) {
 583                strbuf_release(&buf);
 584                return -1;
 585        }
 586        strbuf_stripspace(&buf, 1);
 587
 588        strbuf_addf(&name, "branch.%s.description", branch_name);
 589        git_config_set(name.buf, buf.len ? buf.buf : NULL);
 590        strbuf_release(&name);
 591        strbuf_release(&buf);
 592
 593        return 0;
 594}
 595
 596int cmd_branch(int argc, const char **argv, const char *prefix)
 597{
 598        int delete = 0, rename = 0, copy = 0, force = 0, list = 0;
 599        int show_current = 0;
 600        int reflog = 0, edit_description = 0;
 601        int quiet = 0, unset_upstream = 0;
 602        const char *new_upstream = NULL;
 603        enum branch_track track;
 604        struct ref_filter filter;
 605        int icase = 0;
 606        static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 607        struct ref_format format = REF_FORMAT_INIT;
 608
 609        struct option options[] = {
 610                OPT_GROUP(N_("Generic options")),
 611                OPT__VERBOSE(&filter.verbose,
 612                        N_("show hash and subject, give twice for upstream branch")),
 613                OPT__QUIET(&quiet, N_("suppress informational messages")),
 614                OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
 615                        BRANCH_TRACK_EXPLICIT),
 616                OPT_SET_INT_F(0, "set-upstream", &track, N_("do not use"),
 617                        BRANCH_TRACK_OVERRIDE, PARSE_OPT_HIDDEN),
 618                OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
 619                OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
 620                OPT__COLOR(&branch_use_color, N_("use colored output")),
 621                OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
 622                        FILTER_REFS_REMOTES),
 623                OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
 624                OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
 625                OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
 626                OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
 627                OPT__ABBREV(&filter.abbrev),
 628
 629                OPT_GROUP(N_("Specific git-branch actions:")),
 630                OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
 631                        FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
 632                OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
 633                OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
 634                OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
 635                OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
 636                OPT_BIT('c', "copy", &copy, N_("copy a branch and its reflog"), 1),
 637                OPT_BIT('C', NULL, &copy, N_("copy a branch, even if target exists"), 2),
 638                OPT_BOOL('l', "list", &list, N_("list branch names")),
 639                OPT_BOOL(0, "show-current", &show_current, N_("show current branch name")),
 640                OPT_BOOL(0, "create-reflog", &reflog, N_("create the branch's reflog")),
 641                OPT_BOOL(0, "edit-description", &edit_description,
 642                         N_("edit the description for the branch")),
 643                OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE),
 644                OPT_MERGED(&filter, N_("print only branches that are merged")),
 645                OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
 646                OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
 647                OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 648                             N_("field name to sort on"), &parse_opt_ref_sorting),
 649                {
 650                        OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 651                        N_("print only branches of the object"), 0, parse_opt_object_name
 652                },
 653                OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
 654                OPT_STRING(  0 , "format", &format.format, N_("format"), N_("format to use for the output")),
 655                OPT_END(),
 656        };
 657
 658        setup_ref_filter_porcelain_msg();
 659
 660        memset(&filter, 0, sizeof(filter));
 661        filter.kind = FILTER_REFS_BRANCHES;
 662        filter.abbrev = -1;
 663
 664        if (argc == 2 && !strcmp(argv[1], "-h"))
 665                usage_with_options(builtin_branch_usage, options);
 666
 667        git_config(git_branch_config, sorting_tail);
 668
 669        track = git_branch_track;
 670
 671        head = resolve_refdup("HEAD", 0, &head_oid, NULL);
 672        if (!head)
 673                die(_("Failed to resolve HEAD as a valid ref."));
 674        if (!strcmp(head, "HEAD"))
 675                filter.detached = 1;
 676        else if (!skip_prefix(head, "refs/heads/", &head))
 677                die(_("HEAD not found below refs/heads!"));
 678
 679        argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 680                             0);
 681
 682        if (!delete && !rename && !copy && !edit_description && !new_upstream &&
 683            !show_current && !unset_upstream && argc == 0)
 684                list = 1;
 685
 686        if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr ||
 687            filter.no_commit)
 688                list = 1;
 689
 690        if (!!delete + !!rename + !!copy + !!new_upstream + !!show_current +
 691            list + unset_upstream > 1)
 692                usage_with_options(builtin_branch_usage, options);
 693
 694        if (filter.abbrev == -1)
 695                filter.abbrev = DEFAULT_ABBREV;
 696        filter.ignore_case = icase;
 697
 698        finalize_colopts(&colopts, -1);
 699        if (filter.verbose) {
 700                if (explicitly_enable_column(colopts))
 701                        die(_("--column and --verbose are incompatible"));
 702                colopts = 0;
 703        }
 704
 705        if (force) {
 706                delete *= 2;
 707                rename *= 2;
 708                copy *= 2;
 709        }
 710
 711        if (list)
 712                setup_auto_pager("branch", 1);
 713
 714        if (delete) {
 715                if (!argc)
 716                        die(_("branch name required"));
 717                return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
 718        } else if (show_current) {
 719                print_current_branch_name();
 720                return 0;
 721        } else if (list) {
 722                /*  git branch --local also shows HEAD when it is detached */
 723                if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
 724                        filter.kind |= FILTER_REFS_DETACHED_HEAD;
 725                filter.name_patterns = argv;
 726                /*
 727                 * If no sorting parameter is given then we default to sorting
 728                 * by 'refname'. This would give us an alphabetically sorted
 729                 * array with the 'HEAD' ref at the beginning followed by
 730                 * local branches 'refs/heads/...' and finally remote-tracking
 731                 * branches 'refs/remotes/...'.
 732                 */
 733                if (!sorting)
 734                        sorting = ref_default_sorting();
 735                sorting->ignore_case = icase;
 736                print_ref_list(&filter, sorting, &format);
 737                print_columns(&output, colopts, NULL);
 738                string_list_clear(&output, 0);
 739                return 0;
 740        } else if (edit_description) {
 741                const char *branch_name;
 742                struct strbuf branch_ref = STRBUF_INIT;
 743
 744                if (!argc) {
 745                        if (filter.detached)
 746                                die(_("Cannot give description to detached HEAD"));
 747                        branch_name = head;
 748                } else if (argc == 1)
 749                        branch_name = argv[0];
 750                else
 751                        die(_("cannot edit description of more than one branch"));
 752
 753                strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 754                if (!ref_exists(branch_ref.buf)) {
 755                        strbuf_release(&branch_ref);
 756
 757                        if (!argc)
 758                                return error(_("No commit on branch '%s' yet."),
 759                                             branch_name);
 760                        else
 761                                return error(_("No branch named '%s'."),
 762                                             branch_name);
 763                }
 764                strbuf_release(&branch_ref);
 765
 766                if (edit_branch_description(branch_name))
 767                        return 1;
 768        } else if (copy) {
 769                if (!argc)
 770                        die(_("branch name required"));
 771                else if (argc == 1)
 772                        copy_or_rename_branch(head, argv[0], 1, copy > 1);
 773                else if (argc == 2)
 774                        copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
 775                else
 776                        die(_("too many branches for a copy operation"));
 777        } else if (rename) {
 778                if (!argc)
 779                        die(_("branch name required"));
 780                else if (argc == 1)
 781                        copy_or_rename_branch(head, argv[0], 0, rename > 1);
 782                else if (argc == 2)
 783                        copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
 784                else
 785                        die(_("too many arguments for a rename operation"));
 786        } else if (new_upstream) {
 787                struct branch *branch = branch_get(argv[0]);
 788
 789                if (argc > 1)
 790                        die(_("too many arguments to set new upstream"));
 791
 792                if (!branch) {
 793                        if (!argc || !strcmp(argv[0], "HEAD"))
 794                                die(_("could not set upstream of HEAD to %s when "
 795                                      "it does not point to any branch."),
 796                                    new_upstream);
 797                        die(_("no such branch '%s'"), argv[0]);
 798                }
 799
 800                if (!ref_exists(branch->refname))
 801                        die(_("branch '%s' does not exist"), branch->name);
 802
 803                /*
 804                 * create_branch takes care of setting up the tracking
 805                 * info and making sure new_upstream is correct
 806                 */
 807                create_branch(the_repository, branch->name, new_upstream,
 808                              0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
 809        } else if (unset_upstream) {
 810                struct branch *branch = branch_get(argv[0]);
 811                struct strbuf buf = STRBUF_INIT;
 812
 813                if (argc > 1)
 814                        die(_("too many arguments to unset upstream"));
 815
 816                if (!branch) {
 817                        if (!argc || !strcmp(argv[0], "HEAD"))
 818                                die(_("could not unset upstream of HEAD when "
 819                                      "it does not point to any branch."));
 820                        die(_("no such branch '%s'"), argv[0]);
 821                }
 822
 823                if (!branch_has_merge_config(branch))
 824                        die(_("Branch '%s' has no upstream information"), branch->name);
 825
 826                strbuf_addf(&buf, "branch.%s.remote", branch->name);
 827                git_config_set_multivar(buf.buf, NULL, NULL, 1);
 828                strbuf_reset(&buf);
 829                strbuf_addf(&buf, "branch.%s.merge", branch->name);
 830                git_config_set_multivar(buf.buf, NULL, NULL, 1);
 831                strbuf_release(&buf);
 832        } else if (argc > 0 && argc <= 2) {
 833                if (filter.kind != FILTER_REFS_BRANCHES)
 834                        die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 835
 836                if (track == BRANCH_TRACK_OVERRIDE)
 837                        die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
 838
 839                create_branch(the_repository,
 840                              argv[0], (argc == 2) ? argv[1] : head,
 841                              force, 0, reflog, quiet, track);
 842
 843        } else
 844                usage_with_options(builtin_branch_usage, options);
 845
 846        return 0;
 847}