[PATCH 2/3] builtin/replay: improve documentation on options
- From
Toon Claes <toon@iotcl.com>
- Date
- Mar 23, 2026, 16:09 UTC
- Message-ID
- <20260323-toon-replay-arbitrary-ref-v1-2-5c7172f675ec@iotcl.com>
- In-Reply-To
- <20260323-toon-replay-arbitrary-ref-v1-0-5c7172f675ec@iotcl.com>
Most of the options for the command git-replay(1) expect a value argument. Make that more clear in the docs, by using an equal sign between the option and the value.
Also, none of the options are negatable, thus mark them as such using PARSE_OPT_NONEG.
Signed-off-by: Toon Claes <toon@iotcl.com> --- Documentation/git-replay.adoc | 3 ++- builtin/replay.c | 32 ++++++++++++++++++-------------- 2 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc index 6698cfc047..e4fef548e0 100644 --- a/Documentation/git-replay.adoc +++ b/Documentation/git-replay.adoc @@ -9,7 +9,8 @@ git-replay - EXPERIMENTAL: Replay commits on a new base, works with bare repos t SYNOPSIS -------- [verse] -(EXPERIMENTAL!) 'git replay' ([--contained] --onto <newbase> | --advance <branch> | --revert <branch>) [--ref-action[=<mode>]] <revision-range>... +(EXPERIMENTAL!) 'git replay' ([--contained] --onto=<newbase> | --advance=<branch> | --revert=<branch>) + [--ref-action=<mode>] <revision-range> DESCRIPTION ----------- diff --git a/builtin/replay.c b/builtin/replay.c index fe69f6f8ce..2e9fd6281d 100644 --- a/builtin/replay.c +++ b/builtin/replay.c @@ -83,25 +83,29 @@ int cmd_replay(int argc, const char *const replay_usage[] = { N_("(EXPERIMENTAL!) git replay " - "([--contained] --onto <newbase> | --advance <branch> | --revert <branch>) " - "[--ref-action[=<mode>]] <revision-range>..."), + "([--contained] --onto=<newbase> | --advance=<branch> | --revert=<branch>)\n" + "[--ref-action=<mode>] <revision-range>"), NULL }; struct option replay_options[] = { - OPT_STRING(0, "advance", &opts.advance, - N_("branch"), - N_("make replay advance given branch")), - OPT_STRING(0, "onto", &opts.onto, - N_("revision"), - N_("replay onto given commit")), + OPT_STRING_F(0, "onto", &opts.onto, + N_("revision"), + N_("replay onto given commit"), + PARSE_OPT_NONEG), + OPT_STRING_F(0, "advance", &opts.advance, + N_("branch"), + N_("make replay advance given branch"), + PARSE_OPT_NONEG), + OPT_STRING_F(0, "revert", &opts.revert, + N_("branch"), + N_("revert commits onto given branch"), + PARSE_OPT_NONEG), OPT_BOOL(0, "contained", &opts.contained, N_("update all branches that point at commits in <revision-range>")), - OPT_STRING(0, "revert", &opts.revert, - N_("branch"), - N_("revert commits onto given branch")), - OPT_STRING(0, "ref-action", &ref_action, - N_("mode"), - N_("control ref update behavior (update|print)")), + OPT_STRING_F(0, "ref-action", &ref_action, + N_("mode"), + N_("control ref update behavior (update|print)"), + PARSE_OPT_NONEG), OPT_END() };
-- 2.53.0.310.g728cabbaf7