Bug 493659 - Extension point org.eclipse.e4.ui.css.swt.theme.org.eclipse.e4.ui.css.swt.theme not in Help
Summary: Extension point org.eclipse.e4.ui.css.swt.theme.org.eclipse.e4.ui.css.swt.the...
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.6   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.6 RC3   Edit
Assignee: Dani Megert CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2016-05-13 10:30 EDT by Dani Megert CLA
Modified: 2016-05-24 04:00 EDT (History)
5 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2016-05-13 10:30:26 EDT 
4.6 RC1

Extension point org.eclipse.e4.ui.css.swt.theme.org.eclipse.e4.ui.css.swt.theme not in Help.


I will take that one.
Comment 1 Lars Vogel CLA 2016-05-13 10:49:41 EDT 
Dnai, I know you know that, but just for general FYI these extension points are not API.
Comment 2 Dani Megert CLA 2016-05-13 10:59:55 EDT 
(In reply to Lars Vogel from comment #1)
> Dnai, I know you know that, but just for general FYI these extension points
> are not API.

Why should I or anyone else know? It is not marked as such.
Comment 3 Lars Vogel CLA 2016-05-13 11:07:02 EDT 
(In reply to Dani Megert from comment #2)
> (In reply to Lars Vogel from comment #1)
> > Dnai, I know you know that, but just for general FYI these extension points
> > are not API.
> 
> Why should I or anyone else know? It is not marked as such.

You should know because IIRC you and Brian had this discussion last year for 4.5 or the year before for 4.4.
Comment 4 Lars Vogel CLA 2016-05-13 11:08:13 EDT 
Adding Brian for clarification.
Comment 5 Brian de Alwis CLA 2016-05-13 13:24:12 EDT 
We could mark the schema as being provisional.

The extension points need to fleshing out to specify their applicability.  The SWT properties, for example, don't make sense for a workbench engine.
Comment 6 Dani Megert CLA 2016-05-14 12:04:34 EDT 
(In reply to Brian de Alwis from comment #5)
> We could mark the schema as being provisional.

There is no such thing when we release. It is API or internal. Do you expect clients outside Platform UI to use it?
Comment 7 Brian de Alwis CLA 2016-05-14 22:22:42 EDT 
Then it's internal.  Currently the only other users are experimental packages in e4.ui
Comment 8 Dani Megert CLA 2016-05-16 04:08:17 EDT 
(In reply to Brian de Alwis from comment #7)
> Then it's internal.  Currently the only other users are experimental
> packages in e4.ui

Fixed with http://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=f7d28488aa19cdbda23b5fdbc755173acdab40c6
Comment 9 Dani Megert CLA 2016-05-17 01:56:22 EDT 
Verified in eclipse-SDK-I20160516-2000-win32-x86_64.
Comment 10 Frank Appel CLA 2016-05-23 01:29:22 EDT 
Hi folks, I'm using the extension point org.eclipse.e4.ui.css.swt.theme to provide the Clean Sheet theme (http://fappel.github.io/xiliary/clean-sheet.html). I'm currently updating to the 4.6 development stream and now run into the problem that this EP has been marked as internal. Is there another option to add a theme which I'm not aware of?

In general, it seems to me that it is a bad practice to declare an extension point as internal after it has been published for a while. I would assume that the proper way to handle this should be to declare it as deprecated. Any suggestions?
Comment 11 Dani Megert CLA 2016-05-23 04:05:31 EDT 
(In reply to Frank Appel from comment #10)
> Hi folks, I'm using the extension point org.eclipse.e4.ui.css.swt.theme to
> provide the Clean Sheet theme
> (http://fappel.github.io/xiliary/clean-sheet.html). I'm currently updating
> to the 4.6 development stream and now run into the problem that this EP has
> been marked as internal. Is there another option to add a theme which I'm
> not aware of?
> 
> In general, it seems to me that it is a bad practice to declare an extension
> point as internal after it has been published for a while. I would assume
> that the proper way to handle this should be to declare it as deprecated.
> Any suggestions?

Please open a bug to polish the extension point for 4.6.1 and add it to the Help. So far, it was not part of our documentation.
Comment 12 Lars Vogel CLA 2016-05-23 04:24:56 EDT 
(In reply to Frank Appel from comment #10)
 
> In general, it seems to me that it is a bad practice to declare an extension
> point as internal after it has been published for a while. 

Sounds reasonable, this sounds like a violation of our API contract. I think we should revert the internal flag for RC3. Dani?
Comment 13 Dani Megert CLA 2016-05-23 04:34:09 EDT 
(In reply to Lars Vogel from comment #12)
> (In reply to Frank Appel from comment #10)
>  
> > In general, it seems to me that it is a bad practice to declare an extension
> > point as internal after it has been published for a while. 
> 
> Sounds reasonable, this sounds like a violation of our API contract. I think
> we should revert the internal flag for RC3. Dani?

Fair enough, but then we should also add it to the doc.
Comment 14 Dani Megert CLA 2016-05-23 04:38:05 EDT 
(In reply to Dani Megert from comment #13)
> > Sounds reasonable, this sounds like a violation of our API contract. I think
> > we should revert the internal flag for RC3. Dani?
> 
> Fair enough, but then we should also add it to the doc.

I've reverted the change with http://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=9889223f782ae3191407d0343c68d014f70694c0


Working on the doc now...
Comment 15 Dani Megert CLA 2016-05-23 05:01:46 EDT 
Fixed with (In reply to Dani Megert from comment #14)
> Working on the doc now...

Fixed with http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4e49b6306d68a131191c1d304b9a8d7fa5a1e045
Comment 16 Frank Appel CLA 2016-05-24 01:08:21 EDT 
Thanks for the quick resolution :-)
Comment 17 Dani Megert CLA 2016-05-24 04:00:16 EDT 
Verified in eclipse-SDK-I20160523-2000-win32-x86_64.