Re: [PATCH] doc/technical: remove outdated MIDX default note
- From
Derrick Stolee <stolee@gmail.com>
- Date
- Sep 23, 2021, 13:47 UTC
- Message-ID
- <9ebb4c34-8cdd-3120-ff9a-0e47099c3cf6@gmail.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