Mercurial > hg-stable
changeset 46769:c5912e35d06d
README: document requirement for builtin zstd
Differential Revision: https://phab.mercurial-scm.org/D10226
author | Joerg Sonnenberger <joerg@bec.de> |
---|---|
date | Tue, 16 Mar 2021 00:07:12 +0100 |
parents | 6b5714479288 |
children | 3c9ddb1986a9 |
files | README.rst |
diffstat | 1 files changed, 10 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Mon Mar 08 21:04:51 2021 +0100 +++ b/README.rst Tue Mar 16 00:07:12 2021 +0100 @@ -18,3 +18,13 @@ 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.