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