From: "Kristoffer Haugsbakk" <code@khaugsbakk•name>
To: "Jeff King" <peff@peff•net>,
"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
Cc: git@vger•kernel.org, "Jean-Noël AVILA" <jn.avila@free•fr>
Subject: Re: [PATCH] doc: patch-id: convert to the modern synopsis style
Date: Mon, 13 Oct 2025 17:03:43 +0200 [thread overview]
Message-ID: <932d3fd8-7fd3-4d1c-b3a7-644fb04ef47d@app.fastmail.com> (raw)
In-Reply-To: <20251010050628.GB1897715@coredump.intra.peff.net>
On Fri, Oct 10, 2025, at 07:06, Jeff King wrote:
> On Thu, Oct 09, 2025 at 10:53:53PM +0200,
> kristofferhaugsbakk@fastmail•com wrote:
>
>> Convert this command documentation to the modern synopsis style based on
>> similar work.[1] Concretely:
>>
>> • Change the Synopsis section from `verse` to a `synopsis` block which
>> will automatically apply the correct formatting to various elements
>> (although this Synopsis is very simple)
>> • Use backticks (`) for code-like things which will also use the correct
>> formatting for interior placeholders (`<orderfile>`)
>> • Use backticks on options
>
> These all look like strict improvements to me. Sadly doc-diff doesn't
> show much here because the changes are mostly typographical, so I
> eyeballed the HTML output (which does look much nicer).
Thanks for testing!
--
Kristoffer
next prev parent reply other threads:[~2025-10-13 15:04 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-09 20:53 [PATCH] doc: patch-id: convert to the modern synopsis style kristofferhaugsbakk
2025-10-10 5:06 ` Jeff King
2025-10-13 15:03 ` Kristoffer Haugsbakk [this message]
2025-10-10 6:48 ` Jean-Noël Avila
2025-10-13 14:54 ` Kristoffer Haugsbakk
2025-10-10 8:50 ` Junio C Hamano
2025-10-13 16:42 ` Kristoffer Haugsbakk
2025-10-13 15:42 ` [PATCH v2] " kristofferhaugsbakk
2025-10-13 16:53 ` Eric Sunshine
2025-10-14 20:46 ` Kristoffer Haugsbakk
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=932d3fd8-7fd3-4d1c-b3a7-644fb04ef47d@app.fastmail.com \
--to=code@khaugsbakk$(echo .)name \
--cc=git@vger$(echo .)kernel.org \
--cc=jn.avila@free$(echo .)fr \
--cc=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=peff@peff$(echo .)net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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