From: Junio C Hamano <gitster@pobox.com>
To: kristofferhaugsbakk@fastmail.com
Cc: git@vger.kernel.org,
"Kristoffer Haugsbakk" <code@khaugsbakk.name>,
"Patrick Steinhardt" <ps@pks.im>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH v3 2/2] doc: format-rev: use [synopsis] on code block
Date: Thu, 13 Aug 2026 18:01:18 -0700 [thread overview]
Message-ID: <xmqqfr0hqzvl.fsf@gitster.g> (raw)
In-Reply-To: <V3_synopsis_block.b66@msgid.xyz> (kristofferhaugsbakk@fastmail.com's message of "Thu, 13 Aug 2026 16:23:46 +0200")
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).
prev parent reply other threads:[~2026-08-14 1:01 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-30 12:02 [PATCH] doc: format-rev: use [synopsis] on code block kristofferhaugsbakk
2026-08-10 16:58 ` [PATCH resend] " kristofferhaugsbakk
2026-08-11 12:32 ` Patrick Steinhardt
2026-08-11 16:23 ` Kristoffer Haugsbakk
2026-08-11 16:27 ` Patrick Steinhardt
2026-08-11 16:30 ` Kristoffer Haugsbakk
2026-08-11 19:38 ` Kristoffer Haugsbakk
2026-08-13 9:57 ` [PATCH v2 0/2] " kristofferhaugsbakk
2026-08-13 9:57 ` [PATCH v2 1/2] doc: format-rev: quote subject placeholder before and after kristofferhaugsbakk
2026-08-13 9:57 ` [PATCH v2 2/2] doc: format-rev: use [synopsis] on code block kristofferhaugsbakk
2026-08-13 10:04 ` Patrick Steinhardt
2026-08-13 14:23 ` [PATCH v3 0/2] " kristofferhaugsbakk
2026-08-13 14:23 ` [PATCH v3 1/2] doc: format-rev: quote subject placeholder before and after kristofferhaugsbakk
2026-08-13 14:23 ` [PATCH v3 2/2] doc: format-rev: use [synopsis] on code block kristofferhaugsbakk
2026-08-14 1:01 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqfr0hqzvl.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
--cc=kristofferhaugsbakk@fastmail.com \
--cc=ps@pks.im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.