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>
This commit is contained in:
Kristoffer Haugsbakk
2026-06-03 18:04:23 +02:00
committed by Junio C Hamano
parent 5058b93b95
commit bb75d25548
2 changed files with 11 additions and 6 deletions

View File

@@ -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[]

View File

@@ -211,6 +211,7 @@ to use bare commit IDs instead of branch names.
CONFIGURATION
-------------
:git-replay: 1
include::config/replay.adoc[]
GIT