##// END OF EJS Templates
rust: update README to reflect use of `regex` crate...
Raphaël Gomès -
r45091:c13cbc38 default
parent child Browse files
Show More
@@ -36,15 +36,25 b' extension will be used by default unless'
36 36 One day we may use this environment variable to switch to new experimental
37 37 binding crates like a hypothetical ``HGWITHRUSTEXT=hpy``.
38 38
39 Using the full ``hg status`` extension
40 --------------------------------------
39 Using the fastest ``hg status``
40 -------------------------------
41 41
42 42 The code for ``hg status`` needs to conform to ``.hgignore`` rules, which are
43 all translated into regex. For compatibility and ease of development reasons
44 the Re2 regex engine is in use until we figure out if the ``regex`` crate has
45 similar enough behavior. This implies that you need to install ``Re2``
46 following Google's guidelines: https://github.com/google/re2/wiki/Install
43 all translated into regex.
44
45 In the first version, for compatibility and ease of development reasons, the
46 Re2 regex engine was chosen until we figured out if the ``regex`` crate had
47 similar enough behavior.
47 48
49 Now that that work has been done, the default behavior is to use the ``regex``
50 crate, that provides a significant performance boost compared to the standard
51 Python + C path in many commands such as ``status``, ``diff`` and ``commit``,
52
53 However, the ``Re2`` path remains slightly faster for our use cases and remains
54 a better option for getting the most speed out of your Mercurial.
55
56 If you want to use ``Re2``, you need to install ``Re2`` following Google's
57 guidelines: https://github.com/google/re2/wiki/Install
48 58 Then, use ``HG_RUST_FEATURES=with-re2`` when building ``hg`` to use the full
49 59 status code.
50 60
General Comments 0
You need to be logged in to leave comments. Login now