summaryrefslogtreecommitdiff
path: root/Documentation/config/pack.txt
diff options
context:
space:
mode:
authorLibravatar Derrick Stolee <dstolee@microsoft.com>2020-03-20 12:38:09 +0000
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-03-20 14:22:31 -0700
commitde3a864114291632c05e67bec4a316257c7ff97d (patch)
treea67f00f13d80cffd692e1fc675b57c3745b7a286 /Documentation/config/pack.txt
parentMerge https://github.com/prati0100/git-gui (diff)
downloadtgif-de3a864114291632c05e67bec4a316257c7ff97d.tar.xz
config: set pack.useSparse=true by default
The pack.useSparse config option was introduced by 3d036eb0 (pack-objects: create pack.useSparse setting, 2019-01-19) and was first available in v2.21.0. When enabled, the pack-objects process during 'git push' will use a sparse tree walk when deciding which trees and blobs to send to the remote. The algorithm was introduced by d5d2e93 (revision: implement sparse algorithm, 2019-01-16) and has been in production use by VFS for Git since around that time. The features.experimental config option also enabled pack.useSparse, so hopefully that has also increased exposure. It is worth noting that pack.useSparse has a possibility of sending more objects across a push, but requires a special arrangement of exact _copies_ across directories. There is a test in t5322-pack-objects-sparse.sh that demonstrates this possibility. This test uses the --sparse option to "git pack-objects" but we can make it implied by the config value to demonstrate that the default value has changed. While updating that test, I noticed that the documentation did not include an option for --no-sparse, which is now more important than it was before. Since the downside is unlikely but the upside is significant, set the default value of pack.useSparse to true. Remove it from the set of options implied by features.experimental. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/pack.txt')
-rw-r--r--Documentation/config/pack.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt
index 0dac580581..837f1b1679 100644
--- a/Documentation/config/pack.txt
+++ b/Documentation/config/pack.txt
@@ -119,8 +119,8 @@ pack.useSparse::
objects. This can have significant performance benefits when
computing a pack to send a small change. However, it is possible
that extra objects are added to the pack-file if the included
- commits contain certain types of direct renames. Default is `false`
- unless `feature.experimental` is enabled.
+ commits contain certain types of direct renames. Default is
+ `true`.
pack.writeBitmaps (deprecated)::
This is a deprecated synonym for `repack.writeBitmaps`.