]> git.ipfire.org Git - thirdparty/git.git/commit
doc: replay: improve config description
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Wed, 3 Jun 2026 16:04:23 +0000 (18:04 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 3 Jun 2026 23:12:04 +0000 (08:12 +0900)
commitbb75d255486c484218ef3361654fa0cfa319620f
tree8b7e60c09e8c8ee1a5f5656972272c26ac3ec207
parent5058b93b9527ed37ccb074c05b14b7482e32b9bc
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.

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