Re: [PATCH 3/4] doc: replay: use a nested definition list
- From
Junio C Hamano <gitster@pobox.com>
- Date
- May 30, 2026, 22:37 UTC
- Message-ID
- <xmqqtsroed7f.fsf@gitster.g>
- In-Reply-To
- <--ref-action_definition_list.70c@msgid.xyz>
kristofferhaugsbakk@fastmail.com writes:
Show 5 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name> > > This bullet list for `--ref-action` introduces a term with a colon. > This is exactly what a definition list is, structurally. Let’s be > sylistically consistent and use the definition list markup construct.
Makes sense.
Show 11 quoted lines
> -- > - * `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 transition from a bulleted list to a nested definition list (`;;`) for the `--ref-action` modes indeed makes the document structure much cleaner.
> The default mode can be configured via the `replay.refAction` configuration variable.