[thirdparty/git.git] / builtin / revert.c

#include "cache.h"
#include "config.h"
#include "builtin.h"
#include "parse-options.h"
#include "diff.h"
#include "revision.h"
#include "rerere.h"
#include "dir.h"
#include "sequencer.h"
#include "branch.h"

/*
 * This implements the builtins revert and cherry-pick.
 *
 * Copyright (c) 2007 Johannes E. Schindelin
 *
 * Based on git-revert.sh, which is
 *
 * Copyright (c) 2005 Linus Torvalds
 * Copyright (c) 2005 Junio C Hamano
 */

static const char * const revert_usage[] = {
	N_("git revert [<options>] <commit-ish>..."),
	N_("git revert <subcommand>"),
	NULL
};

static const char * const cherry_pick_usage[] = {
	N_("git cherry-pick [<options>] <commit-ish>..."),
	N_("git cherry-pick <subcommand>"),
	NULL
};

static const char *action_name(const struct replay_opts *opts)
{
	return opts->action == REPLAY_REVERT ? "revert" : "cherry-pick";
}

static const char * const *revert_or_cherry_pick_usage(struct replay_opts *opts)
{
	return opts->action == REPLAY_REVERT ? revert_usage : cherry_pick_usage;
}

static int option_parse_x(const struct option *opt,
			  const char *arg, int unset)
{
	struct replay_opts **opts_ptr = opt->value;
	struct replay_opts *opts = *opts_ptr;

	if (unset)
		return 0;

	ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
	opts->xopts[opts->xopts_nr++] = xstrdup(arg);
	return 0;
}

static int option_parse_m(const struct option *opt,
			  const char *arg, int unset)
{
	struct replay_opts *replay = opt->value;
	char *end;

	if (unset) {
		replay->mainline = 0;
		return 0;
	}

	replay->mainline = strtol(arg, &end, 10);
	if (*end || replay->mainline <= 0)
		return error(_("option `%s' expects a number greater than zero"),
			     opt->long_name);

	return 0;
}

LAST_ARG_MUST_BE_NULL
static void verify_opt_compatible(const char *me, const char *base_opt, ...)
{
	const char *this_opt;
	va_list ap;

	va_start(ap, base_opt);
	while ((this_opt = va_arg(ap, const char *))) {
		if (va_arg(ap, int))
			break;
	}
	va_end(ap);

	if (this_opt)
		die(_("%s: %s cannot be used with %s"), me, this_opt, base_opt);
}

