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 
action_name(const struct replay_opts * opts)35 static const char *action_name(const struct replay_opts *opts)
36 {
37 	return opts->action == REPLAY_REVERT ? "revert" : "cherry-pick";
38 }
39 
revert_or_cherry_pick_usage(struct replay_opts * opts)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 
option_parse_x(const struct option * opt,const char * arg,int unset)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 
option_parse_m(const struct option * opt,const char * arg,int unset)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
verify_opt_compatible(const char * me,const char * base_opt,...)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 
run_sequencer(int argc,const char ** argv,struct replay_opts * opts)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 	}
134 
135 	argc = parse_options(argc, argv, NULL, options, usage_str,
136 			PARSE_OPT_KEEP_ARGV0 |
137 			PARSE_OPT_KEEP_UNKNOWN);
138 
139 	prepare_repo_settings(the_repository);
140 	the_repository->settings.command_requires_full_index = 0;
141 
142 	/* implies allow_empty */
143 	if (opts->keep_redundant_commits)
144 		opts->allow_empty = 1;
145 
146 	if (cleanup_arg) {
147 		opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1);
148 		opts->explicit_cleanup = 1;
149 	}
150 
151 	/* Check for incompatible command line arguments */
152 	if (cmd) {
153 		char *this_operation;
154 		if (cmd == 'q')
155 			this_operation = "--quit";
156 		else if (cmd == 'c')
157 			this_operation = "--continue";
158 		else if (cmd == 's')
159 			this_operation = "--skip";
160 		else {
161 			assert(cmd == 'a');
162 			this_operation = "--abort";
163 		}
164 
165 		verify_opt_compatible(me, this_operation,
166 				"--no-commit", opts->no_commit,
167 				"--signoff", opts->signoff,
168 				"--mainline", opts->mainline,
169 				"--strategy", opts->strategy ? 1 : 0,
170 				"--strategy-option", opts->xopts ? 1 : 0,
171 				"-x", opts->record_origin,
172 				"--ff", opts->allow_ff,
173 				"--rerere-autoupdate", opts->allow_rerere_auto == RERERE_AUTOUPDATE,
174 				"--no-rerere-autoupdate", opts->allow_rerere_auto == RERERE_NOAUTOUPDATE,
175 				NULL);
176 	}
177 
178 	if (!opts->strategy && opts->default_strategy) {
179 		opts->strategy = opts->default_strategy;
180 		opts->default_strategy = NULL;
181 	}
182 
183 	if (opts->allow_ff)
184 		verify_opt_compatible(me, "--ff",
185 				"--signoff", opts->signoff,
186 				"--no-commit", opts->no_commit,
187 				"-x", opts->record_origin,
188 				"--edit", opts->edit > 0,
189 				NULL);
190 
191 	if (cmd) {
192 		opts->revs = NULL;
193 	} else {
194 		struct setup_revision_opt s_r_opt;
195 		opts->revs = xmalloc(sizeof(*opts->revs));
196 		repo_init_revisions(the_repository, opts->revs, NULL);
197 		opts->revs->no_walk = 1;
198 		opts->revs->unsorted_input = 1;
199 		if (argc < 2)
200 			usage_with_options(usage_str, options);
201 		if (!strcmp(argv[1], "-"))
202 			argv[1] = "@{-1}";
203 		memset(&s_r_opt, 0, sizeof(s_r_opt));
204 		s_r_opt.assume_dashdash = 1;
205 		argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
206 	}
207 
208 	if (argc > 1)
209 		usage_with_options(usage_str, options);
210 
211 	/* These option values will be free()d */
212 	opts->gpg_sign = xstrdup_or_null(opts->gpg_sign);
213 	opts->strategy = xstrdup_or_null(opts->strategy);
214 	if (!opts->strategy && getenv("GIT_TEST_MERGE_ALGORITHM"))
215 		opts->strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));
216 
217 	if (cmd == 'q') {
218 		int ret = sequencer_remove_state(opts);
219 		if (!ret)
220 			remove_branch_state(the_repository, 0);
221 		return ret;
222 	}
223 	if (cmd == 'c')
224 		return sequencer_continue(the_repository, opts);
225 	if (cmd == 'a')
226 		return sequencer_rollback(the_repository, opts);
227 	if (cmd == 's')
228 		return sequencer_skip(the_repository, opts);
229 	return sequencer_pick_revisions(the_repository, opts);
230 }
231 
cmd_revert(int argc,const char ** argv,const char * prefix)232 int cmd_revert(int argc, const char **argv, const char *prefix)
233 {
234 	struct replay_opts opts = REPLAY_OPTS_INIT;
235 	int res;
236 
237 	opts.action = REPLAY_REVERT;
238 	sequencer_init_config(&opts);
239 	res = run_sequencer(argc, argv, &opts);
240 	if (res < 0)
241 		die(_("revert failed"));
242 	return res;
243 }
244 
cmd_cherry_pick(int argc,const char ** argv,const char * prefix)245 int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
246 {
247 	struct replay_opts opts = REPLAY_OPTS_INIT;
248 	int res;
249 
250 	opts.action = REPLAY_PICK;
251 	sequencer_init_config(&opts);
252 	res = run_sequencer(argc, argv, &opts);
253 	if (res < 0)
254 		die(_("cherry-pick failed"));
255 	return res;
256 }
257