builtin/branch.c

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