From: kristofferhaugsbakk@fastmail.com Date: Wed, 03 Jun 2026 16:04:21 GMT Subject: [PATCH v2 0/4] doc: replay: fix config link Message-ID: In-Reply-To: From: Kristoffer Haugsbakk 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 v2 See the notes on the patches for more points and details. • Keep the description list for `replay.refAction` (Junio) • Add a comment on both description lists about the fact that the two are similar [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 v1: diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc index 42e521694d1..40d1695782a 100644 --- a/Documentation/config/replay.adoc +++ b/Documentation/config/replay.adoc @@ -1,5 +1,15 @@ replay.refAction:: - Specifies the default mode for handling reference updates. Either `update` or `print`. + Specifies the default mode for handling reference updates. + The value can be: ++ +-- +//// +These use the first sentences from the description list in git-replay(1). +//// +`update`;; (default) Update refs directly using an atomic transaction. +`print`;; Output update-ref commands for pipeline use. +-- ++ ifdef::git-replay[] See `--ref-action`. endif::git-replay[] diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc index 39ecc2e1876..ea4d14baddb 100644 --- a/Documentation/git-replay.adoc +++ b/Documentation/git-replay.adoc @@ -80,6 +80,9 @@ incompatible with `--contained` (which is a modifier for `--onto` only). Control how references are updated. The mode can be: + -- +//// +Expanded description list compared to 'replay.refAction'. +//// `update`;; (default) Update refs directly using an atomic transaction. All refs are updated or none are (all-or-nothing behavior). `print`;; Output update-ref commands for pipeline use. This is the Range-diff against v1: 1: ef8212a076a = 1: ef8212a076a doc: link to config for git-replay(1) 2: 7e915e331b5 ! 2: b60e2e02826 doc: replay: simplify replay.refAction description @@ Metadata Author: Kristoffer Haugsbakk ## Commit message ## - doc: replay: simplify replay.refAction description + doc: replay: improve config description - 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). + 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. - Also make sure to not self-link for the git-replay(1) inclusion. + 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 + conditional so that we avoid a self-link inside git-replay(1).[1] + + † 1: See e.g. e7b3a768 (doc: git-init: rework config item + init.templateDir, 2024-03-10) for another example of + avoiding self-linking Signed-off-by: Kristoffer Haugsbakk @@ Documentation/config/replay.adoc replay.refAction:: - Specifies the default mode for handling reference updates in - `git replay`. The value can be: --+ ---- ++ Specifies the default mode for handling reference updates. ++ The value can be: + + + -- - * `update`: Update refs directly using an atomic transaction (default behavior). - * `print`: Output update-ref commands for pipeline use. ---- --+ ++`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[] 3: 30952387f35 ! 3: d13cd39cb36 doc: replay: use a nested definition list @@ Metadata Author: Kristoffer Haugsbakk ## Commit message ## - doc: replay: use a nested definition list + doc: replay: use a nested description list This bullet list for `--ref-action` introduces a term with a colon. - This is exactly what a definition list is, structurally. Let’s be - sylistically consistent and use the definition list markup construct. + This is exactly what a description list is, structurally. Let’s be + sylistically consistent and use the desc. list markup construct.[1] We can reuse the `::` delimiter since we use an open block. - But for consistency use the typical nested definition list + 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 + Signed-off-by: Kristoffer Haugsbakk ## Documentation/git-replay.adoc ## 4: 71a61bc0ed4 < -: ----------- doc: replay: move “default” to the right-hand-side -: ----------- > 4: 17804ea7afa doc: replay: move “default” to the right-hand side base-commit: a89346e34a937f001e5d397ee62224e3e9852040 -- 2.54.0.22.g9e26862b904