Merge branch 'kh/doc-replay-updates'

"git replay" documentation updates.

* kh/doc-replay-updates:
  doc: replay: link section using markup
  replay: improve --contained and add to doc
  doc: replay: mention no output on conflicts
This commit is contained in:
Junio C Hamano
2025-12-22 14:57:48 +09:00
2 changed files with 11 additions and 2 deletions

View File

@@ -19,7 +19,7 @@ the working tree and the index untouched. By default, updates the
relevant references using an atomic transaction (all refs update or relevant references using an atomic transaction (all refs update or
none). Use `--ref-action=print` to avoid automatic ref updates and none). Use `--ref-action=print` to avoid automatic ref updates and
instead get update commands that can be piped to `git update-ref --stdin` instead get update commands that can be piped to `git update-ref --stdin`
(see the OUTPUT section below). (see the <<output,OUTPUT>> section below).
THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE. THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
@@ -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:
+ +
@@ -62,6 +66,7 @@ The default mode can be configured via the `replay.refAction` configuration vari
include::rev-list-options.adoc[] include::rev-list-options.adoc[]
[[output]]
OUTPUT OUTPUT
------ ------
@@ -80,6 +85,10 @@ the shape of the history being replayed. When using `--advance`, the
number of refs updated is always one, but for `--onto`, it can be one number of refs updated is always one, but for `--onto`, it can be one
or more (rebasing multiple branches simultaneously is supported). or more (rebasing multiple branches simultaneously is supported).
There is no stderr output on conflicts; see the <<exit-status,EXIT
STATUS>> section below.
[[exit-status]]
EXIT STATUS EXIT STATUS
----------- -----------

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)")),