# [PATCH] doc/technical: remove outdated MIDX default note 9 messages from 2021-09-22 to 2021-09-25. Participants: Eric Wong, Derrick Stolee, Taylor Blau, Junio C Hamano. Thread: https://gitlist.dev/t/56568 ## Eric Wong, 2021-09-22 22:13 Subject: [PATCH] doc/technical: remove outdated MIDX default note Message-ID: <20210922221342.6867-1-e@80x24.org> URL: https://gitlist.dev/e/20210922221342.6867-1-e%4080x24.org ``` Multi-pack-index files are used by default since commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the outdated note was misleading. Signed-off-by: Eric Wong --- Documentation/technical/multi-pack-index.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt index 1a73c3ee20..2038fb7995 100644 --- a/Documentation/technical/multi-pack-index.txt +++ b/Documentation/technical/multi-pack-index.txt @@ -36,8 +36,6 @@ 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 file format includes parameters for the object ID hash function, so a future change of hash algorithm does not require a change in format. ``` ## Derrick Stolee, 2021-09-23 13:47 Subject: Re: [PATCH] doc/technical: remove outdated MIDX default note Message-ID: <9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6@gmail.com> URL: https://gitlist.dev/e/9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6%40gmail.com In-Reply-To: <20210922221342.6867-1-e@80x24.org> ``` 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. > -- The core.multiPackIndex config setting must be on to consume MIDX files. > - As it is, this deletion is fine. A nit on your commit message: format commit references like this: 18e449f86 (midx: enable core.multiPackIndex by default, 2020-09-25) Thanks, -Stolee ``` ## Taylor Blau, 2021-09-23 17:45 Subject: Re: [PATCH] doc/technical: remove outdated MIDX default note Message-ID: URL: https://gitlist.dev/e/YUy9HzRgHU2zvI4P%40nand.local In-Reply-To: <9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6@gmail.com> ``` 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. Thanks, Taylor ``` ## Eric Wong, 2021-09-23 20:12 Subject: [PATCH v2] doc/technical: update note about core.multiPackIndex Message-ID: <20210923201252.GA25980@dcvr> URL: https://gitlist.dev/e/20210923201252.GA25980%40dcvr In-Reply-To: ``` Taylor Blau 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 Signed-off-by: Eric Wong --- 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 ``` ## Taylor Blau, 2021-09-23 20:21 Subject: Re: [PATCH v2] doc/technical: update note about core.multiPackIndex Message-ID: URL: https://gitlist.dev/e/YUzh3tahQnoumQ6V%40nand.local In-Reply-To: <20210923201252.GA25980@dcvr> ``` 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 > Signed-off-by: Eric Wong > --- Thanks; this version looks good to me. Thanks, Taylor ``` ## Junio C Hamano, 2021-09-23 20:27 Subject: Re: [PATCH] doc/technical: remove outdated MIDX default note Message-ID: URL: https://gitlist.dev/e/xmqq8rznyr4c.fsf%40gitster.g In-Reply-To: ``` Taylor Blau writes: > 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. Do you want to replace the one-line sentence with that paragraph, instead of removing it, in a replacement patch? ``` ## Taylor Blau, 2021-09-23 20:32 Subject: Re: [PATCH] doc/technical: remove outdated MIDX default note Message-ID: URL: https://gitlist.dev/e/YUzketzIpMqI8wbE%40nand.local In-Reply-To: ``` On Thu, Sep 23, 2021 at 01:27:31PM -0700, Junio C Hamano wrote: > Taylor Blau writes: > > > 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. > > Do you want to replace the one-line sentence with that paragraph, > instead of removing it, in a replacement patch? That's what I was hoping for, and Eric did that here: https://lore.kernel.org/git/20210923201252.GA25980@dcvr/ Thanks, Taylor ``` ## Eric Wong, 2021-09-24 11:11 Subject: [PATCH v3] doc/technical: update note about core.multiPackIndex Message-ID: <20210924111136.GA15127@dcvr> URL: https://gitlist.dev/e/20210924111136.GA15127%40dcvr In-Reply-To: <20210923201252.GA25980@dcvr> ``` MIDX files are used by default since commit 18e449f86b74 (midx: enable core.multiPackIndex by default, 2020-09-25) Helped-by: Taylor Blau Signed-off-by: Eric Wong --- v3: I cited the wrong commit in the commit message of v2 :x 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 ``` ## Derrick Stolee, 2021-09-25 17:17 Subject: Re: [PATCH v3] doc/technical: update note about core.multiPackIndex Message-ID: URL: https://gitlist.dev/e/be95aff9-b2e4-c3b8-a32a-375a3053fdfb%40gmail.com In-Reply-To: <20210924111136.GA15127@dcvr> ``` On 9/24/2021 7:11 AM, Eric Wong wrote: > MIDX files are used by default since commit 18e449f86b74 > (midx: enable core.multiPackIndex by default, 2020-09-25) > > Helped-by: Taylor Blau > Signed-off-by: Eric Wong > --- > v3: I cited the wrong commit in the commit message of v2 :x Good catch. > 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 This looks good to me, too! Thanks, -Stolee ```