Volume XXII, number 279Tuesday, October 6, 2026Latest message 42 minutes ago

The Git List

News and archive of git@vger.kernel.org, since April 2005

patch, 4 partsdoc: replay: fix config link

40 messages between May 21, 2026 and Jul 31, 2026, from kristofferhaugsbakk@fastmail.com, Junio C Hamano, Kristoffer Haugsbakk, Patrick Steinhardt, Toon Claes.

Plain Markdown or JSON for tools and agents. Diffs are folded; open one to read it.

kristofferhaugsbakk@fastmail.comMay 21, 2026, 18:01 UTC on lore
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Topic name: 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`.

[1/4] doc: link to config for git-replay(1) [2/4] doc: replay: simplify replay.refAction description [3/4] doc: replay: use a nested definition list [4/4] doc: replay: move “default” to the right-hand-side

 Documentation/config.adoc        |  2 ++
 Documentation/config/replay.adoc | 17 +++++++----------
 Documentation/git-replay.adoc    | 13 +++++++++----
 3 files changed, 18 insertions(+), 14 deletions(-)
base-commit: a89346e34a937f001e5d397ee62224e3e9852040
-- 
2.54.0.13.g9c7419e39f8
kristofferhaugsbakk@fastmail.comMay 21, 2026, 18:01 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH 1/4] doc: link to config for git-replay(1)

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This config doc was added in 336ac90c (replay: add replay.refAction config option, 2025-11-06) but never included anywhere. Include it in git-replay(1) and git-config(1).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/config.adoc     | 2 ++
 Documentation/git-replay.adoc | 4 ++++
 2 files changed, 6 insertions(+)
Show changes to 2 files +6 −0

Documentation/config.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config.adoc b/Documentation/config.adoc
index 62eebe7c545..51fabecb9b0 100644
--- a/Documentation/config.adoc
+++ b/Documentation/config.adoc
@@ -511,6 +511,8 @@ include::config/remotes.adoc[]
 
 include::config/repack.adoc[]
 
+include::config/replay.adoc[]
+
 include::config/rerere.adoc[]
 
 include::config/revert.adoc[]
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index a32f72aead3..f9ca2db2833 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
 `refs/heads/mybranch` to point at the result. This can be useful when you want
 to use bare commit IDs instead of branch names.
 
+CONFIGURATION
+-------------
+include::config/replay.adoc[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
2.54.0.13.g9c7419e39f8
kristofferhaugsbakk@fastmail.comMay 21, 2026, 18:01 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

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

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(-)
Show changes to 2 files +8 −8

Documentation/config/replay.adoc, Documentation/git-replay.adoc

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
kristofferhaugsbakk@fastmail.comMay 21, 2026, 18:02 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH 3/4] doc: replay: use a nested definition list

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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.

We can reuse the `::` delimiter since we use an open block. But for consistency use the typical nested definition list delimiter, namely `;;`.

Also drop the harmless but unneeded indentation.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-replay.adoc | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-replay.adoc +4 −4
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index 4de85088d6c..b4fe43ec687 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,10 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-	* `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
-	  traditional behavior where output can be piped to `git update-ref --stdin`.
+`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
+	traditional behavior where output can be piped to `git update-ref --stdin`.
 --
 +
 The default mode can be configured via the `replay.refAction` configuration variable.
-- 
2.54.0.13.g9c7419e39f8
kristofferhaugsbakk@fastmail.comMay 21, 2026, 18:02 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH 4/4] doc: replay: move “default” to the right-hand-side

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This is now a definition list (see previous commit) and parentheticals like this do not go on the left-hand-side. Moving it to the other side makes it stand out just as much and is also more consistent with the rest of the documentation.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    > do not go on the left-hand-side.
    
    At least I haven’t seen it.
 Documentation/git-replay.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-replay.adoc +1 −1
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index b4fe43ec687..39ecc2e1876 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,7 +80,7 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-`update` (default);; Update refs directly using an atomic transaction.
+`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
 	traditional behavior where output can be piped to `git update-ref --stdin`.
-- 
2.54.0.13.g9c7419e39f8
Junio C HamanoMay 30, 2026, 22:18 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH 0/4] doc: replay: fix config link

kristofferhaugsbakk@fastmail.com writes:
Show 6 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> [1/4] doc: link to config for git-replay(1)
> [2/4] doc: replay: simplify replay.refAction description
> [3/4] doc: replay: use a nested definition list
> [4/4] doc: replay: move “default” to the right-hand-side
It is always nice to see documentation gaps filled.
Junio C HamanoMay 30, 2026, 22:18 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH 1/4] doc: link to config for git-replay(1)

kristofferhaugsbakk@fastmail.com writes:
Show 11 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> This config doc was added in 336ac90c (replay: add replay.refAction
> config option, 2025-11-06) but never included anywhere. Include it in
> git-replay(1) and git-config(1).
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>  Documentation/config.adoc     | 2 ++
>  Documentation/git-replay.adoc | 4 ++++
>  2 files changed, 6 insertions(+)
It is always nice to see documentation gaps filled.

The `replay.refAction` configuration variable was indeed left dangling without a proper link from the main command documentation, which is embarrassing. I wonder if we can add simple "doc-lint" rule or two to prevent similar mistakes from happening again?

