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