builtin / revert.con commit Merge branch 'jk/check-docs-update' into maint (1e51ae8)
   1#include "cache.h"
   2#include "builtin.h"
   3#include "parse-options.h"
   4#include "diff.h"
   5#include "revision.h"
   6#include "rerere.h"
   7#include "dir.h"
   8#include "sequencer.h"
   9
  10/*
  11 * This implements the builtins revert and cherry-pick.
  12 *
  13 * Copyright (c) 2007 Johannes E. Schindelin
  14 *
  15 * Based on git-revert.sh, which is
  16 *
  17 * Copyright (c) 2005 Linus Torvalds
  18 * Copyright (c) 2005 Junio C Hamano
  19 */
  20
  21static const char * const revert_usage[] = {
  22        "git revert [options] <commit-ish>",
  23        "git revert <subcommand>",
  24        NULL
  25};
  26
  27static const char * const cherry_pick_usage[] = {
  28        "git cherry-pick [options] <commit-ish>",
  29        "git cherry-pick <subcommand>",
  30        NULL
  31};
  32
  33static const char *action_name(const struct replay_opts *opts)
  34{
  35        return opts->action == REPLAY_REVERT ? "revert" : "cherry-pick";
  36}
  37
  38static const char * const *revert_or_cherry_pick_usage(struct replay_opts *opts)
  39{
  40        return opts->action == REPLAY_REVERT ? revert_usage : cherry_pick_usage;
  41}
  42
  43static int option_parse_x(const struct option *opt,
  44                          const char *arg, int unset)
  45{
  46        struct replay_opts **opts_ptr = opt->value;
  47        struct replay_opts *opts = *opts_ptr;
  48
  49        if (unset)
  50                return 0;
  51
  52        ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
  53        opts->xopts[opts->xopts_nr++] = xstrdup(arg);
  54        return 0;
  55}
  56
  57static void verify_opt_compatible(const char *me, const char *base_opt, ...)
  58{
  59        const char *this_opt;
  60        va_list ap;
  61
  62        va_start(ap, base_opt);
  63        while ((this_opt = va_arg(ap, const char *))) {
  64                if (va_arg(ap, int))
  65                        break;
  66        }
  67        va_end(ap);
  68
  69        if (this_opt)
  70                die(_("%s: %s cannot be used with %s"), me, this_opt, base_opt);
  71}
  72
  73static void verify_opt_mutually_compatible(const char *me, ...)
  74{
  75        const char *opt1, *opt2 = NULL;
  76        va_list ap;
  77
  78        va_start(ap, me);
  79        while ((opt1 = va_arg(ap, const char *))) {
  80                if (va_arg(ap, int))
  81                        break;
  82        }
  83        if (opt1) {
  84                while ((opt2 = va_arg(ap, const char *))) {
  85                        if (va_arg(ap, int))
  86                                break;
  87                }
  88        }
  89        va_end(ap);
  90
  91        if (opt1 && opt2)
  92                die(_("%s: %s cannot be used with %s"), me, opt1, opt2);
  93}
  94
  95static void parse_args(int argc, const char **argv, struct replay_opts *opts)
  96{
  97        const char * const * usage_str = revert_or_cherry_pick_usage(opts);
  98        const char *me = action_name(opts);
  99        int remove_state = 0;
 100        int contin = 0;
 101        int rollback = 0;
 102        struct option options[] = {
 103                OPT_BOOLEAN(0, "quit", &remove_state, "end revert or cherry-pick sequence"),
 104                OPT_BOOLEAN(0, "continue", &contin, "resume revert or cherry-pick sequence"),
 105                OPT_BOOLEAN(0, "abort", &rollback, "cancel revert or cherry-pick sequence"),
 106                OPT_BOOLEAN('n', "no-commit", &opts->no_commit, "don't automatically commit"),
 107                OPT_BOOLEAN('e', "edit", &opts->edit, "edit the commit message"),
 108                OPT_NOOP_NOARG('r', NULL),
 109                OPT_BOOLEAN('s', "signoff", &opts->signoff, "add Signed-off-by:"),
 110                OPT_INTEGER('m', "mainline", &opts->mainline, "parent number"),
 111                OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),
 112                OPT_STRING(0, "strategy", &opts->strategy, "strategy", "merge strategy"),
 113                OPT_CALLBACK('X', "strategy-option", &opts, "option",
 114                        "option for merge strategy", option_parse_x),
 115                OPT_END(),
 116                OPT_END(),
 117                OPT_END(),
 118                OPT_END(),
 119                OPT_END(),
 120        };
 121
 122        if (opts->action == REPLAY_PICK) {
 123                struct option cp_extra[] = {
 124                        OPT_BOOLEAN('x', NULL, &opts->record_origin, "append commit name"),
 125                        OPT_BOOLEAN(0, "ff", &opts->allow_ff, "allow fast-forward"),
 126                        OPT_BOOLEAN(0, "allow-empty", &opts->allow_empty, "preserve initially empty commits"),
 127                        OPT_BOOLEAN(0, "keep-redundant-commits", &opts->keep_redundant_commits, "keep redundant, empty commits"),
 128                        OPT_END(),
 129                };
 130                if (parse_options_concat(options, ARRAY_SIZE(options), cp_extra))
 131                        die(_("program error"));
 132        }
 133
 134        argc = parse_options(argc, argv, NULL, options, usage_str,
 135                        PARSE_OPT_KEEP_ARGV0 |
 136                        PARSE_OPT_KEEP_UNKNOWN);
 137
 138        /* Check for incompatible subcommands */
 139        verify_opt_mutually_compatible(me,
 140                                "--quit", remove_state,
 141                                "--continue", contin,
 142                                "--abort", rollback,
 143                                NULL);
 144
 145        /* implies allow_empty */
 146        if (opts->keep_redundant_commits)
 147                opts->allow_empty = 1;
 148
 149        /* Set the subcommand */
 150        if (remove_state)
 151                opts->subcommand = REPLAY_REMOVE_STATE;
 152        else if (contin)
 153                opts->subcommand = REPLAY_CONTINUE;
 154        else if (rollback)
 155                opts->subcommand = REPLAY_ROLLBACK;
 156        else
 157                opts->subcommand = REPLAY_NONE;
 158
 159        /* Check for incompatible command line arguments */
 160        if (opts->subcommand != REPLAY_NONE) {
 161                char *this_operation;
 162                if (opts->subcommand == REPLAY_REMOVE_STATE)
 163                        this_operation = "--quit";
 164                else if (opts->subcommand == REPLAY_CONTINUE)
 165                        this_operation = "--continue";
 166                else {
 167                        assert(opts->subcommand == REPLAY_ROLLBACK);
 168                        this_operation = "--abort";
 169                }
 170
 171                verify_opt_compatible(me, this_operation,
 172                                "--no-commit", opts->no_commit,
 173                                "--signoff", opts->signoff,
 174                                "--mainline", opts->mainline,
 175                                "--strategy", opts->strategy ? 1 : 0,
 176                                "--strategy-option", opts->xopts ? 1 : 0,
 177                                "-x", opts->record_origin,
 178                                "--ff", opts->allow_ff,
 179                                NULL);
 180        }
 181
 182        if (opts->allow_ff)
 183                verify_opt_compatible(me, "--ff",
 184                                "--signoff", opts->signoff,
 185                                "--no-commit", opts->no_commit,
 186                                "-x", opts->record_origin,
 187                                "--edit", opts->edit,
 188                                NULL);
 189
 190        if (opts->subcommand != REPLAY_NONE) {
 191                opts->revs = NULL;
 192        } else {
 193                struct setup_revision_opt s_r_opt;
 194                opts->revs = xmalloc(sizeof(*opts->revs));
 195                init_revisions(opts->revs, NULL);
 196                opts->revs->no_walk = 1;
 197                if (argc < 2)
 198                        usage_with_options(usage_str, options);
 199                memset(&s_r_opt, 0, sizeof(s_r_opt));
 200                s_r_opt.assume_dashdash = 1;
 201                argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
 202        }
 203
 204        if (argc > 1)
 205                usage_with_options(usage_str, options);
 206}
 207
 208int cmd_revert(int argc, const char **argv, const char *prefix)
 209{
 210        struct replay_opts opts;
 211        int res;
 212
 213        memset(&opts, 0, sizeof(opts));
 214        if (isatty(0))
 215                opts.edit = 1;
 216        opts.action = REPLAY_REVERT;
 217        git_config(git_default_config, NULL);
 218        parse_args(argc, argv, &opts);
 219        res = sequencer_pick_revisions(&opts);
 220        if (res < 0)
 221                die(_("revert failed"));
 222        return res;
 223}
 224
 225int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 226{
 227        struct replay_opts opts;
 228        int res;
 229
 230        memset(&opts, 0, sizeof(opts));
 231        opts.action = REPLAY_PICK;
 232        git_config(git_default_config, NULL);
 233        parse_args(argc, argv, &opts);
 234        res = sequencer_pick_revisions(&opts);
 235        if (res < 0)
 236                die(_("cherry-pick failed"));
 237        return res;
 238}