Re: [PATCH v3 2/2] doc: format-rev: use [synopsis] on code block
On Fri, Aug 14, 2026, at 03:01, Junio C Hamano wrote:
Show 32 quoted lines
> kristofferhaugsbakk@fastmail.com writes:
>
>> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>>
>> This code block uses the placeholder `<subject>`. Let’s highlight this
>> placeholder properly by using the `synopsis` block definition which was
>> introduced in a34d1d53 (doc: convert git-show to synopsis style,
>> 2026-02-06).
>>
>> Yes, note that code blocks since commit a34d1d53 can, on synopsis-style
>> docs like this one, be immediately preceded by `[synopsis]`, just like
>> the command synopsis is:
>>
>> [synopsis]
>> (EXPERIMENTAL!) git format-rev - [...]
>>
>> Cf. verse-style:
>>
>> [verse]
>> 'git name-rev' [...]
>>
>> Acked-by: Patrick Steinhardt <ps@pks.im>
>> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
>> ---
>
> Has this been tested with both AsciiDoc and AsciiDoctor?
>
>
> https://github.com/git/git/actions/runs/31751206776/job/94617158587#step:4:4886
>
> Curiously, it does not fail for me locally (by default my builds use
> AsciiDoctor).
Nope. :/
My change uses a code block:
[synopsis]
----
...
----But the ones in `pretty-formats.adoc` use open blocks:
[synopsis]
--
...
--I’ll do some better testing next.