From d2d1c006317aafd5854e941820ef3bc98c16de3b Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Tue, 31 Mar 2020 15:03:50 -0400 Subject: [PATCH] Bug 561623: Starting point for documenting future API removals. This includes all the API changes already made for CDT 10.0 Change-Id: I3bd4c613af5e9ee3d1529afef7307da09efcbbdf --- .../guide/deprecated_API_removals.html | 151 ++++++++++++++++++ doc/org.eclipse.cdt.doc.isv/topics_Guide.xml | 1 + 2 files changed, 152 insertions(+) create mode 100644 doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html diff --git a/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html b/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html new file mode 100644 index 00000000000..83e7758285b --- /dev/null +++ b/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html @@ -0,0 +1,151 @@ + + + + + + + + + Eclipse CDT Deprecated and Breaking API changes and removals + + + +

Eclipse CDT Deprecated and Breaking API changes and removals

+ +

+ Deprecated API can be marked for deletion without requiring a major version increment. + See the policy for the details. + This section describes API removals that occurred in past releases, and upcoming removals in future releases. +

+ +

+ API Changes prior to CDT 10.0 / 2020-09. +

+

+ Prior to CDT 10 release API changes were published as part of the New and Noteworthy entries for that release. From CDT 10 + forward breaking API changes are included in this document. +

+ +

+ API Changes in CDT 10.0. +

+
    +
  1. Eclipse CDT requires Java 11 as a minimum to build and run.
    2. +
  2. Previously exported packages that were not API are now correctly marked as such.
    3. +
  3. Activators removed for all bundles where possible.
    4. +
  4. NewClassCreationWizardPage breaking changes.
    5. +
+

+ Planned Removals after June 2022 +

+
    +
  1. 32-bit Binary parsers with 64-bit replacements
    2. +
+ +
+ +

API Changes in CDT 10.0.

+

1. Eclipse CDT requires Java 11 as a minimum to build and run.

+

+ See Bug 562494. +

+

2. Previously exported packages that were not API are now correctly marked as such.

+

+ A review of the previously exported API of CDT was performed. A lot of what was previously marked as public API has + now been marked as internal. This means the API has either had x-internal or x-friends + added to the Export-Package declarations. +

+

+ The following bundles have had all their packages exported as internal See Bug 561389: +

+

+

+ The following bundles had additional changes made to be able to mark packages as internal: +

+ +

+ +

3. Activators removed for all bundles where possible.

+

+ Where possible bundles have had their Activators removed. Some of these activators were API and are no longer + available. See Bug 561635 for + workarounds where items that used to be in Activators are still needed, such as logging and plug-ids. +

+

+ The following Activators that were API have been removed. +

+

+ +

4. NewClassCreationWizardPage breaking changes.

+

+ The NewClassCreationWizardPage has some API breaking changes due to how some protected fields, especially + ALL_FIELDS was used. While this breaks binary + compatibility, no code changes should be needed in extenders, just compiling against the new version. See Bug 510789 and Bug 561770. +

+ +
+ +

Future Deletions

+

+ The items below can be removed after the given date or on the next major release, whichever is sooner. The details + and discussion on the removal happens in the Bugzilla associated with the entry below. See + the policy for the details. +

+ +

API Removals after June 2022

+ +

1. Planned Removals after June 2022.

+

+ The following binary parser classes have replacements, mostly due to these versions not supporting 64-bit variants + of the binary files. The new 64-bit parsers support both 32 and 64 bit files. +

+ +

+ See Bug 562495. +

+ + + diff --git a/doc/org.eclipse.cdt.doc.isv/topics_Guide.xml b/doc/org.eclipse.cdt.doc.isv/topics_Guide.xml index f558b6e1f52..0f568894946 100644 --- a/doc/org.eclipse.cdt.doc.isv/topics_Guide.xml +++ b/doc/org.eclipse.cdt.doc.isv/topics_Guide.xml @@ -12,6 +12,7 @@ +