##// END OF EJS Templates
tests: update test-releasenotes-formatting.t with new exit codes...
tests: update test-releasenotes-formatting.t with new exit codes I didn't have the fuzzywuzzy package installed before, so I didn't notice this test fail earlier (probably when I made `check_incompatible_arguments` return `InputError`). Differential Revision: https://phab.mercurial-scm.org/D9514

File last commit:

r46189:7bd13bf9 default
r46645:c701f616 default
Show More
README.rst
108 lines | 3.4 KiB | text/x-rst | RstLexer
Gregory Szorc
rust: implementation of `hg`...
r35587 ===================
Mercurial Rust Code
===================
This directory contains various Rust code for the Mercurial project.
Valentin Gatien-Baron
rust: add a README...
r44574 Rust is not required to use (or build) Mercurial, but using it
improves performance in some areas.
Gregory Szorc
rust: implementation of `hg`...
r35587
Valentin Gatien-Baron
rust: add a README...
r44574 There are currently three independent rust projects:
- chg. An implementation of chg, in rust instead of C.
Valentin Gatien-Baron
rust: update the mention of hgcli in rust/README.rst...
r45439 - hgcli. A project that provide a (mostly) self-contained "hg" binary,
for ease of deployment and a bit of speed, using PyOxidizer. See
hgcli/README.md.
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 - hg-core (and hg-cpython): implementation of some
Valentin Gatien-Baron
rust: add a README...
r44574 functionality of mercurial in rust, e.g. ancestry computations in
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 revision graphs, status or pull discovery. The top-level ``Cargo.toml`` file
Valentin Gatien-Baron
rust: add a README...
r44574 defines a workspace containing these crates.
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 Using Rust code
===============
Gregory Szorc
rust: implementation of `hg`...
r35587
Valentin Gatien-Baron
rust: add a README...
r44574 Local use (you need to clean previous build artifacts if you have
built without rust previously)::
Gregory Szorc
rust: implementation of `hg`...
r35587
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 $ make PURE=--rust local # to use ./hg
$ ./tests/run-tests.py --rust # to run all tests
$ ./hg debuginstall | grep -i rust # to validate rust is in use
checking Rust extensions (installed)
Valentin Gatien-Baron
rust: add a README...
r44574 checking module policy (rust+c-allow)
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038
If the environment variable ``HGWITHRUSTEXT=cpython`` is set, the Rust
extension will be used by default unless ``--no-rust``.
One day we may use this environment variable to switch to new experimental
binding crates like a hypothetical ``HGWITHRUSTEXT=hpy``.
Raphaël Gomès
rust: introduce `dirstate-tree` cargo feature...
r46184 Special features
================
You might want to check the `features` section in ``hg-cpython/Cargo.toml``.
It may contain features that might be interesting to try out.
To use features from the Makefile, use the `HG_RUST_FEATURES` environment
variable: for instance `HG_RUST_FEATURES="some-feature other-feature"`
Valentin Gatien-Baron
rust: add a pointer for profiling to the README...
r45440 Profiling
=========
Setting the environment variable ``RUST_LOG=trace`` will make hg print
a few high level rust-related performance numbers. It can also
indicate why the rust code cannot be used (say, using lookarounds in
hgignore).
``py-spy`` (https://github.com/benfred/py-spy) can be used to
construct a single profile with rust functions and python functions
(as opposed to ``hg --profile``, which attributes time spent in rust
to some unlucky python code running shortly after the rust code, and
as opposed to tools for native code like ``perf``, which attribute
time to the python interpreter instead of python functions).
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 Developing Rust
===============
Gregory Szorc
rust: implementation of `hg`...
r35587
Raphaël Gomès
rust: update minimum supported Rust compiler version...
r46189 The current version of Rust in use is ``1.41.1``, because it's what Debian
stable has. You can use ``rustup override set 1.41.1`` at the root of the repo
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 to make it easier on you.
Go to the ``hg-cpython`` folder::
$ cd rust/hg-cpython
Or, only the ``hg-core`` folder. Be careful not to break compatibility::
$ cd rust/hg-core
Valentin Gatien-Baron
rust: add a README...
r44574
Simply run::
Gregory Szorc
rust: implementation of `hg`...
r35587
$ cargo build --release
Valentin Gatien-Baron
rust: add a README...
r44574
It is possible to build without ``--release``, but it is not
recommended if performance is of any interest: there can be an order
of magnitude of degradation when removing ``--release``.
For faster builds, you may want to skip code generation::
$ cargo check
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038 For even faster typing::
$ cargo c
Valentin Gatien-Baron
rust: add a README...
r44574 You can run only the rust-specific tests (as opposed to tests of
mercurial as a whole) with::
$ cargo test --all
Raphaël Gomès
rust: update the README with more up-to-date and thorough information...
r45038
Formatting the code
-------------------
We use ``rustfmt`` to keep the code formatted at all times. For now, we are
using the nightly version because it has been stable enough and provides
comment folding.
To format the entire Rust workspace::
$ cargo +nightly fmt
This requires you to have the nightly toolchain installed.