Re: [PATCH v2 2/2] doc: format-rev: use [synopsis] on code block
Patrick Steinhardt <[email protected]>
| Newsgroups | org.kernel.vger.git |
|---|---|
| Message-ID | <[email protected]> |
On Thu, Aug 13, 2026 at 11:57:36AM +0200, [email protected] wrote: > From: Kristoffer Haugsbakk <[email protected]> > > 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' [...] Thanks for the additional reference to the above commit. That helps, and you can see that as part of the commit we have similar changes to our docs like you do them in your patch. So I'm happy with this version, thanks! Patrick