This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11809

docs: add missing dirstate-v2 documentation
ClosedPublic

Authored by Alphare on Nov 26 2021, 8:30 AM.

Details

Reviewers
pulkit
joerg.sonnenberger
Group Reviewers
hg-reviewers
Commits
rHG5e7a0348acf8: docs: add missing dirstate-v2 documentation
Summary

A user trying out the dirstate-v2 feature without the Rust extensions is
currently faced with an error message suggesting this help section, which does
not exist.

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

Alphare created this revision.Nov 26 2021, 8:30 AM

Pending CI refresh

pulkit accepted this revision.Nov 28 2021, 5:10 PM
This revision is now accepted and ready to land.Nov 28 2021, 5:10 PM
Alphare added a comment.Dec 23 2021, 5:34 AM

This is also destined for stable

joerg.sonnenberger added a subscriber: joerg.sonnenberger.Dec 23 2021, 9:09 AM
joerg.sonnenberger added inline comments.
mercurial/helptext/config.txt
896

I don't know what we use elsewhere, but experimental "dirstate-v2" feature would read more natural for me.

898

The dirstate functionality is shared by all commands interacting with the working copy. The new version is more robust, faster and stores more information.

Alphare updated this revision to Diff 31569.Dec 23 2021, 10:03 AM
Alphare added a commit: rHG5e7a0348acf8: docs: add missing dirstate-v2 documentation.Jan 5 2022, 11:46 AM
Closed by commit rHG5e7a0348acf8: docs: add missing dirstate-v2 documentation (authored by Alphare). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/config.txt (29 lines)

Diff 31594

mercurial/helptext/config.txt

the "store" repository format (which has to be enabled to use the "store" repository format (which has to be enabled to use
fncache) to allow longer filenames and avoids using Windows fncache) to allow longer filenames and avoids using Windows
reserved names, e.g. "nul". reserved names, e.g. "nul".
Repositories with this on-disk format require Mercurial version 1.1. Repositories with this on-disk format require Mercurial version 1.1.
Enabled by default. Enabled by default.
``exp-rc-dirstate-v2``
Enable or disable the experimental "dirstate-v2" feature. The dirstate
joerg.sonnenbergerUnsubmitted
Not Done

I don't know what we use elsewhere, but experimental "dirstate-v2" feature would read more natural for me.

joerg.sonnenberger: I don't know what we use elsewhere, but `experimental "dirstate-v2" feature` would read more…
functionality is shared by all commands interacting with the working copy.
The new version is more robust, faster and stores more information.
joerg.sonnenbergerUnsubmitted
Not Done

The dirstate functionality is shared by all commands interacting with the working copy. The new version is more robust, faster and stores more information.

joerg.sonnenberger: The dirstate functionality is shared by all commands interacting with the working copy. The new…
The performance-improving version of this feature is currently only
implemented in Rust (see :hg:`help rust`), so people not using a version of
Mercurial compiled with the Rust parts might actually suffer some slowdown.
For this reason, such versions will by default refuse to access repositories
with "dirstate-v2" enabled.
This behavior can be adjusted via configuration: check
:hg:`help config.storage.dirstate-v2.slow-path` for details.
Repositories with this on-disk format require Mercurial 6.0 or above.
By default this format variant is disabled if the fast implementation is not
available, and enabled by default if the fast implementation is available.
To accomodate installations of Mercurial without the fast implementation,
you can downgrade your repository. To do so run the following command:
$ hg debugupgraderepo \
--run \
--config format.exp-rc-dirstate-v2=False \
--config storage.dirstate-v2.slow-path=allow
For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
``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 "persistence-nodemap" persist the "node -> rev" on disk removing the The "persistence-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 reduce the startup cost of various local and server-side significantly reduce the startup cost of various local and server-side
operation for larger repository. operation for larger repository.