Thread (21 messages) flat view 21 messages, 3 authors, 27d ago

Re: [PATCH v3 2/2] doc: format-rev: use [synopsis] on code block

From: Junio C Hamano <hidden>
Date: 2026-08-14 01:01:20

kristofferhaugsbakk@fastmail.com writes:
From: Kristoffer Haugsbakk <redacted>

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 <redacted>
Signed-off-by: Kristoffer Haugsbakk <redacted>
---
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).
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help