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