[PATCH v2 1/2] doc/pack-refs: convert synopsis and options to new style
- From
Todd Zullinger <tmz@pobox.com>
- Date
- Sep 14, 2026, 12:46 UTC
- Message-ID
- <20260914124630.154107-2-tmz@pobox.com>
- In-Reply-To
- <20260912191509.844954-1-tmz@pobox.com>
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.
Signed-off-by: Todd Zullinger <tmz@pobox.com> --- Documentation/git-pack-refs.adoc | 8 ++++---- Documentation/pack-refs-options.adoc | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-pack-refs.adoc b/Documentation/git-pack-refs.adoc index fde9f2f294..69e018d07e 100644 --- a/Documentation/git-pack-refs.adoc +++ b/Documentation/git-pack-refs.adoc @@ -7,8 +7,8 @@ git-pack-refs - Pack heads and tags for efficient repository access SYNOPSIS -------- -[verse] -'git pack-refs' [--all] [--no-prune] [--auto] [--include <pattern>] [--exclude <pattern>] +[synopsis] +git pack-refs [--all] [--no-prune] [--auto] [--include <pattern>] [--exclude <pattern>] DESCRIPTION ----------- @@ -52,8 +52,8 @@ BUGS ---- Older documentation written before the packed-refs mechanism was -introduced may still say things like ".git/refs/heads/<branch> file -exists" when it means "branch <branch> exists". +introduced may still say things like ".git/refs/heads/_<branch>_ file +exists" when it means "branch _<branch>_ exists". GIT 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
-- 2.56.0.rc0