diff rust/README.rst @ 45609:e604a3c03ab9

rust: introduce `dirstate-tree` cargo feature

This feature gates (at compile-time) the use of the newly-added dirstate tree.

The motivation for this is that the dirstate tree is currently *very* slow;
replacing the current hashmap-based dirstate is not a viable solution in terms
of performance... and why would you be using the Rust implementation if not
for performance?

The feature will also help reviewers better understand the differences that
will slowly appear as the dirstate tree gets better.

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

--- a/rust/README.rst	Wed Sep 30 18:23:43 2020 +0200
+++ b/rust/README.rst	Wed Sep 30 18:10:53 2020 +0200
@@ -34,6 +34,15 @@
 One day we may use this environment variable to switch to new experimental
 binding crates like a hypothetical ``HGWITHRUSTEXT=hpy``.
 
+Special features
+================
+
+You might want to check the `features` section in ``hg-cpython/Cargo.toml``.
+It may contain features that might be interesting to try out.
+
+To use features from the Makefile, use the `HG_RUST_FEATURES` environment 
+variable: for instance `HG_RUST_FEATURES="some-feature other-feature"`
+
 Profiling
 =========