static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
{
	const char * const * usage_str = revert_or_cherry_pick_usage(opts);
	const char *me = action_name(opts);
	const char *cleanup_arg = NULL;
	int cmd = 0;
	struct option base_options[] = {
		OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'),
		OPT_CMDMODE(0, "continue", &cmd, N_("resume revert or cherry-pick sequence"), 'c'),
		OPT_CMDMODE(0, "abort", &cmd, N_("cancel revert or cherry-pick sequence"), 'a'),
		OPT_CMDMODE(0, "skip", &cmd, N_("skip current commit and continue"), 's'),
		OPT_CLEANUP(&cleanup_arg),
		OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
		OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
		OPT_NOOP_NOARG('r', NULL),
		OPT_BOOL('s', "signoff", &opts->signoff, N_("add a Signed-off-by trailer")),
		OPT_CALLBACK('m', "mainline", opts, N_("parent-number"),
			     N_("select mainline parent"), option_parse_m),
		OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),
		OPT_STRING(0, "strategy", &opts->strategy, N_("strategy"), N_("merge strategy")),
		OPT_CALLBACK('X', "strategy-option", &opts, N_("option"),
			N_("option for merge strategy"), option_parse_x),
		{ OPTION_STRING, 'S', "gpg-sign", &opts->gpg_sign, N_("key-id"),
		  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
		OPT_END()
	};
	struct option *options = base_options;

	if (opts->action == REPLAY_PICK) {
		struct option cp_extra[] = {
			OPT_BOOL('x', NULL, &opts->record_origin, N_("append commit name")),
			OPT_BOOL(0, "ff", &opts->allow_ff, N_("allow fast-forward")),
			OPT_BOOL(0, "allow-empty", &opts->allow_empty, N_("preserve initially empty commits")),
			OPT_BOOL(0, "allow-empty-message", &opts->allow_empty_message, N_("allow commits with empty messages")),
			OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("keep redundant, empty commits")),
			OPT_END(),
		};
		options = parse_options_concat(options, cp_extra);
	} else if (opts->action == REPLAY_REVERT) {
		struct option cp_extra[] = {
			OPT_BOOL(0, "reference", &opts->commit_use_reference,
				 N_("use the 'reference' format to refer to commits")),
			OPT_END(),
		};
		options = parse_options_concat(options, cp_extra);
	}

	argc = parse_options(argc, argv, NULL, options, usage_str,
			PARSE_OPT_KEEP_ARGV0 |
			PARSE_OPT_KEEP_UNKNOWN_OPT);

	prepare_repo_settings(the_repository);
	the_repository->settings.command_requires_full_index = 0;

	/* implies allow_empty */
	if (opts->keep_redundant_commits)
		opts->allow_empty = 1;

	if (cleanup_arg) {
		opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1);
		opts->explicit_cleanup = 1;
	}

	/* Check for incompatible command line arguments */
	if (cmd) {
		char *this_operation;
		if (cmd == 'q')
			this_operation = "--quit";
		else if (cmd == 'c')
			this_operation = "--continue";
		else if (cmd == 's')
			this_operation = "--skip";
		else {
			assert(cmd == 'a');
			this_operation = "--abort";
		}

		verify_opt_compatible(me, this_operation,
				"--no-commit", opts->no_commit,
				"--signoff", opts->signoff,
				"--mainline", opts->mainline,
				"--strategy", opts->strategy ? 1 : 0,
				"--strategy-option", opts->xopts ? 1 : 0,
				"-x", opts->record_origin,
				"--ff", opts->allow_ff,
				"--rerere-autoupdate", opts->allow_rerere_auto == RERERE_AUTOUPDATE,
				"--no-rerere-autoupdate", opts->allow_rerere_auto == RERERE_NOAUTOUPDATE,
				NULL);
	}

	if (!opts->strategy && opts->default_strategy) {
		opts->strategy = opts->default_strategy;
		opts->default_strategy = NULL;
	}

	if (opts->allow_ff)
		verify_opt_compatible(me, "--ff",
				"--signoff", opts->signoff,
				"--no-commit", opts->no_commit,
				"-x", opts->record_origin,
				"--edit", opts->edit > 0,
				NULL);

	if (cmd) {
		opts->revs = NULL;
	} else {
		struct setup_revision_opt s_r_opt;
		opts->revs = xmalloc(sizeof(*opts->revs));
		repo_init_revisions(the_repository, opts->revs, NULL);
		opts->revs->no_walk = 1;
		opts->revs->unsorted_input = 1;
		if (argc < 2)
			usage_with_options(usage_str, options);
		if (!strcmp(argv[1], "-"))
			argv[1] = "@{-1}";
		memset(&s_r_opt, 0, sizeof(s_r_opt));
		s_r_opt.assume_dashdash = 1;
		argc = setup_revisions(argc, argv, opts->revs, &s_r_opt);
	}

	if (argc > 1)
		usage_with_options(usage_str, options);

	/* These option values will be free()d */
	opts->gpg_sign = xstrdup_or_null(opts->gpg_sign);
	opts->strategy = xstrdup_or_null(opts->strategy);
	if (!opts->strategy && getenv("GIT_TEST_MERGE_ALGORITHM"))
		opts->strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));

	if (cmd == 'q') {
		int ret = sequencer_remove_state(opts);
		if (!ret)
			remove_branch_state(the_repository, 0);
		return ret;
	}
	if (cmd == 'c')
		return sequencer_continue(the_repository, opts);
	if (cmd == 'a')
		return sequencer_rollback(the_repository, opts);
	if (cmd == 's')
		return sequencer_skip(the_repository, opts);
	return sequencer_pick_revisions(the_repository, opts);
}

int cmd_revert(int argc, const char **argv, const char *prefix)
{
	struct replay_opts opts = REPLAY_OPTS_INIT;
	int res;

	opts.action = REPLAY_REVERT;
	sequencer_init_config(&opts);
	res = run_sequencer(argc, argv, &opts);
	if (res < 0)
		die(_("revert failed"));
	if (opts.revs)
		release_revisions(opts.revs);
	free(opts.revs);
	return res;
}

