builtin / branch.con commit branch: add --column (ebe31ef)
   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
  21static const char * const builtin_branch_usage[] = {
  22        "git branch [options] [-r | -a] [--merged | --no-merged]",
  23        "git branch [options] [-l] [-f] <branchname> [<start-point>]",
  24        "git branch [options] [-r] (-d | -D) <branchname>...",
  25        "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
  26        NULL
  27};
  28
  29#define REF_LOCAL_BRANCH    0x01
  30#define REF_REMOTE_BRANCH   0x02
  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};
  43enum color_branch {
  44        BRANCH_COLOR_RESET = 0,
  45        BRANCH_COLOR_PLAIN = 1,
  46        BRANCH_COLOR_REMOTE = 2,
  47        BRANCH_COLOR_LOCAL = 3,
  48        BRANCH_COLOR_CURRENT = 4
  49};
  50
  51static enum merge_filter {
  52        NO_FILTER = 0,
  53        SHOW_NOT_MERGED,
  54        SHOW_MERGED
  55} merge_filter;
  56static unsigned char merge_filter_ref[20];
  57
  58static struct string_list output = STRING_LIST_INIT_DUP;
  59static unsigned int colopts;
  60
  61static int parse_branch_color_slot(const char *var, int ofs)
  62{
  63        if (!strcasecmp(var+ofs, "plain"))
  64                return BRANCH_COLOR_PLAIN;
  65        if (!strcasecmp(var+ofs, "reset"))
  66                return BRANCH_COLOR_RESET;
  67        if (!strcasecmp(var+ofs, "remote"))
  68                return BRANCH_COLOR_REMOTE;
  69        if (!strcasecmp(var+ofs, "local"))
  70                return BRANCH_COLOR_LOCAL;
  71        if (!strcasecmp(var+ofs, "current"))
  72                return BRANCH_COLOR_CURRENT;
  73        return -1;
  74}
  75
  76static int git_branch_config(const char *var, const char *value, void *cb)
  77{
  78        if (!prefixcmp(var, "column."))
  79                return git_column_config(var, value, "branch", &colopts);
  80        if (!strcmp(var, "color.branch")) {
  81                branch_use_color = git_config_colorbool(var, value);
  82                return 0;
  83        }
  84        if (!prefixcmp(var, "color.branch.")) {
  85                int slot = parse_branch_color_slot(var, 13);
  86                if (slot < 0)
  87                        return 0;
  88                if (!value)
  89                        return config_error_nonbool(var);
  90                color_parse(value, var, branch_colors[slot]);
  91                return 0;
  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 == REF_LOCAL_BRANCH) {
 118                struct branch *branch = branch_get(name);
 119                unsigned char sha1[20];
 120
 121                if (branch &&
 122                    branch->merge &&
 123                    branch->merge[0] &&
 124                    branch->merge[0]->dst &&
 125                    (reference_name = reference_name_to_free =
 126                     resolve_refdup(branch->merge[0]->dst, sha1, 1, 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, 1);
 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, 1) != 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 delete_branches(int argc, const char **argv, int force, int kinds)
 157{
 158        struct commit *rev, *head_rev = NULL;
 159        unsigned char sha1[20];
 160        char *name = NULL;
 161        const char *fmt, *remote;
 162        int i;
 163        int ret = 0;
 164        struct strbuf bname = STRBUF_INIT;
 165
 166        switch (kinds) {
 167        case REF_REMOTE_BRANCH:
 168                fmt = "refs/remotes/%s";
 169                /* TRANSLATORS: This is "remote " in "remote branch '%s' not found" */
 170                remote = _("remote ");
 171                force = 1;
 172                break;
 173        case REF_LOCAL_BRANCH:
 174                fmt = "refs/heads/%s";
 175                remote = "";
 176                break;
 177        default:
 178                die(_("cannot use -a with -d"));
 179        }
 180
 181        if (!force) {
 182                head_rev = lookup_commit_reference(head_sha1);
 183                if (!head_rev)
 184                        die(_("Couldn't look up commit object for HEAD"));
 185        }
 186        for (i = 0; i < argc; i++, strbuf_release(&bname)) {
 187                strbuf_branchname(&bname, argv[i]);
 188                if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
 189                        error(_("Cannot delete the branch '%s' "
 190                              "which you are currently on."), bname.buf);
 191                        ret = 1;
 192                        continue;
 193                }
 194
 195                free(name);
 196
 197                name = xstrdup(mkpath(fmt, bname.buf));
 198                if (read_ref(name, sha1)) {
 199                        error(_("%sbranch '%s' not found."),
 200                                        remote, bname.buf);
 201                        ret = 1;
 202                        continue;
 203                }
 204
 205                rev = lookup_commit_reference(sha1);
 206                if (!rev) {
 207                        error(_("Couldn't look up commit object for '%s'"), name);
 208                        ret = 1;
 209                        continue;
 210                }
 211
 212                if (!force && !branch_merged(kinds, bname.buf, rev, head_rev)) {
 213                        error(_("The branch '%s' is not fully merged.\n"
 214                              "If you are sure you want to delete it, "
 215                              "run 'git branch -D %s'."), bname.buf, bname.buf);
 216                        ret = 1;
 217                        continue;
 218                }
 219
 220                if (delete_ref(name, sha1, 0)) {
 221                        error(_("Error deleting %sbranch '%s'"), remote,
 222                              bname.buf);
 223                        ret = 1;
 224                } else {
 225                        struct strbuf buf = STRBUF_INIT;
 226                        printf(_("Deleted %sbranch %s (was %s).\n"), remote,
 227                               bname.buf,
 228                               find_unique_abbrev(sha1, DEFAULT_ABBREV));
 229                        strbuf_addf(&buf, "branch.%s", bname.buf);
 230                        if (git_config_rename_section(buf.buf, NULL) < 0)
 231                                warning(_("Update of config-file failed"));
 232                        strbuf_release(&buf);
 233                }
 234        }
 235
 236        free(name);
 237
 238        return(ret);
 239}
 240
 241struct ref_item {
 242        char *name;
 243        char *dest;
 244        unsigned int kind, len;
 245        struct commit *commit;
 246};
 247
 248struct ref_list {
 249        struct rev_info revs;
 250        int index, alloc, maxwidth, verbose, abbrev;
 251        struct ref_item *list;
 252        struct commit_list *with_commit;
 253        int kinds;
 254};
 255
 256static char *resolve_symref(const char *src, const char *prefix)
 257{
 258        unsigned char sha1[20];
 259        int flag;
 260        const char *dst, *cp;
 261
 262        dst = resolve_ref_unsafe(src, sha1, 0, &flag);
 263        if (!(dst && (flag & REF_ISSYMREF)))
 264                return NULL;
 265        if (prefix && (cp = skip_prefix(dst, prefix)))
 266                dst = cp;
 267        return xstrdup(dst);
 268}
 269
 270struct append_ref_cb {
 271        struct ref_list *ref_list;
 272        const char **pattern;
 273        int ret;
 274};
 275
 276static int match_patterns(const char **pattern, const char *refname)
 277{
 278        if (!*pattern)
 279                return 1; /* no pattern always matches */
 280        while (*pattern) {
 281                if (!fnmatch(*pattern, refname, 0))
 282                        return 1;
 283                pattern++;
 284        }
 285        return 0;
 286}
 287
 288static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
 289{
 290        struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
 291        struct ref_list *ref_list = cb->ref_list;
 292        struct ref_item *newitem;
 293        struct commit *commit;
 294        int kind, i;
 295        const char *prefix, *orig_refname = refname;
 296
 297        static struct {
 298                int kind;
 299                const char *prefix;
 300                int pfxlen;
 301        } ref_kind[] = {
 302                { REF_LOCAL_BRANCH, "refs/heads/", 11 },
 303                { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
 304        };
 305
 306        /* Detect kind */
 307        for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
 308                prefix = ref_kind[i].prefix;
 309                if (strncmp(refname, prefix, ref_kind[i].pfxlen))
 310                        continue;
 311                kind = ref_kind[i].kind;
 312                refname += ref_kind[i].pfxlen;
 313                break;
 314        }
 315        if (ARRAY_SIZE(ref_kind) <= i)
 316                return 0;
 317
 318        /* Don't add types the caller doesn't want */
 319        if ((kind & ref_list->kinds) == 0)
 320                return 0;
 321
 322        if (!match_patterns(cb->pattern, refname))
 323                return 0;
 324
 325        commit = NULL;
 326        if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
 327                commit = lookup_commit_reference_gently(sha1, 1);
 328                if (!commit) {
 329                        cb->ret = error(_("branch '%s' does not point at a commit"), refname);
 330                        return 0;
 331                }
 332
 333                /* Filter with with_commit if specified */
 334                if (!is_descendant_of(commit, ref_list->with_commit))
 335                        return 0;
 336
 337                if (merge_filter != NO_FILTER)
 338                        add_pending_object(&ref_list->revs,
 339                                           (struct object *)commit, refname);
 340        }
 341
 342        ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
 343
 344        /* Record the new item */
 345        newitem = &(ref_list->list[ref_list->index++]);
 346        newitem->name = xstrdup(refname);
 347        newitem->kind = kind;
 348        newitem->commit = commit;
 349        newitem->len = strlen(refname);
 350        newitem->dest = resolve_symref(orig_refname, prefix);
 351        /* adjust for "remotes/" */
 352        if (newitem->kind == REF_REMOTE_BRANCH &&
 353            ref_list->kinds != REF_REMOTE_BRANCH)
 354                newitem->len += 8;
 355        if (newitem->len > ref_list->maxwidth)
 356                ref_list->maxwidth = newitem->len;
 357
 358        return 0;
 359}
 360
 361static void free_ref_list(struct ref_list *ref_list)
 362{
 363        int i;
 364
 365        for (i = 0; i < ref_list->index; i++) {
 366                free(ref_list->list[i].name);
 367                free(ref_list->list[i].dest);
 368        }
 369        free(ref_list->list);
 370}
 371
 372static int ref_cmp(const void *r1, const void *r2)
 373{
 374        struct ref_item *c1 = (struct ref_item *)(r1);
 375        struct ref_item *c2 = (struct ref_item *)(r2);
 376
 377        if (c1->kind != c2->kind)
 378                return c1->kind - c2->kind;
 379        return strcmp(c1->name, c2->name);
 380}
 381
 382static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
 383                int show_upstream_ref)
 384{
 385        int ours, theirs;
 386        struct branch *branch = branch_get(branch_name);
 387
 388        if (!stat_tracking_info(branch, &ours, &theirs)) {
 389                if (branch && branch->merge && branch->merge[0]->dst &&
 390                    show_upstream_ref)
 391                        strbuf_addf(stat, "[%s] ",
 392                            shorten_unambiguous_ref(branch->merge[0]->dst, 0));
 393                return;
 394        }
 395
 396        strbuf_addch(stat, '[');
 397        if (show_upstream_ref)
 398                strbuf_addf(stat, "%s: ",
 399                        shorten_unambiguous_ref(branch->merge[0]->dst, 0));
 400        if (!ours)
 401                strbuf_addf(stat, _("behind %d] "), theirs);
 402        else if (!theirs)
 403                strbuf_addf(stat, _("ahead %d] "), ours);
 404        else
 405                strbuf_addf(stat, _("ahead %d, behind %d] "), ours, theirs);
 406}
 407
 408static int matches_merge_filter(struct commit *commit)
 409{
 410        int is_merged;
 411
 412        if (merge_filter == NO_FILTER)
 413                return 1;
 414
 415        is_merged = !!(commit->object.flags & UNINTERESTING);
 416        return (is_merged == (merge_filter == SHOW_MERGED));
 417}
 418
 419static void add_verbose_info(struct strbuf *out, struct ref_item *item,
 420                             int verbose, int abbrev)
 421{
 422        struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
 423        const char *sub = " **** invalid ref ****";
 424        struct commit *commit = item->commit;
 425
 426        if (commit && !parse_commit(commit)) {
 427                pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
 428                sub = subject.buf;
 429        }
 430
 431        if (item->kind == REF_LOCAL_BRANCH)
 432                fill_tracking_info(&stat, item->name, verbose > 1);
 433
 434        strbuf_addf(out, " %s %s%s",
 435                find_unique_abbrev(item->commit->object.sha1, abbrev),
 436                stat.buf, sub);
 437        strbuf_release(&stat);
 438        strbuf_release(&subject);
 439}
 440
 441static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
 442                           int abbrev, int current, char *prefix)
 443{
 444        char c;
 445        int color;
 446        struct commit *commit = item->commit;
 447        struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
 448
 449        if (!matches_merge_filter(commit))
 450                return;
 451
 452        switch (item->kind) {
 453        case REF_LOCAL_BRANCH:
 454                color = BRANCH_COLOR_LOCAL;
 455                break;
 456        case REF_REMOTE_BRANCH:
 457                color = BRANCH_COLOR_REMOTE;
 458                break;
 459        default:
 460                color = BRANCH_COLOR_PLAIN;
 461                break;
 462        }
 463
 464        c = ' ';
 465        if (current) {
 466                c = '*';
 467                color = BRANCH_COLOR_CURRENT;
 468        }
 469
 470        strbuf_addf(&name, "%s%s", prefix, item->name);
 471        if (verbose)
 472                strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
 473                            maxwidth, name.buf,
 474                            branch_get_color(BRANCH_COLOR_RESET));
 475        else
 476                strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
 477                            name.buf, branch_get_color(BRANCH_COLOR_RESET));
 478
 479        if (item->dest)
 480                strbuf_addf(&out, " -> %s", item->dest);
 481        else if (verbose)
 482                /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
 483                add_verbose_info(&out, item, verbose, abbrev);
 484        if (column_active(colopts)) {
 485                assert(!verbose && "--column and --verbose are incompatible");
 486                string_list_append(&output, out.buf);
 487        } else {
 488                printf("%s\n", out.buf);
 489        }
 490        strbuf_release(&name);
 491        strbuf_release(&out);
 492}
 493
 494static int calc_maxwidth(struct ref_list *refs)
 495{
 496        int i, w = 0;
 497        for (i = 0; i < refs->index; i++) {
 498                if (!matches_merge_filter(refs->list[i].commit))
 499                        continue;
 500                if (refs->list[i].len > w)
 501                        w = refs->list[i].len;
 502        }
 503        return w;
 504}
 505
 506
 507static void show_detached(struct ref_list *ref_list)
 508{
 509        struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
 510
 511        if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
 512                struct ref_item item;
 513                item.name = xstrdup(_("(no branch)"));
 514                item.len = strlen(item.name);
 515                item.kind = REF_LOCAL_BRANCH;
 516                item.dest = NULL;
 517                item.commit = head_commit;
 518                if (item.len > ref_list->maxwidth)
 519                        ref_list->maxwidth = item.len;
 520                print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
 521                free(item.name);
 522        }
 523}
 524
 525static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
 526{
 527        int i;
 528        struct append_ref_cb cb;
 529        struct ref_list ref_list;
 530
 531        memset(&ref_list, 0, sizeof(ref_list));
 532        ref_list.kinds = kinds;
 533        ref_list.verbose = verbose;
 534        ref_list.abbrev = abbrev;
 535        ref_list.with_commit = with_commit;
 536        if (merge_filter != NO_FILTER)
 537                init_revisions(&ref_list.revs, NULL);
 538        cb.ref_list = &ref_list;
 539        cb.pattern = pattern;
 540        cb.ret = 0;
 541        for_each_rawref(append_ref, &cb);
 542        if (merge_filter != NO_FILTER) {
 543                struct commit *filter;
 544                filter = lookup_commit_reference_gently(merge_filter_ref, 0);
 545                filter->object.flags |= UNINTERESTING;
 546                add_pending_object(&ref_list.revs,
 547                                   (struct object *) filter, "");
 548                ref_list.revs.limited = 1;
 549                prepare_revision_walk(&ref_list.revs);
 550                if (verbose)
 551                        ref_list.maxwidth = calc_maxwidth(&ref_list);
 552        }
 553
 554        qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
 555
 556        detached = (detached && (kinds & REF_LOCAL_BRANCH));
 557        if (detached && match_patterns(pattern, "HEAD"))
 558                show_detached(&ref_list);
 559
 560        for (i = 0; i < ref_list.index; i++) {
 561                int current = !detached &&
 562                        (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
 563                        !strcmp(ref_list.list[i].name, head);
 564                char *prefix = (kinds != REF_REMOTE_BRANCH &&
 565                                ref_list.list[i].kind == REF_REMOTE_BRANCH)
 566                                ? "remotes/" : "";
 567                print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
 568                               abbrev, current, prefix);
 569        }
 570
 571        free_ref_list(&ref_list);
 572
 573        if (cb.ret)
 574                error(_("some refs could not be read"));
 575
 576        return cb.ret;
 577}
 578
 579static void rename_branch(const char *oldname, const char *newname, int force)
 580{
 581        struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 582        struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 583        int recovery = 0;
 584        int clobber_head_ok;
 585
 586        if (!oldname)
 587                die(_("cannot rename the current branch while not on any."));
 588
 589        if (strbuf_check_branch_ref(&oldref, oldname)) {
 590                /*
 591                 * Bad name --- this could be an attempt to rename a
 592                 * ref that we used to allow to be created by accident.
 593                 */
 594                if (ref_exists(oldref.buf))
 595                        recovery = 1;
 596                else
 597                        die(_("Invalid branch name: '%s'"), oldname);
 598        }
 599
 600        /*
 601         * A command like "git branch -M currentbranch currentbranch" cannot
 602         * cause the worktree to become inconsistent with HEAD, so allow it.
 603         */
 604        clobber_head_ok = !strcmp(oldname, newname);
 605
 606        validate_new_branchname(newname, &newref, force, clobber_head_ok);
 607
 608        strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 609                 oldref.buf, newref.buf);
 610
 611        if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
 612                die(_("Branch rename failed"));
 613        strbuf_release(&logmsg);
 614
 615        if (recovery)
 616                warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
 617
 618        /* no need to pass logmsg here as HEAD didn't really move */
 619        if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
 620                die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 621
 622        strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 623        strbuf_release(&oldref);
 624        strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 625        strbuf_release(&newref);
 626        if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 627                die(_("Branch is renamed, but update of config-file failed"));
 628        strbuf_release(&oldsection);
 629        strbuf_release(&newsection);
 630}
 631
 632static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
 633{
 634        merge_filter = ((opt->long_name[0] == 'n')
 635                        ? SHOW_NOT_MERGED
 636                        : SHOW_MERGED);
 637        if (unset)
 638                merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
 639        if (!arg)
 640                arg = "HEAD";
 641        if (get_sha1(arg, merge_filter_ref))
 642                die(_("malformed object name %s"), arg);
 643        return 0;
 644}
 645
 646static const char edit_description[] = "BRANCH_DESCRIPTION";
 647
 648static int edit_branch_description(const char *branch_name)
 649{
 650        FILE *fp;
 651        int status;
 652        struct strbuf buf = STRBUF_INIT;
 653        struct strbuf name = STRBUF_INIT;
 654
 655        read_branch_desc(&buf, branch_name);
 656        if (!buf.len || buf.buf[buf.len-1] != '\n')
 657                strbuf_addch(&buf, '\n');
 658        strbuf_addf(&buf,
 659                    "# Please edit the description for the branch\n"
 660                    "#   %s\n"
 661                    "# Lines starting with '#' will be stripped.\n",
 662                    branch_name);
 663        fp = fopen(git_path(edit_description), "w");
 664        if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
 665                strbuf_release(&buf);
 666                return error(_("could not write branch description template: %s\n"),
 667                             strerror(errno));
 668        }
 669        strbuf_reset(&buf);
 670        if (launch_editor(git_path(edit_description), &buf, NULL)) {
 671                strbuf_release(&buf);
 672                return -1;
 673        }
 674        stripspace(&buf, 1);
 675
 676        strbuf_addf(&name, "branch.%s.description", branch_name);
 677        status = git_config_set(name.buf, buf.buf);
 678        strbuf_release(&name);
 679        strbuf_release(&buf);
 680
 681        return status;
 682}
 683
 684int cmd_branch(int argc, const char **argv, const char *prefix)
 685{
 686        int delete = 0, rename = 0, force_create = 0, list = 0;
 687        int verbose = 0, abbrev = -1, detached = 0;
 688        int reflog = 0, edit_description = 0;
 689        enum branch_track track;
 690        int kinds = REF_LOCAL_BRANCH;
 691        struct commit_list *with_commit = NULL;
 692
 693        struct option options[] = {
 694                OPT_GROUP("Generic options"),
 695                OPT__VERBOSE(&verbose,
 696                        "show hash and subject, give twice for upstream branch"),
 697                OPT_SET_INT('t', "track",  &track, "set up tracking mode (see git-pull(1))",
 698                        BRANCH_TRACK_EXPLICIT),
 699                OPT_SET_INT( 0, "set-upstream",  &track, "change upstream info",
 700                        BRANCH_TRACK_OVERRIDE),
 701                OPT__COLOR(&branch_use_color, "use colored output"),
 702                OPT_SET_INT('r', "remotes",     &kinds, "act on remote-tracking branches",
 703                        REF_REMOTE_BRANCH),
 704                {
 705                        OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
 706                        "print only branches that contain the commit",
 707                        PARSE_OPT_LASTARG_DEFAULT,
 708                        parse_opt_with_commit, (intptr_t)"HEAD",
 709                },
 710                {
 711                        OPTION_CALLBACK, 0, "with", &with_commit, "commit",
 712                        "print only branches that contain the commit",
 713                        PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
 714                        parse_opt_with_commit, (intptr_t) "HEAD",
 715                },
 716                OPT__ABBREV(&abbrev),
 717
 718                OPT_GROUP("Specific git-branch actions:"),
 719                OPT_SET_INT('a', "all", &kinds, "list both remote-tracking and local branches",
 720                        REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
 721                OPT_BIT('d', "delete", &delete, "delete fully merged branch", 1),
 722                OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
 723                OPT_BIT('m', "move", &rename, "move/rename a branch and its reflog", 1),
 724                OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
 725                OPT_BOOLEAN(0, "list", &list, "list branch names"),
 726                OPT_BOOLEAN('l', "create-reflog", &reflog, "create the branch's reflog"),
 727                OPT_BOOLEAN(0, "edit-description", &edit_description,
 728                            "edit the description for the branch"),
 729                OPT__FORCE(&force_create, "force creation (when already exists)"),
 730                {
 731                        OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
 732                        "commit", "print only not merged branches",
 733                        PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 734                        opt_parse_merge_filter, (intptr_t) "HEAD",
 735                },
 736                {
 737                        OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
 738                        "commit", "print only merged branches",
 739                        PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 740                        opt_parse_merge_filter, (intptr_t) "HEAD",
 741                },
 742                OPT_COLUMN(0, "column", &colopts, "list branches in columns"),
 743                OPT_END(),
 744        };
 745
 746        if (argc == 2 && !strcmp(argv[1], "-h"))
 747                usage_with_options(builtin_branch_usage, options);
 748
 749        git_config(git_branch_config, NULL);
 750
 751        track = git_branch_track;
 752
 753        head = resolve_refdup("HEAD", head_sha1, 0, NULL);
 754        if (!head)
 755                die(_("Failed to resolve HEAD as a valid ref."));
 756        if (!strcmp(head, "HEAD")) {
 757                detached = 1;
 758        } else {
 759                if (prefixcmp(head, "refs/heads/"))
 760                        die(_("HEAD not found below refs/heads!"));
 761                head += 11;
 762        }
 763        hashcpy(merge_filter_ref, head_sha1);
 764
 765
 766        argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 767                             0);
 768
 769        if (!delete && !rename && !edit_description && argc == 0)
 770                list = 1;
 771
 772        if (!!delete + !!rename + !!force_create + !!list > 1)
 773                usage_with_options(builtin_branch_usage, options);
 774
 775        if (abbrev == -1)
 776                abbrev = DEFAULT_ABBREV;
 777        finalize_colopts(&colopts, -1);
 778        if (verbose) {
 779                if (explicitly_enable_column(colopts))
 780                        die(_("--column and --verbose are incompatible"));
 781                colopts = 0;
 782        }
 783
 784        if (delete)
 785                return delete_branches(argc, argv, delete > 1, kinds);
 786        else if (list) {
 787                int ret = print_ref_list(kinds, detached, verbose, abbrev,
 788                                         with_commit, argv);
 789                print_columns(&output, colopts, NULL);
 790                string_list_clear(&output, 0);
 791                return ret;
 792        }
 793        else if (edit_description) {
 794                const char *branch_name;
 795                struct strbuf branch_ref = STRBUF_INIT;
 796
 797                if (detached)
 798                        die("Cannot give description to detached HEAD");
 799                if (!argc)
 800                        branch_name = head;
 801                else if (argc == 1)
 802                        branch_name = argv[0];
 803                else
 804                        usage_with_options(builtin_branch_usage, options);
 805
 806                strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 807                if (!ref_exists(branch_ref.buf)) {
 808                        strbuf_release(&branch_ref);
 809
 810                        if (!argc)
 811                                return error("No commit on branch '%s' yet.",
 812                                             branch_name);
 813                        else
 814                                return error("No such branch '%s'.", branch_name);
 815                }
 816                strbuf_release(&branch_ref);
 817
 818                if (edit_branch_description(branch_name))
 819                        return 1;
 820        } else if (rename) {
 821                if (argc == 1)
 822                        rename_branch(head, argv[0], rename > 1);
 823                else if (argc == 2)
 824                        rename_branch(argv[0], argv[1], rename > 1);
 825                else
 826                        usage_with_options(builtin_branch_usage, options);
 827        } else if (argc > 0 && argc <= 2) {
 828                if (kinds != REF_LOCAL_BRANCH)
 829                        die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 830                create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
 831                              force_create, reflog, 0, track);
 832        } else
 833                usage_with_options(builtin_branch_usage, options);
 834
 835        return 0;
 836}