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