builtin/revert.c

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