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