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