]> git.ipfire.org Git - thirdparty/git.git/commit
doc: replay: improve config description
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Thu, 30 Jul 2026 09:57:14 +0000 (11:57 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 30 Jul 2026 16:15:04 +0000 (09:15 -0700)
commit0c93a65ec6cba0305d295bd14e2d286321f1b2ff
treeb21d001e97ad2f0efdeffe31c26086bfddb0f9b7
parent338765b8a361bec6c45e1df47c9be2dfde45544e
doc: replay: improve config description

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/replay.adoc
Documentation/git-replay.adoc