Re: [PATCH v3 4/4] doc: replay: move “default” to the right-hand side
- From
Toon Claes <toon@iotcl.com>
- Date
- Jul 8, 2026, 12:09 UTC
- Message-ID
- <87a4s1of7b.fsf@emacs.iotcl.com>
- In-Reply-To
- <V3_default_RHS.784@msgid.xyz>
kristofferhaugsbakk@fastmail.com writes:
Show 10 quoted lines
> 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.
Ah, these quad slashes are comments? Well, that's a thing I've learned today.
Makes sense.
Show 62 quoted lines
> 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 > >
-- Cheers, Toon