Show 13 quoted lines
> diff --git a/Documentation/config.adoc b/Documentation/config.adoc
> index 62eebe7c545..51fabecb9b0 100644
> --- a/Documentation/config.adoc
> +++ b/Documentation/config.adoc
> @@ -511,6 +511,8 @@ include::config/remotes.adoc[]
>  
>  include::config/repack.adoc[]
>  
> +include::config/replay.adoc[]
> +
>  include::config/rerere.adoc[]
>  
>  include::config/revert.adoc[]

Placing `include::config/replay.adoc[]` in `config.adoc` alphabetically between `repack` and `rerere` is correct, as the list is alphabetical.

Show 12 quoted lines
> diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
> index a32f72aead3..f9ca2db2833 100644
> --- a/Documentation/git-replay.adoc
> +++ b/Documentation/git-replay.adoc
> @@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
>  `refs/heads/mybranch` to point at the result. This can be useful when you want
>  to use bare commit IDs instead of branch names.
>  
> +CONFIGURATION
> +-------------
> +include::config/replay.adoc[]
> +

Adding the `CONFIGURATION` section near the end of `git-replay.adoc` is also the standard way we expose configuration variables to the command's manual page.

Looking good.
>  GIT
>  ---
>  Part of the linkgit:git[1] suite
Junio C HamanoMay 30, 2026, 22:29 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

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

kristofferhaugsbakk@fastmail.com writes:
Show 18 quoted lines
>  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[]

This makes it a bit roundabout for "git config --help" readers who wanted to figure out what value to set to the configuration variable, because the valid choices are no longer listed here.

Finding `--ref-action=<mode>` and its description in the other page is straight-forward, so it may not be too bad, though.

Show 10 quoted lines
> 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[]

The use of conditional attributes (`ifdef::git-replay[]`) is a neat and standard way to tailor the description depending on whether it is read as part of `git-config(1)` or `git-replay(1)`. It correctly points the reader to `--ref-action` in the latter case, and provides a full `linkgit` reference in the former. Clean and correct.

Junio C HamanoMay 30, 2026, 22:37 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

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

kristofferhaugsbakk@fastmail.com writes:
Show 18 quoted lines
>  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[]

This makes it a bit roundabout for "git config --help" readers who wanted to figure out what value to set to the configuration variable, because the valid choices are no longer listed here.

Finding `--ref-action=<mode>` and its description in the other page is straight-forward, so it may not be too bad, though.

Show 10 quoted lines
> 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[]

The use of conditional attributes (`ifdef::git-replay[]`) is a neat and standard way to tailor the description depending on whether it is read as part of `git-config(1)` or `git-replay(1)`. It correctly points the reader to `--ref-action` in the latter case, and provides a full `linkgit` reference in the former. Clean and correct.

Junio C HamanoMay 30, 2026, 22:37 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH 3/4] doc: replay: use a nested definition list

kristofferhaugsbakk@fastmail.com writes:
Show 5 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> 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.
Makes sense.
Show 11 quoted lines
>  --
> -	* `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
> -	  traditional behavior where output can be piped to `git update-ref --stdin`.
> +`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
> +	traditional behavior where output can be piped to `git update-ref --stdin`.
>  --
>  +

The transition from a bulleted list to a nested definition list (`;;`) for the `--ref-action` modes indeed makes the document structure much cleaner.

>  The default mode can be configured via the `replay.refAction` configuration variable.
Junio C HamanoMay 30, 2026, 22:37 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH 4/4] doc: replay: move “default” to the right-hand-side

kristofferhaugsbakk@fastmail.com writes:
> -`update` (default);; Update refs directly using an atomic transaction.
> +`update`;; (default) Update refs directly using an atomic transaction.
This looks sensible.  Nice.
>  	All refs are updated or none are (all-or-nothing behavior).
>  `print`;; Output update-ref commands for pipeline use. This is the
>  	traditional behavior where output can be piped to `git update-ref --stdin`.
Kristoffer HaugsbakkJun 2, 2026, 11:58 UTC in reply to Junio C Hamano on lore

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

On Sun, May 31, 2026, at 00:37, Junio C Hamano wrote:
Show 24 quoted lines
> kristofferhaugsbakk@fastmail.com writes:
>
>>  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[]
>
> This makes it a bit roundabout for "git config --help" readers who
> wanted to figure out what value to set to the configuration
> variable, because the valid choices are no longer listed here.
That’s a good point. My thought process at the time was

• This description list needs to be changed • But I also need to change it on git-replay(1)... • So why not just gesture towards git-replay(1)?

But now I see that this does make it slightly worse. Which is not worth the saved effort.

I was thinking that a shared file which is included in the config and git-replay(1) could be used. That file would just contain the definition list. I could also duplicate it manually and leave a comment about keeping them in synch. What do you think?

Assuming that they should be equal, which I think right now although I haven’t started on the next version yet.

Show 20 quoted lines
>
> Finding `--ref-action=<mode>` and its description in the other page
> is straight-forward, so it may not be too bad, though.
>
>> 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[]
>
> The use of conditional attributes (`ifdef::git-replay[]`) is a neat
> and standard way to tailor the description depending on whether it
> is read as part of `git-config(1)` or `git-replay(1)`. It correctly
> points the reader to `--ref-action` in the latter case, and provides
> a full `linkgit` reference in the former. Clean and correct.
Thanks for the thorough review.
kristofferhaugsbakk@fastmail.comJun 3, 2026, 16:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v2 0/4] doc: replay: fix config link

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 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:
Show changes to 2 files +14 −2

Documentation/config/replay.adoc, Documentation/git-replay.adoc

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 <code@khaugsbakk.name>
     
      ## 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 <code@khaugsbakk.name>
     
    @@ 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 <code@khaugsbakk.name>
     
      ## 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 <code@khaugsbakk.name>
     
      ## 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
