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