int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
{
	struct replay_opts opts = REPLAY_OPTS_INIT;
	int res;

	opts.action = REPLAY_PICK;
	sequencer_init_config(&opts);
	res = run_sequencer(argc, argv, &opts);
	if (res < 0)
		die(_("cherry-pick failed"));
	return res;
}
Commit	Line	Data
9509af68	1	#include "cache.h"
b2141fc1	2	#include "config.h"
9509af68	3	#include "builtin.h"
f8103794	4	#include "parse-options.h"
0f2d4476 JK	5	#include "diff.h"
0f2d4476 JK	6	#include "revision.h"
aa1a0111	7	#include "rerere.h"
04d3d3cf	8	#include "dir.h"
26ae337b	9	#include "sequencer.h"
3e7dd992	10	#include "branch.h"
9509af68 JS	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
f8103794	23	static const char * const revert_usage[] = {
9c9b4f2f	24	N_("git revert [<options>] <commit-ish>..."),
a3b26dc7	25	N_("git revert <subcommand>"),
f8103794 PH	26	NULL
f8103794 PH	27	};
9509af68	28
f8103794	29	static const char * const cherry_pick_usage[] = {
9c9b4f2f	30	N_("git cherry-pick [<options>] <commit-ish>..."),
a3b26dc7	31	N_("git cherry-pick <subcommand>"),
f8103794 PH	32	NULL
f8103794 PH	33	};
9509af68	34
80e1f791 RR	35	static const char action_name(const struct replay_opts opts)
80e1f791 RR	36	{
644a3690	37	return opts->action == REPLAY_REVERT ? "revert" : "cherry-pick";
80e1f791 RR	38	}
80e1f791 RR	39
80e1f791	40	static const char * const revert_or_cherry_pick_usage(struct replay_opts opts)
e0ef8495	41	{
644a3690	42	return opts->action == REPLAY_REVERT ? revert_usage : cherry_pick_usage;
e0ef8495 JN	43	}
e0ef8495 JN	44
67ac1e1d JN	45	static int option_parse_x(const struct option *opt,
	46	const char *arg, int unset)
	47	{
80e1f791 RR	48	struct replay_opts **opts_ptr = opt->value;
	49	struct replay_opts opts = opts_ptr;
	50
67ac1e1d JN	51	if (unset)
	52	return 0;
	53
80e1f791 RR	54	ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
80e1f791 RR	55	opts->xopts[opts->xopts_nr++] = xstrdup(arg);
67ac1e1d JN	56	return 0;
	57	}
	58
b16a991c JK	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)
9440b831 NTND	72	return error(_("option `%s' expects a number greater than zero"),
9440b831 NTND	73	opt->long_name);
b16a991c JK	74
	75	return 0;
	76	}
	77
9fe3edc4	78	LAST_ARG_MUST_BE_NULL
9044143f RR	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
2863584f	95	static int run_sequencer(int argc, const char *argv, struct replay_opts opts)
9509af68	96	{
80e1f791	97	const char * const * usage_str = revert_or_cherry_pick_usage(opts);
9044143f	98	const char *me = action_name(opts);
1a2b985f	99	const char *cleanup_arg = NULL;
84d83f64	100	int cmd = 0;
023ff39b	101	struct option base_options[] = {
84d83f64 SB	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'),
de81ca3f	105	OPT_CMDMODE(0, "skip", &cmd, N_("skip current commit and continue"), 's'),
1a2b985f	106	OPT_CLEANUP(&cleanup_arg),
84d83f64 SB	107	OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
84d83f64 SB	108	OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
7cfc6057	109	OPT_NOOP_NOARG('r', NULL),
3abd4a67	110	OPT_BOOL('s', "signoff", &opts->signoff, N_("add a Signed-off-by trailer")),
b16a991c JK	111	OPT_CALLBACK('m', "mainline", opts, N_("parent-number"),
b16a991c JK	112	N_("select mainline parent"), option_parse_m),
80e1f791	113	OPT_RERERE_AUTOUPDATE(&opts->allow_rerere_auto),
a3b26dc7 NTND	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),
e703d711	117	{ OPTION_STRING, 'S', "gpg-sign", &opts->gpg_sign, N_("key-id"),
3253553e	118	N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
023ff39b	119	OPT_END()
f8103794	120	};
023ff39b	121	struct option *options = base_options;
f8103794	122
644a3690	123	if (opts->action == REPLAY_PICK) {
c62f6ec3	124	struct option cp_extra[] = {
84d83f64 SB	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")),
c62f6ec3 JH	130	OPT_END(),
c62f6ec3 JH	131	};
023ff39b	132	options = parse_options_concat(options, cp_extra);
191faaf7 JH	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);
c62f6ec3 JH	140	}
c62f6ec3 JH	141
7f13334e JN	142	argc = parse_options(argc, argv, NULL, options, usage_str,
7f13334e JN	143	PARSE_OPT_KEEP_ARGV0 \|
99d86d60	144	PARSE_OPT_KEEP_UNKNOWN_OPT);
26ae337b	145
516680ba DS	146	prepare_repo_settings(the_repository);
	147	the_repository->settings.command_requires_full_index = 0;
	148
b27cfb0d NH	149	/* implies allow_empty */
	150	if (opts->keep_redundant_commits)
	151	opts->allow_empty = 1;
	152