kristofferhaugsbakk@fastmail.comJun 3, 2026, 16:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v2 1/4] doc: link to config for git-replay(1)

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This config doc was added in 336ac90c (replay: add replay.refAction config option, 2025-11-06) but never included anywhere. Include it in git-replay(1) and git-config(1).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/config.adoc     | 2 ++
 Documentation/git-replay.adoc | 4 ++++
 2 files changed, 6 insertions(+)
Show changes to 2 files +6 −0

Documentation/config.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config.adoc b/Documentation/config.adoc
index 62eebe7c545..51fabecb9b0 100644
--- a/Documentation/config.adoc
+++ b/Documentation/config.adoc
@@ -511,6 +511,8 @@ include::config/remotes.adoc[]
 
 include::config/repack.adoc[]
 
+include::config/replay.adoc[]
+
 include::config/rerere.adoc[]
 
 include::config/revert.adoc[]
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index a32f72aead3..f9ca2db2833 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
 `refs/heads/mybranch` to point at the result. This can be useful when you want
 to use bare commit IDs instead of branch names.
 
+CONFIGURATION
+-------------
+include::config/replay.adoc[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 3, 2026, 16:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v2 2/4] doc: replay: improve config description

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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.

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 <code@khaugsbakk.name>
---
Notes (series):
    v2:
    • Keep the description list for `replay.refAction` (Junio)
    • Now rewrite the description list like in patch 1/3 (it’s
      technically an unordered list)
    • Msg: mention a previous commit which also avoided self-linking.
      This helps establish a bit more context for why we do this.
 Documentation/config/replay.adoc | 16 ++++++++++------
 Documentation/git-replay.adoc    |  1 +
 2 files changed, 11 insertions(+), 6 deletions(-)
Show changes to 2 files +11 −6

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7d549d2f0e5..7328da9537d 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -1,11 +1,15 @@
 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.
+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.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 3, 2026, 16:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v2 3/4] doc: replay: use a nested description list

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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]

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
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v2:
    • Msg: Mention that the explanation for the description list is the
      same as in the previous commit
    • Msg: It’s “description list”, not “definition list”
 Documentation/git-replay.adoc | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-replay.adoc +4 −4
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index 4de85088d6c..b4fe43ec687 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,10 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-	* `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
-	  traditional behavior where output can be piped to `git update-ref --stdin`.
+`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
+	traditional behavior where output can be piped to `git update-ref --stdin`.
 --
 +
 The default mode can be configured via the `replay.refAction` configuration variable.
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 3, 2026, 16:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v2 4/4] doc: replay: move “default” to the right-hand side

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This is now a description list (see previous commit) and parentheticals like this do not go on the left-hand side. Moving it to the other side makes it stand out just as much and is also more consistent with the rest of the documentation.

Let’s also do the same for the `replay.refAction` description list. That makes the two desc. lists identical in the first sentence. Let’s add a comment about that for future editors.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v2:
    • It’s “description list”, not “definition list”
      • (Same mistake I have done for “line continuation” (it’s “list”))
    • It’s e.g. “right-hand side” (drop “-side” hyphen)
    • Change `replay.refAction` “default” placement
    • Now that these two description lists are so similar, add an
      AsciiDoc comment about it for future editors. Note that I
      outright deleted this list in the previous version because I
      didn’t want to keep them in synch. But we can remain aware of
      these with two comments.
    
    ---
    
    v1:
    > do not go on the left-hand-side.
    
    At least I haven’t seen it.
 Documentation/config/replay.adoc | 5 ++++-
 Documentation/git-replay.adoc    | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
Show changes to 2 files +8 −2

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7328da9537d..40d1695782a 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -3,7 +3,10 @@ replay.refAction::
 	The value can be:
 +
 --
-`update`;; Update refs directly using an atomic transaction (default behavior).
+////
+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.
 --
 +
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index b4fe43ec687..ea4d14baddb 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,7 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-`update` (default);; Update refs directly using an atomic transaction.
+////
+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
 	traditional behavior where output can be piped to `git update-ref --stdin`.
-- 
2.54.0.22.g9e26862b904
Patrick SteinhardtJun 4, 2026, 06:27 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH v2 2/4] doc: replay: improve config description

On Wed, Jun 03, 2026 at 06:04:23PM +0200, kristofferhaugsbakk@fastmail.com wrote:
Show 5 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
> 
> 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
s/sylistically/stylistically/
Show 10 quoted lines
> 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[]

Not quite sure, but was this change supposed to be part of the preceding commit, where you also added the include?

Patrick
Kristoffer HaugsbakkJun 4, 2026, 06:31 UTC in reply to Patrick Steinhardt on lore

Re: [PATCH v2 2/4] doc: replay: improve config description

On Thu, Jun 4, 2026, at 08:27, Patrick Steinhardt wrote:
Show 9 quoted lines
> On Wed, Jun 03, 2026 at 06:04:23PM +0200,
> kristofferhaugsbakk@fastmail.com wrote:
>> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>>
>> 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
>
> s/sylistically/stylistically/
Thanks, I’ll make the correction.
Show 14 quoted lines
>
>> 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[]
>
> Not quite sure, but was this change supposed to be part of the preceding
> commit, where you also added the include?

No, because the conditional is only being put to use now. That was the intention anyway. Maybe there is some reason to put it in the first commit?

Thanks!
Patrick SteinhardtJun 4, 2026, 09:05 UTC in reply to Kristoffer Haugsbakk on lore

