contrib/chg/README
author Raphaël Gomès <rgomes@octobus.net>
Thu, 08 Oct 2020 10:07:19 +0200
changeset 45656 ba0d93a5f06f
parent 45557 4c8d9b53b1c7
permissions -rw-r--r--
tests: only diff the `Cargo.lock` in `test-check-cargo-lock.t` While not perfect (you could be running tests while developing with a justified modification to `Cargo.lock`), that use-case is small enough that I don't think it's really going to be an issue. This stops the test from failing for unrelated changes when running it locally. Differential Revision: https://phab.mercurial-scm.org/D9170

cHg
===

A fast client for Mercurial command server running on Unix.

Install:

 $ make
 $ make install

Usage:

 $ chg help                 # show help of Mercurial
 $ alias hg=chg             # replace hg command
 $ chg --kill-chg-daemon    # terminate background server

Environment variables:

Although cHg tries to update environment variables, some of them cannot be
changed after spawning the server. The following variables are specially
handled:

 * configuration files are reloaded automatically by default.
 * CHGHG or HG specifies the path to the hg executable spawned as the
   background command server.

The following variables are available for testing:

 * CHGDEBUG enables debug messages.
 * CHGSOCKNAME specifies the socket path of the background cmdserver.
 * CHGTIMEOUT specifies how many seconds chg will wait before giving up
   connecting to a cmdserver. If it is 0, chg will wait forever. Default: 60

Build environment variables:

 * HGPATH: the path to the hg executable to call when CHGHG and HG are not set,
   instead of "hg"
 * HGPATHREL=1: when CHGHG and HG are not set, the hg executable will be ./hg
   relative to the chg executable. Only works on linux, falls back to "hg"
   otherwise.