help: document new "bookmarksinstore" requirement in internals.requirements
authorMartin von Zweigbergk <martinvonz@google.com>
Mon, 20 May 2019 16:12:27 -0700
changeset 42352 1bc7d4cb4182
parent 42351 86f17fc31aa8
child 42353 f22131315791
help: document new "bookmarksinstore" requirement in internals.requirements Differential Revision: https://phab.mercurial-scm.org/D6413
mercurial/help/internals/requirements.txt
--- a/mercurial/help/internals/requirements.txt	Mon May 20 14:00:12 2019 -0400
+++ b/mercurial/help/internals/requirements.txt	Mon May 20 16:12:27 2019 -0700
@@ -129,3 +129,16 @@
 disappear in a future Mercurial release. The requirement will only
 be present on repositories that have opted in to a sparse working
 directory.
+
+bookmarksinstore
+==================
+
+Bookmarks are stored in ``.hg/store/`` instead of directly in ``.hg/``
+where they used to be stored. The active bookmark is still stored
+directly in ``.hg/``. This makes them always shared by ``hg share``,
+whether or not ``-B`` was passed.
+
+Support for this requirement was added in Mercurial 5.1 (released
+August 2019). The requirement will only be present on repositories
+that have opted in to this format (by having
+``format.bookmarks-in-store=true`` set when they were created).