Message ID | 20210924111136.GA15127@dcvr (mailing list archive) |
---|---|
State | Accepted |
Commit | 0d0d8d8a11f85d563552a7e91129814e315d9c78 |
Headers | show |
Series | [v3] doc/technical: update note about core.multiPackIndex | expand |
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 <me@ttaylorr.com> > Signed-off-by: Eric Wong <e@80x24.org> > --- > 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
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
MIDX files are used by default since commit 18e449f86b74 (midx: enable core.multiPackIndex by default, 2020-09-25) Helped-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Eric Wong <e@80x24.org> --- 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(-)