contrib/chg/README
author Anton Shestakov <av6@dwimlabs.net>
Fri, 27 May 2022 14:33:32 +0400
changeset 49235 72ff7cd05176
parent 45551 4c8d9b53b1c7
permissions -rw-r--r--
tests: add hg10 requirement to test-check-module-imports.t This requirement exists to make sure for hg has locate command, which is used in this test file for getting a list of files to check. Since in theory current versions of tests could be run on older hg, it doesn't hurt to mark even this version requirement (as old as it is). See also: a29f071751df.

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.