]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: replay: simplify replay.refAction description
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Thu, 21 May 2026 18:01:59 +0000 (20:01 +0200)
committerJunio C Hamano <gitster@pobox.com>
Fri, 22 May 2026 00:42:48 +0000 (09:42 +0900)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/replay.adoc
Documentation/git-replay.adoc

index 7d549d2f0e519559d4bf4f19f6f08518a5a882f0..42e521694d11469f72bf8835143433e5110f05d8 100644 (file)
@@ -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[]
index f9ca2db2833a1d9a53cd1f43df39fb9e6a1c50d3..4de85088d6c4c9d7e649670f9de48f685a6aa124 100644 (file)
@@ -211,6 +211,7 @@ to use bare commit IDs instead of branch names.
 
 CONFIGURATION
 -------------
+:git-replay: 1
 include::config/replay.adoc[]
 
 GIT