Jump to: navigation, search

Difference between revisions of "OTIndigo"

(Technical Details of Contributing to Indigo)
Line 4: Line 4:
 
</css>
 
</css>
  
The Eclipse Object Teams Project intends to join the [[Indigo]] release train.
+
The Eclipse Object Teams Project joined the [[Indigo]] release train.
 
Here are the details wrt the [http://eclipse.org/helios/planning/EclipseSimultaneousRelease.php Eclipse Simultaneous Release] document.
 
Here are the details wrt the [http://eclipse.org/helios/planning/EclipseSimultaneousRelease.php Eclipse Simultaneous Release] document.
 +
This page overlaps with [http://eclipse.org/indigo/planning/SimultaneousReleaseOverview.php?action=project&projectid=tools.objectteams] which is generated from the data entered through the portal, but here we give more information on background and details.
  
 
==Do the basics ... early==
 
==Do the basics ... early==
Line 11: Line 12:
  
 
==Planning==
 
==Planning==
* [[Image:Progress.gif]] update project plan
+
* [[Image:Ok_green.gif]] update project plan
  
 
==IP Documentation==
 
==IP Documentation==
Line 27: Line 28:
 
===API===
 
===API===
 
Here is where the fun starts :)
 
Here is where the fun starts :)
* '''todo''': document non-standard usage
+
* [[Image:Progress.gif]] document non-standard usage:
** usage of internal classes
+
** [[OTDT/NonAPI]]
** aspect binding to bundle
+
** patch feature for <code>org.eclipse.jdt.core</code>, approved as an exception by the Eclipse PMC, see [http://dev.eclipse.org/mhonarc/lists/eclipse-pmc/msg01338.html this post] and its replies.
*** decapsulation
+
*** interception
+
** patch feature for <code>org.eclipse.jdt.core</code>
+
 
* [[Image:Progress.gif]] Eclipse-wide strategy for dealing with all kinds of exceptions
 
* [[Image:Progress.gif]] Eclipse-wide strategy for dealing with all kinds of exceptions
 
** [[Equinox/p2/Proposals/Install_Capabilities]]
 
** [[Equinox/p2/Proposals/Install_Capabilities]]
Line 43: Line 41:
  
 
===Message Bundles===
 
===Message Bundles===
* [[Image:Progress.gif]] mostly done.
+
* [[Image:Ok_green.gif]] done.
  
 
===Version Numbers===
 
===Version Numbers===
Line 58: Line 56:
  
 
===Jarred Bundles===
 
===Jarred Bundles===
* [[Image:Progress.gif]] most bundles are jarred
+
* [[Image:Ok_green.gif]] most bundles are jarred
** [[Image:Glass.gif]] check the following exceptions, is unpacking still needed?
+
** some bundles required some tweaking during the 0.8 cycle:
*** [[Image:Ok_green.gif]] otdt: changing to jarred install seems to work out of the box, more testing needed
+
*** [[Image:Ok_green.gif]] otdt: changing to jarred install worked out of the box
 
*** [[Image:Ok_green.gif]] otdt.ui.help: got it to work with the little patch in {{bug|329806}}
 
*** [[Image:Ok_green.gif]] otdt.ui.help: got it to work with the little patch in {{bug|329806}}
*** [[Image:Glass.gif]] otdt.samples: could be difficult to persuade the pde.ui.samples extension point to work off a jarred plug-in.
+
** one bundle still requires <code>unpack=false</code> for technical reasons:
 +
*** [[Image:Unsupport.gif]] otdt.samples: could not be persuaded, the pde.ui.samples extension point doesn't work off a jarred plug-in.
 
**: I filed {{bug|332748}} to track this last reason for unpacking.
 
**: I filed {{bug|332748}} to track this last reason for unpacking.
  
Line 69: Line 68:
  
 
===Capabilities===
 
===Capabilities===
* '''todo'''
+
* [[Image:Ok_green.gif]] [[OTCapabilities]]
  
 
===Support Translations===
 
===Support Translations===
* [[Image:Progress.gif]] string externalization is mostly done, participation in babel TODO
+
* [[Image:Progress.gif]] string externalization is done, participation in babel initiated, waiting for our project to appear in the translation tool.
  
 
===Excel in NL support===
 
===Excel in NL support===
* [[Image:Glass.gif]] investigate where this would make sense
+
* [[Image:Ok_green.gif]] the only relevant class was <code>java.text.MessageFormat</code>, which has been fully replaced by <code>org.eclipse.osgi.util.NLS</code>.
  
 
===Branding===
 
===Branding===

Revision as of 14:59, 1 March 2011


The Eclipse Object Teams Project joined the Indigo release train. Here are the details wrt the Eclipse Simultaneous Release document. This page overlaps with [1] which is generated from the data entered through the portal, but here we give more information on background and details.

Do the basics ... early

  • Ok green.gif express statement of intent in the Portal

Planning

  • Ok green.gif update project plan

IP Documentation

  • Progress.gif ongoing

Release Review

  • (typically at RC2)

Play well with others ... to be in common repository

Communication

  • Ok green.gif subscribe to cross-project mailing list (sherrmann)
  • Ok green.gif subscribe to cross-project bugzilla inbox (sherrmann)
  • Ok green.gif provide contact details for build engineer (see objectteams.b3aggrcon).

API

Here is where the fun starts :)

  • Progress.gif document non-standard usage:
    • OTDT/NonAPI
    • patch feature for org.eclipse.jdt.core, approved as an exception by the Eclipse PMC, see this post and its replies.
  • Progress.gif Eclipse-wide strategy for dealing with all kinds of exceptions
  • Glass.gif further discussion (process & technology)
    • API requests in bugzilla
    • extended friend mechanisms?
      • integrate with API tools?
      • establish communication protocol between teams?

Message Bundles

  • Ok green.gif done.

Version Numbers

  • Ok green.gif 4-part version numbers are consistently used

OSGi bundle format

  • Ok green.gif all plugins are true OSGi bundles.

Execution Environment

  • Ok green.gif all bundles have BREE set to J2SE-1.5

Signing

  • Ok green.gif all jars are signed on build.eclipse.org

Jarred Bundles

  • Ok green.gif most bundles are jarred
    • some bundles required some tweaking during the 0.8 cycle:
      • Ok green.gif otdt: changing to jarred install worked out of the box
      • Ok green.gif otdt.ui.help: got it to work with the little patch in bug 329806
    • one bundle still requires unpack=false for technical reasons:
      • Unsupport.gif otdt.samples: could not be persuaded, the pde.ui.samples extension point doesn't work off a jarred plug-in.
      I filed bug 332748 to track this last reason for unpacking.

Re-use and share

  • Ok green.gif the only external dependency org.apache.bcel is consumed from Orbit.

Capabilities

Support Translations

  • Progress.gif string externalization is done, participation in babel initiated, waiting for our project to appear in the translation tool.

Excel in NL support

  • Ok green.gif the only relevant class was java.text.MessageFormat, which has been fully replaced by org.eclipse.osgi.util.NLS.

Branding

  • Ok green.gif About dialog icon with details is in place.

Do No Harm

  • Glass.gif potential incompatibilities could arise from
    • other feature providing a patch to org.eclipse.jdt.core, too. => incompatible
    • other feature applying bytecode weaving, too. Needs investigation, should be possible.
    • actually p2 touchpoints don't currently support smooth installation of several plug-ins using adaptor hooks (see bug 329784).
    • OTDT's aspect bindings interfering with other features. Shouldn't happen, if it happens we can fix on short notice.
  • Glass.gif planning to cross-test the OTDT with other bytecode weaving plugins installed
    • These are not part of Indigo: AJDT, Greclipse, Scala IDE
    • any weaving bundles in Indigo?

License text consistency

  • Ok green.gif Release 0.7.0 already consistently uses the June 15, 2010 version of about texts etc.


Be a good Eclipse Citizen ... and document it

Engage Community

  • Ok green.gif New&Noteworthy documents are available at each milestone (cumulative up-to release)

Usability

  • Ok green.gif Mimic and extend JDT's lead.

Performance

  • todo

Test Localization

  • todo

Enable Use with All Languages

  • todo awaiting users from non-western locals for input

Builds

Ramp Down Planned and Defined

  • todo

Accessibility

  • todo

Unit Tests

  • Ok green.gif currently more than 45400 tests
    • Glass.gif publish test results?

API Policy

  • Progress.gif will follow general rules concerning x-internal etc.

Retention Policy

  • todo

Project Metrics

  • Progress.gif docuware from 0.7.0 release revies should be a good starting point

Technical Details of Contributing to Indigo

  • Ok green.gif As documented in OTBuilding the automated build includes creating a deployable p2 repository with these properties
    • signed
    • with pack200 files
    • accumulative meta data per minor release
    • categorized
  • Ok green.gif Our contribution has been committed by following the steps in Indigo/Contributing_to_Indigo_Build:
    • We are contributing our features to the Programming Languages category, and OT/Equinox also to the EclipseRT Target Platform Components category, see objectteams.b3aggrcon
  • Ok green.gif Two issues were fixed during joining the aggregation build:
    • Our pack200 files were affected by incompatibility between JDK 5 & 6 (see bug 311469#6 ff.).
    • The platform filter of our fragment org.eclipse.objectteams.otequinox.sunjvm had a typo which was never reported (see bug 329984, bug 329985).