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