Bug 254700 - complete internal WikiText release review
Summary: complete internal WikiText release review
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 1.0.0   Edit
Assignee: Mik Kersten CLA
QA Contact:
URL: http://wiki.eclipse.org/Mylyn/Incubat...
Whiteboard:
Keywords:
Depends on: 249244 255367 255368 257592 257593
Blocks: 244650
  Show dependency tree
 
Reported: 2008-11-09 15:18 EST by David Green CLA
Modified: 2011-01-06 10:01 EST (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Green CLA 2008-11-09 15:18:11 EST
Please initiate a release review for WikiText, to move it out of incubation.
Comment 1 Steffen Pingel CLA 2008-11-13 21:21:36 EST
I noticed that all o.e.m.wikitext.*.core plug-ins re-export org.eclipse.mylyn.wikitext.core. My understanding is that re-exporting is generally problematic and should be limited to the rare case where a plug-in is split up into multiple bundles but needs to maintain backwards compatibility. 

Re-exporting makes the same package available from multiple bundles which I believe complicates the resolution process when import package is used. Also it couples the API of the re-exporting bundle to the one that is re-exported. Any API change in o.e.m.wikitext.core would propagate to all other core plug-ins and would require a version update although the API or implementation of those plug-ins may not have changed.

The only minor convenience that I can see is that clients only need to depend on a single bundle instead of requiring o.e.m.wikitext.mediawiki.core and o.e.m.wikitext.core. Are there other advantages or technical reasons for re-exporting?
Comment 2 David Green CLA 2008-11-13 22:52:06 EST
(In reply to comment #1)
> I noticed that all o.e.m.wikitext.*.core plug-ins re-export
> org.eclipse.mylyn.wikitext.core. My understanding is that re-exporting is

Thanks for looking into this

> The only minor convenience that I can see is that clients only need to depend on
> a single bundle instead of requiring o.e.m.wikitext.mediawiki.core and
> o.e.m.wikitext.core. Are there other advantages or technical reasons for
> re-exporting?

This is the only reason that the packages reexport o.e.m.wikitext.core.  If that's not a good reason and it creates problems then I'll fix it.  Let me know what is best practice here.
Comment 3 Steffen Pingel CLA 2008-11-13 23:07:34 EST
I'm +1 for removing the re-exports. The only related thread I could find is this: http://dev.eclipse.org/newslists/news.eclipse.platform/msg53459.html , but there is not much discussion. Mik, do you have any thoughts?
Comment 4 David Green CLA 2008-11-13 23:12:03 EST
(In reply to comment #3)
> I'm +1 for removing the re-exports

Works for me!  I'll get on it.
Comment 5 Steffen Pingel CLA 2008-11-14 01:56:33 EST
David, can you confirm that WikiText meets the applicable Must Do / Should Do criteria for Galileo? If not, could you briefly summarize the (technical) reasons.

http://wiki.eclipse.org/Galileo_Simultaneous_Release#Requirements_For_Participation

APIs: Projects should leverage only published APIs of dependencies. As a Release Review requirement, deviations should be listed as part of a migration plan, with bugs listed where APIs need to be provided by dependent projects. 

Message Bundles: Projects must use Eclipse message bundles unless there are technical reasons not to.

Localization: Must use ICU4J. 

Version Numbering: Projects must use 4-part version numbers.

Leverage OSGi: All plug-ins (bundles) must use the true bundle form. That is, provide a manifest.mf file, and not rely on the plugin.xml file being 'translated' into a manifest.mf file at initial startup.

Execution Environment: All plug-ins must correctly list their required JVM versions in the manifest.mf.

Use Jars: Projects must use jar'ed plug-ins (with unpack=false) unless authorized by the planning council for technical reasons.Nested jars should be avoided if possible since it creates problems for projects that has dependencies to such plug-ins.

Builds: Projects must have build process maturity: scripted, repeatable, and executable by others. 

Orbit: Any new third-party plug-ins that are common between projects must be consumed via Orbit.

Capabilities: Each project will provide basic capability/activity definitions to allow for their UI contributions to be hidden. These must be provided in a separate plugin/feature to facilitate inclusion/exclusion by consumers in product development. 

Usability: Should follow the User Interface Guidelines. 

Accessibility:	 Should design and test for accessibility. 
Comment 6 David Green CLA 2008-12-04 14:25:43 EST
note that a release review has been scheduled for January 8th: http://wiki.eclipse.org/index.php/Mylyn/Meetings
Comment 7 Steffen Pingel CLA 2009-01-08 18:38:11 EST
The release review was completed successfully. I have asked the webmaster to move the wikitext plug-ins to Mylyn proper.
Comment 8 David Green CLA 2009-01-08 19:12:22 EST
(In reply to comment #7)
> The release review was completed successfully. I have asked the webmaster to
> move the wikitext plug-ins to Mylyn proper.

Great, thanks!
Comment 9 David Green CLA 2009-01-12 19:13:55 EST
A release review was performed in the last conference call.
Mik, I'll leave this one for you to close.
Comment 10 Mik Kersten CLA 2009-01-15 13:14:36 EST
Done.  Next step is including this in the Mylyn 3.1 release review.