1a2b985f DL	153	if (cleanup_arg) {
	154	opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1);
	155	opts->explicit_cleanup = 1;
	156	}
	157
26ae337b	158	/* Check for incompatible command line arguments */
2863584f	159	if (cmd) {
5a5d80f4	160	char *this_operation;
2863584f	161	if (cmd == 'q')
f80a8726	162	this_operation = "--quit";
2863584f	163	else if (cmd == 'c')
5a5d80f4	164	this_operation = "--continue";
de81ca3f RA	165	else if (cmd == 's')
de81ca3f RA	166	this_operation = "--skip";
539047c1	167	else {
2863584f	168	assert(cmd == 'a');
539047c1 JN	169	this_operation = "--abort";
539047c1 JN	170	}
5a5d80f4 RR	171
5a5d80f4 RR	172	verify_opt_compatible(me, this_operation,
26ae337b RR	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,
f826fb79 PW	180	"--rerere-autoupdate", opts->allow_rerere_auto == RERERE_AUTOUPDATE,
f826fb79 PW	181	"--no-rerere-autoupdate", opts->allow_rerere_auto == RERERE_NOAUTOUPDATE,
26ae337b RR	182	NULL);
	183	}
	184
14c4586c EN	185	if (!opts->strategy && opts->default_strategy) {
	186	opts->strategy = opts->default_strategy;
	187	opts->default_strategy = NULL;
	188	}
	189
9044143f RR	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,
39edfd5c	195	"--edit", opts->edit > 0,
9044143f	196	NULL);
7f13334e	197
2863584f	198	if (cmd) {
7f13334e JN	199	opts->revs = NULL;
7f13334e JN	200	} else {
6d5b93f2	201	struct setup_revision_opt s_r_opt;
7f13334e	202	opts->revs = xmalloc(sizeof(*opts->revs));
2abf3503	203	repo_init_revisions(the_repository, opts->revs, NULL);
29ef1f27 PS	204	opts->revs->no_walk = 1;
29ef1f27 PS	205	opts->revs->unsorted_input = 1;
7f13334e JN	206	if (argc < 2)
7f13334e JN	207	usage_with_options(usage_str, options);
d644c550 JK	208	if (!strcmp(argv[1], "-"))
d644c550 JK	209	argv[1] = "@{-1}";
6d5b93f2 CB	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);
7f13334e JN	213	}
	214
	215	if (argc > 1)
	216	usage_with_options(usage_str, options);
03a4e260 JS	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);
14c4586c EN	221	if (!opts->strategy && getenv("GIT_TEST_MERGE_ALGORITHM"))
14c4586c EN	222	opts->strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));
2863584f	223
3e7dd992 NTND	224	if (cmd == 'q') {
	225	int ret = sequencer_remove_state(opts);
	226	if (!ret)
f4a4b9ac	227	remove_branch_state(the_repository, 0);
3e7dd992 NTND	228	return ret;
3e7dd992 NTND	229	}
2863584f	230	if (cmd == 'c')
f11c9580	231	return sequencer_continue(the_repository, opts);
2863584f	232	if (cmd == 'a')
005af339	233	return sequencer_rollback(the_repository, opts);
de81ca3f RA	234	if (cmd == 's')
de81ca3f RA	235	return sequencer_skip(the_repository, opts);
f11c9580	236	return sequencer_pick_revisions(the_repository, opts);
9509af68 JS	237	}
9509af68 JS	238
9509af68 JS	239	int cmd_revert(int argc, const char *argv, const char prefix)
9509af68 JS	240	{
ee624c0d	241	struct replay_opts opts = REPLAY_OPTS_INIT;
cf3e2486	242	int res;
80e1f791	243
644a3690	244	opts.action = REPLAY_REVERT;
28d6daed	245	sequencer_init_config(&opts);
2863584f	246	res = run_sequencer(argc, argv, &opts);
cf3e2486 RR	247	if (res < 0)
cf3e2486 RR	248	die(_("revert failed"));
fd74ac95 ÆAB	249	if (opts.revs)
	250	release_revisions(opts.revs);
	251	free(opts.revs);
cf3e2486	252	return res;
9509af68 JS	253	}
	254
	255	int cmd_cherry_pick(int argc, const char *argv, const char prefix)
	256	{
ee624c0d	257	struct replay_opts opts = REPLAY_OPTS_INIT;
cf3e2486	258	int res;
80e1f791	259
644a3690	260	opts.action = REPLAY_PICK;
28d6daed	261	sequencer_init_config(&opts);
2863584f	262	res = run_sequencer(argc, argv, &opts);
cf3e2486 RR	263	if (res < 0)
	264	die(_("cherry-pick failed"));
	265	return res;
9509af68	266	}