This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9664

actions: rename DEFICIENCY constant to FORMAT_VARIANT
ClosedPublic

Authored by pulkit on Dec 30 2020, 5:31 AM.

Details

Reviewers
marmoute
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG9540945e51fd: actions: rename DEFICIENCY constant to FORMAT_VARIANT
Summary

It was not obvious what does deficieny means and every format change can't be a
deficiency. There are some format changes like compression levels, share-safe
which can't be understood at deficiencies.

This patch renames the constant to make things clearer.

Diff Detail

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

Event Timeline

pulkit created this revision.Dec 30 2020, 5:31 AM
joerg.sonnenberger added a subscriber: joerg.sonnenberger.Dec 30 2020, 7:23 AM

I'm not a huge fan of the name FORMAT_VARIANT. Maybe BC_COMPATIBLE and BC_INCOMPATIBLE (for the current OPTIMISATION and DEFICENCY)?

mercurial/upgrade_utils/actions.py
101

Extra line break?

pulkit added a comment.Dec 30 2020, 8:16 AM
In D9664#145868, @joerg.sonnenberger wrote:

I'm not a huge fan of the name FORMAT_VARIANT. Maybe BC_COMPATIBLE and BC_INCOMPATIBLE (for the current OPTIMISATION and DEFICENCY)?

From BC you mean, Backwards compatibility?

mercurial/upgrade_utils/actions.py
101

Ha yep, will fix

joerg.sonnenberger added a comment.Dec 30 2020, 8:31 AM

Yeah, "different from the old state".

pulkit added a comment.Dec 30 2020, 8:35 AM
In D9664#145874, @joerg.sonnenberger wrote:

Yeah, "different from the old state".

I see. Not all format changes are backwards incompatible. When I say changes, it can be any of upgrade or downgrade. One thing we can do is mark which format variants are BC compatible or not.

marmoute accepted this revision.Jan 7 2021, 6:35 PM
mharbison72 accepted this revision.Jan 12 2021, 6:45 PM
This revision is now accepted and ready to land.Jan 12 2021, 6:45 PM
pulkit added a commit: rHG9540945e51fd: actions: rename DEFICIENCY constant to FORMAT_VARIANT.Jan 12 2021, 6:53 PM
Closed by commit rHG9540945e51fd: actions: rename DEFICIENCY constant to FORMAT_VARIANT (authored by pulkit). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/upgrade_utils/actions.py (15 lines)

Diff 24542

mercurial/upgrade_utils/actions.py

requirements.SPARSEREVLOG_REQUIREMENT, requirements.SPARSEREVLOG_REQUIREMENT,
} }
def preservedrequirements(repo): def preservedrequirements(repo):
return set() return set()
DEFICIENCY = b'deficiency' FORMAT_VARIANT = b'deficiency'
OPTIMISATION = b'optimization' OPTIMISATION = b'optimization'
class improvement(object): class improvement(object):
"""Represents an improvement that can be made as part of an upgrade. """Represents an improvement that can be made as part of an upgrade.
The following attributes are defined on each instance: The following attributes are defined on each instance:
name name
Machine-readable string uniquely identifying this improvement. It Machine-readable string uniquely identifying this improvement. It
will be mapped to an action later in the upgrade process. will be mapped to an action later in the upgrade process.
type type
Either ``DEFICIENCY`` or ``OPTIMISATION``. A deficiency is an obvious Either ``FORMAT_VARIANT`` or ``OPTIMISATION``.
problem. An optimization is an action (sometimes optional) that A format variant is where we change the storage format. Not all format
variant changes are an obvious problem.
An optimization is an action (sometimes optional) that
can be taken to further improve the state of the repository. can be taken to further improve the state of the repository.
description description
Message intended for humans explaining the improvement in more detail, Message intended for humans explaining the improvement in more detail,
including the implications of it. For ``DEFICIENCY`` types, should be including the implications of it. For ``FORMAT_VARIANT`` types, should be
worded in the present tense. For ``OPTIMISATION`` types, should be worded in the present tense. For ``OPTIMISATION`` types, should be
worded in the future tense. worded in the future tense.
upgrademessage upgrademessage
Message intended for humans explaining what an upgrade addressing this Message intended for humans explaining what an upgrade addressing this
issue will do. Should be worded in the future tense. issue will do. Should be worded in the future tense.
""" """
def registerformatvariant(cls): def registerformatvariant(cls):
allformatvariant.append(cls) allformatvariant.append(cls)
return cls return cls
class formatvariant(improvement): class formatvariant(improvement):
"""an improvement subclass dedicated to repository format""" """an improvement subclass dedicated to repository format"""
type = DEFICIENCY type = FORMAT_VARIANT
### The following attributes should be defined for each class: ### The following attributes should be defined for each class:
# machine-readable string uniquely identifying this improvement. it will be # machine-readable string uniquely identifying this improvement. it will be
# mapped to an action later in the upgrade process. # mapped to an action later in the upgrade process.
name = None name = None
# message intended for humans explaining the improvement in more detail, # message intended for humans explaining the improvement in more detail,
# including the implications of it ``DEFICIENCY`` types, should be worded # including the implications of it ``FORMAT_VARIANT`` types, should be
# worded
joerg.sonnenbergerUnsubmitted
Not Done

Extra line break?

joerg.sonnenberger: Extra line break?
pulkitAuthorUnsubmitted
Done

Ha yep, will fix

pulkit: Ha yep, will fix
# in the present tense. # in the present tense.
description = None description = None
# message intended for humans explaining what an upgrade addressing this # message intended for humans explaining what an upgrade addressing this
# issue will do. should be worded in the future tense. # issue will do. should be worded in the future tense.
upgrademessage = None upgrademessage = None
# value of current Mercurial default for new repository # value of current Mercurial default for new repository