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