[PATCH v2 3/4] doc: replay: use a nested description list
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- Jun 3, 2026, 16:04 UTC
- Message-ID
- <V2_--ref-action_definition_list.76a@msgid.xyz>
- In-Reply-To
- <V2_CV_doc_replay_config.767@msgid.xyz>
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(-)
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