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