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