Patchwork D8452: rust: update README with new information about the Re2 path

login
register
mail settings
Submitter phabricator
Date April 16, 2020, 3:38 p.m.
Message ID <differential-rev-PHID-DREV-nrrzep4wpyvmnv43w2jf-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/46158/
State Superseded
Headers show

Comments

phabricator - April 16, 2020, 3:38 p.m.
Alphare created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REPOSITORY
  rHG Mercurial

BRANCH
  default

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

AFFECTED FILES
  rust/README.rst

CHANGE DETAILS




To: Alphare, #hg-reviewers
Cc: mercurial-devel

Patch

diff --git a/rust/README.rst b/rust/README.rst
--- a/rust/README.rst
+++ b/rust/README.rst
@@ -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
 ===============