Merge branch 'jk/document-pack-redundant-deprecation'

Document that we have marked "pack-redundant" as deprecated.

* jk/document-pack-redundant-deprecation:
  pack-redundant: document deprecation
This commit is contained in:
Junio C Hamano 2023-04-06 13:38:27 -07:00
commit ae61aecb9e

View file

@ -11,6 +11,20 @@ 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