diff options
| author | Jeff King <peff@peff.net> | 2021-06-08 03:24:48 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-06-09 08:56:09 +0900 |
| commit | 6fb9195f6c6df047949efcdb8a1fb9eaed0c925e (patch) | |
| tree | 6c8598f4de2b790590b40d8fa762fc18ebee7ff7 /Documentation/git-pack-objects.txt | |
| parent | 48bf2fa8bad054d66bd79c6ba903c89c704201f7 (diff) | |
| download | git-6fb9195f6c6df047949efcdb8a1fb9eaed0c925e.tar.gz | |
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-pack-objects.txt')
| -rw-r--r-- | Documentation/git-pack-objects.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index f85cb7ea93..c20b978510 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -118,10 +118,10 @@ depth is 4095. into multiple independent packfiles, each not larger than the given size. The size can be suffixed with "k", "m", or "g". The minimum size allowed is limited to 1 MiB. - This option - 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`. --honor-pack-keep:: This flag causes an object already in a local pack that |