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