rust: update README with new information about the Re2 path
authorRaphaël Gomès <rgomes@octobus.net>
Thu, 16 Apr 2020 17:31:29 +0200
changeset 44714 8dbcd5138102
parent 44713 97c10b157665
child 44715 38f7b2f02f6d
rust: update README with new information about the Re2 path Differential Revision: https://phab.mercurial-scm.org/D8452
rust/README.rst
--- a/rust/README.rst	Thu Apr 16 17:31:11 2020 +0200
+++ b/rust/README.rst	Thu Apr 16 17:31:29 2020 +0200
@@ -54,9 +54,17 @@
 a better option for getting the most speed out of your Mercurial. 
 
 If you want to use ``Re2``, you need to install ``Re2`` following Google's 
-guidelines: https://github.com/google/re2/wiki/Install
-Then, use ``HG_RUST_FEATURES=with-re2`` when building ``hg`` to use the full
-status code.
+guidelines: https://github.com/google/re2/wiki/Install.
+Then, use ``HG_RUST_FEATURES=with-re2`` and 
+``HG_RE2_PATH=system|<path to your re2 install>`` when building ``hg`` to 
+signal the use of Re2. Using the local path instead of the "system" RE2 links
+it statically.
+
+For example::
+
+  $ HG_RUST_FEATURES=with-re2 HG_RE2_PATH=system make PURE=--rust
+  $ # OR
+  $ HG_RUST_FEATURES=with-re2 HG_RE2_PATH=/path/to/re2 make PURE=--rust
 
 Developing Rust
 ===============