builtin/revert.c

   1 #include "git-compat-util.h"
   2 #include "config.h"
   3 #include "builtin.h"
   4 #include "parse-options.h"
   5 #include "diff.h"
   6 #include "gettext.h"
   7 #include "repository.h"
   8 #include "revision.h"
   9 #include "rerere.h"
  10 #include "dir.h"
  11 #include "sequencer.h"
  12 #include "branch.h"
  13
  14 /*
  15  * This implements the builtins revert and cherry-pick.
  16  *
  17  * Copyright (c) 2007 Johannes E. Schindelin
  18  *
  19  * Based on git-revert.sh, which is
  20  *
  21  * Copyright (c) 2005 Linus Torvalds
  22  * Copyright (c) 2005 Junio C Hamano
  23  */
  24
  25 static const char * const revert_usage[] = {
  26         N_("git revert [--[no-]edit] [-n] [-m <parent-number>] [-s] [-S[<keyid>]] <commit>..."),
  27         N_("git revert (--continue | --skip | --abort | --quit)"),
  28         NULL
  29 };
  30
  31 static const char * const cherry_pick_usage[] = {
  32         N_("git cherry-pick [--edit] [-n] [-m <parent-number>] [-s] [-x] [--ff]\n"
  33            "                [-S[<keyid>]] <commit>..."),
  34         N_("git cherry-pick (--continue | --skip | --abort | --quit)"),
  35         NULL
  36 };
  37
  38 static const char *action_name(const struct replay_opts *opts)
  39 {
  40         return opts->action == REPLAY_REVERT ? "revert" : "cherry-pick";
  41 }
  42
  43 static const char * const *revert_or_cherry_pick_usage(struct replay_opts *opts)
  44 {
  45         return opts->action == REPLAY_REVERT ? revert_usage : cherry_pick_usage;
  46 }
  47
  48 static int option_parse_m(const struct option *opt,
  49                           const char *arg, int unset)
  50 {
  51         struct replay_opts *replay = opt->value;
  52         char *end;
  53
  54         if (unset) {
  55                 replay->mainline = 0;
  56                 return 0;
  57         }
  58
  59         replay->mainline = strtol(arg, &end, 10);
  60         if (*end || replay->mainline <= 0)
  61                 return error(_("option `%s' expects a number greater than zero"),
  62                              opt->long_name);
  63
  64         return 0;
  65 }
  66
  67 LAST_ARG_MUST_BE_NULL
  68 static void verify_opt_compatible(const char *me, const char *base_opt, ...)
  69 {
  70         const char *this_opt;
  71         va_list ap;
  72
  73         va_start(ap, base_opt);
  74         while ((this_opt = va_arg(ap, const char *))) {
  75                 if (va_arg(ap, int))
  76                         break;
  77         }
  78         va_end(ap);
  79
  80         if (this_opt)
  81                 die(_("%s: %s cannot be used with %s"), me, this_opt, base_opt);
  82 }
  83
  84 static int run_sequencer(int argc, const char **argv, const char *prefix,
  85                          struct replay_opts *opts)
  86 {
  87         const char * const * usage_str = revert_or_cherry_pick_usage(opts);
  88         const char *me = action_name(opts);
  89         const char *cleanup_arg = NULL;
  90         int cmd = 0;
  91         struct option base_options[] = {
  92                 OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'),
  93                 OPT_CMDMODE(0, "continue", &cmd, N_("resume revert or cherry-pick sequence"), 'c'),
  94                 OPT_CMDMODE(0, "abort", &cmd, N_("cancel revert or cherry-pick sequence"), 'a'),
  95                 OPT_CMDMODE(0, "skip", &cmd, N_("skip current commit and continue"), 's'),
  96                 OPT_CLEANUP(&cleanup_arg),
  97                 OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
  98                 OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
  99                 OPT_NOOP_NOARG('r', NULL),
 100                 OPT_BOOL('s', "signoff", &opts->signoff, N_("add a Signed-off-by trailer")),
 101                 OPT_CALLBACK('m', "mainline", opts, N_("parent-number"),
 102                              N_("select mainline parent"), option_parse_m),
 103                 OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),
 104                 OPT_STRING(0, "strategy", &opts->strategy, N_("strategy"), N_("merge strategy")),
 105                 OPT_STRVEC('X', "strategy-option", &opts->xopts, N_("option"),
 106                         N_("option for merge strategy")),
 107                 { OPTION_STRING, 'S', "gpg-sign", &opts->gpg_sign, N_("key-id"),
 108                   N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
 109                 OPT_END()
 110         };
 111         struct option *options = base_options;
 112
 113         if (opts->action == REPLAY_PICK) {
 114                 struct option cp_extra[] = {
 115                         OPT_BOOL('x', NULL, &opts->record_origin, N_("append commit name")),
 116                         OPT_BOOL(0, "ff", &opts->allow_ff, N_("allow fast-forward")),
 117                         OPT_BOOL(0, "allow-empty", &opts->allow_empty, N_("preserve initially empty commits")),
 118                         OPT_BOOL(0, "allow-empty-message", &opts->allow_empty_message, N_("allow commits with empty messages")),
 119                         OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("keep redundant, empty commits")),
 120                         OPT_END(),
 121                 };
 122                 options = parse_options_concat(options, cp_extra);
 123         } else if (opts->action == REPLAY_REVERT) {
 124                 struct option cp_extra[] = {
 125                         OPT_BOOL(0, "reference", &opts->commit_use_reference,
 126                                  N_("use the 'reference' format to refer to commits")),
 127                         OPT_END(),
 128                 };
 129                 options = parse_options_concat(options, cp_extra);
 130         }
 131
 132         argc = parse_options(argc, argv, prefix, options, usage_str,
 133                         PARSE_OPT_KEEP_ARGV0 |
 134                         PARSE_OPT_KEEP_UNKNOWN_OPT);
 135
 136         prepare_repo_settings(the_repository);
 137         the_repository->settings.command_requires_full_index = 0;
 138
 139         /* implies allow_empty */
 140         if (opts->keep_redundant_commits)
 141                 opts->allow_empty = 1;
 142
 143         if (cleanup_arg) {
 144                 opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1);
 145                 opts->explicit_cleanup = 1;
 146         }
 147
 148         /* Check for incompatible command line arguments */
 149         if (cmd) {
 150                 char *this_operation;
 151                 if (cmd == 'q')
 152                         this_operation = "--quit";
 153                 else if (cmd == 'c')
 154                         this_operation = "--continue";
 155                 else if (cmd == 's')
 156                         this_operation = "--skip";
 157                 else {
 158                         assert(cmd == 'a');
 159                         this_operation = "--abort";
 160                 }
 161
 162                 verify_opt_compatible(me, this_operation,
 163                                 "--no-commit", opts->no_commit,
 164                                 "--signoff", opts->signoff,
 165                                 "--mainline", opts->mainline,
 166                                 "--strategy", opts->strategy ? 1 : 0,
 167                                 "--strategy-option", opts->xopts.nr ? 1 : 0,
 168                                 "-x", opts->record_origin,
 169                                 "--ff", opts->allow_ff,
 170                                 "--rerere-autoupdate", opts->allow_rerere_auto == RERERE_AUTOUPDATE,
 171                                 "--no-rerere-autoupdate", opts->allow_rerere_auto == RERERE_NOAUTOUPDATE,
 172                                 NULL);
 173         }
 174
 175         if (!opts->strategy && opts->default_strategy) {
 176                 opts->strategy = opts->default_strategy;
 177                 opts->default_strategy = NULL;
 178         }
 179
 180         if (opts->allow_ff)
 181                 verify_opt_compatible(me, "--ff",
 182                                 "--signoff", opts->signoff,
 183                                 "--no-commit", opts->no_commit,
 184                                 "-x", opts->record_origin,
 185                                 "--edit", opts->edit > 0,
 186                                 NULL);
 187
 188         if (cmd) {
 189                 opts->revs = NULL;
 190         } else {
 191                 struct setup_revision_opt s_r_opt;
 192                 opts->revs = xmalloc(sizeof(*opts->revs));
 193                 repo_init_revisions(the_repository, opts->revs, NULL);
 194                 opts->revs->no_walk = 1;
 195                 opts->revs->unsorted_input = 1;
 196                 if (argc < 2)
 197                         usage_with_options(usage_str, options);
 198                 if (!strcmp(argv[1], "-"))
 199                         argv[1] = "@{-1}";
 200                 memset(&s_r_opt, 0, sizeof(s_r_opt));
 201                 s_r_opt.assume_dashdash = 1;
 202                 argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
 203         }
 204
 205         if (argc > 1)
 206                 usage_with_options(usage_str, options);
 207
 208         /* These option values will be free()d */
 209         opts->gpg_sign = xstrdup_or_null(opts->gpg_sign);
 210         opts->strategy = xstrdup_or_null(opts->strategy);
 211         if (!opts->strategy && getenv("GIT_TEST_MERGE_ALGORITHM"))
 212                 opts->strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));
 213         free(options);
 214
 215         if (cmd == 'q') {
 216                 int ret = sequencer_remove_state(opts);
 217                 if (!ret)
 218                         remove_branch_state(the_repository, 0);
 219                 return ret;
 220         }
 221         if (cmd == 'c')
 222                 return sequencer_continue(the_repository, opts);
 223         if (cmd == 'a')
 224                 return sequencer_rollback(the_repository, opts);
 225         if (cmd == 's')
 226                 return sequencer_skip(the_repository, opts);
 227         return sequencer_pick_revisions(the_repository, opts);
 228 }
 229
 230 int cmd_revert(int argc, const char **argv, const char *prefix)
 231 {
 232         struct replay_opts opts = REPLAY_OPTS_INIT;
 233         int res;
 234
 235         opts.action = REPLAY_REVERT;
 236         sequencer_init_config(&opts);
 237         res = run_sequencer(argc, argv, prefix, &opts);
 238         if (res < 0)
 239                 die(_("revert failed"));
 240         replay_opts_release(&opts);
 241         return res;
 242 }
 243
 244 int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 245 {
 246         struct replay_opts opts = REPLAY_OPTS_INIT;
 247         int res;
 248
 249         opts.action = REPLAY_PICK;
 250         sequencer_init_config(&opts);
 251         res = run_sequencer(argc, argv, prefix, &opts);
 252         if (res < 0)
 253                 die(_("cherry-pick failed"));
 254         replay_opts_release(&opts);
 255         return res;
 256 }