summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2018-11-20 06:14:26 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-11-21 07:46:54 (GMT)
commit2a9dedef2ef76916be4a314a7e739f253eaf05db (patch)
treea97b4357fc7e93aff9b5b1695757d5cee1446eba /Documentation
parent429160544db9cc0cf748cdc98b21bd3533ec85a3 (diff)
downloadgit-2a9dedef2ef76916be4a314a7e739f253eaf05db.zip
git-2a9dedef2ef76916be4a314a7e739f253eaf05db.tar.gz
git-2a9dedef2ef76916be4a314a7e739f253eaf05db.tar.bz2
index: make index.threads=true enable ieot and eoie
If a user explicitly sets [index] threads = true to read the index using multiple threads, ensure that index writes include the offset table by default to make that possible. This ensures that the user's intent of turning on threading is respected. In other words, permit the following configurations: - index.threads and index.recordOffsetTable unspecified: do not write the offset table yet (to avoid alarming the user with "ignoring IEOT extension" messages when an older version of Git accesses the repository) but do make use of multiple threads to read the index if the supporting offset table is present. This can also be requested explicitly by setting index.threads=true, 0, or >1 and index.recordOffsetTable=false. - index.threads=false or 1: do not write the offset table, and do not make use of the offset table. One can set index.recordOffsetTable=false as well, to be more explicit. - index.threads=true, 0, or >1 and index.recordOffsetTable unspecified: write the offset table and make use of threads at read time. This can also be requested by setting index.threads=true, 0, >1, or unspecified and index.recordOffsetTable=true. Fortunately the complication is temporary: once most Git installations have upgraded to a version with support for the IEOT and EOIE extensions, we can flip the defaults for index.recordEndOfIndexEntries and index.recordOffsetTable to true and eliminate the settings. Helped-by: Ben Peart <benpeart@microsoft.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config/index.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/config/index.txt b/Documentation/config/index.txt
index de44183..f181503 100644
--- a/Documentation/config/index.txt
+++ b/Documentation/config/index.txt
@@ -3,14 +3,16 @@ index.recordEndOfIndexEntries::
Entry" section. This reduces index load time on multiprocessor
machines but produces a message "ignoring EOIE extension" when
reading the index using Git versions before 2.20. Defaults to
- 'false'.
+ 'true' if index.threads has been explicitly enabled, 'false'
+ otherwise.
index.recordOffsetTable::
Specifies whether the index file should include an "Index Entry
Offset Table" section. This reduces index load time on
multiprocessor machines but produces a message "ignoring IEOT
extension" when reading the index using Git versions before 2.20.
- Defaults to 'false'.
+ Defaults to 'true' if index.threads has been explicitly enabled,
+ 'false' otherwise.
index.threads::
Specifies the number of threads to spawn when loading the index.