builtin/revert.c

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