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
Subject: [PATCH v2 4/4] doc: replay: move “default” to the right-hand side
Date: Wed, 3 Jun 2026 18:04:25 +0200 [thread overview]
Message-ID: <V2_default_RHS.76b@msgid.xyz> (raw)
In-Reply-To: <V2_CV_doc_replay_config.767@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
This is now a description list (see previous commit) and parentheticals
like this do not go on the left-hand side. Moving it to the other side
makes it stand out just as much and is also more consistent with the
rest of the documentation.
Let’s also do the same for the `replay.refAction` description list.
That makes the two desc. lists identical in the first sentence. Let’s
add a comment about that for future editors.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
v2:
• It’s “description list”, not “definition list”
• (Same mistake I have done for “line continuation” (it’s “list”))
• It’s e.g. “right-hand side” (drop “-side” hyphen)
• Change `replay.refAction` “default” placement
• Now that these two description lists are so similar, add an
AsciiDoc comment about it for future editors. Note that I
outright deleted this list in the previous version because I
didn’t want to keep them in synch. But we can remain aware of
these with two comments.
---
v1:
> do not go on the left-hand-side.
At least I haven’t seen it.
Documentation/config/replay.adoc | 5 ++++-
Documentation/git-replay.adoc | 5 ++++-
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7328da9537d..40d1695782a 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -3,7 +3,10 @@ replay.refAction::
The value can be:
+
--
-`update`;; Update refs directly using an atomic transaction (default behavior).
+////
+These use the first sentences from the description list in git-replay(1).
+////
+`update`;; (default) Update refs directly using an atomic transaction.
`print`;; Output update-ref commands for pipeline use.
--
+
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index b4fe43ec687..ea4d14baddb 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -80,7 +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.
+////
+Expanded description list compared to 'replay.refAction'.
+////
+`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`.
--
2.54.0.22.g9e26862b904
prev parent reply other threads:[~2026-06-03 16:05 UTC|newest]
Thread overview: 17+ 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-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-03 16:04 ` [PATCH v2 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-03 16:04 ` kristofferhaugsbakk [this message]
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=V2_default_RHS.76b@msgid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--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