Re: [eclipse-dev] Simplified API removal process for Java code

[<jkubitz-eclipse@xxxxxx>]

It seems to be undefined which number to put in the SINCE tag. Shouldn’t it be the version of the plugin?

Please also consider, that the actual removal of an API is a breaking change which requires a major version bumb… which may require dependend plugins to increase the used version.

 

Jörg

 

Von: eclipse-dev <eclipse-dev-bounces@xxxxxxxxxxx> Im Auftrag von Lars Vogel
Gesendet: Freitag, 9. September 2022 22:51
An: General development mailing list of the Eclipse project. <eclipse-dev@xxxxxxxxxxx>
Betreff: Re: [eclipse-dev] Simplified API removal process for Java code

 

Hi Jonah,

 

It is not mandatory to document the removal but if someone like to do this that would be ok.

 

You could check the documentation of the release before to see that is removed.

 

Best regards, Lars 

 

Jonah Graham <jonah@xxxxxxxxxxxxxxxx> schrieb am Fr., 9. Sept. 2022, 21:13:

Hi Lars and the rest of the Eclipse PMC,

 

This sounds like a simplification of the process. However it leaves one thing unclear to me. After the API has been removed, will that be documented? Will it be added to https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/porting/removals.html at the time of removal? That removal document is linked from the migration guide in each release.

 

Thanks,

Jonah

 

 

 

~~~
Jonah Graham
Kichwa Coders
www.kichwacoders.com

 

 

On Wed, 17 Aug 2022 at 11:51, Lars Vogel <lars.vogel@xxxxxxxxxxx> wrote:

Hi,

We simplified the rules to mark deprecated API for deletion.

For Java code you can use "only" the @Deprecation annotation with the
correct flags instead of also adding a manual entry to our API removal
document. This will result in an entry of the Javadoc page.

 * @noextend This class is not intended to be subclassed by clients.
 * @noreference This class is not intended to be referenced by clients.
 * @noinstantiate This class is not intended to be instantiated by clients.
 * @deprecated Use
 *             {@link
org.eclipse.core.databinding.conversion.text.NumberToStringConverter}
 *             instead, which does not use {@code com.ibm.icu} as that package
 *             is planned to be removed.
 */
@Deprecated(forRemoval = true, since = "4.25")

....

See https://github.com/eclipse-platform/.github/wiki/PMC-Meeting-minutes

I moved this also to our guideline wiki, re-using infos from the old wiki
See https://github.com/eclipse-platform/.github/wiki/PMC-project-guidelines#api-removal-process

All the rest of the rules are still the same, for example you still
need PMC approval to mark API for removal and we still have to keep
the API for a minimum of two years after marking it for removal.

Best regards, Lars
--
Eclipse Platform project co-lead
CEO vogella GmbH

Haindaalwisch 17a, 22395 Hamburg
Amtsgericht Hamburg: HRB 127058
Geschäftsführer: Lars Vogel, Jennifer Nerlich de Vogel
USt-IdNr.: DE284122352
Fax (040) 5247 6322, Email: lars.vogel@xxxxxxxxxxx, Web: http://www.vogella.com
_______________________________________________
eclipse-dev mailing list
eclipse-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/eclipse-dev

_______________________________________________
eclipse-dev mailing list
eclipse-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/eclipse-dev