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