git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/2] doc/pack-refs: convert synopsis and options to new style

From
Todd Zullinger <tmz@pobox.com>
Date
Sep 14, 2026, 15:43 UTC
Message-ID
<20260914154350.LjUwy8DF@teonanacatl.net>
In-Reply-To
<xmqqcxuf7svp.fsf@gitster.g>
Junio C Hamano wrote:
Show 14 quoted lines
> 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.

Thanks for spotting.
-- 
Todd
Previous: Junio C HamanoNext: Todd Zullinger
Message 10 of 16 in “doc lint fixes for pack-refs and refs”
  1. 0/3 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 12, 2026
  2. 1/3 doc lint: match commands as well as options for synopsis style checkTodd Zullinger, Sep 12, 2026
  3. 2/3 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 12, 2026
  4. 3/3 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 12, 2026
  5. Jean-Noël AVILASep 13, 2026
  6. Todd ZullingerSep 13, 2026
  7. 0/2 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 14, 2026
  8. 1/2 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 14, 2026
  9. Junio C HamanoSep 14, 2026
  10. Todd ZullingerSep 14, 2026
  11. Todd ZullingerSep 15, 2026
  12. 2/2 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 14, 2026
  13. 1/2 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 15, 2026
  14. 0/2 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 15, 2026
  15. Junio C HamanoSep 15, 2026
  16. 2/2 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 15, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.