D11698: pyoxidizer: update README.md with several small fixes
spectral (Kyle Lippincott)
phabricator at mercurial-scm.org
Tue Oct 19 21:00:21 UTC 2021
spectral created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.
REVISION 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.
REPOSITORY
rHG Mercurial
BRANCH
default
REVISION DETAIL
https://phab.mercurial-scm.org/D11698
AFFECTED FILES
rust/hgcli/README.md
CHANGE DETAILS
diff --git a/rust/hgcli/README.md b/rust/hgcli/README.md
--- a/rust/hgcli/README.md
+++ b/rust/hgcli/README.md
@@ -12,23 +12,21 @@
# Building
-This project currently requires an unreleased version of PyOxidizer
-(0.7.0-pre). For best results, build the exact PyOxidizer commit
-as defined in the `pyoxidizer.bzl` file:
+First, acquire and build a copy of PyOxidizer; you probably want to do this in
+some directory outside of your clone of Mercurial:
$ git clone https://github.com/indygreg/PyOxidizer.git
$ cd PyOxidizer
- $ git checkout <Git commit from pyoxidizer.bzl>
$ 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
-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)
(see https://mercurial-scm.org for more information)
@@ -46,5 +44,5 @@
to the Mercurial source directory. e.g.:
$ cd /path/to/hg/src/tests
- $ PYTHONPATH=`pwd`/.. python3.7 run-tests.py \
- --with-hg `pwd`/../rust/hgcli/build/x86_64-unknown-linux-gnu/debug/app/hg
+ $ PYTHONPATH=`pwd`/.. python3.9 run-tests.py \
+ --with-hg `pwd`/../rust/hgcli/build/x86_64-unknown-linux-gnu/release/app/hg
To: spectral, #hg-reviewers
Cc: mercurial-patches, mercurial-devel
More information about the Mercurial-devel
mailing list