Re: [PATCH v2 2/4] doc: replay: improve config description

On Thu, Jun 04, 2026 at 08:31:57AM +0200, Kristoffer Haugsbakk wrote:
Show 20 quoted lines
> On Thu, Jun 4, 2026, at 08:27, Patrick Steinhardt wrote:
> > On Wed, Jun 03, 2026 at 06:04:23PM +0200,
> > kristofferhaugsbakk@fastmail.com wrote:
> >> 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[]
> >
> > Not quite sure, but was this change supposed to be part of the preceding
> > commit, where you also added the include?
> 
> No, because the conditional is only being put to use now. That was the
> intention anyway. Maybe there is some reason to put it in the first
> commit?

Probably not. It just read funny, but I guess that it's my ignorance about the adoc format that was also at play here.

Patrick
Kristoffer HaugsbakkJun 4, 2026, 20:38 UTC in reply to Junio C Hamano on lore

Re: [PATCH 1/4] doc: link to config for git-replay(1)

On Sun, May 31, 2026, at 00:18, Junio C Hamano wrote:
Show 20 quoted lines
> kristofferhaugsbakk@fastmail.com writes:
>
>> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>>
>> This config doc was added in 336ac90c (replay: add replay.refAction
>> config option, 2025-11-06) but never included anywhere. Include it in
>> git-replay(1) and git-config(1).
>>
>> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
>> ---
>>  Documentation/config.adoc     | 2 ++
>>  Documentation/git-replay.adoc | 4 ++++
>>  2 files changed, 6 insertions(+)
>
> It is always nice to see documentation gaps filled.
>
> The `replay.refAction` configuration variable was indeed left
> dangling without a proper link from the main command documentation,
> which is embarrassing.  I wonder if we can add simple "doc-lint"
> rule or two to prevent similar mistakes from happening again?
For what it’s worth this is how I found it.

I was working on the kh/doc-hook topic and noticed that my changes didn’t trigger any `doc-diff` changes for git-config(1). So I checked the file and nope, it wasn’t included. Then I massaged the file includes and diffed it with `Documentation/config/`. The only missing ones were:

• replay • fmt-merge-msg

And `fmt-merge-msg` turned out to be a false positive since it is included via `merge` or something.

Show 7 quoted lines
>
>> diff --git a/Documentation/config.adoc b/Documentation/config.adoc
>> index 62eebe7c545..51fabecb9b0 100644
>> --- a/Documentation/config.adoc
>> +++ b/Documentation/config.adoc
>> @@ -511,6 +511,8 @@ include::config/remotes.adoc[]
>>[snip]
kristofferhaugsbakk@fastmail.comJun 5, 2026, 13:55 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v3 0/4] doc: replay: fix config link

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 side
base-commit: a89346e34a937f001e5d397ee62224e3e9852040
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 5, 2026, 13:55 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v3 1/4] doc: link to config for git-replay(1)

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This config doc was added in 336ac90c (replay: add replay.refAction config option, 2025-11-06) but never included anywhere. Include it in git-replay(1) and git-config(1).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/config.adoc     | 2 ++
 Documentation/git-replay.adoc | 4 ++++
 2 files changed, 6 insertions(+)
Show changes to 2 files +6 −0

Documentation/config.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config.adoc b/Documentation/config.adoc
index 62eebe7c545..51fabecb9b0 100644
--- a/Documentation/config.adoc
+++ b/Documentation/config.adoc
@@ -511,6 +511,8 @@ include::config/remotes.adoc[]
 
 include::config/repack.adoc[]
 
+include::config/replay.adoc[]
+
 include::config/rerere.adoc[]
 
 include::config/revert.adoc[]
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index a32f72aead3..f9ca2db2833 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
 `refs/heads/mybranch` to point at the result. This can be useful when you want
 to use bare commit IDs instead of branch names.
 
+CONFIGURATION
+-------------
+include::config/replay.adoc[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 5, 2026, 13:56 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v3 2/4] doc: replay: improve config description

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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 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 <code@khaugsbakk.name>
---
Notes (series):
    v3:
    • Msg:[1] typo, fix to “stylistically”
    • Msg: Move the paragraph about delimiters (;;) from the *next*
      patch over here instead. This is the first place we do it. In the
      next patch we can just say that we are doing the same trans-
      formation as here.
    • Msg: Remove double-space to separate two sentences. That’s
      inconsitent for me. I moved away from that because two-space
      separation takes up too much space when linewrapping is set to 72.
    • Msg: This isn’t the option, it is `replay.refAction`
      • Copy–paste mistake? We don’t have to ask
    • Msg: ... and it’s better to call it an unordered list rather than
      bullet points
    
    † 1: Commit message
    
    ---
    
    v2:
    • Keep the description list for `replay.refAction` (Junio)
    • Now rewrite the description list like in patch 1/3 (it’s
      technically an unordered list)
    • Msg: mention a previous commit which also avoided self-linking.
      This helps establish a bit more context for why we do this.
 Documentation/config/replay.adoc | 16 ++++++++++------
 Documentation/git-replay.adoc    |  1 +
 2 files changed, 11 insertions(+), 6 deletions(-)
Show changes to 2 files +11 −6

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7d549d2f0e5..7328da9537d 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -1,11 +1,15 @@
 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.
