##// END OF EJS Templates
rust-chg: add project skeleton...
rust-chg: add project skeleton This directory will host the reimplementation of cHg in Rust. It will use Tokio [1], and tokio-hglib [2] which I wrote for an oxidized CHg, no idea if there's such carbon bonding in nature btw. [1]: https://tokio.rs/ [2]: https://bitbucket.org/yuja/tokio-hglib/ The reasoning for depending on Tokio is that it will allow us to handle Unix signals in a safer way. Well, I believed that until I found a weird function, handlestopsignal(), in cHg codebase. It resends the same signal to the same process by temporarily masking the handler, which can't be inherently async. So the signal handlers will stay in C, which means there isn't actually much reason to write async code right now, other than I've already done most of the async stuff, and slightly easier pager handling. The reasoning for the rewrite is that it will eventually be possible to port server-side config validation back to the client side, which will reduce the complexity of the current daemon management. It will also encourage us to write frontend library (e.g. command line and config parsers) in Rust. The license is GPL2+ because it's likely to include derived work from the cHg of C. The rust/chg crate is excluded from the root workspace as it's unclear how the whole rust packages should be laid out. That can be revisited later.
Yuya Nishihara -
r40003:aab43d58 default
Show More
Name Size Modified Last Commit Author
/ rust
.cargo
chg
hgcli
Cargo.lock Loading ...
Cargo.toml Loading ...
README.rst Loading ...

Mercurial Rust Code

This directory contains various Rust code for the Mercurial project.

The top-level Cargo.toml file defines a workspace containing all primary Mercurial crates.

Building

To build the Rust components:

$ cargo build

If you prefer a non-debug / release configuration:

$ cargo build --release

Features

The following Cargo features are available:

localdev (default)

Produce files that work with an in-source-tree build.

In this mode, the build finds and uses a python2.7 binary from PATH. The hg binary assumes it runs from rust/target/<target>hg and it finds Mercurial files at dirname($0)/../../../.

Build Mechanism

The produced hg binary is bound to a CPython installation. The binary links against and loads a CPython library that is discovered at build time (by a build.rs Cargo build script). The Python standard library defined by this CPython installation is also used.

Finding the appropriate CPython installation to use is done by the python27-sys crate's build.rs. Its search order is:

  1. PYTHON_SYS_EXECUTABLE environment variable.
  2. python executable on PATH
  3. python2 executable on PATH
  4. python2.7 executable on PATH

Additional verification of the found Python will be performed by our build.rs to ensure it meets Mercurial's requirements.

Details about the build-time configured Python are built into the produced hg binary. This means that a built hg binary is only suitable for a specific, well-defined role. These roles are controlled by Cargo features (see above).

Running

The hgcli crate produces an hg binary. You can run this binary via cargo run:

$ cargo run --manifest-path hgcli/Cargo.toml

Or directly:

$ target/debug/hg
$ target/release/hg

You can also run the test harness with this binary:

$ ./run-tests.py --with-hg ../rust/target/debug/hg

Note

Integration with the test harness is still preliminary. Remember to cargo build after changes because the test harness doesn't yet automatically build Rust code.