Merge branch 'jk/readme-gmane-is-no-more' into maint
[git] / 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 LAST_ARG_MUST_BE_NULL
58 static 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
74 static int run_sequencer(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 base_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         };
96         struct option *options = base_options;
97
98         if (opts->action == REPLAY_PICK) {
99                 struct option cp_extra[] = {
100                         OPT_BOOL('x', NULL, &opts->record_origin, N_("append commit name")),
101                         OPT_BOOL(0, "ff", &opts->allow_ff, N_("allow fast-forward")),
102                         OPT_BOOL(0, "allow-empty", &opts->allow_empty, N_("preserve initially empty commits")),
103                         OPT_BOOL(0, "allow-empty-message", &opts->allow_empty_message, N_("allow commits with empty messages")),
104                         OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("keep redundant, empty commits")),
105                         OPT_END(),
106                 };
107                 options = parse_options_concat(options, cp_extra);
108         }
109
110         argc = parse_options(argc, argv, NULL, options, usage_str,
111                         PARSE_OPT_KEEP_ARGV0 |
112                         PARSE_OPT_KEEP_UNKNOWN);
113
114         /* implies allow_empty */
115         if (opts->keep_redundant_commits)
116                 opts->allow_empty = 1;
117
118         /* Check for incompatible command line arguments */
119         if (cmd) {
120                 char *this_operation;
121                 if (cmd == 'q')
122                         this_operation = "--quit";
123                 else if (cmd == 'c')
124                         this_operation = "--continue";
125                 else {
126                         assert(cmd == 'a');
127                         this_operation = "--abort";
128                 }
129
130                 verify_opt_compatible(me, this_operation,
131                                 "--no-commit", opts->no_commit,
132                                 "--signoff", opts->signoff,
133                                 "--mainline", opts->mainline,
134                                 "--strategy", opts->strategy ? 1 : 0,
135                                 "--strategy-option", opts->xopts ? 1 : 0,
136                                 "-x", opts->record_origin,
137                                 "--ff", opts->allow_ff,
138                                 NULL);
139         }
140
141         if (opts->allow_ff)
142                 verify_opt_compatible(me, "--ff",
143                                 "--signoff", opts->signoff,
144                                 "--no-commit", opts->no_commit,
145                                 "-x", opts->record_origin,
146                                 "--edit", opts->edit,
147                                 NULL);
148
149         if (cmd) {
150                 opts->revs = NULL;
151         } else {
152                 struct setup_revision_opt s_r_opt;
153                 opts->revs = xmalloc(sizeof(*opts->revs));
154                 init_revisions(opts->revs, NULL);
155                 opts->revs->no_walk = REVISION_WALK_NO_WALK_UNSORTED;
156                 if (argc < 2)
157                         usage_with_options(usage_str, options);
158                 if (!strcmp(argv[1], "-"))
159                         argv[1] = "@{-1}";
160                 memset(&s_r_opt, 0, sizeof(s_r_opt));
161                 s_r_opt.assume_dashdash = 1;
162                 argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
163         }
164
165         if (argc > 1)
166                 usage_with_options(usage_str, options);
167
168         /* These option values will be free()d */
169         opts->gpg_sign = xstrdup_or_null(opts->gpg_sign);
170         opts->strategy = xstrdup_or_null(opts->strategy);
171
172         if (cmd == 'q')
173                 return sequencer_remove_state(opts);
174         if (cmd == 'c')
175                 return sequencer_continue(opts);
176         if (cmd == 'a')
177                 return sequencer_rollback(opts);
178         return sequencer_pick_revisions(opts);
179 }
180
181 int cmd_revert(int argc, const char **argv, const char *prefix)
182 {
183         struct replay_opts opts = REPLAY_OPTS_INIT;
184         int res;
185
186         if (isatty(0))
187                 opts.edit = 1;
188         opts.action = REPLAY_REVERT;
189         git_config(git_default_config, NULL);
190         res = run_sequencer(argc, argv, &opts);
191         if (res < 0)
192                 die(_("revert failed"));
193         return res;
194 }
195
196 int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
197 {
198         struct replay_opts opts = REPLAY_OPTS_INIT;
199         int res;
200
201         opts.action = REPLAY_PICK;
202         git_config(git_default_config, NULL);
203         res = run_sequencer(argc, argv, &opts);
204         if (res < 0)
205                 die(_("cherry-pick failed"));
206         return res;
207 }