comparison mercurial/helptext/config.txt @ 49195:411d591e0a27

auto-upgrade: introduce a way to auto-upgrade to/from dirstate-v2 This is similar to what we introduced for `share-safe`, but apply to the tracked-hint feature. Differential Revision: https://phab.mercurial-scm.org/D12614
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Tue, 22 Mar 2022 14:14:52 +0100
parents e4b31016e194
children 71774d799de7
comparison
equal deleted inserted replaced
49194:e4b31016e194 49195:411d591e0a27
942 --config format.use-dirstate-v2=False \ 942 --config format.use-dirstate-v2=False \
943 --config storage.dirstate-v2.slow-path=allow 943 --config storage.dirstate-v2.slow-path=allow
944 944
945 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`. 945 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
946 946
947 ``use-dirstate-v2.automatic-upgrade-of-mismatching-repositories``
948 When enabled, an automatic upgrade will be triggered when a repository format
949 does not match its `use-dirstate-v2` config.
950
951 This is an advanced behavior that most users will not need. We recommend you
952 don't use this unless you are a seasoned administrator of a Mercurial install
953 base.
954
955 Automatic upgrade means that any process accessing the repository will
956 upgrade the repository format to use `dirstate-v2`. This only triggers if a
957 change is needed. This also applies to operations that would have been
958 read-only (like hg status).
959
960 This configuration will apply for moves in any direction, either adding the
961 `dirstate-v2` format if `format.use-dirstate-v2=yes` or removing the
962 `dirstate-v2` requirement if `format.use-dirstate-v2=no`. So we recommend
963 setting both this value and `format.use-dirstate-v2` at the same time.
964
947 ``use-dirstate-tracked-hint`` 965 ``use-dirstate-tracked-hint``
948 Enable or disable the writing of "tracked key" file alongside the dirstate. 966 Enable or disable the writing of "tracked key" file alongside the dirstate.
949 (default to disabled) 967 (default to disabled)
950 968
951 That "tracked-hint" can help external automations to detect changes to the 969 That "tracked-hint" can help external automations to detect changes to the