builtin/branch.c

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