annotate contrib/chg/README @ 37053:cd0ca979a8b8

wireproto: nominally don't expose "batch" to version 2 wire transports

The unified frame-based protocol will (eventually) support
multiple requests per client transmission. This means that the
[very hacky] "batch" command has no purpose existing in this protocol.

This commit marks the command as applying to v1 transports only.

But because SSHv2 == SSHv1 currently, we had to hack it back in
for the SSHv2 transport. Bleh.

Tests changed because the capabilities string changed. The order of
tokens in the string is not important.

Differential Revision: https://phab.mercurial-scm.org/D2856

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