( )⚙ D12184 dirstate-tracked-key: update the config value to match latest discussion

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12184

dirstate-tracked-key: update the config value to match latest discussion
ClosedPublic

Authored by marmoute on Feb 15 2022, 10:52 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG79a967128055: dirstate-tracked-key: update the config value to match latest discussion
rHGfd9f2205dd0c: dirstate-tracked-key: update the config value to match latest discussion
Summary

Special cases are not special enough, we align the option name on the other.

The version value is undocumented for now as it can only have a single value.
It is supported in the code to properly detect and abort if more value are
introduced in the future value.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

Diff 32222

mercurial/configitems.py

b'format', b'format',
b'use-dirstate-v2', b'use-dirstate-v2',
default=False, default=False,
experimental=True, experimental=True,
alias=[(b'format', b'exp-rc-dirstate-v2')], alias=[(b'format', b'exp-rc-dirstate-v2')],
) )
coreconfigitem( coreconfigitem(
b'format', b'format',
b'exp-dirstate-tracked-key-version', b'dirstate-tracked-key',
default=0, default=False,
experimental=True,
)
coreconfigitem(
b'format',
b'dirstate-tracked-key.version',
default=1,
experimental=True, experimental=True,
) )
coreconfigitem( coreconfigitem(
b'format', b'format',
b'dotencode', b'dotencode',
default=True, default=True,
) )
coreconfigitem( coreconfigitem(

mercurial/helptext/config.txt

$ hg debugupgraderepo \ $ hg debugupgraderepo \
--run \ --run \
--config format.use-dirstate-v2=False \ --config format.use-dirstate-v2=False \
--config storage.dirstate-v2.slow-path=allow --config storage.dirstate-v2.slow-path=allow
For a more comprehensive guide, see :hg:`help internals.dirstate-v2`. For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
``exp-dirstate-tracked-key-version`` ``dirstate-tracked-key``
Enable or disable the writing of "tracked key" file alongside the dirstate. Enable or disable the writing of "tracked key" file alongside the dirstate.
(default to disabled)
That "tracked-key" can help external automations to detect changes to the That "tracked-key" can help external automations to detect changes to the
set of tracked files. set of tracked files.
Two values are currently supported:
- 0: no file is written (the default),
- 1: a file in version "1" is written.
The tracked-key is written in a new `.hg/dirstate-tracked-key`. That file The tracked-key is written in a new `.hg/dirstate-tracked-key`. That file
contains two lines: contains two lines:
- the first line is the file version (currently: 1), - the first line is the file version (currently: 1),
- the second line contains the "tracked-key". - the second line contains the "tracked-key".
The tracked-key changes whenever the set of file tracked in the dirstate The tracked-key changes whenever the set of file tracked in the dirstate
changes. The general guarantees are: changes. The general guarantees are:
- if the tracked key is identical, the set of tracked file MUST not have changed, - if the tracked key is identical, the set of tracked file MUST not have changed,

mercurial/localrepo.py

requirements -= to_drop requirements -= to_drop
requirements |= source_requirements requirements |= source_requirements
if createopts.get(b'sharedrelative'): if createopts.get(b'sharedrelative'):
requirements.add(requirementsmod.RELATIVE_SHARED_REQUIREMENT) requirements.add(requirementsmod.RELATIVE_SHARED_REQUIREMENT)
else: else:
requirements.add(requirementsmod.SHARED_REQUIREMENT) requirements.add(requirementsmod.SHARED_REQUIREMENT)
tracked_key = ui.configint(b'format', b'exp-dirstate-tracked-key-version') if ui.configbool(b'format', b'dirstate-tracked-key'):
if tracked_key: version = ui.configint(b'format', b'dirstate-tracked-key.version')
if tracked_key != 1:
msg = _("ignoring unknown tracked key version: %d\n") msg = _("ignoring unknown tracked key version: %d\n")
hint = _( hint = _("see `hg help config.format.exp-dirstate-tracked-key-version")
"see `hg help config.format.exp-dirstate-tracked-key-version" if version != 1:
) ui.warn(msg % version, hint=hint)
ui.warn(msg % tracked_key, hint=hint)
else: else:
requirements.add(requirementsmod.DIRSTATE_TRACKED_KEY_V1) requirements.add(requirementsmod.DIRSTATE_TRACKED_KEY_V1)
return requirements return requirements
def checkrequirementscompat(ui, requirements): def checkrequirementscompat(ui, requirements):
"""Checks compatibility of repository requirements enabled and disabled. """Checks compatibility of repository requirements enabled and disabled.

tests/test-help.t

"usegeneraldelta" "usegeneraldelta"
"dotencode" "dotencode"
"usefncache" "usefncache"
"use-dirstate-v2" "use-dirstate-v2"
"exp-dirstate-tracked-key-version" "dirstate-tracked-key"
"use-persistent-nodemap" "use-persistent-nodemap"
"use-share-safe" "use-share-safe"
"usestore" "usestore"
"sparse-revlog" "sparse-revlog"

tests/test-status-tracked-key.t

============================== ==============================
Test the "tracked key" feature Test the "tracked key" feature
============================== ==============================
The tracked key feature provide a file that get updated when the set of tracked The tracked key feature provide a file that get updated when the set of tracked
files get updated. files get updated.
basic setup basic setup
$ cat << EOF >> $HGRCPATH $ cat << EOF >> $HGRCPATH
> [format] > [format]
> exp-dirstate-tracked-key-version=1 > dirstate-tracked-key=yes
> EOF > EOF
$ hg init tracked-key-test $ hg init tracked-key-test
$ cd tracked-key-test $ cd tracked-key-test
$ hg debugbuilddag '.+10' -n $ hg debugbuilddag '.+10' -n
$ hg log -G -T '{rev} {desc} {files}\n' $ hg log -G -T '{rev} {desc} {files}\n'
o 10 r10 nf10 o 10 r10 nf10
| |