]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc/technical: update note about core.multiPackIndex
authorEric Wong <e@80x24.org>
Fri, 24 Sep 2021 11:11:36 +0000 (11:11 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 24 Sep 2021 15:39:53 +0000 (08:39 -0700)
MIDX files are used by default since commit 18e449f86b74
(midx: enable core.multiPackIndex by default, 2020-09-25)

Helped-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Eric Wong <e@80x24.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/multi-pack-index.txt

index e8e377a59f0c19a56fb53ed6d96f10f6c211d087..ddfceece6447b3ae92d7db35a99e0e51cc941313 100644 (file)
@@ -36,7 +36,9 @@ Design Details
   directory of an alternate. It refers only to packfiles in that
   same directory.
 
-- The core.multiPackIndex config setting must be on to consume MIDX files.
+- The core.multiPackIndex config setting must be on (which is the
+  default) to consume MIDX files.  Setting it to `false` prevents
+  Git from reading a MIDX file, even if one exists.
 
 - The file format includes parameters for the object ID hash
   function, so a future change of hash algorithm does not require