# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1610582187 -3600
# Node ID 8b94f05ab069e1029abe6ecfe3c59c708f0a4545
# Parent  04da2ef8b1069fd665b4568c4a9ec30403cbd7a4
persistent-nodemap: document the feature in `hg help config.format`

This is necessary before we advertise the feature more.

Differential Revision: https://phab.mercurial-scm.org/D9755

diff -r 04da2ef8b106 -r 8b94f05ab069 mercurial/helptext/config.txt
--- a/mercurial/helptext/config.txt	Thu Jan 14 00:37:36 2021 +0100
+++ b/mercurial/helptext/config.txt	Thu Jan 14 00:56:27 2021 +0100
@@ -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
diff -r 04da2ef8b106 -r 8b94f05ab069 tests/test-help.t
--- a/tests/test-help.t	Thu Jan 14 00:37:36 2021 +0100
+++ b/tests/test-help.t	Thu Jan 14 00:56:27 2021 +0100
@@ -1551,6 +1551,8 @@
   
       "usefncache"
   
+      "use-persistent-nodemap"
+  
       "usestore"
   
       "sparse-revlog"