[PATCH v3 0/4] doc: replay: fix config link
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- Jun 5, 2026, 13:55 UTC
- Message-ID
- <V3_CV_doc_replay_config.780@msgid.xyz>
- In-Reply-To
- <V2_CV_doc_replay_config.767@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Topic name (applied): kh/doc-replay-config
Topic summary: link to the config for git-replay(1) (one variable) in git-replay(1) and git-config(1). Also improve the doc for that config variable and `--ref-action`.
§ Changes in v3
Fix a commit message typo to “stylistically”. Also improve (IMO) the commit messages a bit. See the notes on the patches for details.
§ Link to v2
https://lore.kernel.org/git/V2_CV_doc_replay_config.767@msgid.xyz/
[1/4] doc: link to config for git-replay(1) [2/4] doc: replay: improve config description [3/4] doc: replay: use a nested description list [4/4] doc: replay: move “default” to the right-hand side
Documentation/config.adoc | 2 ++ Documentation/config/replay.adoc | 19 +++++++++++++------ Documentation/git-replay.adoc | 16 ++++++++++++---- 3 files changed, 27 insertions(+), 10 deletions(-)
Interdiff against v2:
Range-diff against v2:
1: ef8212a076a = 1: ef8212a076a doc: link to config for git-replay(1)
2: b60e2e02826 ! 2: 35b44b922e5 doc: replay: improve config description
@@ Metadata
## Commit message ##
doc: replay: improve config description
- First of all, this bullet list for `--ref-action` introduces a term with
- a colon. This is exactly what a description list is, structurally. Let’s
- be sylistically consistent and use the description list markup
- construct. Let’s also drop the harmless but unneeded indentation.
+ First of all, this unordered list for `replay.refAction` introduces
+ a term with a colon. This is exactly what a description list is,
+ structurally. Let’s be stylistically consistent and use the desc.
+ list markup construct. Let’s also drop the harmless but unneeded
+ indentation.
+
+ We can reuse the `::` delimiter since we use an open block.
+ But for consistency use the typical nested description list
+ delimiter, namely `;;`.
Second, let’s replace the inline-verbatim `git replay` with a link
to git-replay(1), since we are naming the command. But make that
3: d13cd39cb36 ! 3: 12c73641fb9 doc: replay: use a nested description list
@@ Commit message
This bullet list for `--ref-action` introduces a term with a colon.
This is exactly what a description list is, structurally. Let’s be
- sylistically consistent and use the desc. list markup construct.[1]
+ stylistically consistent and use the desc. list markup construct.
- We can reuse the `::` delimiter since we use an open block.
- But for consistency use the typical nested description list
- delimiter, namely `;;`.
-
- Also drop the harmless but unneeded indentation.
-
- † 1: Same explanation as in the previous commit
+ In short, just transform this unordered list in the same way that we
+ did for `replay.refAction` in the previous commit.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
4: 17804ea7afa = 4: e2191c723fc doc: replay: move “default” to the right-hand sidebase-commit: a89346e34a937f001e5d397ee62224e3e9852040
-- 2.54.0.22.g9e26862b904