comparison mercurial/helptext/config.txt @ 48771:79a967128055

dirstate-tracked-key: update the config value to match latest discussion

Special cases are not special enough, we align the option name on the other.

The `version` value is undocumented for now as it can only have a single value.
It is supported in the code to properly detect and abort if more value are
introduced in the future value.

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

48770:f19be290756a

          --config format.use-dirstate-v2=False \
          --config storage.dirstate-v2.slow-path=allow

    For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.

``exp-dirstate-tracked-key-version``
    Enable or disable the writing of "tracked key" file alongside the dirstate.

    That "tracked-key" can help external automations to detect changes to the
    set of tracked files.

    Two values are currently supported:
    - 0: no file is written (the default),
    - 1: a file in version "1" is written.

    The tracked-key is written in a new `.hg/dirstate-tracked-key`. That file
    contains two lines:
    - the first line is the file version (currently: 1),
    - the second line contains the "tracked-key".

48771:79a967128055

          --config format.use-dirstate-v2=False \
          --config storage.dirstate-v2.slow-path=allow

    For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.

``dirstate-tracked-key``
    Enable or disable the writing of "tracked key" file alongside the dirstate.
    (default to disabled)

    That "tracked-key" can help external automations to detect changes to the
    set of tracked files.

    The tracked-key is written in a new `.hg/dirstate-tracked-key`. That file
    contains two lines:
    - the first line is the file version (currently: 1),
    - the second line contains the "tracked-key".