| Alphare |
| hg-reviewers |
This is similar to what we introduced for share-safe, but apply to the
tracked-hint feature.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/configitems.py (6 lines) | |||
| M | mercurial/helptext/config.txt (21 lines) | |||
| M | mercurial/upgrade_utils/auto_upgrade.py (71 lines) | |||
| M | rust/hg-core/src/requirements.rs (4 lines) | |||
| M | rust/rhg/src/main.rs (5 lines) | |||
| M | tests/test-help.t (2 lines) | |||
| M | tests/test-share-safe.t (33 lines) | |||
| M | tests/test-status-tracked-key.t (34 lines) |
| coreconfigitem( | coreconfigitem( | ||||
| b'format', | b'format', | ||||
| b'use-dirstate-tracked-hint.version', | b'use-dirstate-tracked-hint.version', | ||||
| default=1, | default=1, | ||||
| experimental=True, | experimental=True, | ||||
| ) | ) | ||||
| coreconfigitem( | coreconfigitem( | ||||
| b'format', | b'format', | ||||
| b'use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories', | |||||
| default=False, | |||||
| experimental=True, | |||||
| ) | |||||
| coreconfigitem( | |||||
| b'format', | |||||
| b'dotencode', | b'dotencode', | ||||
| default=True, | default=True, | ||||
| ) | ) | ||||
| coreconfigitem( | coreconfigitem( | ||||
| b'format', | b'format', | ||||
| b'generaldelta', | b'generaldelta', | ||||
| default=False, | default=False, | ||||
| experimental=True, | experimental=True, | ||||
| They are two "ways" to use this feature: | They are two "ways" to use this feature: | ||||
| 1) monitoring changes to the `.hg/dirstate-tracked-hint`, if the file | 1) monitoring changes to the `.hg/dirstate-tracked-hint`, if the file | ||||
| changes, the tracked set might have changed. | changes, the tracked set might have changed. | ||||
| 2) storing the value and comparing it to a later value. | 2) storing the value and comparing it to a later value. | ||||
| ``use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories`` | |||||
| When enabled, an automatic upgrade will be triggered when a repository format | |||||
| does not match its `use-dirstate-tracked-hint` 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-tracked-hint`. 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-tracked-hint` format if `format.use-dirstate-tracked-hint=yes` or | |||||
| removing the `dirstate-tracked-hint` requirement if | |||||
| `format.use-dirstate-tracked-hint=no`. So we recommend setting both this | |||||
| value and `format.use-dirstate-tracked-hint` at the same time. | |||||
| ``use-persistent-nodemap`` | ``use-persistent-nodemap`` | ||||
| Enable or disable the "persistent-nodemap" feature which improves | Enable or disable the "persistent-nodemap" feature which improves | ||||
| performance if the Rust extensions are available. | performance if the Rust extensions are available. | ||||
| The "persistent-nodemap" persist the "node -> rev" on disk removing the | The "persistent-nodemap" persist the "node -> rev" on disk removing the | ||||
| need to dynamically build that mapping for each Mercurial invocation. This | need to dynamically build that mapping for each Mercurial invocation. This | ||||
| significantly reduces the startup cost of various local and server-side | significantly reduces the startup cost of various local and server-side | ||||
| operation for larger repositories. | operation for larger repositories. | ||||
| # upgrade.py - functions for automatic upgrade of Mercurial repository | # upgrade.py - functions for automatic upgrade of Mercurial repository | ||||
| # | # | ||||
| # Copyright (c) 2022-present, Pierre-Yves David | # Copyright (c) 2022-present, Pierre-Yves David | ||||
| # | # | ||||
| # This software may be used and distributed according to the terms of the | # This software may be used and distributed according to the terms of the | ||||
| # GNU General Public License version 2 or any later version. | # GNU General Public License version 2 or any later version. | ||||
| from ..i18n import _ | from ..i18n import _ | ||||
| from .. import ( | from .. import ( | ||||
| error, | error, | ||||
| requirements as requirementsmod, | requirements as requirementsmod, | ||||
| scmutil, | scmutil, | ||||
| ) | ) | ||||
| from . import ( | |||||
| actions, | |||||
| engine, | |||||
| ) | |||||
| class AutoUpgradeOperation(actions.BaseOperation): | |||||
| """A limited Upgrade Operation used to run simple auto upgrade task | |||||
| (Expand it as needed in the future) | |||||
| """ | |||||
| def __init__(self, req): | |||||
| super().__init__( | |||||
| new_requirements=req, | |||||
| backup_store=False, | |||||
| ) | |||||
| def get_share_safe_action(repo): | def get_share_safe_action(repo): | ||||
| """return an automatic-upgrade action for `share-safe` if applicable | """return an automatic-upgrade action for `share-safe` if applicable | ||||
| If no action is needed, return None, otherwise return a callback to upgrade | If no action is needed, return None, otherwise return a callback to upgrade | ||||
| or downgrade the repository according the configuration and repository | or downgrade the repository according the configuration and repository | ||||
| format. | format. | ||||
| """ | """ | ||||
| ui.write_err(msg) | ui.write_err(msg) | ||||
| ui.write_err(hint) | ui.write_err(hint) | ||||
| requirements.discard(requirementsmod.SHARESAFE_REQUIREMENT) | requirements.discard(requirementsmod.SHARESAFE_REQUIREMENT) | ||||
| scmutil.writereporequirements(repo, requirements) | scmutil.writereporequirements(repo, requirements) | ||||
| return action | return action | ||||
| def get_tracked_hint_action(repo): | |||||
| """return an automatic-upgrade action for `tracked-hint` 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-tracked-hint.automatic-upgrade-of-mismatching-repositories', | |||||
| ) | |||||
| action = None | |||||
| if auto_upgrade_tracked_hint: | |||||
| th_config = ui.configbool(b'format', b'use-dirstate-tracked-hint') | |||||
| th_local = requirementsmod.DIRSTATE_TRACKED_HINT_V1 in requirements | |||||
| if th_config and not th_local: | |||||
| msg = _( | |||||
| b"automatically upgrading repository to the `tracked-hint`" | |||||
| b" feature\n" | |||||
| ) | |||||
| hint = b"(see `hg help config.format.use-dirstate-tracked-hint` for details)\n" | |||||
| def action(): | |||||
| if not ui.quiet: | |||||
| ui.write_err(msg) | |||||
| ui.write_err(hint) | |||||
| requirements.add(requirementsmod.DIRSTATE_TRACKED_HINT_V1) | |||||
| op = AutoUpgradeOperation(requirements) | |||||
| engine.upgrade_tracked_hint(ui, repo, op, add=True) | |||||
| elif th_local and not th_config: | |||||
| msg = _( | |||||
| b"automatically downgrading repository from the `tracked-hint`" | |||||
| b" feature\n" | |||||
| ) | |||||
| hint = b"(see `hg help config.format.use-dirstate-tracked-hint` for details)\n" | |||||
| def action(): | |||||
| if not ui.quiet: | |||||
| ui.write_err(msg) | |||||
| ui.write_err(hint) | |||||
| requirements.discard(requirementsmod.DIRSTATE_TRACKED_HINT_V1) | |||||
| op = AutoUpgradeOperation(requirements) | |||||
| engine.upgrade_tracked_hint(ui, repo, op, add=False) | |||||
| return action | |||||
| AUTO_UPGRADE_ACTIONS = [ | AUTO_UPGRADE_ACTIONS = [ | ||||
| get_share_safe_action, | get_share_safe_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 | ||||
| Auto-upgrade are "quick" repository upgrade that might automatically be run | Auto-upgrade are "quick" repository upgrade that might automatically be run | ||||
| by "any" repository access. See `hg help config.format` for automatic | by "any" repository access. See `hg help config.format` for automatic | ||||
| // rhg doesn't care about bookmarks at all yet | // rhg doesn't care about bookmarks at all yet | ||||
| BOOKMARKS_IN_STORE_REQUIREMENT, | BOOKMARKS_IN_STORE_REQUIREMENT, | ||||
| ]; | ]; | ||||
| // Copied from mercurial/requirements.py: | // Copied from mercurial/requirements.py: | ||||
| pub const DIRSTATE_V2_REQUIREMENT: &str = "dirstate-v2"; | pub const DIRSTATE_V2_REQUIREMENT: &str = "dirstate-v2"; | ||||
| /// A repository that uses the tracked hint dirstate file | |||||
| #[allow(unused)] | |||||
| pub const DIRSTATE_TRACKED_HINT_V1: &str = "dirstate-tracked-key-v1"; | |||||
| /// When narrowing is finalized and no longer subject to format changes, | /// When narrowing is finalized and no longer subject to format changes, | ||||
| /// we should move this to just "narrow" or similar. | /// we should move this to just "narrow" or similar. | ||||
| #[allow(unused)] | #[allow(unused)] | ||||
| pub const NARROW_REQUIREMENT: &str = "narrowhg-experimental"; | pub const NARROW_REQUIREMENT: &str = "narrowhg-experimental"; | ||||
| /// Bookmarks must be stored in the `store` part of the repository and will be | /// Bookmarks must be stored in the `store` part of the repository and will be | ||||
| /// share accross shares | /// share accross shares | ||||
| #[allow(unused)] | #[allow(unused)] | ||||
| /// Array of tuples of (auto upgrade conf, feature conf, local requirement) | /// Array of tuples of (auto upgrade conf, feature conf, local requirement) | ||||
| const AUTO_UPGRADES: &[((&str, &str), (&str, &str), &str)] = &[ | const AUTO_UPGRADES: &[((&str, &str), (&str, &str), &str)] = &[ | ||||
| ( | ( | ||||
| ("format", "use-share-safe.automatic-upgrade-of-mismatching-repositories"), | ("format", "use-share-safe.automatic-upgrade-of-mismatching-repositories"), | ||||
| ("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"), | |||||
| requirements::DIRSTATE_TRACKED_HINT_V1, | |||||
| ), | |||||
| ]; | ]; | ||||
| /// 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>, | ||||
| "dotencode" | "dotencode" | ||||
| "usefncache" | "usefncache" | ||||
| "use-dirstate-v2" | "use-dirstate-v2" | ||||
| "use-dirstate-tracked-hint" | "use-dirstate-tracked-hint" | ||||
| "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories" | |||||
| "use-persistent-nodemap" | "use-persistent-nodemap" | ||||
| "use-share-safe" | "use-share-safe" | ||||
| "use-share-safe.automatic-upgrade-of-mismatching-repositories" | "use-share-safe.automatic-upgrade-of-mismatching-repositories" | ||||
| "usestore" | "usestore" | ||||
| added: dirstate-tracked-key-v1 | added: dirstate-tracked-key-v1 | ||||
| no revlogs to process | no revlogs to process | ||||
| $ ls -1 .hg/dirstate-tracked-hint | $ ls -1 .hg/dirstate-tracked-hint | ||||
| .hg/dirstate-tracked-hint | .hg/dirstate-tracked-hint | ||||
| $ hg debugrequires | grep 'tracked' | $ hg debugrequires | grep 'tracked' | ||||
| dirstate-tracked-key-v1 | dirstate-tracked-key-v1 | ||||
| $ cd .. | |||||
| Test automatic upgrade and downgrade | |||||
| ------------------------------------ | |||||
| create an initial repository | |||||
| $ hg init auto-upgrade \ | |||||
| > --config format.use-dirstate-tracked-hint=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 tracked | |||||
| tracked-hint: no | |||||
| upgrade it to dirstate-tracked-hint automatically | |||||
| $ hg status -R auto-upgrade \ | |||||
| > --config format.use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-tracked-hint=yes | |||||
| automatically upgrading repository to the `tracked-hint` feature | |||||
| (see `hg help config.format.use-dirstate-tracked-hint` for details) | |||||
| $ hg debugformat -R auto-upgrade | grep tracked | |||||
| tracked-hint: yes | |||||
| downgrade it from dirstate-tracked-hint automatically | |||||
| $ hg status -R auto-upgrade \ | |||||
| > --config format.use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories=yes \ | |||||
| > --config format.use-dirstate-tracked-hint=no | |||||
| automatically downgrading repository from the `tracked-hint` feature | |||||
| (see `hg help config.format.use-dirstate-tracked-hint` for details) | |||||
| $ hg debugformat -R auto-upgrade | grep tracked | |||||
| tracked-hint: no | |||||
automatique