Patchwork D8914: helptext: document exp-sharesafe in internals/requirements.txt

login
register
mail settings
Submitter phabricator
Date Aug. 7, 2020, 12:51 p.m.
Message ID <differential-rev-PHID-DREV-ismh3gexi6zmgz2gjw5o-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/47013/
State Superseded
Headers show

Comments

phabricator - Aug. 7, 2020, 12:51 p.m.
pulkit created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  `exp-sharesafe` is a new requirement and we should document it.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D8914

AFFECTED FILES
  mercurial/helptext/internals/requirements.txt

CHANGE DETAILS




To: pulkit, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/mercurial/helptext/internals/requirements.txt b/mercurial/helptext/internals/requirements.txt
--- a/mercurial/helptext/internals/requirements.txt
+++ b/mercurial/helptext/internals/requirements.txt
@@ -155,3 +155,18 @@ 
 Note that as of 5.5, only installations compiled with the Rust extension will
 benefit from a speedup. The other installations will do the necessary work to
 keep the index up to date, but will suffer a slowdown.
+
+exp-sharesafe
+=============
+
+Represents that the repository can be shared safely. Requirements and config of
+the source repository will be shared.
+Requirements are stored in ``.hg/store`` instead of directly in ``.hg/`` where
+they used to be stored. Some working copy related requirements are still stored
+in ``.hg/``.
+Shares read the ``.hg/hgrc`` of the source repository.
+
+Support for this requirement was added in Mercurial 5.6 (released
+November 2020). The requirement will only be present on repositories that have
+opted in to this format (by having ``format.exp-share-safe=true`` set when
+they were created).