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