Patchwork D9755: persistent-nodemap: document the feature in `hg help config.format`

login
register
mail settings
Submitter phabricator
Date Jan. 14, 2021, 4:05 a.m.
Message ID <differential-rev-PHID-DREV-lpapheabgkrqhpyzmhdf-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/48067/
State Superseded
Headers show

Comments

phabricator - Jan. 14, 2021, 4:05 a.m.
marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  This is necessary before we advertise the feature more.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D9755

AFFECTED FILES
  mercurial/helptext/config.txt
  tests/test-help.t

CHANGE DETAILS




To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -1551,6 +1551,8 @@ 
   
       "usefncache"
   
+      "use-persistent-nodemap"
+  
       "usestore"
   
       "sparse-revlog"
diff --git a/mercurial/helptext/config.txt b/mercurial/helptext/config.txt
--- a/mercurial/helptext/config.txt
+++ b/mercurial/helptext/config.txt
@@ -894,6 +894,23 @@ 
 
     Enabled by default.
 
+``use-persistent-nodemap``
+    Enable or disable the "persistent-nodemap" feature which improves
+    performance if the rust extensions are available.
+
+    The "persistence-nodemap" persist the "node -> rev" on disk removing the
+    need to dynamically build that mapping for each Mercurial invocation. This
+    significantly reduce the startup cost of various local and server-side
+    operation for larger repository.
+
+    The performance improving version of this feature is currently only
+    implemented in Rust, so people using a version of Mercurial compiled
+    without the Rust part might actually suffer some slowdown.
+
+    Repository with this on-disk format require Mercurial version 5.4 or above.
+
+    Disabled by default.
+
 ``usestore``
     Enable or disable the "store" repository format which improves
     compatibility with systems that fold case or otherwise mangle