+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.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 5, 2026, 13:56 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v3 3/4] doc: replay: use a nested description list

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This bullet list for `--ref-action` 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.

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>
---
Notes (series):
    v3:
    • Msg:[1] Fix typo: “stylistically”
    • Msg: Simplify message. Devote one paragraph to   † 1: Commit
      explain the transformation. Then delegate to the         message
      previous patch since we did the same trans-
      formation there.
    
    ---
    
    v2:
    • Msg: Mention that the explanation for the description list is the
      same as in the previous commit
    • Msg: It’s “description list”, not “definition list”
 Documentation/git-replay.adoc | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-replay.adoc +4 −4
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index 4de85088d6c..b4fe43ec687 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,10 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-	* `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
-	  traditional behavior where output can be piped to `git update-ref --stdin`.
+`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
+	traditional behavior where output can be piped to `git update-ref --stdin`.
 --
 +
 The default mode can be configured via the `replay.refAction` configuration variable.
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJun 5, 2026, 13:56 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v3 4/4] doc: replay: move “default” to the right-hand side

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This is now a description list (see previous commit) and parentheticals like this do not go on the left-hand side. Moving it to the other side makes it stand out just as much and is also more consistent with the rest of the documentation.

Let’s also do the same for the `replay.refAction` description list. That makes the two desc. lists identical in the first sentence. Let’s add a comment about that for future editors.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v2:
    • It’s “description list”, not “definition list”
      • (Same mistake I have done for “line continuation” (it’s “list”))
    • It’s e.g. “right-hand side” (drop “-side” hyphen)
    • Change `replay.refAction` “default” placement
    • Now that these two description lists are so similar, add an
      AsciiDoc comment about it for future editors. Note that I
      outright deleted this list in the previous version because I
      didn’t want to keep them in synch. But we can remain aware of
      these with two comments.
    
    ---
    
    v1:
    > do not go on the left-hand-side.
    
    At least I haven’t seen it.
 Documentation/config/replay.adoc | 5 ++++-
 Documentation/git-replay.adoc    | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
Show changes to 2 files +8 −2

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7328da9537d..40d1695782a 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -3,7 +3,10 @@ replay.refAction::
 	The value can be:
 +
 --
-`update`;; Update refs directly using an atomic transaction (default behavior).
+////
+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.
 --
 +
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index b4fe43ec687..ea4d14baddb 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,7 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-`update` (default);; Update refs directly using an atomic transaction.
+////
+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
 	traditional behavior where output can be piped to `git update-ref --stdin`.
-- 
2.54.0.22.g9e26862b904
Toon ClaesJul 8, 2026, 12:04 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH v3 2/4] doc: replay: improve config description

kristofferhaugsbakk@fastmail.com writes:
Show 11 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> 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 `;;`.

Yeah, looking at some other docs (for example Documenation/config/branch.adoc) it makes sense to do it like this.

Show 66 quoted lines
> 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 <code@khaugsbakk.name>
> ---
>
> Notes (series):
>     v3:
>     • Msg:[1] typo, fix to “stylistically”
>     • Msg: Move the paragraph about delimiters (;;) from the *next*
>       patch over here instead. This is the first place we do it. In the
>       next patch we can just say that we are doing the same trans-
>       formation as here.
>     • Msg: Remove double-space to separate two sentences. That’s
>       inconsitent for me. I moved away from that because two-space
>       separation takes up too much space when linewrapping is set to 72.
>     • Msg: This isn’t the option, it is `replay.refAction`
>       • Copy–paste mistake? We don’t have to ask
>     • Msg: ... and it’s better to call it an unordered list rather than
>       bullet points
>     
>     † 1: Commit message
>     
>     ---
>     
>     v2:
>     • Keep the description list for `replay.refAction` (Junio)
>     • Now rewrite the description list like in patch 1/3 (it’s
>       technically an unordered list)
>     • Msg: mention a previous commit which also avoided self-linking.
>       This helps establish a bit more context for why we do this.
>
>  Documentation/config/replay.adoc | 16 ++++++++++------
>  Documentation/git-replay.adoc    |  1 +
>  2 files changed, 11 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
> index 7d549d2f0e5..7328da9537d 100644
> --- a/Documentation/config/replay.adoc
> +++ b/Documentation/config/replay.adoc
> @@ -1,11 +1,15 @@
>  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.
> +ifdef::git-replay[]
> +See `--ref-action`.
> +endif::git-replay[]
> +ifndef::git-replay[]
> +See `--ref-action` for linkgit:git-replay[1] for details.
I'm not sure about using "for" twice, how about:
    See `--ref-action` in linkgit:git-replay[1] for details.
Show 17 quoted lines
> +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.22.g9e26862b904
>
>
-- 
Cheers,
Toon
Toon ClaesJul 8, 2026, 12:09 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH v3 4/4] doc: replay: move “default” to the right-hand side

kristofferhaugsbakk@fastmail.com writes:
Show 10 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> This is now a description list (see previous commit) and parentheticals
> like this do not go on the left-hand side. Moving it to the other side
> makes it stand out just as much and is also more consistent with the
> rest of the documentation.
>
> Let’s also do the same for the `replay.refAction` description list.
> That makes the two desc. lists identical in the first sentence. Let’s
> add a comment about that for future editors.

Ah, these quad slashes are comments? Well, that's a thing I've learned today.

