]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-pack-objects.txt
doc: warn people against --max-pack-size
authorJeff King <peff@peff.net>
Tue, 8 Jun 2021 07:24:48 +0000 (03:24 -0400)
committerJunio C Hamano <gitster@pobox.com>
Tue, 8 Jun 2021 23:56:09 +0000 (08:56 +0900)
commit6fb9195f6c6df047949efcdb8a1fb9eaed0c925e
tree6c8598f4de2b790590b40d8fa762fc18ebee7ff7
parent48bf2fa8bad054d66bd79c6ba903c89c704201f7
doc: warn people against --max-pack-size

This option is almost never a good idea, as the resulting repository is
larger and slower (see the new explanations in the docs).

I outlined the potential problems. We could go further and make the
option harder to find (or at least, make the command-line option
descriptions a much more terse "you probably don't want this; see
pack.packsizeLimit for details"). But this seems like a minimal change
that may prevent people from thinking it's more useful than it is.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/pack.txt
Documentation/git-pack-objects.txt
Documentation/git-repack.txt