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