Difference between revisions of "Policies to retire functionality"
(add draft) |
(removed draft status) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | == | + | == Thorn and parameter retirement policies == |
| − | At release time, the main Einstein Toolkit thornlist in the manifest [https://svn.einsteintoolkit.org/manifest/trunk/einsteintoolkit.th] should only contain thorns that are supported and actively maintained. Thorns that do not meet these requirements | + | At release time, the main Einstein Toolkit thornlist in the manifest [https://svn.einsteintoolkit.org/manifest/trunk/einsteintoolkit.th] should only contain thorns that are supported and actively maintained. Thorns that do not meet these requirements are candidates for retirements. |
| − | In order to retire a thorn or parameter it needs to be marked as deprecated for at least one release. Deprecation notices appear in the release | + | In order to retire a thorn or parameter: |
| + | |||
| + | * it needs to be marked as deprecated for at least one release. Deprecation notices appear in the release announcement. | ||
| + | ** for parameters we would like a means to mark them as deprecated in param.ccl (not implemented yet) | ||
| + | ** thorns are to be marked as deprecated in the thornlist | ||
| + | * deprecated thorns are to be listed on the ET website | ||
| + | * In order for a thorn to be retired, no other active thorn's testsuite may depend on it, unless the test is designed to only test the to-be-retired thorn. | ||
| + | * Deprecating and finally retiring a thorn both needs to be result of a public discussion, usually on one of the public meetings (phone calls). | ||
Latest revision as of 14:04, 15 June 2023
Thorn and parameter retirement policies
At release time, the main Einstein Toolkit thornlist in the manifest [1] should only contain thorns that are supported and actively maintained. Thorns that do not meet these requirements are candidates for retirements.
In order to retire a thorn or parameter:
- it needs to be marked as deprecated for at least one release. Deprecation notices appear in the release announcement.
- for parameters we would like a means to mark them as deprecated in param.ccl (not implemented yet)
- thorns are to be marked as deprecated in the thornlist
- deprecated thorns are to be listed on the ET website
- In order for a thorn to be retired, no other active thorn's testsuite may depend on it, unless the test is designed to only test the to-be-retired thorn.
- Deprecating and finally retiring a thorn both needs to be result of a public discussion, usually on one of the public meetings (phone calls).
