Module Volgo_hg_backendSource

Volgo_hg_backend is a helper library to build Mercurial backends for the Vcs library based on the Mercurial cli hg.

Given the ability to run a hg process, Volgo_hg_backend knows what command to run, how to parse its output and how to interpret its exit code to turn it into a typed result.

Volgo_hg_backend is not meant to be used directly by a user. Rather it is one of the building blocks involved in creating a Mercurial backend for the Vcs library.

Volgo_hg_backend has currently two instantiations as part of its distribution (packaged separately to keep the dependencies isolated).

• One based on the Eio runtime
• One based on the Stdlib.Unix runtime, for blocking programs.

We make some efforts to rely on stable and machine friendly output when one is available and documented in the hg cli man pages, but this is not always possible, so the implementation uses some kind of best effort strategy. Also, to avoid running into hg version issues, we're trying to rely on Mercurial commands that have been there for a while.

Providers of Vcs Traits

Create a backend based on a runtime.

Individual Trait Implementation

The rest of the modules are functors that are parametrized by your Runtime. Given the ability to run a hg command line, this modules return a backend implementation for each of the traits defined by the Vcs library supported by this library. The individual functors are exposed for convenience.