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