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 "config.h"
  10 #include "color.h"
  11 #include "refs.h"
  12 #include "commit.h"
  13 #include "builtin.h"
  14 #include "remote.h"
  15 #include "parse-options.h"
  16 #include "branch.h"
  17 #include "diff.h"
  18 #include "revision.h"
  19 #include "string-list.h"
  20 #include "column.h"
  21 #include "utf8.h"
  22 #include "wt-status.h"
  23 #include "ref-filter.h"
  24 #include "worktree.h"
  25
  26 static const char * const builtin_branch_usage[] = {
  27         N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
  28         N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
  29         N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
  30         N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
  31         N_("git branch [<options>] (-c | -C) [<old-branch>] <new-branch>"),
  32         N_("git branch [<options>] [-r | -a] [--points-at]"),
  33         N_("git branch [<options>] [-r | -a] [--format]"),
  34         NULL
  35 };
  36
  37 static const char *head;
  38 static struct object_id head_oid;
  39
  40 static int branch_use_color = -1;
  41 static char branch_colors[][COLOR_MAXLEN] = {
  42         GIT_COLOR_RESET,
  43         GIT_COLOR_NORMAL,       /* PLAIN */
  44         GIT_COLOR_RED,          /* REMOTE */
  45         GIT_COLOR_NORMAL,       /* LOCAL */
  46         GIT_COLOR_GREEN,        /* CURRENT */
  47         GIT_COLOR_BLUE,         /* UPSTREAM */
  48 };
  49 enum color_branch {
  50         BRANCH_COLOR_RESET = 0,
  51         BRANCH_COLOR_PLAIN = 1,
  52         BRANCH_COLOR_REMOTE = 2,
  53         BRANCH_COLOR_LOCAL = 3,
  54         BRANCH_COLOR_CURRENT = 4,
  55         BRANCH_COLOR_UPSTREAM = 5
  56 };
  57
  58 static struct string_list output = STRING_LIST_INIT_DUP;
  59 static unsigned int colopts;
  60
  61 static int parse_branch_color_slot(const char *slot)
  62 {
  63         if (!strcasecmp(slot, "plain"))
  64                 return BRANCH_COLOR_PLAIN;
  65         if (!strcasecmp(slot, "reset"))
  66                 return BRANCH_COLOR_RESET;
  67         if (!strcasecmp(slot, "remote"))
  68                 return BRANCH_COLOR_REMOTE;
  69         if (!strcasecmp(slot, "local"))
  70                 return BRANCH_COLOR_LOCAL;
  71         if (!strcasecmp(slot, "current"))
  72                 return BRANCH_COLOR_CURRENT;
  73         if (!strcasecmp(slot, "upstream"))
  74                 return BRANCH_COLOR_UPSTREAM;
  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_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                 struct object_id oid;
 124
 125                 if (upstream &&
 126                     (reference_name = reference_name_to_free =
 127                      resolve_refdup(upstream, RESOLVE_REF_READING,
 128                                     oid.hash, NULL)) != NULL)
 129                         reference_rev = lookup_commit_reference(&oid);
 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 struct object_id *oid, struct commit *head_rev,
 160                                int kinds, int force)
 161 {
 162         struct commit *rev = lookup_commit_reference(oid);
 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         struct object_id oid;
 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         unsigned allowed_interpret;
 197
 198         switch (kinds) {
 199         case FILTER_REFS_REMOTES:
 200                 fmt = "refs/remotes/%s";
 201                 /* For subsequent UI messages */
 202                 remote_branch = 1;
 203                 allowed_interpret = INTERPRET_BRANCH_REMOTE;
 204
 205                 force = 1;
 206                 break;
 207         case FILTER_REFS_BRANCHES:
 208                 fmt = "refs/heads/%s";
 209                 allowed_interpret = INTERPRET_BRANCH_LOCAL;
 210                 break;
 211         default:
 212                 die(_("cannot use -a with -d"));
 213         }
 214
 215         if (!force) {
 216                 head_rev = lookup_commit_reference(&head_oid);
 217                 if (!head_rev)
 218                         die(_("Couldn't look up commit object for HEAD"));
 219         }
 220         for (i = 0; i < argc; i++, strbuf_release(&bname)) {
 221                 char *target = NULL;
 222                 int flags = 0;
 223
 224                 strbuf_branchname(&bname, argv[i], allowed_interpret);
 225                 free(name);
 226                 name = mkpathdup(fmt, bname.buf);
 227
 228                 if (kinds == FILTER_REFS_BRANCHES) {
 229                         const struct worktree *wt =
 230                                 find_shared_symref("HEAD", name);
 231                         if (wt) {
 232                                 error(_("Cannot delete branch '%s' "
 233                                         "checked out at '%s'"),
 234                                       bname.buf, wt->path);
 235                                 ret = 1;
 236                                 continue;
 237                         }
 238                 }
 239
 240                 target = resolve_refdup(name,
 241                                         RESOLVE_REF_READING
 242                                         | RESOLVE_REF_NO_RECURSE
 243                                         | RESOLVE_REF_ALLOW_BAD_NAME,
 244                                         oid.hash, &flags);
 245                 if (!target) {
 246                         error(remote_branch
 247                               ? _("remote-tracking branch '%s' not found.")
 248                               : _("branch '%s' not found."), bname.buf);
 249                         ret = 1;
 250                         continue;
 251                 }
 252
 253                 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
 254                     check_branch_commit(bname.buf, name, &oid, head_rev, kinds,
 255                                         force)) {
 256                         ret = 1;
 257                         goto next;
 258                 }
 259
 260                 if (delete_ref(NULL, name, is_null_oid(&oid) ? NULL : oid.hash,
 261                                REF_NODEREF)) {
 262                         error(remote_branch
 263                               ? _("Error deleting remote-tracking branch '%s'")
 264                               : _("Error deleting branch '%s'"),
 265                               bname.buf);
 266                         ret = 1;
 267                         goto next;
 268                 }
 269                 if (!quiet) {
 270                         printf(remote_branch
 271                                ? _("Deleted remote-tracking branch %s (was %s).\n")
 272                                : _("Deleted branch %s (was %s).\n"),
 273                                bname.buf,
 274                                (flags & REF_ISBROKEN) ? "broken"
 275                                : (flags & REF_ISSYMREF) ? target
 276                                : find_unique_abbrev(oid.hash, DEFAULT_ABBREV));
 277                 }
 278                 delete_branch_config(bname.buf);
 279
 280         next:
 281                 free(target);
 282         }
 283
 284         free(name);
 285
 286         return(ret);
 287 }
 288
 289 static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
 290 {
 291         int i, max = 0;
 292         for (i = 0; i < refs->nr; i++) {
 293                 struct ref_array_item *it = refs->items[i];
 294                 const char *desc = it->refname;
 295                 int w;
 296
 297                 skip_prefix(it->refname, "refs/heads/", &desc);
 298                 skip_prefix(it->refname, "refs/remotes/", &desc);
 299                 if (it->kind == FILTER_REFS_DETACHED_HEAD) {
 300                         char *head_desc = get_head_description();
 301                         w = utf8_strwidth(head_desc);
 302                         free(head_desc);
 303                 } else
 304                         w = utf8_strwidth(desc);
 305
 306                 if (it->kind == FILTER_REFS_REMOTES)
 307                         w += remote_bonus;
 308                 if (w > max)
 309                         max = w;
 310         }
 311         return max;
 312 }
 313
 314 static const char *quote_literal_for_format(const char *s)
 315 {
 316         static struct strbuf buf = STRBUF_INIT;
 317
 318         strbuf_reset(&buf);
 319         while (*s) {
 320                 const char *ep = strchrnul(s, '%');
 321                 if (s < ep)
 322                         strbuf_add(&buf, s, ep - s);
 323                 if (*ep == '%') {
 324                         strbuf_addstr(&buf, "%%");
 325                         s = ep + 1;
 326                 } else {
 327                         s = ep;
 328                 }
 329         }
 330         return buf.buf;
 331 }
 332
 333 static char *build_format(struct ref_filter *filter, int maxwidth, const char *remote_prefix)
 334 {
 335         struct strbuf fmt = STRBUF_INIT;
 336         struct strbuf local = STRBUF_INIT;
 337         struct strbuf remote = STRBUF_INIT;
 338
 339         strbuf_addf(&local, "%%(if)%%(HEAD)%%(then)* %s%%(else)  %s%%(end)",
 340                     branch_get_color(BRANCH_COLOR_CURRENT),
 341                     branch_get_color(BRANCH_COLOR_LOCAL));
 342         strbuf_addf(&remote, "  %s",
 343                     branch_get_color(BRANCH_COLOR_REMOTE));
 344
 345         if (filter->verbose) {
 346                 struct strbuf obname = STRBUF_INIT;
 347
 348                 if (filter->abbrev < 0)
 349                         strbuf_addf(&obname, "%%(objectname:short)");
 350                 else if (!filter->abbrev)
 351                         strbuf_addf(&obname, "%%(objectname)");
 352                 else
 353                         strbuf_addf(&obname, "%%(objectname:short=%d)", filter->abbrev);
 354
 355                 strbuf_addf(&local, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth);
 356                 strbuf_addstr(&local, branch_get_color(BRANCH_COLOR_RESET));
 357                 strbuf_addf(&local, " %s ", obname.buf);
 358
 359                 if (filter->verbose > 1)
 360                         strbuf_addf(&local, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
 361                                     "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
 362                                     branch_get_color(BRANCH_COLOR_UPSTREAM), branch_get_color(BRANCH_COLOR_RESET));
 363                 else
 364                         strbuf_addf(&local, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
 365
 366                 strbuf_addf(&remote, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
 367                             "%%(if)%%(symref)%%(then) -> %%(symref:short)"
 368                             "%%(else) %s %%(contents:subject)%%(end)",
 369                             maxwidth, quote_literal_for_format(remote_prefix),
 370                             branch_get_color(BRANCH_COLOR_RESET), obname.buf);
 371                 strbuf_release(&obname);
 372         } else {
 373                 strbuf_addf(&local, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
 374                             branch_get_color(BRANCH_COLOR_RESET));
 375                 strbuf_addf(&remote, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
 376                             quote_literal_for_format(remote_prefix),
 377                             branch_get_color(BRANCH_COLOR_RESET));
 378         }
 379
 380         strbuf_addf(&fmt, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local.buf, remote.buf);
 381
 382         strbuf_release(&local);
 383         strbuf_release(&remote);
 384         return strbuf_detach(&fmt, NULL);
 385 }
 386
 387 static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting, struct ref_format *format)
 388 {
 389         int i;
 390         struct ref_array array;
 391         int maxwidth = 0;
 392         const char *remote_prefix = "";
 393         struct strbuf out = STRBUF_INIT;
 394         char *to_free = NULL;
 395
 396         /*
 397          * If we are listing more than just remote branches,
 398          * then remote branches will have a "remotes/" prefix.
 399          * We need to account for this in the width.
 400          */
 401         if (filter->kind != FILTER_REFS_REMOTES)
 402                 remote_prefix = "remotes/";
 403
 404         memset(&array, 0, sizeof(array));
 405
 406         filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
 407
 408         if (filter->verbose)
 409                 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
 410
 411         if (!format->format)
 412                 format->format = to_free = build_format(filter, maxwidth, remote_prefix);
 413         format->use_color = branch_use_color;
 414
 415         if (verify_ref_format(format))
 416                 die(_("unable to parse format string"));
 417
 418         ref_array_sort(sorting, &array);
 419
 420         for (i = 0; i < array.nr; i++) {
 421                 format_ref_array_item(array.items[i], format, &out);
 422                 if (column_active(colopts)) {
 423                         assert(!filter->verbose && "--column and --verbose are incompatible");
 424                          /* format to a string_list to let print_columns() do its job */
 425                         string_list_append(&output, out.buf);
 426                 } else {
 427                         fwrite(out.buf, 1, out.len, stdout);
 428                         putchar('\n');
 429                 }
 430                 strbuf_release(&out);
 431         }
 432
 433         ref_array_clear(&array);
 434         free(to_free);
 435 }
 436
 437 static void reject_rebase_or_bisect_branch(const char *target)
 438 {
 439         struct worktree **worktrees = get_worktrees(0);
 440         int i;
 441
 442         for (i = 0; worktrees[i]; i++) {
 443                 struct worktree *wt = worktrees[i];
 444
 445                 if (!wt->is_detached)
 446                         continue;
 447
 448                 if (is_worktree_being_rebased(wt, target))
 449                         die(_("Branch %s is being rebased at %s"),
 450                             target, wt->path);
 451
 452                 if (is_worktree_being_bisected(wt, target))
 453                         die(_("Branch %s is being bisected at %s"),
 454                             target, wt->path);
 455         }
 456
 457         free_worktrees(worktrees);
 458 }
 459
 460 static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
 461 {
 462         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 463         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 464         int recovery = 0;
 465         int clobber_head_ok;
 466
 467         if (!oldname) {
 468                 if (copy)
 469                         die(_("cannot copy the current branch while not on any."));
 470                 else
 471                         die(_("cannot rename the current branch while not on any."));
 472         }
 473
 474         if (strbuf_check_branch_ref(&oldref, oldname)) {
 475                 /*
 476                  * Bad name --- this could be an attempt to rename a
 477                  * ref that we used to allow to be created by accident.
 478                  */
 479                 if (ref_exists(oldref.buf))
 480                         recovery = 1;
 481                 else
 482                         die(_("Invalid branch name: '%s'"), oldname);
 483         }
 484
 485         /*
 486          * A command like "git branch -M currentbranch currentbranch" cannot
 487          * cause the worktree to become inconsistent with HEAD, so allow it.
 488          */
 489         clobber_head_ok = !strcmp(oldname, newname);
 490
 491         validate_new_branchname(newname, &newref, force, clobber_head_ok);
 492
 493         reject_rebase_or_bisect_branch(oldref.buf);
 494
 495         if (copy)
 496                 strbuf_addf(&logmsg, "Branch: copied %s to %s",
 497                             oldref.buf, newref.buf);
 498         else
 499                 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 500                             oldref.buf, newref.buf);
 501
 502         if (!copy && rename_ref(oldref.buf, newref.buf, logmsg.buf))
 503                 die(_("Branch rename failed"));
 504         if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
 505                 die(_("Branch copy failed"));
 506
 507         if (recovery) {
 508                 if (copy)
 509                         warning(_("Copied a misnamed branch '%s' away"),
 510                                 oldref.buf + 11);
 511                 else
 512                         warning(_("Renamed a misnamed branch '%s' away"),
 513                                 oldref.buf + 11);
 514         }
 515
 516         if (!copy &&
 517             replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
 518                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 519
 520         strbuf_release(&logmsg);
 521
 522         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 523         strbuf_release(&oldref);
 524         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 525         strbuf_release(&newref);
 526         if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 527                 die(_("Branch is renamed, but update of config-file failed"));
 528         if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
 529                 die(_("Branch is copied, but update of config-file failed"));
 530         strbuf_release(&oldsection);
 531         strbuf_release(&newsection);
 532 }
 533
 534 static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
 535
 536 static int edit_branch_description(const char *branch_name)
 537 {
 538         struct strbuf buf = STRBUF_INIT;
 539         struct strbuf name = STRBUF_INIT;
 540
 541         read_branch_desc(&buf, branch_name);
 542         if (!buf.len || buf.buf[buf.len-1] != '\n')
 543                 strbuf_addch(&buf, '\n');
 544         strbuf_commented_addf(&buf,
 545                     _("Please edit the description for the branch\n"
 546                       "  %s\n"
 547                       "Lines starting with '%c' will be stripped.\n"),
 548                     branch_name, comment_line_char);
 549         write_file_buf(edit_description(), buf.buf, buf.len);
 550         strbuf_reset(&buf);
 551         if (launch_editor(edit_description(), &buf, NULL)) {
 552                 strbuf_release(&buf);
 553                 return -1;
 554         }
 555         strbuf_stripspace(&buf, 1);
 556
 557         strbuf_addf(&name, "branch.%s.description", branch_name);
 558         git_config_set(name.buf, buf.len ? buf.buf : NULL);
 559         strbuf_release(&name);
 560         strbuf_release(&buf);
 561
 562         return 0;
 563 }
 564
 565 int cmd_branch(int argc, const char **argv, const char *prefix)
 566 {
 567         int delete = 0, rename = 0, copy = 0, force = 0, list = 0;
 568         int reflog = 0, edit_description = 0;
 569         int quiet = 0, unset_upstream = 0;
 570         const char *new_upstream = NULL;
 571         enum branch_track track;
 572         struct ref_filter filter;
 573         int icase = 0;
 574         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 575         struct ref_format format = REF_FORMAT_INIT;
 576
 577         struct option options[] = {
 578                 OPT_GROUP(N_("Generic options")),
 579                 OPT__VERBOSE(&filter.verbose,
 580                         N_("show hash and subject, give twice for upstream branch")),
 581                 OPT__QUIET(&quiet, N_("suppress informational messages")),
 582                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
 583                         BRANCH_TRACK_EXPLICIT),
 584                 { OPTION_SET_INT, 0, "set-upstream", &track, NULL, N_("do not use"),
 585                         PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, BRANCH_TRACK_OVERRIDE },
 586                 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
 587                 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
 588                 OPT__COLOR(&branch_use_color, N_("use colored output")),
 589                 OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
 590                         FILTER_REFS_REMOTES),
 591                 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
 592                 OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
 593                 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
 594                 OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
 595                 OPT__ABBREV(&filter.abbrev),
 596
 597                 OPT_GROUP(N_("Specific git-branch actions:")),
 598                 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
 599                         FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
 600                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
 601                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
 602                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
 603                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
 604                 OPT_BIT('c', "copy", &copy, N_("copy a branch and its reflog"), 1),
 605                 OPT_BIT('C', NULL, &copy, N_("copy a branch, even if target exists"), 2),
 606                 OPT_BOOL(0, "list", &list, N_("list branch names")),
 607                 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
 608                 OPT_BOOL(0, "edit-description", &edit_description,
 609                          N_("edit the description for the branch")),
 610                 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
 611                 OPT_MERGED(&filter, N_("print only branches that are merged")),
 612                 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
 613                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
 614                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 615                              N_("field name to sort on"), &parse_opt_ref_sorting),
 616                 {
 617                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 618                         N_("print only branches of the object"), 0, parse_opt_object_name
 619                 },
 620                 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
 621                 OPT_STRING(  0 , "format", &format.format, N_("format"), N_("format to use for the output")),
 622                 OPT_END(),
 623         };
 624
 625         setup_ref_filter_porcelain_msg();
 626
 627         memset(&filter, 0, sizeof(filter));
 628         filter.kind = FILTER_REFS_BRANCHES;
 629         filter.abbrev = -1;
 630
 631         if (argc == 2 && !strcmp(argv[1], "-h"))
 632                 usage_with_options(builtin_branch_usage, options);
 633
 634         git_config(git_branch_config, NULL);
 635
 636         track = git_branch_track;
 637
 638         head = resolve_refdup("HEAD", 0, head_oid.hash, NULL);
 639         if (!head)
 640                 die(_("Failed to resolve HEAD as a valid ref."));
 641         if (!strcmp(head, "HEAD"))
 642                 filter.detached = 1;
 643         else if (!skip_prefix(head, "refs/heads/", &head))
 644                 die(_("HEAD not found below refs/heads!"));
 645
 646         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 647                              0);
 648
 649         if (!delete && !rename && !copy && !edit_description && !new_upstream && !unset_upstream && argc == 0)
 650                 list = 1;
 651
 652         if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr ||
 653             filter.no_commit)
 654                 list = 1;
 655
 656         if (!!delete + !!rename + !!copy + !!new_upstream +
 657             list + unset_upstream > 1)
 658                 usage_with_options(builtin_branch_usage, options);
 659
 660         if (filter.abbrev == -1)
 661                 filter.abbrev = DEFAULT_ABBREV;
 662         filter.ignore_case = icase;
 663
 664         finalize_colopts(&colopts, -1);
 665         if (filter.verbose) {
 666                 if (explicitly_enable_column(colopts))
 667                         die(_("--column and --verbose are incompatible"));
 668                 colopts = 0;
 669         }
 670
 671         if (force) {
 672                 delete *= 2;
 673                 rename *= 2;
 674                 copy *= 2;
 675         }
 676
 677         if (delete) {
 678                 if (!argc)
 679                         die(_("branch name required"));
 680                 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
 681         } else if (list) {
 682                 /*  git branch --local also shows HEAD when it is detached */
 683                 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
 684                         filter.kind |= FILTER_REFS_DETACHED_HEAD;
 685                 filter.name_patterns = argv;
 686                 /*
 687                  * If no sorting parameter is given then we default to sorting
 688                  * by 'refname'. This would give us an alphabetically sorted
 689                  * array with the 'HEAD' ref at the beginning followed by
 690                  * local branches 'refs/heads/...' and finally remote-tacking
 691                  * branches 'refs/remotes/...'.
 692                  */
 693                 if (!sorting)
 694                         sorting = ref_default_sorting();
 695                 sorting->ignore_case = icase;
 696                 print_ref_list(&filter, sorting, &format);
 697                 print_columns(&output, colopts, NULL);
 698                 string_list_clear(&output, 0);
 699                 return 0;
 700         }
 701         else if (edit_description) {
 702                 const char *branch_name;
 703                 struct strbuf branch_ref = STRBUF_INIT;
 704
 705                 if (!argc) {
 706                         if (filter.detached)
 707                                 die(_("Cannot give description to detached HEAD"));
 708                         branch_name = head;
 709                 } else if (argc == 1)
 710                         branch_name = argv[0];
 711                 else
 712                         die(_("cannot edit description of more than one branch"));
 713
 714                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 715                 if (!ref_exists(branch_ref.buf)) {
 716                         strbuf_release(&branch_ref);
 717
 718                         if (!argc)
 719                                 return error(_("No commit on branch '%s' yet."),
 720                                              branch_name);
 721                         else
 722                                 return error(_("No branch named '%s'."),
 723                                              branch_name);
 724                 }
 725                 strbuf_release(&branch_ref);
 726
 727                 if (edit_branch_description(branch_name))
 728                         return 1;
 729         } else if (copy) {
 730                 if (!argc)
 731                         die(_("branch name required"));
 732                 else if (argc == 1)
 733                         copy_or_rename_branch(head, argv[0], 1, copy > 1);
 734                 else if (argc == 2)
 735                         copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
 736                 else
 737                         die(_("too many branches for a copy operation"));
 738         } else if (rename) {
 739                 if (!argc)
 740                         die(_("branch name required"));
 741                 else if (argc == 1)
 742                         copy_or_rename_branch(head, argv[0], 0, rename > 1);
 743                 else if (argc == 2)
 744                         copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
 745                 else
 746                         die(_("too many branches for a rename operation"));
 747         } else if (new_upstream) {
 748                 struct branch *branch = branch_get(argv[0]);
 749
 750                 if (argc > 1)
 751                         die(_("too many branches to set new upstream"));
 752
 753                 if (!branch) {
 754                         if (!argc || !strcmp(argv[0], "HEAD"))
 755                                 die(_("could not set upstream of HEAD to %s when "
 756                                       "it does not point to any branch."),
 757                                     new_upstream);
 758                         die(_("no such branch '%s'"), argv[0]);
 759                 }
 760
 761                 if (!ref_exists(branch->refname))
 762                         die(_("branch '%s' does not exist"), branch->name);
 763
 764                 /*
 765                  * create_branch takes care of setting up the tracking
 766                  * info and making sure new_upstream is correct
 767                  */
 768                 create_branch(branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
 769         } else if (unset_upstream) {
 770                 struct branch *branch = branch_get(argv[0]);
 771                 struct strbuf buf = STRBUF_INIT;
 772
 773                 if (argc > 1)
 774                         die(_("too many branches to unset upstream"));
 775
 776                 if (!branch) {
 777                         if (!argc || !strcmp(argv[0], "HEAD"))
 778                                 die(_("could not unset upstream of HEAD when "
 779                                       "it does not point to any branch."));
 780                         die(_("no such branch '%s'"), argv[0]);
 781                 }
 782
 783                 if (!branch_has_merge_config(branch))
 784                         die(_("Branch '%s' has no upstream information"), branch->name);
 785
 786                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
 787                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 788                 strbuf_reset(&buf);
 789                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
 790                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
 791                 strbuf_release(&buf);
 792         } else if (argc > 0 && argc <= 2) {
 793                 struct branch *branch = branch_get(argv[0]);
 794
 795                 if (!strcmp(argv[0], "HEAD"))
 796                         die(_("it does not make sense to create 'HEAD' manually"));
 797
 798                 if (!branch)
 799                         die(_("no such branch '%s'"), argv[0]);
 800
 801                 if (filter.kind != FILTER_REFS_BRANCHES)
 802                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 803
 804                 if (track == BRANCH_TRACK_OVERRIDE)
 805                         die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
 806
 807                 create_branch(argv[0], (argc == 2) ? argv[1] : head,
 808                               force, reflog, 0, quiet, track);
 809
 810         } else
 811                 usage_with_options(builtin_branch_usage, options);
 812
 813         return 0;
 814 }