[PATCH v2] doc/technical: update note about core.multiPackIndex

From

EWEric Wong <e@80x24.org>

Date

Sep 23, 2021, 20:12 UTC

Message-ID

<20210923201252.GA25980@dcvr>

In-Reply-To

<YUy9HzRgHU2zvI4P@nand.local>

Taylor Blau <me@ttaylorr.com> wrote:

> On Thu, Sep 23, 2021 at 09:47:03AM -0400, Derrick Stolee wrote:
> > On 9/22/2021 6:13 PM, Eric Wong wrote:
> > > Multi-pack-index files are used by default since
> > > commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the
> > > outdated note was misleading.
> >
> > You are correct that the note is misleading, but it is still correct.
> >
> > A user can _disable_ reading MIDX files by setting core.multiPackIndex
> > to false. If this was in the user-facing docs, not the technical docs,
> > then I might push back on trying to make that distinction.
> 
> It may present a fuller picture to instead say:
> 
>   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.

Ah, thanks, I'll just use your text.

---------8<----------
Subject: [PATCH] doc/technical: update note about core.multiPackIndex

Helped-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Eric Wong <e@80x24.org>
---
 Documentation/technical/multi-pack-index.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt
index 1a73c3ee203e..86f40f24909a 100644
--- a/Documentation/technical/multi-pack-index.txt
+++ b/Documentation/technical/multi-pack-index.txt
@@ -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