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