summaryrefslogtreecommitdiff
path: root/Documentation/git-repack.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2021-06-08 07:24:48 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-06-08 23:56:09 (GMT)
commit6fb9195f6c6df047949efcdb8a1fb9eaed0c925e (patch)
tree6c8598f4de2b790590b40d8fa762fc18ebee7ff7 /Documentation/git-repack.txt
parent48bf2fa8bad054d66bd79c6ba903c89c704201f7 (diff)
downloadgit-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.zip
git-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.tar.gz
git-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.tar.bz2
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>
Diffstat (limited to 'Documentation/git-repack.txt')
-rw-r--r--Documentation/git-repack.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index fbd4b4a..7bb797c 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -121,7 +121,9 @@ depth is 4095.
If specified, multiple packfiles may be created, which also
prevents the creation of a bitmap index.
The default is unlimited, unless the config variable
- `pack.packSizeLimit` is set.
+ `pack.packSizeLimit` is set. Note that this option may result in
+ a larger and slower repository; see the discussion in
+ `pack.packSizeLimit`.
-b::
--write-bitmap-index::