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                 } else {
 255                         if (!quiet)
 256                                 printf(remote_branch
 257                                        ? _("Deleted remote branch %s (was %s).\n")
 258                                        : _("Deleted branch %s (was %s).\n"),
 259                                        bname.buf,
 260                                        find_unique_abbrev(sha1, DEFAULT_ABBREV));
 261                         delete_branch_config(bname.buf);
 262                 }
 263         }
 264
 265         free(name);
 266
 267         return(ret);
 268 }
 269
 270 struct ref_item {
 271         char *name;
 272         char *dest;
 273         unsigned int kind, width;
 274         struct commit *commit;
 275 };
 276
 277 struct ref_list {
 278         struct rev_info revs;
 279         int index, alloc, maxwidth, verbose, abbrev;
 280         struct ref_item *list;
 281         struct commit_list *with_commit;
 282         int kinds;
 283 };
 284
 285 static char *resolve_symref(const char *src, const char *prefix)
 286 {
 287         unsigned char sha1[20];
 288         int flag;
 289         const char *dst, *cp;
 290
 291         dst = resolve_ref_unsafe(src, sha1, 0, &flag);
 292         if (!(dst && (flag & REF_ISSYMREF)))
 293                 return NULL;
 294         if (prefix && (cp = skip_prefix(dst, prefix)))
 295                 dst = cp;
 296         return xstrdup(dst);
 297 }
 298
 299 struct append_ref_cb {
 300         struct ref_list *ref_list;
 301         const char **pattern;
 302         int ret;
 303 };
 304
 305 static int match_patterns(const char **pattern, const char *refname)
 306 {
 307         if (!*pattern)
 308                 return 1; /* no pattern always matches */
 309         while (*pattern) {
 310                 if (!fnmatch(*pattern, refname, 0))
 311                         return 1;
 312                 pattern++;
 313         }
 314         return 0;
 315 }
 316
 317 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
 318 {
 319         struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
 320         struct ref_list *ref_list = cb->ref_list;
 321         struct ref_item *newitem;
 322         struct commit *commit;
 323         int kind, i;
 324         const char *prefix, *orig_refname = refname;
 325
 326         static struct {
 327                 int kind;
 328                 const char *prefix;
 329                 int pfxlen;
 330         } ref_kind[] = {
 331                 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
 332                 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
 333         };
 334
 335         /* Detect kind */
 336         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
 337                 prefix = ref_kind[i].prefix;
 338                 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
 339                         continue;
 340                 kind = ref_kind[i].kind;
 341                 refname += ref_kind[i].pfxlen;
 342                 break;
 343         }
 344         if (ARRAY_SIZE(ref_kind) <= i)
 345                 return 0;
 346
 347         /* Don't add types the caller doesn't want */
 348         if ((kind & ref_list->kinds) == 0)
 349                 return 0;
 350
 351         if (!match_patterns(cb->pattern, refname))
 352                 return 0;
 353
 354         commit = NULL;
 355         if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
 356                 commit = lookup_commit_reference_gently(sha1, 1);
 357                 if (!commit) {
 358                         cb->ret = error(_("branch '%s' does not point at a commit"), refname);
 359                         return 0;
 360                 }
 361
 362                 /* Filter with with_commit if specified */
 363                 if (!is_descendant_of(commit, ref_list->with_commit))
 364                         return 0;
 365
 366                 if (merge_filter != NO_FILTER)
 367                         add_pending_object(&ref_list->revs,
 368                                            (struct object *)commit, refname);
 369         }
 370
 371         ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
 372
 373         /* Record the new item */
 374         newitem = &(ref_list->list[ref_list->index++]);
 375         newitem->name = xstrdup(refname);
 376         newitem->kind = kind;
 377         newitem->commit = commit;
 378         newitem->width = utf8_strwidth(refname);
 379         newitem->dest = resolve_symref(orig_refname, prefix);
 380         /* adjust for "remotes/" */
 381         if (newitem->kind == REF_REMOTE_BRANCH &&
 382             ref_list->kinds != REF_REMOTE_BRANCH)
 383                 newitem->width += 8;
 384         if (newitem->width > ref_list->maxwidth)
 385                 ref_list->maxwidth = newitem->width;
 386
 387         return 0;
 388 }
 389
 390 static void free_ref_list(struct ref_list *ref_list)
 391 {
 392         int i;
 393
 394         for (i = 0; i < ref_list->index; i++) {
 395                 free(ref_list->list[i].name);
 396                 free(ref_list->list[i].dest);
 397         }
 398         free(ref_list->list);
 399 }
 400
 401 static int ref_cmp(const void *r1, const void *r2)
 402 {
 403         struct ref_item *c1 = (struct ref_item *)(r1);
 404         struct ref_item *c2 = (struct ref_item *)(r2);
 405
 406         if (c1->kind != c2->kind)
 407                 return c1->kind - c2->kind;
 408         return strcmp(c1->name, c2->name);
 409 }
 410
 411 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
 412                 int show_upstream_ref)
 413 {
 414         int ours, theirs;
 415         char *ref = NULL;
 416         struct branch *branch = branch_get(branch_name);
 417
 418         if (!stat_tracking_info(branch, &ours, &theirs)) {
 419                 if (branch && branch->merge && branch->merge[0]->dst &&
 420                     show_upstream_ref)
 421                         strbuf_addf(stat, "[%s] ",
 422                             shorten_unambiguous_ref(branch->merge[0]->dst, 0));
 423                 return;
 424         }
 425
 426         if (show_upstream_ref)
 427                 ref = shorten_unambiguous_ref(branch->merge[0]->dst, 0);
 428         if (!ours) {
 429                 if (ref)
 430                         strbuf_addf(stat, _("[%s: behind %d]"), ref, theirs);
 431                 else
 432                         strbuf_addf(stat, _("[behind %d]"), theirs);
 433
 434         } else if (!theirs) {
 435                 if (ref)
 436                         strbuf_addf(stat, _("[%s: ahead %d]"), ref, ours);
 437                 else
 438                         strbuf_addf(stat, _("[ahead %d]"), ours);
 439         } else {
 440                 if (ref)
 441                         strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
 442                                     ref, ours, theirs);
 443                 else
 444                         strbuf_addf(stat, _("[ahead %d, behind %d]"),
 445                                     ours, theirs);
 446         }
 447         strbuf_addch(stat, ' ');
 448         free(ref);
 449 }
 450
 451 static int matches_merge_filter(struct commit *commit)
 452 {
 453         int is_merged;
 454
 455         if (merge_filter == NO_FILTER)
 456                 return 1;
 457
 458         is_merged = !!(commit->object.flags & UNINTERESTING);
 459         return (is_merged == (merge_filter == SHOW_MERGED));
 460 }
 461
 462 static void add_verbose_info(struct strbuf *out, struct ref_item *item,
 463                              int verbose, int abbrev)
 464 {
 465         struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
 466         const char *sub = " **** invalid ref ****";
 467         struct commit *commit = item->commit;
 468
 469         if (commit && !parse_commit(commit)) {
 470                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
 471                 sub = subject.buf;
 472         }
 473
 474         if (item->kind == REF_LOCAL_BRANCH)
 475                 fill_tracking_info(&stat, item->name, verbose > 1);
 476
 477         strbuf_addf(out, " %s %s%s",
 478                 find_unique_abbrev(item->commit->object.sha1, abbrev),
 479                 stat.buf, sub);
 480         strbuf_release(&stat);
 481         strbuf_release(&subject);
 482 }
 483
 484 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
 485                            int abbrev, int current, char *prefix)
 486 {
 487         char c;
 488         int color;
 489         struct commit *commit = item->commit;
 490         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
 491
 492         if (!matches_merge_filter(commit))
 493                 return;
 494
 495         switch (item->kind) {
 496         case REF_LOCAL_BRANCH:
 497                 color = BRANCH_COLOR_LOCAL;
 498                 break;
 499         case REF_REMOTE_BRANCH:
 500                 color = BRANCH_COLOR_REMOTE;
 501                 break;
 502         default:
 503                 color = BRANCH_COLOR_PLAIN;
 504                 break;
 505         }
 506
 507         c = ' ';
 508         if (current) {
 509                 c = '*';
 510                 color = BRANCH_COLOR_CURRENT;
 511         }
 512
 513         strbuf_addf(&name, "%s%s", prefix, item->name);
 514         if (verbose) {
 515                 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
 516                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
 517                             maxwidth + utf8_compensation, name.buf,
 518                             branch_get_color(BRANCH_COLOR_RESET));
 519         } else
 520                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
 521                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
 522
 523         if (item->dest)
 524                 strbuf_addf(&out, " -> %s", item->dest);
 525         else if (verbose)
 526                 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
 527                 add_verbose_info(&out, item, verbose, abbrev);
 528         if (column_active(colopts)) {
 529                 assert(!verbose && "--column and --verbose are incompatible");
 530                 string_list_append(&output, out.buf);
 531         } else {
 532                 printf("%s\n", out.buf);
 533         }
 534         strbuf_release(&name);
 535         strbuf_release(&out);
 536 }
 537
 538 static int calc_maxwidth(struct ref_list *refs)
 539 {
 540         int i, w = 0;
 541         for (i = 0; i < refs->index; i++) {
 542                 if (!matches_merge_filter(refs->list[i].commit))
 543                         continue;
 544                 if (refs->list[i].width > w)
 545                         w = refs->list[i].width;
 546         }
 547         return w;
 548 }
 549
 550
 551 static void show_detached(struct ref_list *ref_list)
 552 {
 553         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
 554
 555         if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
 556                 struct ref_item item;
 557                 item.name = xstrdup(_("(no branch)"));
 558                 item.width = utf8_strwidth(item.name);
 559                 item.kind = REF_LOCAL_BRANCH;
 560                 item.dest = NULL;
 561                 item.commit = head_commit;
 562                 if (item.width > ref_list->maxwidth)
 563                         ref_list->maxwidth = item.width;
 564                 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
 565                 free(item.name);
 566         }
 567 }
 568
 569 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
 570 {
 571         int i;
 572         struct append_ref_cb cb;
 573         struct ref_list ref_list;
 574
 575         memset(&ref_list, 0, sizeof(ref_list));
 576         ref_list.kinds = kinds;
 577         ref_list.verbose = verbose;
 578         ref_list.abbrev = abbrev;
 579         ref_list.with_commit = with_commit;
 580         if (merge_filter != NO_FILTER)
 581                 init_revisions(&ref_list.revs, NULL);
 582         cb.ref_list = &ref_list;
 583         cb.pattern = pattern;
 584         cb.ret = 0;
 585         for_each_rawref(append_ref, &cb);
 586         if (merge_filter != NO_FILTER) {
 587                 struct commit *filter;
 588                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
 589                 if (!filter)
 590                         die("object '%s' does not point to a commit",
 591                             sha1_to_hex(merge_filter_ref));
 592
 593                 filter->object.flags |= UNINTERESTING;
 594                 add_pending_object(&ref_list.revs,
 595                                    (struct object *) filter, "");
 596                 ref_list.revs.limited = 1;
 597                 prepare_revision_walk(&ref_list.revs);
 598                 if (verbose)
 599                         ref_list.maxwidth = calc_maxwidth(&ref_list);
 600         }
 601
 602         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
 603
 604         detached = (detached && (kinds & REF_LOCAL_BRANCH));
 605         if (detached && match_patterns(pattern, "HEAD"))
 606                 show_detached(&ref_list);
 607
 608         for (i = 0; i < ref_list.index; i++) {
 609                 int current = !detached &&
 610                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
 611                         !strcmp(ref_list.list[i].name, head);
 612                 char *prefix = (kinds != REF_REMOTE_BRANCH &&
 613                                 ref_list.list[i].kind == REF_REMOTE_BRANCH)
 614                                 ? "remotes/" : "";
 615                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
 616                                abbrev, current, prefix);
 617         }
 618
 619         free_ref_list(&ref_list);
 620
 621         if (cb.ret)
 622                 error(_("some refs could not be read"));
 623
 624         return cb.ret;
 625 }
 626
 627 static void rename_branch(const char *oldname, const char *newname, int force)
 628 {
 629         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 630         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 631         int recovery = 0;
 632         int clobber_head_ok;
 633
 634         if (!oldname)
 635                 die(_("cannot rename the current branch while not on any."));
 636
 637         if (strbuf_check_branch_ref(&oldref, oldname)) {
 638                 /*
 639                  * Bad name --- this could be an attempt to rename a
 640                  * ref that we used to allow to be created by accident.
 641                  */
 642                 if (ref_exists(oldref.buf))
 643                         recovery = 1;
 644                 else
 645                         die(_("Invalid branch name: '%s'"), oldname);
 646         }
 647
 648         /*
 649          * A command like "git branch -M currentbranch currentbranch" cannot
 650          * cause the worktree to become inconsistent with HEAD, so allow it.
 651          */
 652         clobber_head_ok = !strcmp(oldname, newname);
 653
 654         validate_new_branchname(newname, &newref, force, clobber_head_ok);
 655
 656         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 657                  oldref.buf, newref.buf);
 658
 659         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
 660                 die(_("Branch rename failed"));
 661         strbuf_release(&logmsg);
 662
 663         if (recovery)
 664                 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
 665
 666         /* no need to pass logmsg here as HEAD didn't really move */
 667         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
 668                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 669
 670         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 671         strbuf_release(&oldref);
 672         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 673         strbuf_release(&newref);
 674         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 675                 die(_("Branch is renamed, but update of config-file failed"));
 676         strbuf_release(&oldsection);
 677         strbuf_release(&newsection);
 678 }
 679
 680 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
 681 {
 682         merge_filter = ((opt->long_name[0] == 'n')
 683                         ? SHOW_NOT_MERGED
 684                         : SHOW_MERGED);
 685         if (unset)
 686                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
 687         if (!arg)
 688                 arg = "HEAD";
 689         if (get_sha1(arg, merge_filter_ref))
 690                 die(_("malformed object name %s"), arg);
 691         return 0;
 692 }
 693
 694 static const char edit_description[] = "BRANCH_DESCRIPTION";
 695
 696 static int edit_branch_description(const char *branch_name)
 697 {
 698         FILE *fp;
 699         int status;
 700         struct strbuf buf = STRBUF_INIT;
 701         struct strbuf name = STRBUF_INIT;
 702
 703         read_branch_desc(&buf, branch_name);
 704         if (!buf.len || buf.buf[buf.len-1] != '\n')
 705                 strbuf_addch(&buf, '\n');
 706         strbuf_addf(&buf,
 707                     "# Please edit the description for the branch\n"
 708                     "#   %s\n"
 709                     "# Lines starting with '#' will be stripped.\n",
 710                     branch_name);
 711         fp = fopen(git_path(edit_description), "w");
 712         if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
 713                 strbuf_release(&buf);
 714                 return error(_("could not write branch description template: %s"),
 715                              strerror(errno));
 716         }
 717         strbuf_reset(&buf);
 718         if (launch_editor(git_path(edit_description), &buf, NULL)) {
 719                 strbuf_release(&buf);
 720                 return -1;
 721         }
 722         stripspace(&buf, 1);
 723
 724         strbuf_addf(&name, "branch.%s.description", branch_name);
 725         status = git_config_set(name.buf, buf.buf);
 726         strbuf_release(&name);
 727         strbuf_release(&buf);
 728
 729         return status;
 730 }
 731
 732 int cmd_branch(int argc, const char **argv, const char *prefix)
 733 {
 734         int delete = 0, rename = 0, force_create = 0, list = 0;
 735         int verbose = 0, abbrev = -1, detached = 0;
 736         int reflog = 0, edit_description = 0;
 737         int quiet = 0, unset_upstream = 0;
 738         const char *new_upstream = NULL;
 739         enum branch_track track;
 740         int kinds = REF_LOCAL_BRANCH;
 741         struct commit_list *with_commit = NULL;
 742
 743         struct option options[] = {
 744                 OPT_GROUP(N_("Generic options")),
 745                 OPT__VERBOSE(&verbose,
 746                         N_("show hash and subject, give twice for upstream branch")),
 747                 OPT__QUIET(&quiet, N_("suppress informational messages")),
 748                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
 749                         BRANCH_TRACK_EXPLICIT),
 750                 OPT_SET_INT( 0, "set-upstream",  &track, N_("change upstream info"),
 751                         BRANCH_TRACK_OVERRIDE),
 752                 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
 753                 OPT_BOOLEAN(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
 754                 OPT__COLOR(&branch_use_color, N_("use colored output")),
 755                 OPT_SET_INT('r', "remotes",     &kinds, N_("act on remote-tracking branches"),
 756                         REF_REMOTE_BRANCH),
 757                 {
 758                         OPTION_CALLBACK, 0, "contains", &with_commit, N_("commit"),
 759                         N_("print only branches that contain the commit"),
 760                         PARSE_OPT_LASTARG_DEFAULT,
 761                         parse_opt_with_commit, (intptr_t)"HEAD",
 762                 },
 763                 {
 764                         OPTION_CALLBACK, 0, "with", &with_commit, N_("commit"),
 765                         N_("print only branches that contain the commit"),
 766                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
 767                         parse_opt_with_commit, (intptr_t) "HEAD",
 768                 },
 769                 OPT__ABBREV(&abbrev),
 770
 771                 OPT_GROUP(N_("Specific git-branch actions:")),
 772                 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
 773                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
 774                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
 775                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
 776                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
 777                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
 778                 OPT_BOOLEAN(0, "list", &list, N_("list branch names")),
 779                 OPT_BOOLEAN('l', "create-reflog", &reflog, N_("create the branch's reflog")),
 780                 OPT_BOOLEAN(0, "edit-description", &edit_description,
 781                             N_("edit the description for the branch")),
 782                 OPT__FORCE(&force_create, N_("force creation (when already exists)")),
 783                 {
 784                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
 785                         N_("commit"), N_("print only not merged branches"),
 786                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 787                         opt_parse_merge_filter, (intptr_t) "HEAD",
 788                 },
 789                 {
 790                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
 791                         N_("commit"), N_("print only merged branches"),
 792                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 793                         opt_parse_merge_filter, (intptr_t) "HEAD",
 794                 },
 795                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
 796                 OPT_END(),
 797         };
 798
 799         if (argc == 2 && !strcmp(argv[1], "-h"))
 800                 usage_with_options(builtin_branch_usage, options);
 801
 802         git_config(git_branch_config, NULL);
 803
 804         track = git_branch_track;
 805
 806         head = resolve_refdup("HEAD", head_sha1, 0, NULL);
 807         if (!head)
 808                 die(_("Failed to resolve HEAD as a valid ref."));
 809         if (!strcmp(head, "HEAD")) {
 810                 detached = 1;
 811         } else {
 812                 if (prefixcmp(head, "refs/heads/"))
 813                         die(_("HEAD not found below refs/heads!"));
 814                 head += 11;
 815         }
 816         hashcpy(merge_filter_ref, head_sha1);
 817
 818
 819         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 820                              0);
 821
 822         if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
 823                 list = 1;
 824
 825         if (!!delete + !!rename + !!force_create + !!list + !!new_upstream + !!unset_upstream > 1)
 826                 usage_with_options(builtin_branch_usage, options);
 827
 828         if (abbrev == -1)
 829                 abbrev = DEFAULT_ABBREV;
 830         finalize_colopts(&colopts, -1);
 831         if (verbose) {
 832                 if (explicitly_enable_column(colopts))
 833                         die(_("--column and --verbose are incompatible"));
 834                 colopts = 0;
 835         }
 836
 837         if (delete)
 838                 return delete_branches(argc, argv, delete > 1, kinds, quiet);
 839         else if (list) {
 840                 int ret = print_ref_list(kinds, detached, verbose, abbrev,
 841                                          with_commit, argv);
 842                 print_columns(&output, colopts, NULL);
 843                 string_list_clear(&output, 0);
 844                 return ret;
 845         }
 846         else if (edit_description) {
 847                 const char *branch_name;
 848                 struct strbuf branch_ref = STRBUF_INIT;
 849
 850                 if (detached)
 851                         die("Cannot give description to detached HEAD");
 852                 if (!argc)
 853                         branch_name = head;
 854                 else if (argc == 1)
 855                         branch_name = argv[0];
 856                 else
 857                         usage_with_options(builtin_branch_usage, options);
 858
 859                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 860                 if (!ref_exists(branch_ref.buf)) {
 861                         strbuf_release(&branch_ref);
 862
 863                         if (!argc)
 864                                 return error("No commit on branch '%s' yet.",
 865                                              branch_name);
 866                         else
 867                                 return error("No such branch '%s'.", branch_name);
 868                 }
 869                 strbuf_release(&branch_ref);
 870
 871                 if (edit_branch_description(branch_name))
 872                         return 1;
 873         } else if (rename) {
 874                 if (argc == 1)
 875                         rename_branch(head, argv[0], rename > 1);
 876                 else if (argc == 2)
 877                         rename_branch(argv[0], argv[1], rename > 1);
 878                 else
 879                         usage_with_options(builtin_branch_usage, options);
 880         } else if (new_upstream) {
 881                 struct branch *branch = branch_get(argv[0]);
 882
 883                 if (!ref_exists(branch->refname))
 884                         die(_("branch '%s' does not exist"), branch->name);
 885
 886                 /*
 887                  * create_branch takes care of setting up the tracking
 888                  * info and making sure new_upstream is correct
 889                  */
 890                 create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
 891         } else if (unset_upstream) {
 892                 struct branch *branch = branch_get(argv[0]);
 893                 struct strbuf buf = STRBUF_INIT;
 894
 895                 if (!branch_has_merge_config(branch)) {
 896                         die(_("Branch '%s' has no upstream information"), branch->name);
 897                 }
 898
 899                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
 900                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 901                 strbuf_reset(&buf);
 902                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
 903                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 904                 strbuf_release(&buf);
 905         } else if (argc > 0 && argc <= 2) {
 906                 struct branch *branch = branch_get(argv[0]);
 907                 int branch_existed = 0, remote_tracking = 0;
 908                 struct strbuf buf = STRBUF_INIT;
 909
 910                 if (kinds != REF_LOCAL_BRANCH)
 911                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 912
 913                 if (track == BRANCH_TRACK_OVERRIDE)
 914                         fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
 915
 916                 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
 917                 remote_tracking = ref_exists(buf.buf);
 918                 strbuf_release(&buf);
 919
 920                 branch_existed = ref_exists(branch->refname);
 921                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
 922                               force_create, reflog, 0, quiet, track);
 923
 924                 /*
 925                  * We only show the instructions if the user gave us
 926                  * one branch which doesn't exist locally, but is the
 927                  * name of a remote-tracking branch.
 928                  */
 929                 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
 930                     !branch_existed && remote_tracking) {
 931                         fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
 932                         fprintf(stderr, _("    git branch -d %s\n"), branch->name);
 933                         fprintf(stderr, _("    git branch --set-upstream-to %s\n"), branch->name);
 934                 }
 935
 936         } else
 937                 usage_with_options(builtin_branch_usage, options);
 938
 939         return 0;
 940 }