Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Todd Zullinger <tmz@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: Mon, 14 Sep 2026 08:30:18 -0700	[thread overview]
Message-ID: <xmqqcxuf7svp.fsf@gitster.g> (raw)
In-Reply-To: <20260914124630.154107-2-tmz@pobox.com> (Todd Zullinger's message of "Mon, 14 Sep 2026 08:46:27 -0400")

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.

> 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

  reply	other threads:[~2026-09-14 15:30 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 [this message]
2026-09-14 15:43     ` Todd Zullinger
2026-09-15 13:15       ` Todd Zullinger
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=xmqqcxuf7svp.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    --cc=tmz@pobox.com \
    /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