mercurial/upgrade.py
changeset 45993 8037d0641146
parent 45981 53bde3ad0270
child 45994 cfae98c4e1f1
equal deleted inserted replaced
45992:9dd5b129ff28 45993:8037d0641146
   149 
   149 
   150 def preservedrequirements(repo):
   150 def preservedrequirements(repo):
   151     return set()
   151     return set()
   152 
   152 
   153 
   153 
   154 deficiency = b'deficiency'
   154 DEFICIENCY = b'deficiency'
   155 optimisation = b'optimization'
   155 optimisation = b'optimization'
   156 
   156 
   157 
   157 
   158 class improvement(object):
   158 class improvement(object):
   159     """Represents an improvement that can be made as part of an upgrade.
   159     """Represents an improvement that can be made as part of an upgrade.
   163     name
   163     name
   164        Machine-readable string uniquely identifying this improvement. It
   164        Machine-readable string uniquely identifying this improvement. It
   165        will be mapped to an action later in the upgrade process.
   165        will be mapped to an action later in the upgrade process.
   166 
   166 
   167     type
   167     type
   168        Either ``deficiency`` or ``optimisation``. A deficiency is an obvious
   168        Either ``DEFICIENCY`` or ``optimisation``. A deficiency is an obvious
   169        problem. An optimization is an action (sometimes optional) that
   169        problem. An optimization is an action (sometimes optional) that
   170        can be taken to further improve the state of the repository.
   170        can be taken to further improve the state of the repository.
   171 
   171 
   172     description
   172     description
   173        Message intended for humans explaining the improvement in more detail,
   173        Message intended for humans explaining the improvement in more detail,
   174        including the implications of it. For ``deficiency`` types, should be
   174        including the implications of it. For ``DEFICIENCY`` types, should be
   175        worded in the present tense. For ``optimisation`` types, should be
   175        worded in the present tense. For ``optimisation`` types, should be
   176        worded in the future tense.
   176        worded in the future tense.
   177 
   177 
   178     upgrademessage
   178     upgrademessage
   179        Message intended for humans explaining what an upgrade addressing this
   179        Message intended for humans explaining what an upgrade addressing this
   208 
   208 
   209 
   209 
   210 class formatvariant(improvement):
   210 class formatvariant(improvement):
   211     """an improvement subclass dedicated to repository format"""
   211     """an improvement subclass dedicated to repository format"""
   212 
   212 
   213     type = deficiency
   213     type = DEFICIENCY
   214     ### The following attributes should be defined for each class:
   214     ### The following attributes should be defined for each class:
   215 
   215 
   216     # machine-readable string uniquely identifying this improvement. it will be
   216     # machine-readable string uniquely identifying this improvement. it will be
   217     # mapped to an action later in the upgrade process.
   217     # mapped to an action later in the upgrade process.
   218     name = None
   218     name = None
   219 
   219 
   220     # message intended for humans explaining the improvement in more detail,
   220     # message intended for humans explaining the improvement in more detail,
   221     # including the implications of it ``deficiency`` types, should be worded
   221     # including the implications of it ``DEFICIENCY`` types, should be worded
   222     # in the present tense.
   222     # in the present tense.
   223     description = None
   223     description = None
   224 
   224 
   225     # message intended for humans explaining what an upgrade addressing this
   225     # message intended for humans explaining what an upgrade addressing this
   226     # issue will do. should be worded in the future tense.
   226     # issue will do. should be worded in the future tense.