builtin / revert.con commit send-email: simplify Gmail example in the documentation (4855f06)
   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        N_("git revert [<options>] <commit-ish>..."),
  23        N_("git revert <subcommand>"),
  24        NULL
  25};
  26
  27static const char * const cherry_pick_usage[] = {
  28        N_("git cherry-pick [<options>] <commit-ish>..."),
  29        N_("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
  57LAST_ARG_MUST_BE_NULL
  58static void verify_opt_compatible(const char *me, const char *base_opt, ...)
  59{
  60        const char *this_opt;
  61        va_list ap;
  62
  63        va_start(ap, base_opt);
  64        while ((this_opt = va_arg(ap, const char *))) {
  65                if (va_arg(ap, int))
  66                        break;
  67        }
  68        va_end(ap);
  69
  70        if (this_opt)
  71                die(_("%s: %s cannot be used with %s"), me, this_opt, base_opt);
  72}
  73
  74static void parse_args(int argc, const char **argv, struct replay_opts *opts)
  75{
  76        const char * const * usage_str = revert_or_cherry_pick_usage(opts);
  77        const char *me = action_name(opts);
  78        int cmd = 0;
  79        struct option options[] = {
  80                OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'),
  81                OPT_CMDMODE(0, "continue", &cmd, N_("resume revert or cherry-pick sequence"), 'c'),
  82                OPT_CMDMODE(0, "abort", &cmd, N_("cancel revert or cherry-pick sequence"), 'a'),
  83                OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
  84                OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
  85                OPT_NOOP_NOARG('r', NULL),
  86                OPT_BOOL('s', "signoff", &opts->signoff, N_("add Signed-off-by:")),
  87                OPT_INTEGER('m', "mainline", &opts->mainline, N_("parent number")),
  88                OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),
  89                OPT_STRING(0, "strategy", &opts->strategy, N_("strategy"), N_("merge strategy")),
  90                OPT_CALLBACK('X', "strategy-option", &opts, N_("option"),
  91                        N_("option for merge strategy"), option_parse_x),
  92                { OPTION_STRING, 'S', "gpg-sign", &opts->gpg_sign, N_("key-id"),
  93                  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
  94                OPT_END(),
  95                OPT_END(),
  96                OPT_END(),
  97                OPT_END(),
  98                OPT_END(),
  99                OPT_END(),
 100        };
 101
 102        if (opts->action == REPLAY_PICK) {
 103                struct option cp_extra[] = {
 104                        OPT_BOOL('x', NULL, &opts->record_origin, N_("append commit name")),
 105                        OPT_BOOL(0, "ff", &opts->allow_ff, N_("allow fast-forward")),
 106                        OPT_BOOL(0, "allow-empty", &opts->allow_empty, N_("preserve initially empty commits")),
 107                        OPT_BOOL(0, "allow-empty-message", &opts->allow_empty_message, N_("allow commits with empty messages")),
 108                        OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("keep redundant, empty commits")),
 109                        OPT_END(),
 110                };
 111                if (parse_options_concat(options, ARRAY_SIZE(options), cp_extra))
 112                        die(_("program error"));
 113        }
 114
 115        argc = parse_options(argc, argv, NULL, options, usage_str,
 116                        PARSE_OPT_KEEP_ARGV0 |
 117                        PARSE_OPT_KEEP_UNKNOWN);
 118
 119        /* implies allow_empty */
 120        if (opts->keep_redundant_commits)
 121                opts->allow_empty = 1;
 122
 123        /* Set the subcommand */
 124        if (cmd == 'q')
 125                opts->subcommand = REPLAY_REMOVE_STATE;
 126        else if (cmd == 'c')
 127                opts->subcommand = REPLAY_CONTINUE;
 128        else if (cmd == 'a')
 129                opts->subcommand = REPLAY_ROLLBACK;
 130        else
 131                opts->subcommand = REPLAY_NONE;
 132
 133        /* Check for incompatible command line arguments */
 134        if (opts->subcommand != REPLAY_NONE) {
 135                char *this_operation;
 136                if (opts->subcommand == REPLAY_REMOVE_STATE)
 137                        this_operation = "--quit";
 138                else if (opts->subcommand == REPLAY_CONTINUE)
 139                        this_operation = "--continue";
 140                else {
 141                        assert(opts->subcommand == REPLAY_ROLLBACK);
 142                        this_operation = "--abort";
 143                }
 144
 145                verify_opt_compatible(me, this_operation,
 146                                "--no-commit", opts->no_commit,
 147                                "--signoff", opts->signoff,
 148                                "--mainline", opts->mainline,
 149                                "--strategy", opts->strategy ? 1 : 0,
 150                                "--strategy-option", opts->xopts ? 1 : 0,
 151                                "-x", opts->record_origin,
 152                                "--ff", opts->allow_ff,
 153                                NULL);
 154        }
 155
 156        if (opts->allow_ff)
 157                verify_opt_compatible(me, "--ff",
 158                                "--signoff", opts->signoff,
 159                                "--no-commit", opts->no_commit,
 160                                "-x", opts->record_origin,
 161                                "--edit", opts->edit,
 162                                NULL);
 163
 164        if (opts->subcommand != REPLAY_NONE) {
 165                opts->revs = NULL;
 166        } else {
 167                struct setup_revision_opt s_r_opt;
 168                opts->revs = xmalloc(sizeof(*opts->revs));
 169                init_revisions(opts->revs, NULL);
 170                opts->revs->no_walk = REVISION_WALK_NO_WALK_UNSORTED;
 171                if (argc < 2)
 172                        usage_with_options(usage_str, options);
 173                if (!strcmp(argv[1], "-"))
 174                        argv[1] = "@{-1}";
 175                memset(&s_r_opt, 0, sizeof(s_r_opt));
 176                s_r_opt.assume_dashdash = 1;
 177                argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
 178        }
 179
 180        if (argc > 1)
 181                usage_with_options(usage_str, options);
 182}
 183
 184int cmd_revert(int argc, const char **argv, const char *prefix)
 185{
 186        struct replay_opts opts;
 187        int res;
 188
 189        memset(&opts, 0, sizeof(opts));
 190        if (isatty(0))
 191                opts.edit = 1;
 192        opts.action = REPLAY_REVERT;
 193        git_config(git_default_config, NULL);
 194        parse_args(argc, argv, &opts);
 195        res = sequencer_pick_revisions(&opts);
 196        if (res < 0)
 197                die(_("revert failed"));
 198        return res;
 199}
 200
 201int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 202{
 203        struct replay_opts opts;
 204        int res;
 205
 206        memset(&opts, 0, sizeof(opts));
 207        opts.action = REPLAY_PICK;
 208        git_config(git_default_config, NULL);
 209        parse_args(argc, argv, &opts);
 210        res = sequencer_pick_revisions(&opts);
 211        if (res < 0)
 212                die(_("cherry-pick failed"));
 213        return res;
 214}