[thirdparty/git.git] / Documentation / config / feature.txt

feature.*::
	The config settings that start with `feature.` modify the defaults of
	a group of other config settings. These groups are created by the Git
	developer community as recommended defaults and are subject to change.
	In particular, new config options may be added with different defaults.

feature.experimental::
	Enable config options that are new to Git, and are being considered for
	future defaults. Config settings included here may be added or removed
	with each release, including minor version updates. These settings may
	have unintended interactions since they are so new. Please enable this
	setting if you are interested in providing feedback on experimental
	features. The new default values are:
+
* `fetch.negotiationAlgorithm=skipping` may improve fetch negotiation times by
skipping more commits at a time, reducing the number of round trips.
+
* `pack.useBitmapBoundaryTraversal=true` may improve bitmap traversal times by
walking fewer objects.
+
* `pack.allowPackReuse=multi` may improve the time it takes to create a pack by
reusing objects from multiple packs instead of just one.

feature.manyFiles::
	Enable config options that optimize for repos with many files in the
	working directory. With many files, commands such as `git status` and
	`git checkout` may be slow and these new defaults improve performance:
+
* `index.skipHash=true` speeds up index writes by not computing a trailing
  checksum. Note that this will cause Git versions earlier than 2.13.0 to
  refuse to parse the index and Git versions earlier than 2.40.0 will report
  a corrupted index during `git fsck`.
+
* `index.version=4` enables path-prefix compression in the index.
+
* `core.untrackedCache=true` enables the untracked cache. This setting assumes
that mtime is working on your machine.
Commit	Line	Data
c6cc4c5a DS	1	feature.*::
	2	The config settings that start with `feature.` modify the defaults of
	3	a group of other config settings. These groups are created by the Git
	4	developer community as recommended defaults and are subject to change.
	5	In particular, new config options may be added with different defaults.
	6
aaf633c2 DS	7	feature.experimental::
	8	Enable config options that are new to Git, and are being considered for
	9	future defaults. Config settings included here may be added or removed
	10	with each release, including minor version updates. These settings may
	11	have unintended interactions since they are so new. Please enable this
	12	setting if you are interested in providing feedback on experimental
	13	features. The new default values are:
	14	+
aaf633c2 DS	15	* `fetch.negotiationAlgorithm=skipping` may improve fetch negotiation times by
aaf633c2 DS	16	skipping more commits at a time, reducing the number of round trips.
b0afdce5 TB	17	+
	18	* `pack.useBitmapBoundaryTraversal=true` may improve bitmap traversal times by
	19	walking fewer objects.
23c1e713 TB	20	+
	21	* `pack.allowPackReuse=multi` may improve the time it takes to create a pack by
	22	reusing objects from multiple packs instead of just one.
aaf633c2	23
c6cc4c5a DS	24	feature.manyFiles::
	25	Enable config options that optimize for repos with many files in the
	26	working directory. With many files, commands such as `git status` and
	27	`git checkout` may be slow and these new defaults improve performance:
	28	+
17194b19 DS	29	* `index.skipHash=true` speeds up index writes by not computing a trailing
	30	checksum. Note that this will cause Git versions earlier than 2.13.0 to
	31	refuse to parse the index and Git versions earlier than 2.40.0 will report
	32	a corrupted index during `git fsck`.
	33	+
c6cc4c5a DS	34	* `index.version=4` enables path-prefix compression in the index.
	35	+
	36	* `core.untrackedCache=true` enables the untracked cache. This setting assumes
	37	that mtime is working on your machine.