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