deprecation.md

Eclipse OpenJ9 Deprecation Process

To deprecate a documented OpenJ9 option, behaviour, or feature, follow the process described below:

1. Determine the Java version the deprecation is to take effect.
2. Announce the deprecation that is to occur in version n in the release notes of version n-1. Furthermore, update any documentation to warn about the upcoming changes.
3. Change the codebase in the master branch following the split for version n-1, as well as update any relevant documentation, to reflect the deprecation.
4. Remove any relevant documentation once all versions prior to the version n go out of service.

Important Notes

• Deprecation normally only occurs when a new Java version is released; this should not be confused with a new OpenJ9 version, which may not necessarily include a new Java version.
• If an OpenJ9 release does not include Java version n-1 (i.e., the version used to announce the deprecation), the release notes can still announce the upcoming deprecation; however, this notice should be added to all subsequent release notes until the OpenJ9 release that includes Java version n.