Git development
 help / color / mirror / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Jean-Noël Avila" <jn.avila@free.fr>, git@vger.kernel.org
Subject: Re: [PATCH v2 1/2] doc/pack-refs: convert synopsis and options to new style
Date: Tue, 15 Sep 2026 09:15:09 -0400	[thread overview]
Message-ID: <20260915131509.EztJBORN@teonanacatl.net> (raw)
In-Reply-To: <20260914154350.LjUwy8DF@teonanacatl.net>

I wrote:
> Junio C Hamano wrote:
>> Todd Zullinger <tmz@pobox.com> writes:
>> 
>>> Replace [verse] with [synopsis] in the SYNOPSIS block and remove
>>> single-quote formatting from the command name.
>>>
>>> Backtick-quote all option terms in the OPTIONS section and convert
>>> the standalone placeholder _<branch>_ in prose.
>>>
>>> Update the included pack-refs-options.adoc to backtick-quote all
>>> configuration key terms.
>> 
>> Micronit.  I think you backtick-quoted `--all`, `--no-prune`, and
>> friends, that are not configuration keyu terms but command line
>> options.
> 
> Ahh, right you are.  That was due to my re-use of an earlier
> example from Jean-Noël's work and an incomplete
> proof-reading.  So I'll want to change "configuration key
> terms" to something like "option terms" to match what
> previous commits have used for similar changes.

In looking at that commit message further, I update the
wording slightly as there are no options in the OPTION
section which are not part of pack-refs-options.adoc.  I
condensed that to a single, more accurate sentence.

With luck, v3 is now ready to go.

Thanks,

-- 
Todd

  reply	other threads:[~2026-09-15 13:15 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-12 19:14 [PATCH 0/3] doc lint fixes for pack-refs and refs Todd Zullinger
2026-09-12 19:15 ` [PATCH 1/3] doc lint: match commands as well as options for synopsis style check Todd Zullinger
2026-09-12 19:15 ` [PATCH 2/3] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-12 19:15 ` [PATCH 3/3] doc/refs: backtick-quote commands and options consistently Todd Zullinger
2026-09-13 10:26 ` [PATCH 0/3] doc lint fixes for pack-refs and refs Jean-Noël AVILA
2026-09-13 14:14   ` Todd Zullinger
2026-09-14 12:46 ` [PATCH v2 0/2] " Todd Zullinger
2026-09-14 12:46 ` [PATCH v2 1/2] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-14 15:30   ` Junio C Hamano
2026-09-14 15:43     ` Todd Zullinger
2026-09-15 13:15       ` Todd Zullinger [this message]
2026-09-14 12:46 ` [PATCH v2 2/2] doc/refs: backtick-quote commands and options consistently Todd Zullinger
2026-09-15 13:10 ` [PATCH v2 0/2] doc lint fixes for pack-refs and refs Todd Zullinger
2026-09-15 16:25   ` Junio C Hamano
2026-09-15 13:10 ` [PATCH v3 1/2] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-15 13:10 ` [PATCH v3 2/2] doc/refs: backtick-quote commands and options consistently Todd Zullinger

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=20260915131509.EztJBORN@teonanacatl.net \
    --to=tmz@pobox.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