| Alphare |
| hg-reviewers |
This is similar to what we introduced for share-safe, but apply to the
tracked-hint feature.
| No Linters Available |
| No Unit Test Coverage |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/configitems.py (6 lines) | |||
| M | mercurial/helptext/config.txt (18 lines) | |||
| M | mercurial/upgrade_utils/auto_upgrade.py (57 lines) | |||
| M | rust/rhg/src/main.rs (5 lines) | |||
| M | tests/test-help.t (2 lines) | |||
| M | tests/test-upgrade-repo.t (67 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| 411d591e0a27 | e4b31016e194 | Pierre-Yves David | Mar 22 2022, 9:14 AM |
| 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'use-dirstate-v2.automatic-upgrade-of-mismatching-repositories', | |||||
| default=False, | |||||
| experimental=True, | |||||
| ) | |||||
| coreconfigitem( | |||||
| b'format', | |||||
| b'use-dirstate-tracked-hint', | b'use-dirstate-tracked-hint', | ||||
| default=False, | default=False, | ||||
| experimental=True, | experimental=True, | ||||
| ) | ) | ||||
| coreconfigitem( | coreconfigitem( | ||||
| b'format', | b'format', | ||||
| b'use-dirstate-tracked-hint.version', | b'use-dirstate-tracked-hint.version', | ||||
| default=1, | default=1, | ||||
| $ 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`. | ||||
| ``use-dirstate-v2.automatic-upgrade-of-mismatching-repositories`` | |||||
| When enabled, an automatic upgrade will be triggered when a repository format | |||||
| does not match its `use-dirstate-v2` config. | |||||
| This is an advanced behavior that most users will not need. We recommend you | |||||
| don't use this unless you are a seasoned administrator of a Mercurial install | |||||
| base. | |||||
| Automatic upgrade means that any process accessing the repository will | |||||
| upgrade the repository format to use `dirstate-v2`. This only triggers if a | |||||
| change is needed. This also applies to operations that would have been | |||||
| read-only (like hg status). | |||||
| This configuration will apply for moves in any direction, either adding the | |||||
| `dirstate-v2` format if `format.use-dirstate-v2=yes` or removing the | |||||
| `dirstate-v2` requirement if `format.use-dirstate-v2=no`. So we recommend | |||||
| setting both this value and `format.use-dirstate-v2` at the same time. | |||||
| ``use-dirstate-tracked-hint`` | ``use-dirstate-tracked-hint`` | ||||
| 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-hint" can help external automations to detect changes to the | That "tracked-hint" can help external automations to detect changes to the | ||||
| set of tracked files. (i.e the result of `hg files` or `hg status -macd`) | set of tracked files. (i.e the result of `hg files` or `hg status -macd`) | ||||
| The tracked-hint is written in a new `.hg/dirstate-tracked-hint`. That file | The tracked-hint is written in a new `.hg/dirstate-tracked-hint`. That file | ||||
| ui.write_err(hint) | ui.write_err(hint) | ||||
| requirements.discard(requirementsmod.DIRSTATE_TRACKED_HINT_V1) | requirements.discard(requirementsmod.DIRSTATE_TRACKED_HINT_V1) | ||||
| op = AutoUpgradeOperation(requirements) | op = AutoUpgradeOperation(requirements) | ||||
| engine.upgrade_tracked_hint(ui, repo, op, add=False) | engine.upgrade_tracked_hint(ui, repo, op, add=False) | ||||
| return action | return action | ||||
| def get_dirstate_v2_action(repo): | |||||
| """return an automatic-upgrade action for `dirstate-v2` if applicable | |||||
| If no action is needed, return None, otherwise return a callback to upgrade | |||||
| or downgrade the repository according the configuration and repository | |||||
| format. | |||||
| """ | |||||
| ui = repo.ui | |||||
| requirements = set(repo.requirements) | |||||
| auto_upgrade_tracked_hint = ui.configbool( | |||||
| b'format', | |||||
| b'use-dirstate-v2.automatic-upgrade-of-mismatching-repositories', | |||||
| ) | |||||
| action = None | |||||
| if auto_upgrade_tracked_hint: | |||||
| d2_config = ui.configbool(b'format', b'use-dirstate-v2') | |||||
| d2_local = requirementsmod.DIRSTATE_V2_REQUIREMENT in requirements | |||||
| if d2_config and not d2_local: | |||||
| msg = _( | |||||
| b"automatically upgrading repository to the `dirstate-v2`" | |||||
| b" feature\n" | |||||
| ) | |||||
| hint = ( | |||||
| b"(see `hg help config.format.use-dirstate-v2` for details)\n" | |||||
| ) | |||||
| def action(): | |||||
| if not ui.quiet: | |||||
| ui.write_err(msg) | |||||
| ui.write_err(hint) | |||||
| requirements.add(requirementsmod.DIRSTATE_V2_REQUIREMENT) | |||||
| fake_op = AutoUpgradeOperation(requirements) | |||||
| engine.upgrade_dirstate(repo.ui, repo, fake_op, b'v1', b'v2') | |||||
| elif d2_local and not d2_config: | |||||
| msg = _( | |||||
| b"automatically downgrading repository from the `dirstate-v2`" | |||||
| b" feature\n" | |||||
| ) | |||||
| hint = ( | |||||
| b"(see `hg help config.format.use-dirstate-v2` for details)\n" | |||||
| ) | |||||
| def action(): | |||||
| if not ui.quiet: | |||||
| ui.write_err(msg) | |||||
| ui.write_err(hint) | |||||
| requirements.discard(requirementsmod.DIRSTATE_V2_REQUIREMENT) | |||||
| fake_op = AutoUpgradeOperation(requirements) | |||||
| engine.upgrade_dirstate(repo.ui, repo, fake_op, b'v2', b'v1') | |||||
| return action | |||||
| AUTO_UPGRADE_ACTIONS = [ | AUTO_UPGRADE_ACTIONS = [ | ||||
| get_dirstate_v2_action, | |||||
| get_share_safe_action, | get_share_safe_action, | ||||
| get_tracked_hint_action, | get_tracked_hint_action, | ||||
| ] | ] | ||||
| def may_auto_upgrade(repo, maker_func): | def may_auto_upgrade(repo, maker_func): | ||||
| """potentially perform auto-upgrade and return the final repository to use | """potentially perform auto-upgrade and return the final repository to use | ||||
| ("format", "use-share-safe"), | ("format", "use-share-safe"), | ||||
| requirements::SHARESAFE_REQUIREMENT, | requirements::SHARESAFE_REQUIREMENT, | ||||
| ), | ), | ||||
| ( | ( | ||||
| ("format", "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories"), | ("format", "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories"), | ||||
| ("format", "use-dirstate-tracked-hint"), | ("format", "use-dirstate-tracked-hint"), | ||||
| requirements::DIRSTATE_TRACKED_HINT_V1, | requirements::DIRSTATE_TRACKED_HINT_V1, | ||||
| ), | ), | ||||
| ( | |||||
| ("use-dirstate-v2", "automatic-upgrade-of-mismatching-repositories"), | |||||
| ("format", "use-dirstate-v2"), | |||||
| requirements::DIRSTATE_V2_REQUIREMENT, | |||||
| ), | |||||
| ]; | ]; | ||||
| /// Mercurial allows users to automatically upgrade their repository. | /// Mercurial allows users to automatically upgrade their repository. | ||||
| /// `rhg` does not have the ability to upgrade yet, so fallback if an upgrade | /// `rhg` does not have the ability to upgrade yet, so fallback if an upgrade | ||||
| /// is needed. | /// is needed. | ||||
| fn check_auto_upgrade( | fn check_auto_upgrade( | ||||
| config: &Config, | config: &Config, | ||||
| reqs: &HashSet<String>, | reqs: &HashSet<String>, | ||||
| "usegeneraldelta" | "usegeneraldelta" | ||||
| "dotencode" | "dotencode" | ||||
| "usefncache" | "usefncache" | ||||
| "use-dirstate-v2" | "use-dirstate-v2" | ||||
| "use-dirstate-v2.automatic-upgrade-of-mismatching-repositories" | |||||
| "use-dirstate-tracked-hint" | "use-dirstate-tracked-hint" | ||||
| "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories" | "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories" | ||||
| "use-persistent-nodemap" | "use-persistent-nodemap" | ||||
| "use-share-safe" | "use-share-safe" | ||||
| (it is safe to interrupt this process any time before data migration completes) | (it is safe to interrupt this process any time before data migration completes) | ||||
| downgrading from dirstate-v2 to v1 | downgrading from dirstate-v2 to v1 | ||||
| replaced files will be backed up at $TESTTMP/dirstate-v2-empty/.hg/upgradebackup.* (glob) | replaced files will be backed up at $TESTTMP/dirstate-v2-empty/.hg/upgradebackup.* (glob) | ||||
| removing temporary repository $TESTTMP/dirstate-v2-empty/.hg/upgrade.* (glob) | removing temporary repository $TESTTMP/dirstate-v2-empty/.hg/upgrade.* (glob) | ||||
| $ hg debugformat | grep dirstate-v2 | $ hg debugformat | grep dirstate-v2 | ||||
| dirstate-v2: no | dirstate-v2: no | ||||
| $ cd .. | $ cd .. | ||||
| Test automatic upgrade/downgrade | |||||
| ================================ | |||||
| For dirstate v2 | |||||
| --------------- | |||||
| create an initial repository | |||||
| $ hg init auto-upgrade \ | |||||
| > --config format.use-dirstate-v2=no \ | |||||
| > --config format.use-dirstate-tracked-hint=yes \ | |||||
| > --config format.use-share-safe=no | |||||
| $ hg debugbuilddag -R auto-upgrade --new-file .+5 | |||||
| $ hg -R auto-upgrade update | |||||
| 6 files updated, 0 files merged, 0 files removed, 0 files unresolved | |||||
| $ hg debugformat -R auto-upgrade | grep dirstate-v2 | |||||
| dirstate-v2: no | |||||
| upgrade it to dirstate-v2 automatically | |||||
| $ hg status -R auto-upgrade \ | |||||
| > --config format.use-dirstate-v2.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-v2=yes | |||||
| automatically upgrading repository to the `dirstate-v2` feature | |||||
| (see `hg help config.format.use-dirstate-v2` for details) | |||||
| $ hg debugformat -R auto-upgrade | grep dirstate-v2 | |||||
| dirstate-v2: yes | |||||
| downgrade it from dirstate-v2 automatically | |||||
| $ hg status -R auto-upgrade \ | |||||
| > --config format.use-dirstate-v2.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-v2=no | |||||
| automatically downgrading repository from the `dirstate-v2` feature | |||||
| (see `hg help config.format.use-dirstate-v2` for details) | |||||
| $ hg debugformat -R auto-upgrade | grep dirstate-v2 | |||||
| dirstate-v2: no | |||||
| For multiple change at the same time | |||||
| ------------------------------------ | |||||
| $ hg debugformat -R auto-upgrade | egrep '(dirstate-v2|tracked|share-safe)' | |||||
| dirstate-v2: no | |||||
| tracked-hint: yes | |||||
| share-safe: no | |||||
| $ hg status -R auto-upgrade \ | |||||
| > --config format.use-dirstate-v2.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-v2=yes \ | |||||
| > --config format.use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-tracked-hint=no\ | |||||
| > --config format.use-share-safe.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-share-safe=yes | |||||
| automatically upgrading repository to the `dirstate-v2` feature | |||||
| (see `hg help config.format.use-dirstate-v2` for details) | |||||
| automatically upgrading repository to the `share-safe` feature | |||||
| (see `hg help config.format.use-share-safe` for details) | |||||
| automatically downgrading repository from the `tracked-hint` feature | |||||
| (see `hg help config.format.use-dirstate-tracked-hint` for details) | |||||
| $ hg debugformat -R auto-upgrade | egrep '(dirstate-v2|tracked|share-safe)' | |||||
| dirstate-v2: yes | |||||
| tracked-hint: no | |||||
| share-safe: yes | |||||