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