This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11811

docs: update Rust readme with a mention of `rhg`
ClosedPublic

Authored by Alphare on Nov 26 2021, 8:31 AM.

Details

Reviewers
pulkit
joerg.sonnenberger
Group Reviewers
hg-reviewers
Commits
rHG799fdf4cca80: docs: update Rust readme with a mention of `rhg`

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

Alphare created this revision.Nov 26 2021, 8:31 AM

Pending CI refresh

Alphare added a comment.Nov 26 2021, 10:23 AM

(CI is ok, I swear)

pulkit accepted this revision.Nov 28 2021, 5:10 PM
This revision is now accepted and ready to land.Nov 28 2021, 5:10 PM
Alphare added a comment.Dec 23 2021, 5:34 AM

This is also destined for stable

joerg.sonnenberger accepted this revision.Dec 23 2021, 9:11 AM
joerg.sonnenberger added a subscriber: joerg.sonnenberger.
joerg.sonnenberger added inline comments.
rust/README.rst
9–11

Not your fault, but change it to provides please.

Alphare updated this revision to Diff 31571.Dec 23 2021, 10:03 AM
Alphare added a commit: rHG799fdf4cca80: docs: update Rust readme with a mention of `rhg`.Jan 5 2022, 11:46 AM
Closed by commit rHG799fdf4cca80: docs: update Rust readme with a mention of `rhg` (authored by Alphare). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mrust/README.rst (11 lines)

Diff 31596

rust/README.rst

=================== ===================
Mercurial Rust Code Mercurial Rust Code
=================== ===================
This directory contains various Rust code for the Mercurial project. This directory contains various Rust code for the Mercurial project.
Rust is not required to use (or build) Mercurial, but using it Rust is not required to use (or build) Mercurial, but using it
improves performance in some areas. improves performance in some areas.
There are currently three independent rust projects: There are currently four independent Rust projects:
- chg. An implementation of chg, in rust instead of C. - chg. An implementation of chg, in Rust instead of C.
- hgcli. A project that provide a (mostly) self-contained "hg" binary, - hgcli. A project that provides a (mostly) self-contained "hg" binary,
joerg.sonnenbergerUnsubmitted
Not Done

Not your fault, but change it to provides please.

joerg.sonnenberger: Not your fault, but change it to `provides` please.
for ease of deployment and a bit of speed, using PyOxidizer. See for ease of deployment and a bit of speed, using PyOxidizer. See
hgcli/README.md. hgcli/README.md.
- hg-core (and hg-cpython): implementation of some - hg-core (and hg-cpython): implementation of some
functionality of mercurial in rust, e.g. ancestry computations in functionality of mercurial in Rust, e.g. ancestry computations in
revision graphs, status or pull discovery. The top-level ``Cargo.toml`` file revision graphs, status or pull discovery. The top-level ``Cargo.toml`` file
defines a workspace containing these crates. defines a workspace containing these crates.
- rhg: a pure Rust implementation of Mercurial, with a fallback mechanism for
unsupported invocations. It reuses the logic `hg-core` but completely forgoes
interaction with Python. See `rust/rhg/README.md` for more details.
Using Rust code Using Rust code
=============== ===============
Local use (you need to clean previous build artifacts if you have Local use (you need to clean previous build artifacts if you have
built without rust previously):: built without rust previously)::
$ make PURE=--rust local # to use ./hg $ make PURE=--rust local # to use ./hg