view README.rst @ 47334:18b3060fe598

dirstate-v2: Add a zero-size error type for dirstate v2 parse errors

This error should only happen if Mercurial is buggy or the file is corrupted.
It indicates for example that:

* A part of the file refers to another part, and the byte offset or item count
  would cause reading out of bounds, beyond the end of the file.
* The byte for an entry state has an invalid value

When parsing becomes lazy, many more functions will return a `Result` with
this error. Making it zero-size reduces the work that the `?` operator needs
to do to pass around the error value.

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

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.