kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

doc/pack-refs: convert synopsis and options to new style 

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 via the included
pack-refs-options.adoc and convert the standalone placeholder _<branch>_
in prose.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
main
Todd Zullinger 2026-09-15 09:10:31 -04:00 committed by Junio C Hamano
parent 47ce80527c
commit db06ca011e
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/git-pack-refs.adoc
View File

@ -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

10
Documentation/pack-refs-options.adoc
View File

@ -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