diff options
| author | Jeff King <peff@peff.net> | 2021-06-08 09:24:48 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-06-09 01:56:09 +0200 |
| commit | 6fb9195f6c6df047949efcdb8a1fb9eaed0c925e (patch) | |
| tree | 6c8598f4de2b790590b40d8fa762fc18ebee7ff7 /Documentation/git-repack.txt | |
| parent | Git 2.31.1 (diff) | |
| download | git-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.tar.xz git-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.zip | |
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 '')
| -rw-r--r-- | Documentation/git-repack.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index fbd4b4ae06..7bb797cbe8 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:: |