Mercurial > hg
changeset 46346:60e6bf3bf681 stable
doc: improves the share-safe documentation
The associated behavior is now clearer and we point to the other configuration
that control the mismatching behavior.
Differential Revision: https://phab.mercurial-scm.org/D9839
| author | Pierre-Yves David <pierre-yves.david@octobus.net> |
|---|---|
| date | Wed, 20 Jan 2021 12:12:31 +0100 |
| parents | 043781c0ffd6 |
| children | 5249ac2bc7a4 |
| files | mercurial/helptext/config.txt |
| diffstat | 1 files changed, 21 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/helptext/config.txt Wed Jan 20 12:11:41 2021 +0100 +++ b/mercurial/helptext/config.txt Wed Jan 20 12:12:31 2021 +0100 @@ -913,8 +913,27 @@ Disabled by default. ``use-share-safe`` - Enable or disable the "share-safe" functionality, which enables shares - to read requirements and configuration of its source repository. + Enforce "safe" behaviors for all "shares" that access this repository. + + With this feature, "shares" using this repository as a source will: + + * read the source repository's configuration (`<source>/.hg/hgrc`). + * read and use the source repository's "requirements" + (except the working copy specific one). + + Without this feature, "shares" using this repository as a source will: + + * keep tracking the repository "requirements" in the share only, ignoring + the source "requirements", possibly diverging from them. + * ignore source repository config. This can create problems, like silently + ignoring important hooks. + + Beware that existing shares will not be upgraded/downgraded, and by + default, Mercurial will refuse to interact with them until the mismatch + is resolved. See :hg:`help config share.safe-mismatch.source-safe` and + :hg:`help config share.safe-mismatch.source-not-safe` for details. + + Introduced in Mercurial 5.7. Disabled by default.