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