@@ -22,12 +22,15 @@ import Prettyprinter
2222
2323{- Note [Adding new builtins: protocol versions]
2424
25- *** ATTENTION! ***
26- New built-in functions must initially be added under
27- `futurePV` and should only be moved to an earlier MajorProtocolVersion once
28- they have been fully implemented and costed and their release under the
29- relevant protocol version has been officially approved. Remember to update
30- the tests in `Spec.Versions` and `Spec.Data.Versions` when this happens.
25+ *** ATTENTION! *** New built-in functions must initially be added in a batch
26+ under `futurePV` in `builtinsAvailableIn` in `Common.Versions` and should only
27+ be moved to an earlier MajorProtocolVersion once they have been fully
28+ implemented and costed and their release under the relevant protocol version
29+ has been officially approved. Remember to update the tests in `Spec.Versions`
30+ and `Spec.Data.Versions` when this happens. If there are some builtins that
31+ are not to be released then leave them under `futurePV` (splitting the batch
32+ if necessary) and also make sure that the names of their cost model parameters
33+ come at the end of the `ParamName` types.
3134-}
3235
3336-- | This represents the major component of the Cardano protocol version.
@@ -106,11 +109,9 @@ newestPV = pv11PV
106109
107110{-| This is a placeholder for when we don't yet know what protocol version will
108111 be used for something. It's a very high protocol version that should never
109- appear in reality. New builtins should always be given this protocol version
110- until they've been finalised (at which point they should be moved to
111- the PV named in `newestPV`).
112+ appear in reality.
112113
113- We should not assign names to future protocol versions until it's
114+ We should not assign names to future protocol versions until it's
114115 confirmed that they are correct, otherwise we could accidentally
115116 associate something with the wrong protocol version.
116117-}
0 commit comments