view README.rst @ 50093:ce60c8d4ac87

typing: add type hints to argument checking functions in cmdutil

These might be surprising, since they can take strings instead of bytes.  The
way `AnyStr` works is that it must be all bytes or all str for any given
invocation.

The wildcard here will be the `opts` that get passed in- if the type is unknown
and defaults to `Any`, there's no enforcement that the dict key type matches the
additional args.  But a lot of uses should be using `**opts` from the command
method, which has a str key.  The uses of these methods in this module are now
typed because their internals force a specific type, and it can't just be
inferred from the caller.

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.