( )⚙ D12200 tracked-file: rename the format option to use `use-`

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12200

tracked-file: rename the format option to use `use-`
ClosedPublic

Authored by marmoute on Feb 17 2022, 5:24 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG8bbb1abb9d19: tracked-file: rename the format option to use `use-`
Summary

This is more consistent with the other options.

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.

Event Timeline

marmoute created this revision.Feb 17 2022, 5:24 AM
Alphare accepted this revision.Feb 17 2022, 5:41 AM
This revision is now accepted and ready to land.Feb 17 2022, 5:41 AM
marmoute added a commit: rHG8bbb1abb9d19: tracked-file: rename the format option to use `use-`.Feb 18 2022, 5:29 AM
Closed by commit rHG8bbb1abb9d19: tracked-file: rename the format option to use `use-` (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 32264

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'dirstate-tracked-key', b'use-dirstate-tracked-key',
default=False, default=False,
experimental=True, experimental=True,
) )
coreconfigitem( coreconfigitem(
b'format', b'format',
b'dirstate-tracked-key.version', b'use-dirstate-tracked-key.version',
default=1, default=1,
experimental=True, experimental=True,
) )
coreconfigitem( coreconfigitem(
b'format', b'format',
b'dotencode', b'dotencode',
default=True, default=True,
) )

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`.
``dirstate-tracked-key`` ``use-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) (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.
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:

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)
if ui.configbool(b'format', b'dirstate-tracked-key'): if ui.configbool(b'format', b'use-dirstate-tracked-key'):
version = ui.configint(b'format', b'dirstate-tracked-key.version') version = ui.configint(b'format', b'use-dirstate-tracked-key.version')
msg = _("ignoring unknown tracked key version: %d\n") msg = _("ignoring unknown tracked key version: %d\n")
hint = _("see `hg help config.format.exp-dirstate-tracked-key-version") hint = _("see `hg help config.format.use-dirstate-tracked-key-version")
if version != 1: if version != 1:
ui.warn(msg % version, hint=hint) ui.warn(msg % version, hint=hint)
else: else:
requirements.add(requirementsmod.DIRSTATE_TRACKED_KEY_V1) requirements.add(requirementsmod.DIRSTATE_TRACKED_KEY_V1)
return requirements return requirements

tests/test-help.t

"usegeneraldelta" "usegeneraldelta"
"dotencode" "dotencode"
"usefncache" "usefncache"
"use-dirstate-v2" "use-dirstate-v2"
"dirstate-tracked-key" "use-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]
> dirstate-tracked-key=yes > use-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
| |
$ ls .hg/dirstate-tracked-key $ ls .hg/dirstate-tracked-key
.hg/dirstate-tracked-key .hg/dirstate-tracked-key
$ hg debugrequires | grep 'tracked' $ hg debugrequires | grep 'tracked'
dirstate-tracked-key-v1 dirstate-tracked-key-v1
downgrade downgrade
$ hg debugupgraderepo --config format.dirstate-tracked-key=no --run --quiet $ hg debugupgraderepo --config format.use-dirstate-tracked-key=no --run --quiet
upgrade will perform the following actions: upgrade will perform the following actions:
requirements requirements
preserved: * (glob) preserved: * (glob)
removed: dirstate-tracked-key-v1 removed: dirstate-tracked-key-v1
no revlogs to process no revlogs to process
$ ls -1 .hg/dirstate-tracked-key $ ls -1 .hg/dirstate-tracked-key
ls: cannot access '.hg/dirstate-tracked-key': $ENOENT$ ls: cannot access '.hg/dirstate-tracked-key': $ENOENT$
[2] [2]
$ hg debugrequires | grep 'tracked' $ hg debugrequires | grep 'tracked'
[1] [1]
upgrade upgrade
$ hg debugupgraderepo --config format.dirstate-tracked-key=yes --run --quiet $ hg debugupgraderepo --config format.use-dirstate-tracked-key=yes --run --quiet
upgrade will perform the following actions: upgrade will perform the following actions:
requirements requirements
preserved: * (glob) preserved: * (glob)
added: dirstate-tracked-key-v1 added: dirstate-tracked-key-v1
no revlogs to process no revlogs to process
$ ls -1 .hg/dirstate-tracked-key $ ls -1 .hg/dirstate-tracked-key
.hg/dirstate-tracked-key .hg/dirstate-tracked-key
$ hg debugrequires | grep 'tracked' $ hg debugrequires | grep 'tracked'
dirstate-tracked-key-v1 dirstate-tracked-key-v1