tracked-key: remove the dual write and rename to tracked-hint The dual-write approach was mostly useless. As explained in the previous version of the help, the key had to be read twice before we could cache a value. However this "read twice" limitation actually also apply to any usage of the key. If some operation wants to rely of the "same value == same tracked set" property it would need to read the value before, and after running that operation (or at least, after, in all cases). So it cannot be sure the operation it did is "valid" until checking the key after the operation. As a resultat such operation can only be read-only or rollbackable. This reduce the utility of the "same value == same tracked set" a lot. So it seems simpler to drop the double write and to update the documentation to highlight that this file does not garantee race-free operation. As a result the "key" is demoted to a "hint". Documentation is updated accordingly. Differential Revision: https://phab.mercurial-scm.org/D12201

     1

Mercurial

     2

=========

     3

     4

Mercurial is a fast, easy to use, distributed revision control tool

     5

for software developers.

     6

     7

Basic install::

     8

     9

 $ make            # see install targets

    10

 $ make install    # do a system-wide install

    11

 $ hg debuginstall # sanity-check setup

    12

 $ hg              # see help

    13

    14

Running without installing::

    15

    16

 $ make local      # build for inplace usage

    17

 $ ./hg --version  # should show the latest version

    18

    19

See https://mercurial-scm.org/ for detailed installation

    20

instructions, platform-specific notes, and Mercurial user information.

    21

    22

Notes for packagers

    23

===================

    24

    25

Mercurial ships a copy of the python-zstandard sources. This is used to

    26

provide support for zstd compression and decompression functionality. The

    27

module is not intended to be replaced by the plain python-zstandard nor

    28

is it intended to use a system zstd library. Patches can result in hard

    29

to diagnose errors and are explicitly discouraged as unsupported

    30

configuration.