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         unsigned allowed_interpret;
 194
 195         switch (kinds) {
 196         case FILTER_REFS_REMOTES:
 197                 fmt = "refs/remotes/%s";
 198                 /* For subsequent UI messages */
 199                 remote_branch = 1;
 200                 allowed_interpret = INTERPRET_BRANCH_REMOTE;
 201
 202                 force = 1;
 203                 break;
 204         case FILTER_REFS_BRANCHES:
 205                 fmt = "refs/heads/%s";
 206                 allowed_interpret = INTERPRET_BRANCH_LOCAL;
 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                 char *target = NULL;
 219                 int flags = 0;
 220
 221                 strbuf_branchname(&bname, argv[i], allowed_interpret);
 222                 free(name);
 223                 name = mkpathdup(fmt, bname.buf);
 224
 225                 if (kinds == FILTER_REFS_BRANCHES) {
 226                         const struct worktree *wt =
 227                                 find_shared_symref("HEAD", name);
 228                         if (wt) {
 229                                 error(_("Cannot delete branch '%s' "
 230                                         "checked out at '%s'"),
 231                                       bname.buf, wt->path);
 232                                 ret = 1;
 233                                 continue;
 234                         }
 235                 }
 236
 237                 target = resolve_refdup(name,
 238                                         RESOLVE_REF_READING
 239                                         | RESOLVE_REF_NO_RECURSE
 240                                         | RESOLVE_REF_ALLOW_BAD_NAME,
 241                                         sha1, &flags);
 242                 if (!target) {
 243                         error(remote_branch
 244                               ? _("remote-tracking branch '%s' not found.")
 245                               : _("branch '%s' not found."), bname.buf);
 246                         ret = 1;
 247                         continue;
 248                 }
 249
 250                 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
 251                     check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
 252                                         force)) {
 253                         ret = 1;
 254                         goto next;
 255                 }
 256
 257                 if (delete_ref(name, is_null_sha1(sha1) ? NULL : sha1,
 258                                REF_NODEREF)) {
 259                         error(remote_branch
 260                               ? _("Error deleting remote-tracking branch '%s'")
 261                               : _("Error deleting branch '%s'"),
 262                               bname.buf);
 263                         ret = 1;
 264                         goto next;
 265                 }
 266                 if (!quiet) {
 267                         printf(remote_branch
 268                                ? _("Deleted remote-tracking branch %s (was %s).\n")
 269                                : _("Deleted branch %s (was %s).\n"),
 270                                bname.buf,
 271                                (flags & REF_ISBROKEN) ? "broken"
 272                                : (flags & REF_ISSYMREF) ? target
 273                                : find_unique_abbrev(sha1, DEFAULT_ABBREV));
 274                 }
 275                 delete_branch_config(bname.buf);
 276
 277         next:
 278                 free(target);
 279         }
 280
 281         free(name);
 282
 283         return(ret);
 284 }
 285
 286 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
 287                 int show_upstream_ref)
 288 {
 289         int ours, theirs;
 290         char *ref = NULL;
 291         struct branch *branch = branch_get(branch_name);
 292         const char *upstream;
 293         struct strbuf fancy = STRBUF_INIT;
 294         int upstream_is_gone = 0;
 295         int added_decoration = 1;
 296
 297         if (stat_tracking_info(branch, &ours, &theirs, &upstream) < 0) {
 298                 if (!upstream)
 299                         return;
 300                 upstream_is_gone = 1;
 301         }
 302
 303         if (show_upstream_ref) {
 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 (upstream_is_gone) {
 314                 if (show_upstream_ref)
 315                         strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
 316                 else
 317                         added_decoration = 0;
 318         } else if (!ours && !theirs) {
 319                 if (show_upstream_ref)
 320                         strbuf_addf(stat, _("[%s]"), fancy.buf);
 321                 else
 322                         added_decoration = 0;
 323         } else if (!ours) {
 324                 if (show_upstream_ref)
 325                         strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
 326                 else
 327                         strbuf_addf(stat, _("[behind %d]"), theirs);
 328
 329         } else if (!theirs) {
 330                 if (show_upstream_ref)
 331                         strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
 332                 else
 333                         strbuf_addf(stat, _("[ahead %d]"), ours);
 334         } else {
 335                 if (show_upstream_ref)
 336                         strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
 337                                     fancy.buf, ours, theirs);
 338                 else
 339                         strbuf_addf(stat, _("[ahead %d, behind %d]"),
 340                                     ours, theirs);
 341         }
 342         strbuf_release(&fancy);
 343         if (added_decoration)
 344                 strbuf_addch(stat, ' ');
 345         free(ref);
 346 }
 347
 348 static void add_verbose_info(struct strbuf *out, struct ref_array_item *item,
 349                              struct ref_filter *filter, const char *refname)
 350 {
 351         struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
 352         const char *sub = _(" **** invalid ref ****");
 353         struct commit *commit = item->commit;
 354
 355         if (!parse_commit(commit)) {
 356                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
 357                 sub = subject.buf;
 358         }
 359
 360         if (item->kind == FILTER_REFS_BRANCHES)
 361                 fill_tracking_info(&stat, refname, filter->verbose > 1);
 362
 363         strbuf_addf(out, " %s %s%s",
 364                 find_unique_abbrev(item->commit->object.oid.hash, filter->abbrev),
 365                 stat.buf, sub);
 366         strbuf_release(&stat);
 367         strbuf_release(&subject);
 368 }
 369
 370 static char *get_head_description(void)
 371 {
 372         struct strbuf desc = STRBUF_INIT;
 373         struct wt_status_state state;
 374         memset(&state, 0, sizeof(state));
 375         wt_status_get_state(&state, 1);
 376         if (state.rebase_in_progress ||
 377             state.rebase_interactive_in_progress)
 378                 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
 379                             state.branch);
 380         else if (state.bisect_in_progress)
 381                 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
 382                             state.branch);
 383         else if (state.detached_from) {
 384                 if (state.detached_at)
 385                         /* TRANSLATORS: make sure this matches
 386                            "HEAD detached at " in wt-status.c */
 387                         strbuf_addf(&desc, _("(HEAD detached at %s)"),
 388                                 state.detached_from);
 389                 else
 390                         /* TRANSLATORS: make sure this matches
 391                            "HEAD detached from " in wt-status.c */
 392                         strbuf_addf(&desc, _("(HEAD detached from %s)"),
 393                                 state.detached_from);
 394         }
 395         else
 396                 strbuf_addstr(&desc, _("(no branch)"));
 397         free(state.branch);
 398         free(state.onto);
 399         free(state.detached_from);
 400         return strbuf_detach(&desc, NULL);
 401 }
 402
 403 static void format_and_print_ref_item(struct ref_array_item *item, int maxwidth,
 404                                       struct ref_filter *filter, const char *remote_prefix)
 405 {
 406         char c;
 407         int current = 0;
 408         int color;
 409         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
 410         const char *prefix_to_show = "";
 411         const char *prefix_to_skip = NULL;
 412         const char *desc = item->refname;
 413         char *to_free = NULL;
 414
 415         switch (item->kind) {
 416         case FILTER_REFS_BRANCHES:
 417                 prefix_to_skip = "refs/heads/";
 418                 skip_prefix(desc, prefix_to_skip, &desc);
 419                 if (!filter->detached && !strcmp(desc, head))
 420                         current = 1;
 421                 else
 422                         color = BRANCH_COLOR_LOCAL;
 423                 break;
 424         case FILTER_REFS_REMOTES:
 425                 prefix_to_skip = "refs/remotes/";
 426                 skip_prefix(desc, prefix_to_skip, &desc);
 427                 color = BRANCH_COLOR_REMOTE;
 428                 prefix_to_show = remote_prefix;
 429                 break;
 430         case FILTER_REFS_DETACHED_HEAD:
 431                 desc = to_free = get_head_description();
 432                 current = 1;
 433                 break;
 434         default:
 435                 color = BRANCH_COLOR_PLAIN;
 436                 break;
 437         }
 438
 439         c = ' ';
 440         if (current) {
 441                 c = '*';
 442                 color = BRANCH_COLOR_CURRENT;
 443         }
 444
 445         strbuf_addf(&name, "%s%s", prefix_to_show, desc);
 446         if (filter->verbose) {
 447                 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
 448                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
 449                             maxwidth + utf8_compensation, name.buf,
 450                             branch_get_color(BRANCH_COLOR_RESET));
 451         } else
 452                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
 453                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
 454
 455         if (item->symref) {
 456                 const char *symref = item->symref;
 457                 if (prefix_to_skip)
 458                         skip_prefix(symref, prefix_to_skip, &symref);
 459                 strbuf_addf(&out, " -> %s", symref);
 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         ref_array_sort(sorting, &array);
 519
 520         for (i = 0; i < array.nr; i++)
 521                 format_and_print_ref_item(array.items[i], maxwidth, filter, remote_prefix);
 522
 523         ref_array_clear(&array);
 524 }
 525
 526 static void reject_rebase_or_bisect_branch(const char *target)
 527 {
 528         struct worktree **worktrees = get_worktrees(0);
 529         int i;
 530
 531         for (i = 0; worktrees[i]; i++) {
 532                 struct worktree *wt = worktrees[i];
 533
 534                 if (!wt->is_detached)
 535                         continue;
 536
 537                 if (is_worktree_being_rebased(wt, target))
 538                         die(_("Branch %s is being rebased at %s"),
 539                             target, wt->path);
 540
 541                 if (is_worktree_being_bisected(wt, target))
 542                         die(_("Branch %s is being bisected at %s"),
 543                             target, wt->path);
 544         }
 545
 546         free_worktrees(worktrees);
 547 }
 548
 549 static void rename_branch(const char *oldname, const char *newname, int force)
 550 {
 551         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 552         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 553         int recovery = 0;
 554         int clobber_head_ok;
 555
 556         if (!oldname)
 557                 die(_("cannot rename the current branch while not on any."));
 558
 559         if (strbuf_check_branch_ref(&oldref, oldname)) {
 560                 /*
 561                  * Bad name --- this could be an attempt to rename a
 562                  * ref that we used to allow to be created by accident.
 563                  */
 564                 if (ref_exists(oldref.buf))
 565                         recovery = 1;
 566                 else
 567                         die(_("Invalid branch name: '%s'"), oldname);
 568         }
 569
 570         /*
 571          * A command like "git branch -M currentbranch currentbranch" cannot
 572          * cause the worktree to become inconsistent with HEAD, so allow it.
 573          */
 574         clobber_head_ok = !strcmp(oldname, newname);
 575
 576         validate_new_branchname(newname, &newref, force, clobber_head_ok);
 577
 578         reject_rebase_or_bisect_branch(oldref.buf);
 579
 580         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 581                  oldref.buf, newref.buf);
 582
 583         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
 584                 die(_("Branch rename failed"));
 585         strbuf_release(&logmsg);
 586
 587         if (recovery)
 588                 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
 589
 590         if (replace_each_worktree_head_symref(oldref.buf, newref.buf))
 591                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 592
 593         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 594         strbuf_release(&oldref);
 595         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 596         strbuf_release(&newref);
 597         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 598                 die(_("Branch is renamed, but update of config-file failed"));
 599         strbuf_release(&oldsection);
 600         strbuf_release(&newsection);
 601 }
 602
 603 static const char edit_description[] = "BRANCH_DESCRIPTION";
 604
 605 static int edit_branch_description(const char *branch_name)
 606 {
 607         struct strbuf buf = STRBUF_INIT;
 608         struct strbuf name = STRBUF_INIT;
 609
 610         read_branch_desc(&buf, branch_name);
 611         if (!buf.len || buf.buf[buf.len-1] != '\n')
 612                 strbuf_addch(&buf, '\n');
 613         strbuf_commented_addf(&buf,
 614                     _("Please edit the description for the branch\n"
 615                       "  %s\n"
 616                       "Lines starting with '%c' will be stripped.\n"),
 617                     branch_name, comment_line_char);
 618         write_file_buf(git_path(edit_description), buf.buf, buf.len);
 619         strbuf_reset(&buf);
 620         if (launch_editor(git_path(edit_description), &buf, NULL)) {
 621                 strbuf_release(&buf);
 622                 return -1;
 623         }
 624         strbuf_stripspace(&buf, 1);
 625
 626         strbuf_addf(&name, "branch.%s.description", branch_name);
 627         git_config_set(name.buf, buf.len ? buf.buf : NULL);
 628         strbuf_release(&name);
 629         strbuf_release(&buf);
 630
 631         return 0;
 632 }
 633
 634 int cmd_branch(int argc, const char **argv, const char *prefix)
 635 {
 636         int delete = 0, rename = 0, force = 0, list = 0;
 637         int reflog = 0, edit_description = 0;
 638         int quiet = 0, unset_upstream = 0;
 639         const char *new_upstream = NULL;
 640         enum branch_track track;
 641         struct ref_filter filter;
 642         int icase = 0;
 643         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 644
 645         struct option options[] = {
 646                 OPT_GROUP(N_("Generic options")),
 647                 OPT__VERBOSE(&filter.verbose,
 648                         N_("show hash and subject, give twice for upstream branch")),
 649                 OPT__QUIET(&quiet, N_("suppress informational messages")),
 650                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
 651                         BRANCH_TRACK_EXPLICIT),
 652                 OPT_SET_INT( 0, "set-upstream",  &track, N_("change upstream info"),
 653                         BRANCH_TRACK_OVERRIDE),
 654                 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
 655                 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
 656                 OPT__COLOR(&branch_use_color, N_("use colored output")),
 657                 OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
 658                         FILTER_REFS_REMOTES),
 659                 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
 660                 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
 661                 OPT__ABBREV(&filter.abbrev),
 662
 663                 OPT_GROUP(N_("Specific git-branch actions:")),
 664                 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
 665                         FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
 666                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
 667                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
 668                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
 669                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
 670                 OPT_BOOL(0, "list", &list, N_("list branch names")),
 671                 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
 672                 OPT_BOOL(0, "edit-description", &edit_description,
 673                          N_("edit the description for the branch")),
 674                 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
 675                 OPT_MERGED(&filter, N_("print only branches that are merged")),
 676                 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
 677                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
 678                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 679                              N_("field name to sort on"), &parse_opt_ref_sorting),
 680                 {
 681                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 682                         N_("print only branches of the object"), 0, parse_opt_object_name
 683                 },
 684                 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
 685                 OPT_END(),
 686         };
 687
 688         memset(&filter, 0, sizeof(filter));
 689         filter.kind = FILTER_REFS_BRANCHES;
 690         filter.abbrev = -1;
 691
 692         if (argc == 2 && !strcmp(argv[1], "-h"))
 693                 usage_with_options(builtin_branch_usage, options);
 694
 695         git_config(git_branch_config, NULL);
 696
 697         track = git_branch_track;
 698
 699         head = resolve_refdup("HEAD", 0, head_sha1, NULL);
 700         if (!head)
 701                 die(_("Failed to resolve HEAD as a valid ref."));
 702         if (!strcmp(head, "HEAD"))
 703                 filter.detached = 1;
 704         else if (!skip_prefix(head, "refs/heads/", &head))
 705                 die(_("HEAD not found below refs/heads!"));
 706
 707         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 708                              0);
 709
 710         if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
 711                 list = 1;
 712
 713         if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr)
 714                 list = 1;
 715
 716         if (!!delete + !!rename + !!new_upstream +
 717             list + unset_upstream > 1)
 718                 usage_with_options(builtin_branch_usage, options);
 719
 720         if (filter.abbrev == -1)
 721                 filter.abbrev = DEFAULT_ABBREV;
 722         filter.ignore_case = icase;
 723
 724         finalize_colopts(&colopts, -1);
 725         if (filter.verbose) {
 726                 if (explicitly_enable_column(colopts))
 727                         die(_("--column and --verbose are incompatible"));
 728                 colopts = 0;
 729         }
 730
 731         if (force) {
 732                 delete *= 2;
 733                 rename *= 2;
 734         }
 735
 736         if (delete) {
 737                 if (!argc)
 738                         die(_("branch name required"));
 739                 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
 740         } else if (list) {
 741                 /*  git branch --local also shows HEAD when it is detached */
 742                 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
 743                         filter.kind |= FILTER_REFS_DETACHED_HEAD;
 744                 filter.name_patterns = argv;
 745                 /*
 746                  * If no sorting parameter is given then we default to sorting
 747                  * by 'refname'. This would give us an alphabetically sorted
 748                  * array with the 'HEAD' ref at the beginning followed by
 749                  * local branches 'refs/heads/...' and finally remote-tacking
 750                  * branches 'refs/remotes/...'.
 751                  */
 752                 if (!sorting)
 753                         sorting = ref_default_sorting();
 754                 sorting->ignore_case = icase;
 755                 print_ref_list(&filter, sorting);
 756                 print_columns(&output, colopts, NULL);
 757                 string_list_clear(&output, 0);
 758                 return 0;
 759         }
 760         else if (edit_description) {
 761                 const char *branch_name;
 762                 struct strbuf branch_ref = STRBUF_INIT;
 763
 764                 if (!argc) {
 765                         if (filter.detached)
 766                                 die(_("Cannot give description to detached HEAD"));
 767                         branch_name = head;
 768                 } else if (argc == 1)
 769                         branch_name = argv[0];
 770                 else
 771                         die(_("cannot edit description of more than one branch"));
 772
 773                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 774                 if (!ref_exists(branch_ref.buf)) {
 775                         strbuf_release(&branch_ref);
 776
 777                         if (!argc)
 778                                 return error(_("No commit on branch '%s' yet."),
 779                                              branch_name);
 780                         else
 781                                 return error(_("No branch named '%s'."),
 782                                              branch_name);
 783                 }
 784                 strbuf_release(&branch_ref);
 785
 786                 if (edit_branch_description(branch_name))
 787                         return 1;
 788         } else if (rename) {
 789                 if (!argc)
 790                         die(_("branch name required"));
 791                 else if (argc == 1)
 792                         rename_branch(head, argv[0], rename > 1);
 793                 else if (argc == 2)
 794                         rename_branch(argv[0], argv[1], rename > 1);
 795                 else
 796                         die(_("too many branches for a rename operation"));
 797         } else if (new_upstream) {
 798                 struct branch *branch = branch_get(argv[0]);
 799
 800                 if (argc > 1)
 801                         die(_("too many branches to set new upstream"));
 802
 803                 if (!branch) {
 804                         if (!argc || !strcmp(argv[0], "HEAD"))
 805                                 die(_("could not set upstream of HEAD to %s when "
 806                                       "it does not point to any branch."),
 807                                     new_upstream);
 808                         die(_("no such branch '%s'"), argv[0]);
 809                 }
 810
 811                 if (!ref_exists(branch->refname))
 812                         die(_("branch '%s' does not exist"), branch->name);
 813
 814                 /*
 815                  * create_branch takes care of setting up the tracking
 816                  * info and making sure new_upstream is correct
 817                  */
 818                 create_branch(branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
 819         } else if (unset_upstream) {
 820                 struct branch *branch = branch_get(argv[0]);
 821                 struct strbuf buf = STRBUF_INIT;
 822
 823                 if (argc > 1)
 824                         die(_("too many branches to unset upstream"));
 825
 826                 if (!branch) {
 827                         if (!argc || !strcmp(argv[0], "HEAD"))
 828                                 die(_("could not unset upstream of HEAD when "
 829                                       "it does not point to any branch."));
 830                         die(_("no such branch '%s'"), argv[0]);
 831                 }
 832
 833                 if (!branch_has_merge_config(branch))
 834                         die(_("Branch '%s' has no upstream information"), branch->name);
 835
 836                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
 837                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 838                 strbuf_reset(&buf);
 839                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
 840                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 841                 strbuf_release(&buf);
 842         } else if (argc > 0 && argc <= 2) {
 843                 struct branch *branch = branch_get(argv[0]);
 844                 int branch_existed = 0, remote_tracking = 0;
 845                 struct strbuf buf = STRBUF_INIT;
 846
 847                 if (!strcmp(argv[0], "HEAD"))
 848                         die(_("it does not make sense to create 'HEAD' manually"));
 849
 850                 if (!branch)
 851                         die(_("no such branch '%s'"), argv[0]);
 852
 853                 if (filter.kind != FILTER_REFS_BRANCHES)
 854                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 855
 856                 if (track == BRANCH_TRACK_OVERRIDE)
 857                         fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
 858
 859                 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
 860                 remote_tracking = ref_exists(buf.buf);
 861                 strbuf_release(&buf);
 862
 863                 branch_existed = ref_exists(branch->refname);
 864                 create_branch(argv[0], (argc == 2) ? argv[1] : head,
 865                               force, reflog, 0, quiet, track);
 866
 867                 /*
 868                  * We only show the instructions if the user gave us
 869                  * one branch which doesn't exist locally, but is the
 870                  * name of a remote-tracking branch.
 871                  */
 872                 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
 873                     !branch_existed && remote_tracking) {
 874                         fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
 875                         fprintf(stderr, "    git branch -d %s\n", branch->name);
 876                         fprintf(stderr, "    git branch --set-upstream-to %s\n", branch->name);
 877                 }
 878
 879         } else
 880                 usage_with_options(builtin_branch_usage, options);
 881
 882         return 0;
 883 }