Git development
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: Junio C Hamano <gitster@pobox.com>
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	Siddharth Asthana <siddharthasthana31@gmail.com>,
	git@vger.kernel.org, Patrick Steinhardt <ps@pks.im>
Subject: [PATCH v3 3/4] doc: replay: use a nested description list
Date: Fri,  5 Jun 2026 15:56:01 +0200	[thread overview]
Message-ID: <V3_--ref-action_definition_list.783@msgid.xyz> (raw)
In-Reply-To: <V3_CV_doc_replay_config.780@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
stylistically consistent and use the desc. list markup construct.

In short, just transform this unordered list in the same way that we
did for `replay.refAction` in the previous commit.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v3:
    • Msg:[1] Fix typo: “stylistically”
    • Msg: Simplify message. Devote one paragraph to   † 1: Commit
      explain the transformation. Then delegate to the         message
      previous patch since we did the same trans-
      formation there.
    
    ---
    
    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


  parent reply	other threads:[~2026-06-05 13:57 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-21 18:01 [PATCH 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-05-21 18:01 ` [PATCH 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-05-30 22:18   ` Junio C Hamano
2026-06-04 20:38     ` Kristoffer Haugsbakk
2026-05-21 18:01 ` [PATCH 2/4] doc: replay: simplify replay.refAction description kristofferhaugsbakk
2026-05-30 22:29   ` Junio C Hamano
2026-05-30 22:37   ` Junio C Hamano
2026-06-02 11:58     ` Kristoffer Haugsbakk
2026-05-21 18:02 ` [PATCH 3/4] doc: replay: use a nested definition list kristofferhaugsbakk
2026-05-30 22:37   ` Junio C Hamano
2026-05-21 18:02 ` [PATCH 4/4] doc: replay: move “default” to the right-hand-side kristofferhaugsbakk
2026-05-30 22:37   ` Junio C Hamano
2026-05-30 22:18 ` [PATCH 0/4] doc: replay: fix config link Junio C Hamano
2026-06-03 16:04 ` [PATCH v2 " kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-04  6:27     ` Patrick Steinhardt
2026-06-04  6:31       ` Kristoffer Haugsbakk
2026-06-04  9:05         ` Patrick Steinhardt
2026-06-03 16:04   ` [PATCH v2 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 4/4] doc: replay: move “default” to the right-hand side kristofferhaugsbakk
2026-06-05 13:55   ` [PATCH v3 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-06-05 13:55     ` [PATCH v3 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-05 13:56     ` kristofferhaugsbakk [this message]
2026-06-05 13:56     ` [PATCH v3 4/4] doc: replay: move “default” to the right-hand side kristofferhaugsbakk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=V3_--ref-action_definition_list.783@msgid.xyz \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=ps@pks.im \
    --cc=siddharthasthana31@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox