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