Makes sense.
Show 62 quoted lines
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>
> Notes (series):
>     v2:
>     • It’s “description list”, not “definition list”
>       • (Same mistake I have done for “line continuation” (it’s “list”))
>     • It’s e.g. “right-hand side” (drop “-side” hyphen)
>     • Change `replay.refAction` “default” placement
>     • Now that these two description lists are so similar, add an
>       AsciiDoc comment about it for future editors. Note that I
>       outright deleted this list in the previous version because I
>       didn’t want to keep them in synch. But we can remain aware of
>       these with two comments.
>     
>     ---
>     
>     v1:
>     > do not go on the left-hand-side.
>     
>     At least I haven’t seen it.
>
>  Documentation/config/replay.adoc | 5 ++++-
>  Documentation/git-replay.adoc    | 5 ++++-
>  2 files changed, 8 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
> index 7328da9537d..40d1695782a 100644
> --- a/Documentation/config/replay.adoc
> +++ b/Documentation/config/replay.adoc
> @@ -3,7 +3,10 @@ replay.refAction::
>  	The value can be:
>  +
>  --
> -`update`;; Update refs directly using an atomic transaction (default behavior).
> +////
> +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.
>  --
>  +
> diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
> index b4fe43ec687..ea4d14baddb 100644
> --- a/Documentation/git-replay.adoc
> +++ b/Documentation/git-replay.adoc
> @@ -80,7 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
>  	Control how references are updated. The mode can be:
>  +
>  --
> -`update` (default);; Update refs directly using an atomic transaction.
> +////
> +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
>  	traditional behavior where output can be piped to `git update-ref --stdin`.
> -- 
> 2.54.0.22.g9e26862b904
>
>
-- 
Cheers,
Toon
Junio C HamanoJul 23, 2026, 23:58 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH v3 0/4] doc: replay: fix config link

kristofferhaugsbakk@fastmail.com writes:
Show 7 quoted lines
> 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`.

I was reviewing the draft of the What's Cooking report and noticed that this topic is among a handful of stalled efforts going nowhere.

It has been more than a month since this thread got a few good comments by Toon Claes. Would we see an update anytime soon? If not, let me mark the topic to be discarded in my draft of the whats-cooking report.

Thanks.
Kristoffer HaugsbakkJul 30, 2026, 09:50 UTC in reply to Toon Claes on lore

Re: [PATCH v3 2/4] doc: replay: improve config description

On Wed, Jul 8, 2026, at 14:04, Toon Claes wrote:
Show 12 quoted lines
>>[snip]
>> -This setting can be overridden with the `--ref-action` command-line option.
>> -When not configured, `git replay` defaults to `update` mode.
>> +ifdef::git-replay[]
>> +See `--ref-action`.
>> +endif::git-replay[]
>> +ifndef::git-replay[]
>> +See `--ref-action` for linkgit:git-replay[1] for details.
>
> I'm not sure about using "for" twice, how about:
>
>     See `--ref-action` in linkgit:git-replay[1] for details.
That’s excellent. I’ll use it.
Thanks for taking a look!
Show 8 quoted lines
>
>> +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.
>>[snip]
kristofferhaugsbakk@fastmail.comJul 30, 2026, 09:57 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v4 0/4] doc: replay: fix config link

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 v4

Patch “improve config description”: Take Toon’s suggestion about avoiding two “for”.

§ Link to v3
https://lore.kernel.org/git/V3_CV_doc_replay_config.780@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 v3:
Show changes to Documentation/config/replay.adoc +1 −1
diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 40d1695782a..84e17e313a1 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -14,5 +14,5 @@ ifdef::git-replay[]
 See `--ref-action`.
 endif::git-replay[]
 ifndef::git-replay[]
-See `--ref-action` for linkgit:git-replay[1] for details.
+See `--ref-action` in linkgit:git-replay[1] for details.
 endif::git-replay[]
Range-diff against v3:
1:  ef8212a076a = 1:  ef8212a076a doc: link to config for git-replay(1)
2:  35b44b922e5 ! 2:  392c4f3ab9e doc: replay: improve config description
    @@ Documentation/config/replay.adoc
     +See `--ref-action`.
     +endif::git-replay[]
     +ifndef::git-replay[]
    -+See `--ref-action` for linkgit:git-replay[1] for details.
    ++See `--ref-action` in linkgit:git-replay[1] for details.
     +endif::git-replay[]
     
      ## Documentation/git-replay.adoc ##
3:  12c73641fb9 = 3:  a693ab0b6d3 doc: replay: use a nested description list
4:  e2191c723fc = 4:  53663bd54ed doc: replay: move “default” to the right-hand side

base-commit: a89346e34a937f001e5d397ee62224e3e9852040
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJul 30, 2026, 09:57 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v4 1/4] doc: link to config for git-replay(1)

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This config doc was added in 336ac90c (replay: add replay.refAction config option, 2025-11-06) but never included anywhere. Include it in git-replay(1) and git-config(1).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/config.adoc     | 2 ++
 Documentation/git-replay.adoc | 4 ++++
 2 files changed, 6 insertions(+)
Show changes to 2 files +6 −0

Documentation/config.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config.adoc b/Documentation/config.adoc
index 62eebe7c545..51fabecb9b0 100644
--- a/Documentation/config.adoc
+++ b/Documentation/config.adoc
@@ -511,6 +511,8 @@ include::config/remotes.adoc[]
 
 include::config/repack.adoc[]
 
+include::config/replay.adoc[]
+
 include::config/rerere.adoc[]
 
 include::config/revert.adoc[]
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index a32f72aead3..f9ca2db2833 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
 `refs/heads/mybranch` to point at the result. This can be useful when you want
 to use bare commit IDs instead of branch names.
 
+CONFIGURATION
+-------------
+include::config/replay.adoc[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
2.54.0.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJul 30, 2026, 09:57 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v4 2/4] doc: replay: improve config description

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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 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 <code@khaugsbakk.name>
---
Notes (series):
    v4:
    • Avoid two “for” in the same sentence; makes the sentence
      flow better
    
      Suggested by Toon: https://lore.kernel.org/git/87cxwxofgv.fsf@emacs.iotcl.com/#t
    
    ---
    
    v3:
    • Msg:[1] typo, fix to “stylistically”
    • Msg: Move the paragraph about delimiters (;;) from the *next*
      patch over here instead. This is the first place we do it. In the
      next patch we can just say that we are doing the same trans-
      formation as here.
    • Msg: Remove double-space to separate two sentences. That’s
      inconsitent for me. I moved away from that because two-space
      separation takes up too much space when linewrapping is set to 72.
    • Msg: This isn’t the option, it is `replay.refAction`
      • Copy–paste mistake? We don’t have to ask
    • Msg: ... and it’s better to call it an unordered list rather than
      bullet points
    
    † 1: Commit message
    
    ---
    
    v2:
    • Keep the description list for `replay.refAction` (Junio)
    • Now rewrite the description list like in patch 1/3 (it’s
      technically an unordered list)
    • Msg: mention a previous commit which also avoided self-linking.
      This helps establish a bit more context for why we do this.
 Documentation/config/replay.adoc | 16 ++++++++++------
 Documentation/git-replay.adoc    |  1 +
 2 files changed, 11 insertions(+), 6 deletions(-)
Show changes to 2 files +11 −6

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7d549d2f0e5..a7dd5288553 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -1,11 +1,15 @@
 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.
+ifdef::git-replay[]
+See `--ref-action`.
+endif::git-replay[]
+ifndef::git-replay[]
+See `--ref-action` in 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.22.g9e26862b904
kristofferhaugsbakk@fastmail.comJul 30, 2026, 09:57 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v4 3/4] doc: replay: use a nested description list

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This bullet list for `--ref-action` 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.

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>
---
Notes (series):
    v3:
    • Msg:[1] Fix typo: “stylistically”
    • Msg: Simplify message. Devote one paragraph to   † 1: Commit
      explain the transformation. Then delegate to the         message
      previous patch since we did the same trans-
      formation there.
    
    ---
    
    v2:
    • Msg: Mention that the explanation for the description list is the
      same as in the previous commit
    • Msg: It’s “description list”, not “definition list”
 Documentation/git-replay.adoc | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-replay.adoc +4 −4
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index 4de85088d6c..b4fe43ec687 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,10 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-	* `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
-	  traditional behavior where output can be piped to `git update-ref --stdin`.
+`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
+	traditional behavior where output can be piped to `git update-ref --stdin`.
 --
 +
 The default mode can be configured via the `replay.refAction` configuration variable.
-- 
2.54.0.22.g9e26862b904
Kristoffer HaugsbakkJul 30, 2026, 09:58 UTC in reply to Junio C Hamano on lore

Re: [PATCH v3 0/4] doc: replay: fix config link

On Fri, Jul 24, 2026, at 01:58, Junio C Hamano wrote:
Show 19 quoted lines
> kristofferhaugsbakk@fastmail.com writes:
>
>> 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`.
>
> I was reviewing the draft of the What's Cooking report and noticed  
> that this topic is among a handful of stalled efforts going nowhere.
>
> It has been more than a month since this thread got a few good
> comments by Toon Claes.  Would we see an update anytime soon?  If
> not, let me mark the topic to be discarded in my draft of the
> whats-cooking report.
>
> Thanks.
I have posted a new version now.
kristofferhaugsbakk@fastmail.comJul 30, 2026, 09:57 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

