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

Commit Message

Eric Wong Sept. 23, 2021, 8:12 p.m. UTC

Taylor Blau <[e-mail]> 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

MIDX files are used by default since commit d0fa539bc569
(doc/technical: remove outdated MIDX default note, 2021-09-22)

Helped-by: Taylor Blau <[e-mail]>
Signed-off-by: Eric Wong <[e-mail]>
---
 Documentation/technical/multi-pack-index.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Taylor Blau Sept. 23, 2021, 8:21 p.m. UTC | #1

On Thu, Sep 23, 2021 at 08:12:52PM +0000, Eric Wong wrote:
> Subject: [PATCH] doc/technical: update note about core.multiPackIndex
>
> MIDX files are used by default since commit d0fa539bc569
> (doc/technical: remove outdated MIDX default note, 2021-09-22)
>
> Helped-by: Taylor Blau <[e-mail]>
> Signed-off-by: Eric Wong <[e-mail]>
> ---

Thanks; this version looks good to me.

Thanks,
Taylor

Patch

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