Andrew's git / gitweb.git / builtin/branch.c
?
builtin / branch.con commit Merge branch 'ew/send-email-drop-data-dumper' (56b5a91)
   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
  25static 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
  34static const char *head;
  35static unsigned char head_sha1[20];
  36
  37static int branch_use_color = -1;
  38static 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};
  46enum 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
  55static struct string_list output = STRING_LIST_INIT_DUP;
  56static unsigned int colopts;
  57
  58static 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
  75static 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
  96static 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
 103static 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
 155static 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
 173static 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
 182static 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                const char *target;
 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                        char *worktree = find_shared_symref("HEAD", name);
 224                        if (worktree) {
 225                                error(_("Cannot delete branch '%s' "
 226                                        "checked out at '%s'"),
 227                                      bname.buf, worktree);
 228                                free(worktree);
 229                                ret = 1;
 230                                continue;
 231                        }
 232                }
 233
 234                target = resolve_ref_unsafe(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                        continue;
 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                        continue;
 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
 275        free(name);
 276
 277        return(ret);
 278}
 279
 280static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
 281                int show_upstream_ref)
 282{
 283        int ours, theirs;
 284        char *ref = NULL;
 285        struct branch *branch = branch_get(branch_name);
 286        const char *upstream;
 287        struct strbuf fancy = STRBUF_INIT;
 288        int upstream_is_gone = 0;
 289        int added_decoration = 1;
 290
 291        if (stat_tracking_info(branch, &ours, &theirs, &upstream) < 0) {
 292                if (!upstream)
 293                        return;
 294                upstream_is_gone = 1;
 295        }
 296
 297        if (show_upstream_ref) {
 298                ref = shorten_unambiguous_ref(upstream, 0);
 299                if (want_color(branch_use_color))
 300                        strbuf_addf(&fancy, "%s%s%s",
 301                                        branch_get_color(BRANCH_COLOR_UPSTREAM),
 302                                        ref, branch_get_color(BRANCH_COLOR_RESET));
 303                else
 304                        strbuf_addstr(&fancy, ref);
 305        }
 306
 307        if (upstream_is_gone) {
 308                if (show_upstream_ref)
 309                        strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
 310                else
 311                        added_decoration = 0;
 312        } else if (!ours && !theirs) {
 313                if (show_upstream_ref)
 314                        strbuf_addf(stat, _("[%s]"), fancy.buf);
 315                else
 316                        added_decoration = 0;
 317        } else if (!ours) {
 318                if (show_upstream_ref)
 319                        strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
 320                else
 321                        strbuf_addf(stat, _("[behind %d]"), theirs);
 322
 323        } else if (!theirs) {
 324                if (show_upstream_ref)
 325                        strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
 326                else
 327                        strbuf_addf(stat, _("[ahead %d]"), ours);
 328        } else {
 329                if (show_upstream_ref)
 330                        strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
 331                                    fancy.buf, ours, theirs);
 332                else
 333                        strbuf_addf(stat, _("[ahead %d, behind %d]"),
 334                                    ours, theirs);
 335        }
 336        strbuf_release(&fancy);
 337        if (added_decoration)
 338                strbuf_addch(stat, ' ');
 339        free(ref);
 340}
 341
 342static void add_verbose_info(struct strbuf *out, struct ref_array_item *item,
 343                             struct ref_filter *filter, const char *refname)
 344{
 345        struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
 346        const char *sub = _(" **** invalid ref ****");
 347        struct commit *commit = item->commit;
 348
 349        if (!parse_commit(commit)) {
 350                pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
 351                sub = subject.buf;
 352        }
 353
 354        if (item->kind == FILTER_REFS_BRANCHES)
 355                fill_tracking_info(&stat, refname, filter->verbose > 1);
 356
 357        strbuf_addf(out, " %s %s%s",
 358                find_unique_abbrev(item->commit->object.oid.hash, filter->abbrev),
 359                stat.buf, sub);
 360        strbuf_release(&stat);
 361        strbuf_release(&subject);
 362}
 363
 364static char *get_head_description(void)
 365{
 366        struct strbuf desc = STRBUF_INIT;
 367        struct wt_status_state state;
 368        memset(&state, 0, sizeof(state));
 369        wt_status_get_state(&state, 1);
 370        if (state.rebase_in_progress ||
 371            state.rebase_interactive_in_progress)
 372                strbuf_addf(&desc, _("(no branch, rebasing %s)"),
 373                            state.branch);
 374        else if (state.bisect_in_progress)
 375                strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
 376                            state.branch);
 377        else if (state.detached_from) {
 378                /* TRANSLATORS: make sure these match _("HEAD detached at ")
 379                   and _("HEAD detached from ") in wt-status.c */
 380                if (state.detached_at)
 381                        strbuf_addf(&desc, _("(HEAD detached at %s)"),
 382                                state.detached_from);
 383                else
 384                        strbuf_addf(&desc, _("(HEAD detached from %s)"),
 385                                state.detached_from);
 386        }
 387        else
 388                strbuf_addstr(&desc, _("(no branch)"));
 389        free(state.branch);
 390        free(state.onto);
 391        free(state.detached_from);
 392        return strbuf_detach(&desc, NULL);
 393}
 394
 395static void format_and_print_ref_item(struct ref_array_item *item, int maxwidth,
 396                                      struct ref_filter *filter, const char *remote_prefix)
 397{
 398        char c;
 399        int current = 0;
 400        int color;
 401        struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
 402        const char *prefix_to_show = "";
 403        const char *prefix_to_skip = NULL;
 404        const char *desc = item->refname;
 405        char *to_free = NULL;
 406
 407        switch (item->kind) {
 408        case FILTER_REFS_BRANCHES:
 409                prefix_to_skip = "refs/heads/";
 410                skip_prefix(desc, prefix_to_skip, &desc);
 411                if (!filter->detached && !strcmp(desc, head))
 412                        current = 1;
 413                else
 414                        color = BRANCH_COLOR_LOCAL;
 415                break;
 416        case FILTER_REFS_REMOTES:
 417                prefix_to_skip = "refs/remotes/";
 418                skip_prefix(desc, prefix_to_skip, &desc);
 419                color = BRANCH_COLOR_REMOTE;
 420                prefix_to_show = remote_prefix;
 421                break;
 422        case FILTER_REFS_DETACHED_HEAD:
 423                desc = to_free = get_head_description();
 424                current = 1;
 425                break;
 426        default:
 427                color = BRANCH_COLOR_PLAIN;
 428                break;
 429        }
 430
 431        c = ' ';
 432        if (current) {
 433                c = '*';
 434                color = BRANCH_COLOR_CURRENT;
 435        }
 436
 437        strbuf_addf(&name, "%s%s", prefix_to_show, desc);
 438        if (filter->verbose) {
 439                int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
 440                strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
 441                            maxwidth + utf8_compensation, name.buf,
 442                            branch_get_color(BRANCH_COLOR_RESET));
 443        } else
 444                strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
 445                            name.buf, branch_get_color(BRANCH_COLOR_RESET));
 446
 447        if (item->symref) {
 448                const char *symref = item->symref;
 449                if (prefix_to_skip)
 450                        skip_prefix(symref, prefix_to_skip, &symref);
 451                strbuf_addf(&out, " -> %s", symref);
 452        }
 453        else if (filter->verbose)
 454                /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
 455                add_verbose_info(&out, item, filter, desc);
 456        if (column_active(colopts)) {
 457                assert(!filter->verbose && "--column and --verbose are incompatible");
 458                string_list_append(&output, out.buf);
 459        } else {
 460                printf("%s\n", out.buf);
 461        }
 462        strbuf_release(&name);
 463        strbuf_release(&out);
 464        free(to_free);
 465}
 466
 467static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
 468{
 469        int i, max = 0;
 470        for (i = 0; i < refs->nr; i++) {
 471                struct ref_array_item *it = refs->items[i];
 472                const char *desc = it->refname;
 473                int w;
 474
 475                skip_prefix(it->refname, "refs/heads/", &desc);
 476                skip_prefix(it->refname, "refs/remotes/", &desc);
 477                w = utf8_strwidth(desc);
 478
 479                if (it->kind == FILTER_REFS_REMOTES)
 480                        w += remote_bonus;
 481                if (w > max)
 482                        max = w;
 483        }
 484        return max;
 485}
 486
 487static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting)
 488{
 489        int i;
 490        struct ref_array array;
 491        int maxwidth = 0;
 492        const char *remote_prefix = "";
 493
 494        /*
 495         * If we are listing more than just remote branches,
 496         * then remote branches will have a "remotes/" prefix.
 497         * We need to account for this in the width.
 498         */
 499        if (filter->kind != FILTER_REFS_REMOTES)
 500                remote_prefix = "remotes/";
 501
 502        memset(&array, 0, sizeof(array));
 503
 504        verify_ref_format("%(refname)%(symref)");
 505        filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
 506
 507        if (filter->verbose)
 508                maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
 509
 510        /*
 511         * If no sorting parameter is given then we default to sorting
 512         * by 'refname'. This would give us an alphabetically sorted
 513         * array with the 'HEAD' ref at the beginning followed by
 514         * local branches 'refs/heads/...' and finally remote-tacking
 515         * branches 'refs/remotes/...'.
 516         */
 517        if (!sorting)
 518                sorting = ref_default_sorting();
 519        ref_array_sort(sorting, &array);
 520
 521        for (i = 0; i < array.nr; i++)
 522                format_and_print_ref_item(array.items[i], maxwidth, filter, remote_prefix);
 523
 524        ref_array_clear(&array);
 525}
 526
 527static void rename_branch(const char *oldname, const char *newname, int force)
 528{
 529        struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 530        struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 531        int recovery = 0;
 532        int clobber_head_ok;
 533
 534        if (!oldname)
 535                die(_("cannot rename the current branch while not on any."));
 536
 537        if (strbuf_check_branch_ref(&oldref, oldname)) {
 538                /*
 539                 * Bad name --- this could be an attempt to rename a
 540                 * ref that we used to allow to be created by accident.
 541                 */
 542                if (ref_exists(oldref.buf))
 543                        recovery = 1;
 544                else
 545                        die(_("Invalid branch name: '%s'"), oldname);
 546        }
 547
 548        /*
 549         * A command like "git branch -M currentbranch currentbranch" cannot
 550         * cause the worktree to become inconsistent with HEAD, so allow it.
 551         */
 552        clobber_head_ok = !strcmp(oldname, newname);
 553
 554        validate_new_branchname(newname, &newref, force, clobber_head_ok);
 555
 556        strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 557                 oldref.buf, newref.buf);
 558
 559        if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
 560                die(_("Branch rename failed"));
 561        strbuf_release(&logmsg);
 562
 563        if (recovery)
 564                warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
 565
 566        if (replace_each_worktree_head_symref(oldref.buf, newref.buf))
 567                die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
 568
 569        strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 570        strbuf_release(&oldref);
 571        strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 572        strbuf_release(&newref);
 573        if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 574                die(_("Branch is renamed, but update of config-file failed"));
 575        strbuf_release(&oldsection);
 576        strbuf_release(&newsection);
 577}
 578
 579static const char edit_description[] = "BRANCH_DESCRIPTION";
 580
 581static int edit_branch_description(const char *branch_name)
 582{
 583        struct strbuf buf = STRBUF_INIT;
 584        struct strbuf name = STRBUF_INIT;
 585
 586        read_branch_desc(&buf, branch_name);
 587        if (!buf.len || buf.buf[buf.len-1] != '\n')
 588                strbuf_addch(&buf, '\n');
 589        strbuf_commented_addf(&buf,
 590                    "Please edit the description for the branch\n"
 591                    "  %s\n"
 592                    "Lines starting with '%c' will be stripped.\n",
 593                    branch_name, comment_line_char);
 594        if (write_file_gently(git_path(edit_description), "%s", buf.buf)) {
 595                strbuf_release(&buf);
 596                return error(_("could not write branch description template: %s"),
 597                             strerror(errno));
 598        }
 599        strbuf_reset(&buf);
 600        if (launch_editor(git_path(edit_description), &buf, NULL)) {
 601                strbuf_release(&buf);
 602                return -1;
 603        }
 604        strbuf_stripspace(&buf, 1);
 605
 606        strbuf_addf(&name, "branch.%s.description", branch_name);
 607        git_config_set(name.buf, buf.len ? buf.buf : NULL);
 608        strbuf_release(&name);
 609        strbuf_release(&buf);
 610
 611        return 0;
 612}
 613
 614int cmd_branch(int argc, const char **argv, const char *prefix)
 615{
 616        int delete = 0, rename = 0, force = 0, list = 0;
 617        int reflog = 0, edit_description = 0;
 618        int quiet = 0, unset_upstream = 0;
 619        const char *new_upstream = NULL;
 620        enum branch_track track;
 621        struct ref_filter filter;
 622        static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 623
 624        struct option options[] = {
 625                OPT_GROUP(N_("Generic options")),
 626                OPT__VERBOSE(&filter.verbose,
 627                        N_("show hash and subject, give twice for upstream branch")),
 628                OPT__QUIET(&quiet, N_("suppress informational messages")),
 629                OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
 630                        BRANCH_TRACK_EXPLICIT),
 631                OPT_SET_INT( 0, "set-upstream",  &track, N_("change upstream info"),
 632                        BRANCH_TRACK_OVERRIDE),
 633                OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
 634                OPT_BOOL(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
 635                OPT__COLOR(&branch_use_color, N_("use colored output")),
 636                OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
 637                        FILTER_REFS_REMOTES),
 638                OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
 639                OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
 640                OPT__ABBREV(&filter.abbrev),
 641
 642                OPT_GROUP(N_("Specific git-branch actions:")),
 643                OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
 644                        FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
 645                OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
 646                OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
 647                OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
 648                OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
 649                OPT_BOOL(0, "list", &list, N_("list branch names")),
 650                OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
 651                OPT_BOOL(0, "edit-description", &edit_description,
 652                         N_("edit the description for the branch")),
 653                OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
 654                OPT_MERGED(&filter, N_("print only branches that are merged")),
 655                OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
 656                OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
 657                OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 658                             N_("field name to sort on"), &parse_opt_ref_sorting),
 659                {
 660                        OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 661                        N_("print only branches of the object"), 0, parse_opt_object_name
 662                },
 663                OPT_END(),
 664        };
 665
 666        memset(&filter, 0, sizeof(filter));
 667        filter.kind = FILTER_REFS_BRANCHES;
 668        filter.abbrev = -1;
 669
 670        if (argc == 2 && !strcmp(argv[1], "-h"))
 671                usage_with_options(builtin_branch_usage, options);
 672
 673        git_config(git_branch_config, NULL);
 674
 675        track = git_branch_track;
 676
 677        head = resolve_refdup("HEAD", 0, head_sha1, NULL);
 678        if (!head)
 679                die(_("Failed to resolve HEAD as a valid ref."));
 680        if (!strcmp(head, "HEAD"))
 681                filter.detached = 1;
 682        else if (!skip_prefix(head, "refs/heads/", &head))
 683                die(_("HEAD not found below refs/heads!"));
 684
 685        argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
 686                             0);
 687
 688        if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
 689                list = 1;
 690
 691        if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr)
 692                list = 1;
 693
 694        if (!!delete + !!rename + !!new_upstream +
 695            list + unset_upstream > 1)
 696                usage_with_options(builtin_branch_usage, options);
 697
 698        if (filter.abbrev == -1)
 699                filter.abbrev = DEFAULT_ABBREV;
 700        finalize_colopts(&colopts, -1);
 701        if (filter.verbose) {
 702                if (explicitly_enable_column(colopts))
 703                        die(_("--column and --verbose are incompatible"));
 704                colopts = 0;
 705        }
 706
 707        if (force) {
 708                delete *= 2;
 709                rename *= 2;
 710        }
 711
 712        if (delete) {
 713                if (!argc)
 714                        die(_("branch name required"));
 715                return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
 716        } else if (list) {
 717                /*  git branch --local also shows HEAD when it is detached */
 718                if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
 719                        filter.kind |= FILTER_REFS_DETACHED_HEAD;
 720                filter.name_patterns = argv;
 721                print_ref_list(&filter, sorting);
 722                print_columns(&output, colopts, NULL);
 723                string_list_clear(&output, 0);
 724                return 0;
 725        }
 726        else if (edit_description) {
 727                const char *branch_name;
 728                struct strbuf branch_ref = STRBUF_INIT;
 729
 730                if (!argc) {
 731                        if (filter.detached)
 732                                die(_("Cannot give description to detached HEAD"));
 733                        branch_name = head;
 734                } else if (argc == 1)
 735                        branch_name = argv[0];
 736                else
 737                        die(_("cannot edit description of more than one branch"));
 738
 739                strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
 740                if (!ref_exists(branch_ref.buf)) {
 741                        strbuf_release(&branch_ref);
 742
 743                        if (!argc)
 744                                return error(_("No commit on branch '%s' yet."),
 745                                             branch_name);
 746                        else
 747                                return error(_("No branch named '%s'."),
 748                                             branch_name);
 749                }
 750                strbuf_release(&branch_ref);
 751
 752                if (edit_branch_description(branch_name))
 753                        return 1;
 754        } else if (rename) {
 755                if (!argc)
 756                        die(_("branch name required"));
 757                else if (argc == 1)
 758                        rename_branch(head, argv[0], rename > 1);
 759                else if (argc == 2)
 760                        rename_branch(argv[0], argv[1], rename > 1);
 761                else
 762                        die(_("too many branches for a rename operation"));
 763        } else if (new_upstream) {
 764                struct branch *branch = branch_get(argv[0]);
 765
 766                if (argc > 1)
 767                        die(_("too many branches to set new upstream"));
 768
 769                if (!branch) {
 770                        if (!argc || !strcmp(argv[0], "HEAD"))
 771                                die(_("could not set upstream of HEAD to %s when "
 772                                      "it does not point to any branch."),
 773                                    new_upstream);
 774                        die(_("no such branch '%s'"), argv[0]);
 775                }
 776
 777                if (!ref_exists(branch->refname))
 778                        die(_("branch '%s' does not exist"), branch->name);
 779
 780                /*
 781                 * create_branch takes care of setting up the tracking
 782                 * info and making sure new_upstream is correct
 783                 */
 784                create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
 785        } else if (unset_upstream) {
 786                struct branch *branch = branch_get(argv[0]);
 787                struct strbuf buf = STRBUF_INIT;
 788
 789                if (argc > 1)
 790                        die(_("too many branches to unset upstream"));
 791
 792                if (!branch) {
 793                        if (!argc || !strcmp(argv[0], "HEAD"))
 794                                die(_("could not unset upstream of HEAD when "
 795                                      "it does not point to any branch."));
 796                        die(_("no such branch '%s'"), argv[0]);
 797                }
 798
 799                if (!branch_has_merge_config(branch))
 800                        die(_("Branch '%s' has no upstream information"), branch->name);
 801
 802                strbuf_addf(&buf, "branch.%s.remote", branch->name);
 803                git_config_set_multivar(buf.buf, NULL, NULL, 1);
 804                strbuf_reset(&buf);
 805                strbuf_addf(&buf, "branch.%s.merge", branch->name);
 806                git_config_set_multivar(buf.buf, NULL, NULL, 1);
 807                strbuf_release(&buf);
 808        } else if (argc > 0 && argc <= 2) {
 809                struct branch *branch = branch_get(argv[0]);
 810                int branch_existed = 0, remote_tracking = 0;
 811                struct strbuf buf = STRBUF_INIT;
 812
 813                if (!strcmp(argv[0], "HEAD"))
 814                        die(_("it does not make sense to create 'HEAD' manually"));
 815
 816                if (!branch)
 817                        die(_("no such branch '%s'"), argv[0]);
 818
 819                if (filter.kind != FILTER_REFS_BRANCHES)
 820                        die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
 821
 822                if (track == BRANCH_TRACK_OVERRIDE)
 823                        fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
 824
 825                strbuf_addf(&buf, "refs/remotes/%s", branch->name);
 826                remote_tracking = ref_exists(buf.buf);
 827                strbuf_release(&buf);
 828
 829                branch_existed = ref_exists(branch->refname);
 830                create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
 831                              force, reflog, 0, quiet, track);
 832
 833                /*
 834                 * We only show the instructions if the user gave us
 835                 * one branch which doesn't exist locally, but is the
 836                 * name of a remote-tracking branch.
 837                 */
 838                if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
 839                    !branch_existed && remote_tracking) {
 840                        fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
 841                        fprintf(stderr, _("    git branch -d %s\n"), branch->name);
 842                        fprintf(stderr, _("    git branch --set-upstream-to %s\n"), branch->name);
 843                }
 844
 845        } else
 846                usage_with_options(builtin_branch_usage, options);
 847
 848        return 0;
 849}