[PATCH 2/4] doc: replay: simplify replay.refAction description
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- May 21, 2026, 18:01 UTC
- Message-ID
- <simplify_replay.refAction.70b@msgid.xyz>
- In-Reply-To
- <CV_doc_replay_config.709@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
We don’t need to list what each argument does since the documentation for `--ref-action` does that. So let’s simplify the `replay.refAction` description by referring to git-replay(1).
Also make sure to not self-link for the git-replay(1) inclusion.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- Documentation/config/replay.adoc | 17 +++++++---------- Documentation/git-replay.adoc | 1 + 2 files changed, 8 insertions(+), 10 deletions(-)
diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc index 7d549d2f0e5..42e521694d1 100644 --- a/Documentation/config/replay.adoc +++ b/Documentation/config/replay.adoc @@ -1,11 +1,8 @@ replay.refAction:: - Specifies the default mode for handling reference updates in - `git replay`. The value can be: -+ --- - * `update`: Update refs directly using an atomic transaction (default behavior). - * `print`: Output update-ref commands for pipeline use. --- -+ -This setting can be overridden with the `--ref-action` command-line option. -When not configured, `git replay` defaults to `update` mode. + Specifies the default mode for handling reference updates. Either `update` or `print`. +ifdef::git-replay[] +See `--ref-action`. +endif::git-replay[] +ifndef::git-replay[] +See `--ref-action` for linkgit:git-replay[1] for details. +endif::git-replay[] diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc index f9ca2db2833..4de85088d6c 100644 --- a/Documentation/git-replay.adoc +++ b/Documentation/git-replay.adoc @@ -211,6 +211,7 @@ to use bare commit IDs instead of branch names. CONFIGURATION ------------- +:git-replay: 1 include::config/replay.adoc[] GIT
-- 2.54.0.13.g9c7419e39f8