[PATCH v2 3/3] doc: add a short explanation for git-repack options
- From
- Damien Robert <damien.olivier.robert@gmail.com>
- Date
- Mar 12, 2020, 17:09 UTC
- Message-ID
- <20200312170931.2392490-4-damien.olivier.robert+git@gmail.com>
- In-Reply-To
- <20200312170931.2392490-1-damien.olivier.robert+git@gmail.com>
For some git-repack options passed on to git-pack-objects, there was only a link to git-pack-objects(1). Add a short documentation explaining their meaning so that the reader does not have to consult another man page.
We also explain that unreachable objects are not packed.
Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com> --- Documentation/git-repack.txt | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 0962562c17..8f7f1140c3 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -14,9 +14,9 @@ SYNOPSIS DESCRIPTION ----------- -This command is used to combine all objects that do not currently -reside in a "pack", into a pack. It can also be used to re-organize -existing packs into a single, more efficient pack. +This command is used to combine all objects (except unreachable ones) that +do not currently reside in a "pack", into a pack. It can also be used to +re-organize existing packs into a single, more efficient pack. A pack is a collection of objects, individually compressed, with delta compression applied, stored in a single file, with an @@ -66,18 +66,27 @@ to the new separate pack will be written. -l:: Pass the `--local` option to 'git pack-objects'. See linkgit:git-pack-objects[1]. + This causes an object that is borrowed from an alternate + object store to be ignored even if it would have otherwise been + packed. -f:: Pass the `--no-reuse-delta` option to `git pack-objects`, see linkgit:git-pack-objects[1]. + The repack will not reuse existing deltas but compute them from + scratch. -F:: Pass the `--no-reuse-object` option to `git pack-objects`, see linkgit:git-pack-objects[1]. + The repack will not reuse existing object data at all, including + non deltified object, forcing recompression of everything. -q:: Pass the `-q` option to 'git pack-objects'. See linkgit:git-pack-objects[1]. + This flag makes the command not to report its progress + on the standard error stream. -n:: Do not update the server information with
-- Patched on top of v2.26.0-rc1-6-ga56d361f66 (git version 2.25.1)