[PATCH v4 4/4] doc: replay: move “default” to the right-hand side

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This is now a description list (see previous commit) and parentheticals like this do not go on the left-hand side. Moving it to the other side makes it stand out just as much and is also more consistent with the rest of the documentation.

Let’s also do the same for the `replay.refAction` description list. That makes the two desc. lists identical in the first sentence. Let’s add a comment about that for future editors.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v2:
    • It’s “description list”, not “definition list”
      • (Same mistake I have done for “line continuation” (it’s “list”))
    • It’s e.g. “right-hand side” (drop “-side” hyphen)
    • Change `replay.refAction` “default” placement
    • Now that these two description lists are so similar, add an
      AsciiDoc comment about it for future editors. Note that I
      outright deleted this list in the previous version because I
      didn’t want to keep them in synch. But we can remain aware of
      these with two comments.
    
    ---
    
    v1:
    > do not go on the left-hand-side.
    
    At least I haven’t seen it.
 Documentation/config/replay.adoc | 5 ++++-
 Documentation/git-replay.adoc    | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
Show changes to 2 files +8 −2

Documentation/config/replay.adoc, Documentation/git-replay.adoc

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index a7dd5288553..84e17e313a1 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -3,7 +3,10 @@ replay.refAction::
 	The value can be:
 +
 --
-`update`;; Update refs directly using an atomic transaction (default behavior).
+////
+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.
 --
 +
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index b4fe43ec687..ea4d14baddb 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,7 +80,10 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
 	Control how references are updated. The mode can be:
 +
 --
-`update` (default);; Update refs directly using an atomic transaction.
+////
+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
 	traditional behavior where output can be piped to `git update-ref --stdin`.
-- 
2.54.0.22.g9e26862b904
Junio C HamanoJul 30, 2026, 16:19 UTC in reply to kristofferhaugsbakk@fastmail.com on lore

