git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 17, 2026, 21:46 UTC
Message-ID
<xmqq33wc4dyq.fsf@gitster.g>
In-Reply-To
<V4_CV_synopsis_block.b8e@msgid.xyz>
kristofferhaugsbakk@fastmail.com writes:
Show 39 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> 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/
>
> 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/
>
> [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.
Previous: kristofferhaugsbakk@fastmail.com
Message 21 of 21 in “doc: format-rev: use [synopsis] on code block”
  1. doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  2. doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 10, 2026
  3. Patrick SteinhardtAug 11, 2026
  4. Kristoffer HaugsbakkAug 11, 2026
  5. Patrick SteinhardtAug 11, 2026
  6. Kristoffer HaugsbakkAug 11, 2026
  7. Kristoffer HaugsbakkAug 11, 2026
  8. 0/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  9. 1/2 doc: format-rev: quote subject placeholder before and afterkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  10. 2/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  11. Patrick SteinhardtAug 13, 2026
  12. 0/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  13. 1/2 doc: format-rev: quote subject placeholder before and afterkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  14. 2/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 13, 2026
  15. Junio C HamanoAug 14, 2026
  16. Kristoffer HaugsbakkAug 14, 2026
  17. Junio C HamanoAug 14, 2026
  18. 0/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 17, 2026
  19. 1/2 doc: format-rev: quote subject placeholder before and afterkristofferhaugsbakk@fastmail.com, Aug 17, 2026
  20. 2/2 doc: format-rev: use [synopsis] on code blockkristofferhaugsbakk@fastmail.com, Aug 17, 2026
  21. Junio C HamanoAug 17, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.