This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9769

share: add documentation about various configs introduced recently
AbandonedPublic

Authored by pulkit on Jan 14 2021, 6:19 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

My recent series added these 4 configs which control how to behave when there is
difference in share-safe state of source and shares. However my patches were
missing documentation. This patch adds it.

The documentation is added in verbose part as the feature and config are
experimental.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

pulkit created this revision.Jan 14 2021, 6:19 AM
marmoute added a subscriber: marmoute.Jan 14 2021, 6:24 AM

I feel like I already comment on that, but I cannot find that comment anymore ‽

→ this should go in the main config definition since most of share and the associated behavior lives in core.
→ I would rather have the config renamed to their final form so that we can document the final API directly.

marmoute added a comment.Jan 14 2021, 6:26 AM

I am a bit surprised to see only 4 options. Their should be 6, 3 for upgrade and 3 for downgrade.

The relationship between the three options should be clearer. For example, the warning do control if we issue a warning on failed upgrade, right? The abort case primarily control the non-upgrade case, and as a secondary effect effect the failed-upgrade case right? That documentation should present this in a clearer way.

mharbison72 added a subscriber: mharbison72.Jan 18 2021, 9:12 PM

Is this one obsoleted by D9785, D9786 (and friends)?

pulkit abandoned this revision.Jan 19 2021, 8:08 AM
In D9769#148814, @mharbison72 wrote:

Is this one obsoleted by D9785, D9786 (and friends)?

Yes.

Revision Contents
Changeset List

PathPackages
Mhgext/share.py (24 lines)

Diff 24848

hgext/share.py

Setting `format.exp-share-safe = True` enables sharing configs and Setting `format.exp-share-safe = True` enables sharing configs and
requirements. This only applies to shares which are done after enabling requirements. This only applies to shares which are done after enabling
the config option. the config option.
For enabling this in existing shares, enable the config option and reshare. For enabling this in existing shares, enable the config option and reshare.
For resharing existing shares, make sure your working directory is clean For resharing existing shares, make sure your working directory is clean
and there are no untracked files, delete that share and create a new share. and there are no untracked files, delete that share and create a new share.
Shares can be automatically upgraded and downgraded to use share-safe
mechanism. Following config options control the behavior:
``experimental.sharesafe-warn-outdated-shares`` (default: True)
Shows a warning if the current share is outdated and can be upgraded to
use share-safe functionality.
``experimental.sharesafe-auto-upgrade-shares`` (default: False)
Automatically upgrades shares if the share source supports share-safe
functionality.
If the upgrade fails, a warning is shown and the command which is
running is continued.
``experimental.sharesafe-auto-upgrade-fail-error`` (default: False)
If auto upgrade of share fails, error out the process and don't continue
the command which is running.
``experimental.sharesafe-auto-downgrade-shares`` (default: False)
Automatically downgrade shares if it was using share-safe functionality
but the share source stopped using it.
If the downgrade process fails, we error out because current share
does not have complete set of requirements and shared source no longer
supports share-safe mechanism.
''' '''
from __future__ import absolute_import from __future__ import absolute_import
import errno import errno
from mercurial.i18n import _ from mercurial.i18n import _
from mercurial import ( from mercurial import (
bookmarks, bookmarks,