git/Documentation/git-pack-redundant.txt
Jeff King fcf31daae4 pack-redundant: document deprecation
Running the command itself has generated a warning for several versions,
which has recently been upgraded to an error. Let's also make sure the
documentation mentions what is going on. This also gives us a good spot
to explain the reasoning and recommend alternatives.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-03-30 07:50:43 -07:00

64 lines
1.8 KiB
Text

git-pack-redundant(1)
=====================
NAME
----
git-pack-redundant - Find redundant pack files
SYNOPSIS
--------
[verse]
'git pack-redundant' [--verbose] [--alt-odb] (--all | <pack-filename>...)
WARNING
-------
`git pack-redundant` has been deprecated and is scheduled for removal in
a future version of Git. Because it can only remove entire duplicate
packs and not individual duplicate objects, it is generally not a useful
tool for reducing repository size. You are better off using `git gc` to
do so, which will put objects into a new pack, removing duplicates.
Running `pack-redundant` without the `--i-still-use-this` flag will fail
in this release. If you believe you have a use case for which
`pack-redundant` is better suited and oppose this removal, please
contact the Git mailing list at git@vger.kernel.org. More information
about the list is available at https://git-scm.com/community.
DESCRIPTION
-----------
This program computes which packs in your repository
are redundant. The output is suitable for piping to
`xargs rm` if you are in the root of the repository.
'git pack-redundant' accepts a list of objects on standard input. Any objects
given will be ignored when checking which packs are required. This makes the
following command useful when wanting to remove packs which contain unreachable
objects.
git fsck --full --unreachable | cut -d ' ' -f3 | \
git pack-redundant --all | xargs rm
OPTIONS
-------
--all::
Processes all packs. Any filenames on the command line are ignored.
--alt-odb::
Don't require objects present in packs from alternate object
database (odb) directories to be present in local packs.
--verbose::
Outputs some statistics to stderr. Has a small performance penalty.
SEE ALSO
--------
linkgit:git-pack-objects[1]
linkgit:git-repack[1]
linkgit:git-prune-packed[1]
GIT
---
Part of the linkgit:git[1] suite