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