##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

setup: define build_doc command...
setup: define build_doc command Currently, various processes for packaging Mercurial state to manually invoke `make -C doc` in order to generate the documentation. This Makefile merely invokes `gendoc.py` and `runrst` to produce man pages and HTML pages. Not all environments may have the ability to easily run Makefiles. Windows is notably in this set. This commit ports the man page and HTML generation logic from doc/Makefile to setup.py. We introduce a new build_doc command which generates documentation by calling gendoc.py and runrst. The documentation can now be built via pure Python by running `python setup.py build_doc`. We don't implement dependency tracking because IMO it is more effort than it is worth. We could potentially remove the duplicated functionality in doc/Makefile. But I'm not sure what all is depending on it. So I plan to keep it around. # no-check-commit because forced foo_bar function names Differential Revision: https://phab.mercurial-scm.org/D6063
Gregory Szorc -
r42016:d80d4892 default
Show More
Name Size Modified Last Commit Author
/ rust
.cargo
chg
hg-core
hg-cpython
hg-direct-ffi
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.