builtin/branch.c

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