Difference between revisions of "Policies to retire functionality"
(add draft) |
(→Draft of thorn and parameter retirement policies) |
||
| Line 1: | Line 1: | ||
== Draft of thorn and parameter retirement policies == | == Draft of 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, 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. |
Revision as of 12:35, 13 December 2013
Draft of 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, 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.
