Policies to retire functionality - Revision history

Rhaas: removed draft status

2023-06-15T14:04:06Z

removed draft status

Knarf: /* Draft of thorn and parameter retirement policies */

2013-12-13T12:43:35Z

‎Draft of thorn and parameter retirement policies

Knarf: /* Draft of thorn and parameter retirement policies */

2013-12-13T12:35:33Z

‎Draft of thorn and parameter retirement policies

Rhaas: add draft

2013-12-09T12:14:10Z

add draft

New page

== 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 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 announement. 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 thorn are to be listed on the ET website. In order for a thorn to be retired, no other thorn's testsuite may depend on it, unless the test is designed to only test the to-be-retired test.

←Older revision		Revision as of 14:04, 15 June 2023
Line 1:		Line 1:
−	== ~~Draft of thorn~~ and parameter retirement policies ==	+	== 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 are candidates for retirements.		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.

←Older revision		Revision as of 12:43, 13 December 2013
Line 3:		Line 3:
	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.		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 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.	+	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).

@@ Line 1: / Line 1: @@
 == 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 candidates for retirements.
+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 announement.  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 thorn are to be listed on the ET website.  In order for a thorn to be retired, no other thorn's testsuite may depend on it, unless the test is designed to only test the to-be-retired test.
+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.