This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11698

pyoxidizer: update README.md with several small fixes
ClosedPublic

Authored by spectral on Oct 19 2021, 5:00 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG16c3fe46929a: pyoxidizer: update README.md with several small fixes
Summary

Currently, pyoxidizer.bzl does not mention the git commit that should be checked
out, so these instructions are a bit difficult to follow right now (impossible,
technically), so I removed the instruction to git checkout <Git commit> and
the admonition to use a specific version of PyOxidizer. I don't even know if the
project currently builds with the "0.7.0-pre" version that was previously
recommended.

As fallout from that change to not "pin" to a specific PyOxidizer, I had to
update the Python version to use when running the tests.

While here, I added a recommendation to use --release, as the primary reason
for this project is performance, and it may have been leaving some on the table
to not have that there.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

spectral created this revision.Oct 19 2021, 5:00 PM
Alphare accepted this revision.Oct 20 2021, 3:22 AM
This revision is now accepted and ready to land.Oct 20 2021, 3:22 AM
spectral added a commit: rHG16c3fe46929a: pyoxidizer: update README.md with several small fixes.Oct 20 2021, 5:35 AM
Closed by commit rHG16c3fe46929a: pyoxidizer: update README.md with several small fixes (authored by spectral). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mrust/hgcli/README.md (18 lines)

Diff 30950

rust/hgcli/README.md

# Oxidized Mercurial # Oxidized Mercurial
This project provides a Rust implementation of the Mercurial (`hg`) This project provides a Rust implementation of the Mercurial (`hg`)
version control tool. version control tool.
Under the hood, the project uses Under the hood, the project uses
[PyOxidizer](https://github.com/indygreg/PyOxidizer) to embed a Python [PyOxidizer](https://github.com/indygreg/PyOxidizer) to embed a Python
interpreter in a binary built with Rust. At run-time, the Rust `fn main()` interpreter in a binary built with Rust. At run-time, the Rust `fn main()`
is called and Rust code handles initial process startup. An in-process is called and Rust code handles initial process startup. An in-process
Python interpreter is started (if needed) to provide additional Python interpreter is started (if needed) to provide additional
functionality. functionality.
# Building # Building
This project currently requires an unreleased version of PyOxidizer First, acquire and build a copy of PyOxidizer; you probably want to do this in
(0.7.0-pre). For best results, build the exact PyOxidizer commit some directory outside of your clone of Mercurial:
as defined in the `pyoxidizer.bzl` file:
$ git clone https://github.com/indygreg/PyOxidizer.git $ git clone https://github.com/indygreg/PyOxidizer.git
$ cd PyOxidizer $ cd PyOxidizer
$ git checkout <Git commit from pyoxidizer.bzl>
$ cargo build --release $ cargo build --release
Then build this Rust project using the built `pyoxidizer` executable:: Then build this Rust project using the built `pyoxidizer` executable:
$ /path/to/pyoxidizer/target/release/pyoxidizer build $ /path/to/pyoxidizer/target/release/pyoxidizer build --release
If all goes according to plan, there should be an assembled application If all goes according to plan, there should be an assembled application
under `build/<arch>/debug/app/` with an `hg` executable: under `build/<arch>/release/app/` with an `hg` executable:
$ build/x86_64-unknown-linux-gnu/debug/app/hg version $ build/x86_64-unknown-linux-gnu/release/app/hg version
Mercurial Distributed SCM (version 5.3.1+433-f99cd77d53dc+20200331) Mercurial Distributed SCM (version 5.3.1+433-f99cd77d53dc+20200331)
(see https://mercurial-scm.org for more information) (see https://mercurial-scm.org for more information)
Copyright (C) 2005-2020 Olivia Mackall and others Copyright (C) 2005-2020 Olivia Mackall and others
This is free software; see the source for copying conditions. There is NO This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# Running Tests # Running Tests
To run tests with a built `hg` executable, you can use the `--with-hg` To run tests with a built `hg` executable, you can use the `--with-hg`
argument to `run-tests.py`. But there's a wrinkle: many tests run custom argument to `run-tests.py`. But there's a wrinkle: many tests run custom
Python scripts that need to `import` modules provided by Mercurial. Since Python scripts that need to `import` modules provided by Mercurial. Since
these modules are embedded in the produced `hg` executable, a regular these modules are embedded in the produced `hg` executable, a regular
Python interpreter can't access them! To work around this, set `PYTHONPATH` Python interpreter can't access them! To work around this, set `PYTHONPATH`
to the Mercurial source directory. e.g.: to the Mercurial source directory. e.g.:
$ cd /path/to/hg/src/tests $ cd /path/to/hg/src/tests
$ PYTHONPATH=`pwd`/.. python3.7 run-tests.py \ $ PYTHONPATH=`pwd`/.. python3.9 run-tests.py \
--with-hg `pwd`/../rust/hgcli/build/x86_64-unknown-linux-gnu/debug/app/hg --with-hg `pwd`/../rust/hgcli/build/x86_64-unknown-linux-gnu/release/app/hg