git-commit-vandalism/Documentation/config/index.txt

index.recordEndOfIndexEntries::
	Specifies whether the index file should include an "End Of Index
	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
	'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 'true' if index.threads has been explicitly enabled,
	'false' otherwise.

index.sparse::
	When enabled, write the index using sparse-directory entries. This
	has no effect unless `core.sparseCheckout` and
	`core.sparseCheckoutCone` are both enabled. Defaults to 'false'.

index.threads::
	Specifies the number of threads to spawn when loading the index.
	This is meant to reduce index load time on multiprocessor machines.
	Specifying 0 or 'true' will cause Git to auto-detect the number of
	CPU's and set the number of threads accordingly. Specifying 1 or
	'false' will disable multithreading. Defaults to 'true'.

index.version::
	Specify the version with which new index files should be
	initialized.  This does not affect existing repositories.
	If `feature.manyFiles` is enabled, then the default is 4.
eoie: default to not writing EOIE section Since 3b1d9e04 (eoie: add End of Index Entry (EOIE) extension, 2018-10-10) Git defaults to writing the new EOIE section when writing out an index file. Usually that is a good thing because it improves threaded performance, but when a Git repository is shared with older versions of Git, it produces a confusing warning: $ git status ignoring EOIE extension HEAD detached at 371ed0defa nothing to commit, working tree clean Let's introduce the new index extension more gently. First we'll roll out the new version of Git that understands it, and then once sufficiently many users are using such a version, we can flip the default to writing it by default. Introduce a '[index] recordEndOfIndexEntries' configuration variable to allow interested users to benefit from this index extension early. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2018-11-20 07:11:47 +01:00			`index.recordEndOfIndexEntries::`
			`Specifies whether the index file should include an "End Of Index`
			`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`
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> 2018-11-20 07:14:26 +01:00			`'true' if index.threads has been explicitly enabled, 'false'`
			`otherwise.`
eoie: default to not writing EOIE section Since 3b1d9e04 (eoie: add End of Index Entry (EOIE) extension, 2018-10-10) Git defaults to writing the new EOIE section when writing out an index file. Usually that is a good thing because it improves threaded performance, but when a Git repository is shared with older versions of Git, it produces a confusing warning: $ git status ignoring EOIE extension HEAD detached at 371ed0defa nothing to commit, working tree clean Let's introduce the new index extension more gently. First we'll roll out the new version of Git that understands it, and then once sufficiently many users are using such a version, we can flip the default to writing it by default. Introduce a '[index] recordEndOfIndexEntries' configuration variable to allow interested users to benefit from this index extension early. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2018-11-20 07:11:47 +01:00
ieot: default to not writing IEOT section As with EOIE, popular versions of Git do not support the new IEOT extension yet. When accessing a Git repository written by a more modern version of Git, they correctly ignore the unrecognized section, but in the process they loudly warn ignoring IEOT extension resulting in confusion for users. Introduce the index extension more gently by not writing it yet in this first version with support for it. Soon, once sufficiently many users are running a modern version of Git, we can flip the default so users benefit from this index extension by default. Introduce a '[index] recordOffsetTable' configuration variable to control whether the new index extension is written. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2018-11-20 07:12:22 +01:00			`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.`
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> 2018-11-20 07:14:26 +01:00			`Defaults to 'true' if index.threads has been explicitly enabled,`
			`'false' otherwise.`
ieot: default to not writing IEOT section As with EOIE, popular versions of Git do not support the new IEOT extension yet. When accessing a Git repository written by a more modern version of Git, they correctly ignore the unrecognized section, but in the process they loudly warn ignoring IEOT extension resulting in confusion for users. Introduce the index extension more gently by not writing it yet in this first version with support for it. Soon, once sufficiently many users are running a modern version of Git, we can flip the default so users benefit from this index extension by default. Introduce a '[index] recordOffsetTable' configuration variable to control whether the new index extension is written. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2018-11-20 07:12:22 +01:00
sparse-index: add index.sparse config option When enabled, this config option signals that index writes should attempt to use sparse-directory entries. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2021-03-30 15:10:59 +02:00			`index.sparse::`
			`When enabled, write the index using sparse-directory entries. This`
			has no effect unless `core.sparseCheckout` and
			`core.sparseCheckoutCone` are both enabled. Defaults to 'false'.

config.txt: move index.* to a separate file Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2018-10-27 08:23:11 +02:00			`index.threads::`
			`Specifies the number of threads to spawn when loading the index.`
			`This is meant to reduce index load time on multiprocessor machines.`
			`Specifying 0 or 'true' will cause Git to auto-detect the number of`
			`CPU's and set the number of threads accordingly. Specifying 1 or`
			`'false' will disable multithreading. Defaults to 'true'.`

			`index.version::`
			`Specify the version with which new index files should be`
			`initialized. This does not affect existing repositories.`
repo-settings: create feature.manyFiles setting The feature.manyFiles setting is suitable for repos with many files in the working directory. By setting index.version=4 and core.untrackedCache=true, commands such as 'git status' should improve. While adding this setting, modify the index version precedence tests to check how this setting overrides the default for index.version is unset. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2019-08-13 20:37:47 +02:00			If `feature.manyFiles` is enabled, then the default is 4.