This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8452

rust: update README with new information about the Re2 path
ClosedPublic

Authored by Alphare on Apr 16 2020, 11:38 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG8dbcd5138102: rust: update README with new information about the Re2 path

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Alphare created this revision.Apr 16 2020, 11:38 AM
Alphare added a commit: rHG8dbcd5138102: rust: update README with new information about the Re2 path.Apr 16 2020, 12:42 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG8dbcd5138102: rust: update README with new information about the Re2 path (authored by Alphare). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mrust/README.rst (14 lines)

Diff 21131

rust/README.rst

Now that that work has been done, the default behavior is to use the ``regex`` Now that that work has been done, the default behavior is to use the ``regex``
crate, that provides a significant performance boost compared to the standard crate, that provides a significant performance boost compared to the standard
Python + C path in many commands such as ``status``, ``diff`` and ``commit``, Python + C path in many commands such as ``status``, ``diff`` and ``commit``,
However, the ``Re2`` path remains slightly faster for our use cases and remains However, the ``Re2`` path remains slightly faster for our use cases and remains
a better option for getting the most speed out of your Mercurial. 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 If you want to use ``Re2``, you need to install ``Re2`` following Google's
guidelines: https://github.com/google/re2/wiki/Install guidelines: https://github.com/google/re2/wiki/Install.
Then, use ``HG_RUST_FEATURES=with-re2`` when building ``hg`` to use the full Then, use ``HG_RUST_FEATURES=with-re2`` and
status code. ``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 Developing Rust
=============== ===============
The current version of Rust in use is ``1.34.2``, because it's what Debian The current version of Rust in use is ``1.34.2``, because it's what Debian
stable has. You can use ``rustup override set 1.34.2`` at the root of the repo stable has. You can use ``rustup override set 1.34.2`` at the root of the repo
to make it easier on you. to make it easier on you.