replay: improve --contained and add to doc

There is no documentation for `--contained`.

Start by copying the text from `replay_options` in `builtin/
replay.c`. But some people think that the existing text is a
bit unclear; what does it mean for a branch to be contained
in a revision range? Let’s include the implied commits here:
the branches that point at commits in the range.

Also use “update” instead of “advance”. “Update” is the verb
commonly used in this context.

Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Kristoffer Haugsbakk
2025-12-13 14:46:57 +01:00
committed by Junio C Hamano
parent 8467c95419
commit 03d7c9c457
2 changed files with 5 additions and 1 deletions

View File

@@ -42,6 +42,10 @@ The history is replayed on top of the <branch> and <branch> is updated to
point at the tip of the resulting history. This is different from `--onto`, point at the tip of the resulting history. This is different from `--onto`,
which uses the target only as a starting point without updating it. which uses the target only as a starting point without updating it.
--contained::
Update all branches that point at commits in
<revision-range>. Requires `--onto`.
--ref-action[=<mode>]:: --ref-action[=<mode>]::
Control how references are updated. The mode can be: Control how references are updated. The mode can be:
+ +

View File

@@ -377,7 +377,7 @@ int cmd_replay(int argc,
N_("revision"), N_("revision"),
N_("replay onto given commit")), N_("replay onto given commit")),
OPT_BOOL(0, "contained", &contained, OPT_BOOL(0, "contained", &contained,
N_("advance all branches contained in revision-range")), N_("update all branches that point at commits in <revision-range>")),
OPT_STRING(0, "ref-action", &ref_action, OPT_STRING(0, "ref-action", &ref_action,
N_("mode"), N_("mode"),
N_("control ref update behavior (update|print)")), N_("control ref update behavior (update|print)")),