Patchwork D8325: rust: update README to reflect use of `regex` crate

login
register
mail settings
Submitter phabricator
Date March 25, 2020, 9:38 a.m.
Message ID <differential-rev-PHID-DREV-ol3dljvurx3ltclusyw2-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/45877/
State Superseded
Headers show

Comments

phabricator - March 25, 2020, 9:38 a.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/D8325

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
@@ -36,15 +36,25 @@ 
 One day we may use this environment variable to switch to new experimental
 binding crates like a hypothetical ``HGWITHRUSTEXT=hpy``.
 
-Using the full ``hg status`` extension
---------------------------------------
+Using the fastest ``hg status``
+-------------------------------
 
 The code for ``hg status`` needs to conform to ``.hgignore`` rules, which are
-all translated into regex. For compatibility and ease of development reasons
-the Re2 regex engine is in use until we figure out if the ``regex`` crate has
-similar enough behavior. This implies that you need to install ``Re2``
-following Google's guidelines: https://github.com/google/re2/wiki/Install
+all translated into regex. 
+
+In the first version, for compatibility and ease of development reasons, the 
+Re2 regex engine was chosen until we figured out if the ``regex`` crate had
+similar enough behavior.
 
+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 
+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
+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.