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