From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: "Kristoffer Haugsbakk" <code@khaugsbakk.name>,
"Patrick Steinhardt" <ps@pks.im>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v2 2/2] doc: format-rev: use [synopsis] on code block
Date: Thu, 13 Aug 2026 11:57:36 +0200 [thread overview]
Message-ID: <V2_synopsis_block.b4c@msgid.xyz> (raw)
In-Reply-To: <V2_CV_synopsis_block.b4a@msgid.xyz>
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' [...]
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
v2:
• Add a paragraph to contrast synopsis code blocks with synopsis
command description after talk with Patrick on v1[1]
🔗 1: https://lore.kernel.org/git/ansWZxZ6lB0tYIJD@pks.im/
Documentation/git-format-rev.adoc | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/git-format-rev.adoc b/Documentation/git-format-rev.adoc
index 19241837345..d6c2e4aec1a 100644
--- a/Documentation/git-format-rev.adoc
+++ b/Documentation/git-format-rev.adoc
@@ -96,6 +96,7 @@ The mode `--stdin-mode=text` replaces each object name with the
formatted commit, i.e. the format `"%s"` would transform some commit
object name to `"<subject>"` without any termination. Like this:
+[synopsis]
----
Did we not fix this in "<subject>"?
----
--
2.54.0.22.g9e26862b904
next prev parent reply other threads:[~2026-08-13 9:58 UTC|newest]
Thread overview: 11+ 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 ` kristofferhaugsbakk [this message]
2026-08-13 10:04 ` [PATCH v2 2/2] doc: format-rev: use [synopsis] on code block Patrick Steinhardt
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=V2_synopsis_block.b4c@msgid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox