Skip to content

Commit bb75d25

Browse files
LemmingAvalanchegitster
authored andcommitted
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. e7b3a76 (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>
1 parent 5058b93 commit bb75d25

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

Documentation/config/replay.adoc

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
replay.refAction::
2-
Specifies the default mode for handling reference updates in
3-
`git replay`. The value can be:
2+
Specifies the default mode for handling reference updates.
3+
The value can be:
44
+
55
--
6-
* `update`: Update refs directly using an atomic transaction (default behavior).
7-
* `print`: Output update-ref commands for pipeline use.
6+
`update`;; Update refs directly using an atomic transaction (default behavior).
7+
`print`;; Output update-ref commands for pipeline use.
88
--
99
+
10-
This setting can be overridden with the `--ref-action` command-line option.
11-
When not configured, `git replay` defaults to `update` mode.
10+
ifdef::git-replay[]
11+
See `--ref-action`.
12+
endif::git-replay[]
13+
ifndef::git-replay[]
14+
See `--ref-action` for linkgit:git-replay[1] for details.
15+
endif::git-replay[]

Documentation/git-replay.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ to use bare commit IDs instead of branch names.
211211

212212
CONFIGURATION
213213
-------------
214+
:git-replay: 1
214215
include::config/replay.adoc[]
215216
216217
GIT

0 commit comments

Comments
 (0)