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
Junio C Hamano <gitster@pobox.com>
Date
Sep 14, 2026, 15:30 UTC
Message-ID
<xmqqcxuf7svp.fsf@gitster.g>
In-Reply-To
<20260914124630.154107-2-tmz@pobox.com>
Todd Zullinger <tmz@pobox.com> writes:
Show 8 quoted lines
> 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.

Show 43 quoted lines
> diff --git a/Documentation/pack-refs-options.adoc b/Documentation/pack-refs-options.adoc
> index 0b11282941..2263648b39 100644
> --- a/Documentation/pack-refs-options.adoc
> +++ b/Documentation/pack-refs-options.adoc
> @@ -1,4 +1,4 @@
> ---all::
> +`--all`::
>  
>  The command by default packs all tags and refs that are already
>  packed, and leaves other refs
> @@ -8,12 +8,12 @@ This option causes all refs to be packed as well, with the exception
>  of hidden refs, broken refs, and symbolic refs. Useful for a repository
>  with many branches of historical interests.
>  
> ---no-prune::
> +`--no-prune`::
>  
>  The command usually removes loose refs under `$GIT_DIR/refs`
>  hierarchy after packing them.  This option tells it not to.
>  
> ---auto::
> +`--auto`::
>  
>  Pack refs as needed depending on the current state of the ref database. The
>  behavior depends on the ref format used by the repository and may change in the
> @@ -29,7 +29,7 @@ future.
>  	  maintains the property that N is at least twice as big as N+1. Only
>  	  tables that violate this property are compacted.
>  
> ---include <pattern>::
> +`--include <pattern>`::
>  
>  Pack refs based on a `glob(7)` pattern. Repetitions of this option
>  accumulate inclusion patterns. If a ref is both included in `--include` and
> @@ -38,7 +38,7 @@ tags from being included by default. Symbolic refs and broken refs will never
>  be packed. When used with `--all`, it will be a noop. Use `--no-include` to clear
>  and reset the list of patterns.
>  
> ---exclude <pattern>::
> +`--exclude <pattern>`::
>  
>  Do not pack refs matching the given `glob(7)` pattern. Repetitions of this option
>  accumulate exclusion patterns. Use `--no-exclude` to clear and reset the list of
Previous: Todd ZullingerNext: Todd Zullinger
Message 9 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.