3abd4a67d9
Ted reported an old typo in the git-commit.txt and merge-options.txt. Namely, the phrase "Signed-off-by line" was used without either a definite nor indefinite article. Upon examination, it seems that the documentation (including items in Documentation/, but also option help strings) have been quite inconsistent on usage when referring to `Signed-off-by`. First, very few places used a definite or indefinite article with the phrase "Signed-off-by line", but that was the initial typo that led to this investigation. So, normalize using either an indefinite or definite article consistently. The original phrasing, in Commit3f971fc425
(Documentation updates, 2005-08-14), is "Add Signed-off-by line". Commit6f855371a5
(Add --signoff, --check, and long option-names. 2005-12-09) switched to using "Add `Signed-off-by:` line", but didn't normalize the former commit to match. Later commits seem to have cut and pasted from one or the other, which is likely how the usage became so inconsistent. Junio stated on the git mailing list in <xmqqy2k1dfoh.fsf@gitster.c.googlers.com> a preference to leave off the colon. Thus, prefer `Signed-off-by` (with backticks) for the documentation files and Signed-off-by (without backticks) for option help strings. Additionally, Junio argued that "trailer" is now the standard term to refer to `Signed-off-by`, saying that "becomes plenty clear that we are not talking about any random line in the log message". As such, prefer "trailer" over "line" anywhere the former word fits. However, leave alone those few places in documentation that use Signed-off-by to refer to the process (rather than the specific trailer), or in places where mail headers are generally discussed in comparison with Signed-off-by. Reported-by: "Theodore Y. Ts'o" <tytso@mit.edu> Signed-off-by: Bradley M. Kuhn <bkuhn@sfconservancy.org> Acked-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
248 lines
6.9 KiB
C
248 lines
6.9 KiB
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);
|
|
}
|
|
|
|
argc = parse_options(argc, argv, NULL, options, usage_str,
|
|
PARSE_OPT_KEEP_ARGV0 |
|
|
PARSE_OPT_KEEP_UNKNOWN);
|
|
|
|
/* 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->allow_ff)
|
|
verify_opt_compatible(me, "--ff",
|
|
"--signoff", opts->signoff,
|
|
"--no-commit", opts->no_commit,
|
|
"-x", opts->record_origin,
|
|
"--edit", opts->edit,
|
|
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 = REVISION_WALK_NO_WALK_UNSORTED;
|
|
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 (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;
|
|
|
|
if (isatty(0))
|
|
opts.edit = 1;
|
|
opts.action = REPLAY_REVERT;
|
|
sequencer_init_config(&opts);
|
|
res = run_sequencer(argc, argv, &opts);
|
|
if (res < 0)
|
|
die(_("revert failed"));
|
|
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;
|
|
}
|