changeset 52693:3b0625a3f04a

slow-path: document the dirstate-v2 slow-path option This config option is mentioned in the dirstate-v2 config option, so we rather document it :-)
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Mon, 09 Dec 2024 06:23:29 +0100
parents 61bddae63bbe
children bbbb12632607
files mercurial/configitems.toml mercurial/helptext/config.txt
diffstat 2 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/configitems.toml	Mon Dec 09 06:23:24 2024 +0100
+++ b/mercurial/configitems.toml	Mon Dec 09 06:23:29 2024 +0100
@@ -2188,6 +2188,17 @@
 name = "dirstate-v2.slow-path"
 default = "abort"
 experimental = true  # experimental as long as format.use-dirstate-v2 is.
+documentation = """Control the behavior of Mercurial when using a repository with the "dirstate-v2"
+feature with an installation of Mercurial without a fast implementation for
+the feature:
+
+``allow``: Silently use the slower implementation to access the repository.
+``warn``: Warn, but use the slower implementation to access the repository.
+``abort``: Prevent access to such repositories. (This is the default)
+
+For details on the "dirstate-v2" feature, see:
+:hg:`help config.format.use-dirstate-v2`.
+"""
 
 [[items]]
 section = "storage"
--- a/mercurial/helptext/config.txt	Mon Dec 09 06:23:24 2024 +0100
+++ b/mercurial/helptext/config.txt	Mon Dec 09 06:23:29 2024 +0100
@@ -2325,6 +2325,9 @@
 Control the strategy Mercurial uses internally to store history. Options in this
 category impact performance and repository size.
 
+``revlog.dirstate-v2.slow-path``
+    :config-doc:`storage.dirstate-v2.slow-path`
+
 ``revlog.issue6528.fix-incoming``
     Version 5.8 of Mercurial had a bug leading to altering the parent of file
     revision with copy information (or any other metadata) on exchange. This