annotate README.rst @ 52187:3ba998d7fc77 stable

tests: treat `select` as a built-in module on Windows

This fixes:

    --- C:/Users/Matt/hg/tests/test-check-module-imports.t
    +++ C:/Users/Matt/hg/tests/test-check-module-imports.t.err
    @@ -43,3 +43,15 @@
       > -X tests/test-verify-repo-operations.py \
       > -X tests/test-extension.t \
       > | sed 's-\\-/-g' | "$PYTHON" "$import_checker" -
    +  hgext/zeroconf/Zeroconf.py:86: stdlib import "socket" follows local import: select\r (esc)
    +  hgext/zeroconf/Zeroconf.py:87: stdlib import "struct" follows local import: select\r (esc)
    +  hgext/zeroconf/Zeroconf.py:88: stdlib import "threading" follows local import: select\r (esc)
    +  hgext/zeroconf/Zeroconf.py:89: stdlib import "time" follows local import: select\r (esc)
    +  hgext/zeroconf/Zeroconf.py:90: stdlib import "traceback" follows local import: select\r (esc)
    +  mercurial/posix.py:18: stdlib import "stat" follows local import: select\r (esc)
    +  mercurial/posix.py:19: stdlib import "sys" follows local import: select\r (esc)
    +  mercurial/posix.py:20: stdlib import "tempfile" follows local import: select\r (esc)
    +  mercurial/posix.py:21: stdlib import "typing" follows local import: select\r (esc)
    +  tests/tinyproxy.py:19: stdlib import "socket" follows local import: select\r (esc)
    +  tests/tinyproxy.py:20: stdlib import "sys" follows local import: select\r (esc)
    +  [1]

    ERROR: test-check-module-imports.t output changed

Mercurial
=========

Mercurial is a fast, easy to use, distributed revision control tool
for software developers.

Basic install::

 $ make            # see install targets
 $ make install    # do a system-wide install
 $ hg debuginstall # sanity-check setup
 $ hg              # see help

Running without installing::

 $ make local      # build for inplace usage
 $ ./hg --version  # should show the latest version

See https://mercurial-scm.org/ for detailed installation
instructions, platform-specific notes, and Mercurial user information.

Notes for packagers
===================

Mercurial ships a copy of the python-zstandard sources. This is used to
provide support for zstd compression and decompression functionality. The
module is not intended to be replaced by the plain python-zstandard nor
is it intended to use a system zstd library. Patches can result in hard
to diagnose errors and are explicitly discouraged as unsupported
configuration.