builtin/revert.c

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