public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: git@vger.kernel.org, "Jean-Noël AVILA" <jn.avila@free.fr>
Subject: Re: [PATCH 1/3] doc: interpret-trailers: convert to synopsis style
Date: Fri, 13 Mar 2026 17:43:38 +0100	[thread overview]
Message-ID: <aa0664a5-09fe-4dee-b243-b3b5dff41b68@app.fastmail.com> (raw)
In-Reply-To: <xmqq8qbxkes4.fsf@gitster.g>

On Thu, Mar 12, 2026, at 02:38, Junio C Hamano wrote:
> kristofferhaugsbakk@fastmail.com writes:
>
>> ...s. The only thing is that `": "` is
>> used instead of `': '` ...
>
> The description says that a pair of dqs inside `verbatim` replaces a
> pair of sqs inside `verbatim` in the original.
>
> Does this refer to this change?
>
>> -This means that the trimmed <key> and <value> will be separated by
>> -`': '` (one colon followed by one space).
>> +This means that the trimmed _<key>_ and _<value>_ will be separated by
>> +": " (one colon followed by one space).
>
> We seem to have lost the `backticks` around the thing.  Intended?

Yes it is intended. It seems to be the current approach to “verbatim”
(in spirit) that ends in a space is to use "<verbatim> ".

I had this arrow from `Documentation/pretty-formats.adoc` in the back of
my mind when editing this part:[1]

    `pointer=<value>`;; Shown between HEAD and the branch it points to, if any.
                  Defaults to "{nbsp}->{nbsp}".

So (finally looking back at this) maybe I need to use the no-break space
expression here.

† 1: This part was recently changed although this `{nbsp}->{nbsp}` part
     did not change: a34d1d53 (doc: convert git-show to synopsis style,
     2026-02-06)

> Does the thing still typeset as verbatim in the manpages?

No. It’s just regular text.

For that matter: my setup (perhaps flawed[2]) also renders ': ' in the
preimage as regular text in the HTML output.

🔗 2: https://lore.kernel.org/git/9570525.CDJkKcVGEf@piment-oiseau/

  reply	other threads:[~2026-03-13 16:44 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-11 22:31 [PATCH 0/3] doc: interpret-trailers: convert to synopsis and update options kristofferhaugsbakk
2026-03-11 22:31 ` [PATCH 1/3] doc: interpret-trailers: convert to synopsis style kristofferhaugsbakk
2026-03-12  1:38   ` Junio C Hamano
2026-03-13 16:43     ` Kristoffer Haugsbakk [this message]
2026-03-12 17:34   ` Jean-Noël AVILA
2026-03-12 19:11     ` Kristoffer Haugsbakk
2026-03-11 22:31 ` [PATCH 2/3] doc: interpret-trailers: normalize and fill out options kristofferhaugsbakk
2026-03-11 22:31 ` [PATCH 3/3] doc: config: convert trailers section to synopsis style kristofferhaugsbakk
2026-03-12 17:48   ` Jean-Noël AVILA
2026-03-12 18:14     ` Junio C Hamano
2026-03-12  0:51 ` [PATCH 0/3] doc: interpret-trailers: convert to synopsis and update options Junio C Hamano
2026-03-12  0:53   ` Kristoffer Haugsbakk
2026-03-16 21:48 ` [PATCH v2 0/4] " kristofferhaugsbakk
2026-03-16 21:48   ` [PATCH v2 1/4] doc: interpret-trailers: convert to synopsis style kristofferhaugsbakk
2026-03-16 21:48   ` [PATCH v2 2/4] doc: interpret-trailers: normalize and fill out options kristofferhaugsbakk
2026-03-16 21:48   ` [PATCH v2 3/4] doc: config: convert trailers section to synopsis style kristofferhaugsbakk
2026-03-16 21:48   ` [PATCH v2 4/4] interpret-trailers: use placeholder instead of * kristofferhaugsbakk

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=aa0664a5-09fe-4dee-b243-b3b5dff41b68@app.fastmail.com \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    /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