Show More
@@ -28,7 +28,7 b' def preservedrequirements(repo):' | |||
|
28 | 28 | return set() |
|
29 | 29 | |
|
30 | 30 | |
|
31 |
|
|
|
31 | FORMAT_VARIANT = b'deficiency' | |
|
32 | 32 | OPTIMISATION = b'optimization' |
|
33 | 33 | |
|
34 | 34 | |
@@ -42,13 +42,15 b' class improvement(object):' | |||
|
42 | 42 | will be mapped to an action later in the upgrade process. |
|
43 | 43 | |
|
44 | 44 | type |
|
45 |
Either `` |
|
|
46 | problem. An optimization is an action (sometimes optional) that | |
|
45 | Either ``FORMAT_VARIANT`` or ``OPTIMISATION``. | |
|
46 | A format variant is where we change the storage format. Not all format | |
|
47 | variant changes are an obvious problem. | |
|
48 | An optimization is an action (sometimes optional) that | |
|
47 | 49 | can be taken to further improve the state of the repository. |
|
48 | 50 | |
|
49 | 51 | description |
|
50 | 52 | Message intended for humans explaining the improvement in more detail, |
|
51 |
including the implications of it. For `` |
|
|
53 | including the implications of it. For ``FORMAT_VARIANT`` types, should be | |
|
52 | 54 | worded in the present tense. For ``OPTIMISATION`` types, should be |
|
53 | 55 | worded in the future tense. |
|
54 | 56 | |
@@ -87,7 +89,7 b' def registerformatvariant(cls):' | |||
|
87 | 89 | class formatvariant(improvement): |
|
88 | 90 | """an improvement subclass dedicated to repository format""" |
|
89 | 91 | |
|
90 |
type = |
|
|
92 | type = FORMAT_VARIANT | |
|
91 | 93 | ### The following attributes should be defined for each class: |
|
92 | 94 | |
|
93 | 95 | # machine-readable string uniquely identifying this improvement. it will be |
@@ -95,7 +97,8 b' class formatvariant(improvement):' | |||
|
95 | 97 | name = None |
|
96 | 98 | |
|
97 | 99 | # message intended for humans explaining the improvement in more detail, |
|
98 |
# including the implications of it `` |
|
|
100 | # including the implications of it ``FORMAT_VARIANT`` types, should be | |
|
101 | # worded | |
|
99 | 102 | # in the present tense. |
|
100 | 103 | description = None |
|
101 | 104 |
General Comments 0
You need to be logged in to leave comments.
Login now