Patchwork D11811: docs: update Rust readme with a mention of `rhg`

login
register
mail settings
Submitter phabricator
Date Nov. 26, 2021, 1:31 p.m.
Message ID <differential-rev-PHID-DREV-6m62f2dec7t3syp2rfvf-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/50137/
State New
Headers show

Comments

phabricator - Nov. 26, 2021, 1:31 p.m.
Alphare created this revision.
Alphare added a comment.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.


  Pending CI refresh

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D11811

AFFECTED FILES
  rust/README.rst

CHANGE DETAILS




To: Alphare, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/rust/README.rst b/rust/README.rst
--- a/rust/README.rst
+++ b/rust/README.rst
@@ -6,15 +6,18 @@ 
 Rust is not required to use (or build) Mercurial, but using it
 improves performance in some areas.
 
-There are currently three independent rust projects:
-- chg. An implementation of chg, in rust instead of C.
+There are currently four independent Rust projects:
+- chg. An implementation of chg, in Rust instead of C.
 - hgcli. A project that provide a (mostly) self-contained "hg" binary,
   for ease of deployment and a bit of speed, using PyOxidizer. See
   hgcli/README.md.
 - 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
   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
 ===============