view README.rst @ 51918:d62887764687

lfs: fix various signature mismatches for vfs subclasses

These were flagged by PyCharm.  I'm not sure why pytype doesn't catch these-
only `hgext/lfs/__init__.py` in the lfs extension is excluded from being
checked.

I'm not sure if the `*insidef` arg to `join()` was meant as an internal
convencience, because I see another class that gets flagged for the same
signature problem (to be fixed next).  But I don't feel bold enough to make this
an internal function, and provide a simplified public `join()` on the `vfs`
classes.  That can still be done later, if desired.  For now, process the
additional args and pass them along, even though there don't appear to be any
current callers that provide extra args to these classes.  We need all of the
subclasses to agree on the signature, or they won't be considered to implement
the `Vfs` protocol being developed.

While we're copy/pasting from the base class, bring the type annotations along
for the ride.

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.