Thread (21 messages) 21 messages, 3 authors, 2026-08-17

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

From: Junio C Hamano <hidden>
Date: 2026-08-17 21:46:56

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

Topic name (applied): kh/format-rev-doc-synopsis

Topic summary: Use '[synopsis]' on block in order to highlight
placeholder properly. Also quote the subject consistently.

§ Changes in v4

Sorry about not reading carefully. An open block is not a code block.

(copied from the patch note)

Fix block: use open block, not code block.[1] This is what was done for the
synopsis blocks in commit a34d1d53, the commit mentioned here. I have
tested this with what I believe are the use-asciidoc (tool) and
use-asciidoctor (tool):

    make doc
    make USE_ASCIIDOCTOR=1 doc

And they didn’t give any warnings. And they produced the correct result.

  🔗 1: https://lore.kernel.org/git/xmqqfr0hqzvl.fsf@gitster.g/ (local)

Rewrite or flesh out the commit message to reflect this newfound knowledge.

Also remove the Ack since this change invalidates it.

§ Cc

(See v2)

§ Link to v3

https://lore.kernel.org/git/V3_CV_synopsis_block.b64@msgid.xyz/ (local)

[1/2] doc: format-rev: quote subject placeholder before and after
[2/2] doc: format-rev: use [synopsis] on code block
Hopefully this is now ready for 'next'.

Thanks.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help