view README.rst @ 52245:d57d1606049c stable

clone: properly exclude rev-branch-cache from post clone cache warming

When adding "CACHE_REV_BRANCH" to "CACHES_ALL" in e51161b12c7e, I did not
expected it to impact the clone steps. However the "CACHES_POST_CLONE" set is
created rather creatively. (we should fix that, but not on stable)

The benchmark caught a quite significant slowdown one hardlink and ssh-stream
clones. Such slow down can be reduced to around ~5% by fully warming the cache
before the clone. However keeping this expensive step away from the clone
operation fully fix the slowdown and preserve the initial intend.


Example slowdow for hardlink clone

### benchmark.name                               = hg.command.clone
  # bin-env-vars.hg.flavor                       = default
  # bin-env-vars.hg.py-re2-module                = default
  # benchmark.variants.explicit-rev              = none
  # benchmark.variants.issue6528                 = default
  # benchmark.variants.protocol                  = local-hardlink
  # benchmark.variants.pulled-delta-reuse-policy = default
  # benchmark.variants.resource-usage            = default
  # benchmark.variants.validate                  = default
 ## data-env-vars.name = netbeans-2018-08-01-zstd-sparse-revlog
6.8.2:  19.799752
6.9rc0: 29.017493  (+46.55%, +9.22)
after:  19.929341

 ## data-env-vars.name = mercurial-public-2018-08-01-zstd-sparse-revlog
6.8.2:  0.468020
6.9rc0: 1.701294 (+263.51%, +1.23)
after:  0.471934

 ## data-env-vars.name = pypy-2024-03-22-zstd-sparse-revlog
6.8.2:  2.397564
6.9rc0: 5.666641 (+137.41%, +3.28)
after:  2.428085

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.