doc: pack-refs: factor out common options
In preparation for adding documentation for `git refs optimize`, factor out the common options from the `git-pack-refs` man page into a shareable file `pack-refs-options.adoc` and update `git-pack-refs.adoc` to use an `include::` macro. This change is a pure refactoring and results in no change to the final rendered documentation for `pack-refs`. Mentored-by: Patrick Steinhardt <ps@pks.im> Mentored-by: shejialuo <shejialuo@gmail.com> Signed-off-by: Meet Soni <meetsoni3017@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>main
Meet Soni
Junio C Hamano
parent
0d4ec33922
commit
93efe34f5a
|
|
@ -45,58 +45,7 @@ unpacked.
|
|||
OPTIONS
|
||||
-------
|
||||
|
||||
--all::
|
||||
|
||||
The command by default packs all tags and refs that are already
|
||||
packed, and leaves other refs
|
||||
alone. This is because branches are expected to be actively
|
||||
developed and packing their tips does not help performance.
|
||||
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::
|
||||
|
||||
The command usually removes loose refs under `$GIT_DIR/refs`
|
||||
hierarchy after packing them. This option tells it not to.
|
||||
|
||||
--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
|
||||
future.
|
||||
+
|
||||
- "files": Loose references are packed into the `packed-refs` file
|
||||
based on the ratio of loose references to the size of the
|
||||
`packed-refs` file. The bigger the `packed-refs` file, the more loose
|
||||
references need to exist before we repack.
|
||||
+
|
||||
- "reftable": Tables are compacted such that they form a geometric
|
||||
sequence. For two tables N and N+1, where N+1 is newer, this
|
||||
maintains the property that N is at least twice as big as N+1. Only
|
||||
tables that violate this property are compacted.
|
||||
|
||||
--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
|
||||
`--exclude`, `--exclude` takes precedence. Using `--include` will preclude all
|
||||
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>::
|
||||
|
||||
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
|
||||
patterns. If a ref is already packed, including it with `--exclude` will not
|
||||
unpack it.
|
||||
+
|
||||
When used with `--all`, pack only loose refs which do not match any of
|
||||
the provided `--exclude` patterns.
|
||||
+
|
||||
When used with `--include`, refs provided to `--include`, minus refs that are
|
||||
provided to `--exclude` will be packed.
|
||||
include::pack-refs-options.adoc[]
|
||||
|
||||
|
||||
BUGS
|
||||
|
|
|
|||
|
|
@ -0,0 +1,52 @@
|
|||
--all::
|
||||
|
||||
The command by default packs all tags and refs that are already
|
||||
packed, and leaves other refs
|
||||
alone. This is because branches are expected to be actively
|
||||
developed and packing their tips does not help performance.
|
||||
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::
|
||||
|
||||
The command usually removes loose refs under `$GIT_DIR/refs`
|
||||
hierarchy after packing them. This option tells it not to.
|
||||
|
||||
--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
|
||||
future.
|
||||
+
|
||||
- "files": Loose references are packed into the `packed-refs` file
|
||||
based on the ratio of loose references to the size of the
|
||||
`packed-refs` file. The bigger the `packed-refs` file, the more loose
|
||||
references need to exist before we repack.
|
||||
+
|
||||
- "reftable": Tables are compacted such that they form a geometric
|
||||
sequence. For two tables N and N+1, where N+1 is newer, this
|
||||
maintains the property that N is at least twice as big as N+1. Only
|
||||
tables that violate this property are compacted.
|
||||
|
||||
--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
|
||||
`--exclude`, `--exclude` takes precedence. Using `--include` will preclude all
|
||||
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>::
|
||||
|
||||
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
|
||||
patterns. If a ref is already packed, including it with `--exclude` will not
|
||||
unpack it.
|
||||
+
|
||||
When used with `--all`, pack only loose refs which do not match any of
|
||||
the provided `--exclude` patterns.
|
||||
+
|
||||
When used with `--include`, refs provided to `--include`, minus refs that are
|
||||
provided to `--exclude` will be packed.
|
||||
Loading…
Reference in New Issue