git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/4] doc: replay: simplify replay.refAction description

From
Kkristofferhaugsbakk@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
Previous: Kristoffer HaugsbakkNext: Junio C Hamano
Message 5 of 40 in “doc: replay: fix config link”
  1. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, May 21, 2026
  2. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, May 21, 2026
  3. Junio C HamanoMay 30, 2026
  4. Kristoffer HaugsbakkJun 4, 2026
  5. 2/4 doc: replay: simplify replay.refAction descriptionkristofferhaugsbakk@fastmail.com, May 21, 2026
  6. Junio C HamanoMay 30, 2026
  7. Junio C HamanoMay 30, 2026
  8. Kristoffer HaugsbakkJun 2, 2026
  9. 3/4 doc: replay: use a nested definition listkristofferhaugsbakk@fastmail.com, May 21, 2026
  10. Junio C HamanoMay 30, 2026
  11. 4/4 doc: replay: move “default” to the right-hand-sidekristofferhaugsbakk@fastmail.com, May 21, 2026
  12. Junio C HamanoMay 30, 2026
  13. Junio C HamanoMay 30, 2026
  14. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  15. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jun 3, 2026
  16. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  17. Patrick SteinhardtJun 4, 2026
  18. Kristoffer HaugsbakkJun 4, 2026
  19. Patrick SteinhardtJun 4, 2026
  20. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  21. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jun 3, 2026
  22. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  23. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jun 5, 2026
  24. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  25. Toon ClaesJul 8, 2026
  26. Kristoffer HaugsbakkJul 30, 2026
  27. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  28. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jun 5, 2026
  29. Toon ClaesJul 8, 2026
  30. Junio C HamanoJul 23, 2026
  31. Kristoffer HaugsbakkJul 30, 2026
  32. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  33. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jul 30, 2026
  34. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  35. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  36. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jul 30, 2026
  37. Junio C HamanoJul 30, 2026
  38. Kristoffer HaugsbakkJul 30, 2026
  39. Toon ClaesJul 31, 2026
  40. Junio C HamanoJul 31, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.