Mercurial > hg
changeset 51446:5d0d510d2db1 stable
config: document the storage and format sections
This should help people to put configuration in the right section.
| author | Pierre-Yves David <pierre-yves.david@octobus.net> |
|---|---|
| date | Mon, 04 Mar 2024 04:13:33 +0100 |
| parents | 6a98abbb95ee |
| children | 40943970b7ae |
| files | mercurial/configitems.toml |
| diffstat | 1 files changed, 22 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/configitems.toml Fri Feb 23 15:55:53 2024 +0100 +++ b/mercurial/configitems.toml Mon Mar 04 04:13:33 2024 +0100 @@ -1160,6 +1160,19 @@ default = false generic = true + +# The format section is dedicated to control of the repository on disk format +# and constraints. +# +# A format change affects which data is expected to be stored in the repository +# and how. It impacts other client whichever their version are, format change +# often comes with an associated entry in the requirements. +# +# The option are usually in the form `use-xxx-yyy` (with xxx-yy the feature name). +# +# To configure details of how the repository is accessed, without affect the +# repository formats, see the `storage section`. + [[items]] section = "format" name = "bookmarks-in-store" @@ -2102,6 +2115,15 @@ default = true experimental = true + +# The "storage" section house config options that change how the repository +# data are accessed by the current process but does not affects the on disk +# format. They can also adjust how the storage is computed, but without affect +# compatibility wither other clients. +# +# For deeper format change, see the `format` section. + + [[items]] section = "storage" name = "dirstate-v2.slow-path"