{"thread":{"id":"56568","subject":"[PATCH] doc/technical: remove outdated MIDX default note","startedAt":"2021-09-22T22:13:43Z","lastAt":"2021-09-25T17:18:04Z","messageCount":9,"participants":["Eric Wong","Derrick Stolee","Taylor Blau","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"436789","messageId":"20210922221342.6867-1-e@80x24.org","threadId":"56568","inReplyTo":null,"subject":"[PATCH] doc/technical: remove outdated MIDX default note","fromName":"Eric Wong","fromEmail":"e@80x24.org","sentAt":"2021-09-22T22:13:42Z","receivedAt":"2021-09-22T22:13:43Z","isPatch":true,"sender":{"key":"e@80x24.org","avatar":null},"body":"Multi-pack-index files are used by default since\ncommit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\noutdated note was misleading.\n\nSigned-off-by: Eric Wong <e@80x24.org>\n---\n Documentation/technical/multi-pack-index.txt | 2 --\n 1 file changed, 2 deletions(-)\n\ndiff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt\nindex 1a73c3ee20..2038fb7995 100644\n--- a/Documentation/technical/multi-pack-index.txt\n+++ b/Documentation/technical/multi-pack-index.txt\n@@ -36,8 +36,6 @@ Design Details\n   directory of an alternate. It refers only to packfiles in that\n   same directory.\n \n-- The core.multiPackIndex config setting must be on to consume MIDX files.\n-\n - The file format includes parameters for the object ID hash\n   function, so a future change of hash algorithm does not require\n   a change in format.\n"},{"id":"436854","messageId":"9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6@gmail.com","threadId":"56568","inReplyTo":"20210922221342.6867-1-e@80x24.org","subject":"Re: [PATCH] doc/technical: remove outdated MIDX default note","fromName":"Derrick Stolee","fromEmail":"stolee@gmail.com","sentAt":"2021-09-23T13:47:03Z","receivedAt":"2021-09-23T13:47:07Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"On 9/22/2021 6:13 PM, Eric Wong wrote:\n> Multi-pack-index files are used by default since\n> commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\n> outdated note was misleading.\n\nYou are correct that the note is misleading, but it is still correct.\n\nA user can _disable_ reading MIDX files by setting core.multiPackIndex\nto false. If this was in the user-facing docs, not the technical docs,\nthen I might push back on trying to make that distinction.\n\n> -- The core.multiPackIndex config setting must be on to consume MIDX files.\n> -\n\nAs it is, this deletion is fine.\n\nA nit on your commit message: format commit references like this:\n\n  18e449f86 (midx: enable core.multiPackIndex by default, 2020-09-25)\n\nThanks,\n-Stolee\n"},{"id":"436880","messageId":"YUy9HzRgHU2zvI4P@nand.local","threadId":"56568","inReplyTo":"9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6@gmail.com","subject":"Re: [PATCH] doc/technical: remove outdated MIDX default note","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2021-09-23T17:45:03Z","receivedAt":"2021-09-23T17:45:07Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Thu, Sep 23, 2021 at 09:47:03AM -0400, Derrick Stolee wrote:\n> On 9/22/2021 6:13 PM, Eric Wong wrote:\n> > Multi-pack-index files are used by default since\n> > commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\n> > outdated note was misleading.\n>\n> You are correct that the note is misleading, but it is still correct.\n>\n> A user can _disable_ reading MIDX files by setting core.multiPackIndex\n> to false. If this was in the user-facing docs, not the technical docs,\n> then I might push back on trying to make that distinction.\n\nIt may present a fuller picture to instead say:\n\n  The core.multiPackIndex config setting must be on (which is the default)\n  to consume MIDX files. Setting it to `false` prevents Git from reading a\n  MIDX file, even if one exists.\n\nThanks,\nTaylor\n"},{"id":"436890","messageId":"20210923201252.GA25980@dcvr","threadId":"56568","inReplyTo":"YUy9HzRgHU2zvI4P@nand.local","subject":"[PATCH v2] doc/technical: update note about core.multiPackIndex","fromName":"Eric Wong","fromEmail":"e@80x24.org","sentAt":"2021-09-23T20:12:52Z","receivedAt":"2021-09-23T20:12:54Z","isPatch":true,"sender":{"key":"e@80x24.org","avatar":null},"body":"Taylor Blau <me@ttaylorr.com> wrote:\n> On Thu, Sep 23, 2021 at 09:47:03AM -0400, Derrick Stolee wrote:\n> > On 9/22/2021 6:13 PM, Eric Wong wrote:\n> > > Multi-pack-index files are used by default since\n> > > commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\n> > > outdated note was misleading.\n> >\n> > You are correct that the note is misleading, but it is still correct.\n> >\n> > A user can _disable_ reading MIDX files by setting core.multiPackIndex\n> > to false. If this was in the user-facing docs, not the technical docs,\n> > then I might push back on trying to make that distinction.\n> \n> It may present a fuller picture to instead say:\n> \n>   The core.multiPackIndex config setting must be on (which is the default)\n>   to consume MIDX files. Setting it to `false` prevents Git from reading a\n>   MIDX file, even if one exists.\n\nAh, thanks, I'll just use your text.\n\n---------8<----------\nSubject: [PATCH] doc/technical: update note about core.multiPackIndex\n\nMIDX files are used by default since commit d0fa539bc569\n(doc/technical: remove outdated MIDX default note, 2021-09-22)\n\nHelped-by: Taylor Blau <me@ttaylorr.com>\nSigned-off-by: Eric Wong <e@80x24.org>\n---\n Documentation/technical/multi-pack-index.txt | 4 +++-\n 1 file changed, 3 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt\nindex 1a73c3ee203e..86f40f24909a 100644\n--- a/Documentation/technical/multi-pack-index.txt\n+++ b/Documentation/technical/multi-pack-index.txt\n@@ -36,7 +36,9 @@ Design Details\n   directory of an alternate. It refers only to packfiles in that\n   same directory.\n \n-- The core.multiPackIndex config setting must be on to consume MIDX files.\n+- The core.multiPackIndex config setting must be on (which is the\n+  default) to consume MIDX files.  Setting it to `false` prevents\n+  Git from reading a MIDX file, even if one exists.\n \n - The file format includes parameters for the object ID hash\n   function, so a future change of hash algorithm does not require\n"},{"id":"436891","messageId":"YUzh3tahQnoumQ6V@nand.local","threadId":"56568","inReplyTo":"20210923201252.GA25980@dcvr","subject":"Re: [PATCH v2] doc/technical: update note about core.multiPackIndex","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2021-09-23T20:21:50Z","receivedAt":"2021-09-23T20:21:53Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Thu, Sep 23, 2021 at 08:12:52PM +0000, Eric Wong wrote:\n> Subject: [PATCH] doc/technical: update note about core.multiPackIndex\n>\n> MIDX files are used by default since commit d0fa539bc569\n> (doc/technical: remove outdated MIDX default note, 2021-09-22)\n>\n> Helped-by: Taylor Blau <me@ttaylorr.com>\n> Signed-off-by: Eric Wong <e@80x24.org>\n> ---\n\nThanks; this version looks good to me.\n\nThanks,\nTaylor\n"},{"id":"436892","messageId":"xmqq8rznyr4c.fsf@gitster.g","threadId":"56568","inReplyTo":"YUy9HzRgHU2zvI4P@nand.local","subject":"Re: [PATCH] doc/technical: remove outdated MIDX default note","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-09-23T20:27:31Z","receivedAt":"2021-09-23T20:27:35Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Taylor Blau <me@ttaylorr.com> writes:\n\n> On Thu, Sep 23, 2021 at 09:47:03AM -0400, Derrick Stolee wrote:\n>> On 9/22/2021 6:13 PM, Eric Wong wrote:\n>> > Multi-pack-index files are used by default since\n>> > commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\n>> > outdated note was misleading.\n>>\n>> You are correct that the note is misleading, but it is still correct.\n>>\n>> A user can _disable_ reading MIDX files by setting core.multiPackIndex\n>> to false. If this was in the user-facing docs, not the technical docs,\n>> then I might push back on trying to make that distinction.\n>\n> It may present a fuller picture to instead say:\n>\n>   The core.multiPackIndex config setting must be on (which is the default)\n>   to consume MIDX files. Setting it to `false` prevents Git from reading a\n>   MIDX file, even if one exists.\n\nDo you want to replace the one-line sentence with that paragraph,\ninstead of removing it, in a replacement patch?\n\n"},{"id":"436893","messageId":"YUzketzIpMqI8wbE@nand.local","threadId":"56568","inReplyTo":"xmqq8rznyr4c.fsf@gitster.g","subject":"Re: [PATCH] doc/technical: remove outdated MIDX default note","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2021-09-23T20:32:58Z","receivedAt":"2021-09-23T20:33:01Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Thu, Sep 23, 2021 at 01:27:31PM -0700, Junio C Hamano wrote:\n> Taylor Blau <me@ttaylorr.com> writes:\n>\n> > On Thu, Sep 23, 2021 at 09:47:03AM -0400, Derrick Stolee wrote:\n> >> On 9/22/2021 6:13 PM, Eric Wong wrote:\n> >> > Multi-pack-index files are used by default since\n> >> > commit 18e449f86b74bab35b150549c8342d252fe7ae00, so the\n> >> > outdated note was misleading.\n> >>\n> >> You are correct that the note is misleading, but it is still correct.\n> >>\n> >> A user can _disable_ reading MIDX files by setting core.multiPackIndex\n> >> to false. If this was in the user-facing docs, not the technical docs,\n> >> then I might push back on trying to make that distinction.\n> >\n> > It may present a fuller picture to instead say:\n> >\n> >   The core.multiPackIndex config setting must be on (which is the default)\n> >   to consume MIDX files. Setting it to `false` prevents Git from reading a\n> >   MIDX file, even if one exists.\n>\n> Do you want to replace the one-line sentence with that paragraph,\n> instead of removing it, in a replacement patch?\n\nThat's what I was hoping for, and Eric did that here:\n\n    https://lore.kernel.org/git/20210923201252.GA25980@dcvr/\n\nThanks,\nTaylor\n"},{"id":"436941","messageId":"20210924111136.GA15127@dcvr","threadId":"56568","inReplyTo":"20210923201252.GA25980@dcvr","subject":"[PATCH v3] doc/technical: update note about core.multiPackIndex","fromName":"Eric Wong","fromEmail":"e@80x24.org","sentAt":"2021-09-24T11:11:36Z","receivedAt":"2021-09-24T11:11:38Z","isPatch":true,"sender":{"key":"e@80x24.org","avatar":null},"body":"MIDX files are used by default since commit 18e449f86b74\n(midx: enable core.multiPackIndex by default, 2020-09-25)\n\nHelped-by: Taylor Blau <me@ttaylorr.com>\nSigned-off-by: Eric Wong <e@80x24.org>\n---\n v3: I cited the wrong commit in the commit message of v2 :x\n\n Documentation/technical/multi-pack-index.txt | 4 +++-\n 1 file changed, 3 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt\nindex 1a73c3ee203e..86f40f24909a 100644\n--- a/Documentation/technical/multi-pack-index.txt\n+++ b/Documentation/technical/multi-pack-index.txt\n@@ -36,7 +36,9 @@ Design Details\n   directory of an alternate. It refers only to packfiles in that\n   same directory.\n \n-- The core.multiPackIndex config setting must be on to consume MIDX files.\n+- The core.multiPackIndex config setting must be on (which is the\n+  default) to consume MIDX files.  Setting it to `false` prevents\n+  Git from reading a MIDX file, even if one exists.\n \n - The file format includes parameters for the object ID hash\n   function, so a future change of hash algorithm does not require\n"},{"id":"437074","messageId":"be95aff9-b2e4-c3b8-a32a-375a3053fdfb@gmail.com","threadId":"56568","inReplyTo":"20210924111136.GA15127@dcvr","subject":"Re: [PATCH v3] doc/technical: update note about core.multiPackIndex","fromName":"Derrick Stolee","fromEmail":"stolee@gmail.com","sentAt":"2021-09-25T17:17:56Z","receivedAt":"2021-09-25T17:18:04Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"On 9/24/2021 7:11 AM, Eric Wong wrote:\n> MIDX files are used by default since commit 18e449f86b74\n> (midx: enable core.multiPackIndex by default, 2020-09-25)\n> \n> Helped-by: Taylor Blau <me@ttaylorr.com>\n> Signed-off-by: Eric Wong <e@80x24.org>\n> ---\n>  v3: I cited the wrong commit in the commit message of v2 :x\n\nGood catch.\n \n>  Documentation/technical/multi-pack-index.txt | 4 +++-\n>  1 file changed, 3 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt\n> index 1a73c3ee203e..86f40f24909a 100644\n> --- a/Documentation/technical/multi-pack-index.txt\n> +++ b/Documentation/technical/multi-pack-index.txt\n> @@ -36,7 +36,9 @@ Design Details\n>    directory of an alternate. It refers only to packfiles in that\n>    same directory.\n>  \n> -- The core.multiPackIndex config setting must be on to consume MIDX files.\n> +- The core.multiPackIndex config setting must be on (which is the\n> +  default) to consume MIDX files.  Setting it to `false` prevents\n> +  Git from reading a MIDX file, even if one exists.\n>  \n>  - The file format includes parameters for the object ID hash\n>    function, so a future change of hash algorithm does not require\n\nThis looks good to me, too!\n\nThanks,\n-Stolee\n"}]}