view README.rst @ 47981:d1d9510f73f0

rust: Update the memmap2 crate to version 0.4.0

This version:

* Optionally implements the `StableDeref` trait, removing the need
  for a wrapper type doing that
* Adds support for mapping empty files, which can routinely happen
  for dirstate-v2 data files. This was a cause of some failing tests
  when running with `run-tests.py --rhg --extra-config-opt rhg.status=1`

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

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.