This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 304171 - [api] add API exceptions for internal provisional packages not marked as x-internal
Summary: [api] add API exceptions for internal provisional packages not marked as x-in...
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: 3.3   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 3.4   Edit
Assignee: Steffen Pingel CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 294957
  Show dependency tree
 
Reported: 2010-02-28 18:20 EST by Steffen Pingel CLA
Modified: 2010-03-04 16:37 EST (History)
4 users (show)

See Also:


Attachments
patch that marks org.eclipse.mylyn.internal.provisional.commons.ui.editor as x-internal:=true; (10.33 KB, patch)
2010-03-04 16:24 EST, Steffen Pingel CLA
no flags Details | Diff
mylyn/context/zip (2.16 KB, application/octet-stream)
2010-03-04 16:24 EST, Steffen Pingel CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Steffen Pingel CLA 2010-02-28 18:20:01 EST
The following internal provisional packages were not marked as x-internal which prevents them from moving into API without breaking backwards compatibility:

 org.eclipse.mylyn.internal.provisional.commons.ui.dialogs  (since 3.3)
 org.eclipse.mylyn.internal.provisional.tasks.bugs  (since 3.2)

This affects moving the support extension point into API (bug 294957) since that involves renaming the org.eclipse.mylyn.internal.provisional.tasks.bugs package to org.eclipse.mylyn.tasks.bugs. 

There are two alternatives:
* Leave internal packages as API but deprecate classes to maintain binary compatibility. The disadvantage is that multiple classes with the same name would exist in different namespaces which is confusing.
* Remove API, inform integrators and add API filters to suppress API tooling errors.
Comment 1 Steffen Pingel CLA 2010-03-04 16:24:28 EST
Created attachment 161035 [details]
patch that marks org.eclipse.mylyn.internal.provisional.commons.ui.editor as x-internal:=true;
Comment 2 Steffen Pingel CLA 2010-03-04 16:24:32 EST
Created attachment 161036 [details]
mylyn/context/zip
Comment 3 Steffen Pingel CLA 2010-03-04 16:37:13 EST
As discussed on the call today, I have marked org.eclipse.mylyn.internal.provisional.commons.ui.dialogs as x-internal in the manifest. This change only affects clients running in strict mode that where relying on the package being publicly visible. 

The org.eclipse.mylyn.internal.provisional.tasks.bugs has been renamed to org.eclipse.mylyn.tasks.bugs. The changes are described on bug 294957.

The consensus was that not marking packages in an internal namespace as x-internal is a defect. While constituting a breaking change in terms of API tooling internal.provisional packages were always considered internal by convention and the changes above restore the clear split between API and internals while avoiding additional baggage caused by deprecating and duplicating classes for instance.

Integrators, please reopen this bug and comment here if these changes cause any problems.