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