Re: [PATCH v4 0/4] doc: replay: fix config link

kristofferhaugsbakk@fastmail.com writes:
Show 16 quoted lines
> 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 v4
>
> Patch “improve config description”: Take Toon’s suggestion about avoiding
> two “for”.
>
> § Link to v3
>
> https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/

That's truly minimal update. It is a bit surprising that the topic was stuck for a long time, nearing its expiration date.

A quick look at the thread https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/ tells me that there weren't any outstanding review comments.

That unfortunately does not say if this version is good enough or people got tired of reviewing and did not pick all lints in v3, but we need to work with what we have, so let's see how smoothly this round goes.

Will replace.  Thanks.
Show 38 quoted lines
> [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 v3:
> diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
> index 40d1695782a..84e17e313a1 100644
> --- a/Documentation/config/replay.adoc
> +++ b/Documentation/config/replay.adoc
> @@ -14,5 +14,5 @@ ifdef::git-replay[]
>  See `--ref-action`.
>  endif::git-replay[]
>  ifndef::git-replay[]
> -See `--ref-action` for linkgit:git-replay[1] for details.
> +See `--ref-action` in linkgit:git-replay[1] for details.
>  endif::git-replay[]
> Range-diff against v3:
> 1:  ef8212a076a = 1:  ef8212a076a doc: link to config for git-replay(1)
> 2:  35b44b922e5 ! 2:  392c4f3ab9e doc: replay: improve config description
>     @@ Documentation/config/replay.adoc
>      +See `--ref-action`.
>      +endif::git-replay[]
>      +ifndef::git-replay[]
>     -+See `--ref-action` for linkgit:git-replay[1] for details.
>     ++See `--ref-action` in linkgit:git-replay[1] for details.
>      +endif::git-replay[]
>      
>       ## Documentation/git-replay.adoc ##
> 3:  12c73641fb9 = 3:  a693ab0b6d3 doc: replay: use a nested description list
> 4:  e2191c723fc = 4:  53663bd54ed doc: replay: move “default” to the right-hand side
>
> base-commit: a89346e34a937f001e5d397ee62224e3e9852040
Kristoffer HaugsbakkJul 30, 2026, 16:31 UTC in reply to Junio C Hamano on lore

Re: [PATCH v4 0/4] doc: replay: fix config link

On Thu, Jul 30, 2026, at 18:19, Junio C Hamano wrote:
Show 22 quoted lines
> kristofferhaugsbakk@fastmail.com writes:
>>[snip]
>> § Changes in v4
>>
>> Patch “improve config description”: Take Toon’s suggestion about avoiding
>> two “for”.
>>
>> § Link to v3
>>
>> https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/
>
> That's truly minimal update.  It is a bit surprising that the topic
> was stuck for a long time, nearing its expiration date.
>
> A quick look at the thread
> https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/
> tells me that there weren't any outstanding review comments.
>
> That unfortunately does not say if this version is good enough or
> people got tired of reviewing and did not pick all lints in v3, but
> we need to work with what we have, so let's see how smoothly this
> round goes.

Yeah, there just hasn’t been much interest in this topic. But thanks again to Toon for taking a fresh look.

>
> Will replace.  Thanks.
>[snip]
Toon ClaesJul 31, 2026, 08:26 UTC in reply to Kristoffer Haugsbakk on lore

Re: [PATCH v4 0/4] doc: replay: fix config link

"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com> writes:
Show 19 quoted lines
> On Thu, Jul 30, 2026, at 18:19, Junio C Hamano wrote:
>> That's truly minimal update.  It is a bit surprising that the topic
>> was stuck for a long time, nearing its expiration date.
>>
>> A quick look at the thread
>> https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/
>> tells me that there weren't any outstanding review comments.
>>
>> That unfortunately does not say if this version is good enough or
>> people got tired of reviewing and did not pick all lints in v3, but
>> we need to work with what we have, so let's see how smoothly this
>> round goes.
>
> Yeah, there just hasn’t been much interest in this topic. But thanks
> again to Toon for taking a fresh look.
>
>>
>> Will replace.  Thanks.
>>[snip]

I'm happy with this version too. And for the record, I've locally rendered this as it would on git-scm.com, and all look good.

-- 
Cheers,
Toon
Junio C HamanoJul 31, 2026, 15:45 UTC in reply to Toon Claes on lore

Re: [PATCH v4 0/4] doc: replay: fix config link

Toon Claes <toon@iotcl.com> writes:
Show 24 quoted lines
> "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com> writes:
>
>> On Thu, Jul 30, 2026, at 18:19, Junio C Hamano wrote:
>>> That's truly minimal update.  It is a bit surprising that the topic
>>> was stuck for a long time, nearing its expiration date.
>>>
>>> A quick look at the thread
>>> https://lore.kernel.org/git/V3_CV_doc_replay_config.780@msgid.xyz/
>>> tells me that there weren't any outstanding review comments.
>>>
>>> That unfortunately does not say if this version is good enough or
>>> people got tired of reviewing and did not pick all lints in v3, but
>>> we need to work with what we have, so let's see how smoothly this
>>> round goes.
>>
>> Yeah, there just hasn’t been much interest in this topic. But thanks
>> again to Toon for taking a fresh look.
>>
>>>
>>> Will replace.  Thanks.
>>>[snip]
>
> I'm happy with this version too. And for the record, I've locally
> rendered this as it would on git-scm.com, and all look good.
Thanks.  Let's mark it for 'next' then.

Back to recent threads