Revision as of 05:33, 25 May 2012

Eclipse Juno (3.8/4.2) Release Review - Mylyn Intent 0.7

Alex Lagarde (alex.lagarde@obeo.fr)

Release Review : June, 2012

Communication Channel : [1] (newsgroup) & [2] (mailing list)

Process Documentation : http://www.eclipse.org/projects/dev_process/development_process.php

Project Plan : http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent

Introduction

Intent is a tool allowing developers to easily write a documentation up-to-date with any development artifact (models, code, environment...).

The documentation, integrated with other Eclipse tools, then becomes truly useful and is no longer a burden that developer have to carry to please their customers or their project manager.

Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent will try to reconcile developers with Documentation.

Fore more details about Intent scope, please refer to Intent Project mission statements

Features

As listed in the Project Plan, Intent 0.7 provides the following features :

• Mylyn Intent IDE integration : An authoring environment allowing to create, manage and author Intent projects through the Eclipse IDE (editor, wizards...)
• Doc generators For Wikitext : A set of generators for Wikitext documents (Latex, html...)
• Doc generators For Intent document : A set of generators allowing to export an Intent Project to several formats (HTML Bootstrap...)

Notice that another (yet completely optionnal) feature provides an exemple of contribution to Intent. However, this feature is not included inside the juno update site (you have to check http://download.eclipse.org/intent/updates/milestones/0.7 ).

Non-Code Aspects

• Website: The Website has been reworked for the release and reflects the latest information
• User documentation: Intent Wiki includes Getting Started Tutorials and some more detailed documentation.
• Full talk transcripts: every talk gave at technical conferences (like EclipseCon) are made available to readers Agile ALM Connect 2012 and EclipseConEurope 2011
• Video demonstrations : representative Intent video demonstrations are available on wiki

Basically, any relevant informations (new blog bost, getting started guides...) is listed in the useful links wiki page

Code Aspects

API

Mylyn Intent 0.7 is still in incubation, and moreover this is its first release. We have made effort to make the API as complete as possible, but we do not forbid ourselves to make minor breaks in the API for the next year release. We do not plan to graduate next year: next release will be Intent 0.8 and will stay in incubation phase.

Committer Diversity

3 Committers from Obeo, and 2 individual committers.

IP Issues

The about files and use licenses are in place as per the Guidelines to Legal Documentation.

All other contributions (code, documentation, images, etc) have been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy. The other contributions of the IP log are not significant or are written 100% by employees of the same employer (Obeo) as the Submitting Committer (http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).

The "provider" field of each plugin is set to "Eclipse Mylyn".

The "copyright" field of each plugin is set to the copyright owner.

Any third-party logos or trademarks included in the distribution (icons, logos, etc) have been licensed under the EPL.

The Intent 0.7 IP log is located at http://www.eclipse.org/projects/ip_log.php?projectid=mylyn.docs.intent

Non-Code Aspects

Unit tests

2477 unit tests are launched every day.

Code coverage is about:

• 82.9 % of the traceability engine
• 80.6 % of the compiler
• 61.7 % of the code generation engine

Code quality

Checkstyle activated on each distinct plug-in.

Eclemma used on a regular basis to improve test coverage.

Yourkit used on a regular basis to improve performances.

Javadoc represents more than 44% of the Java source code.

An Ohloh page is available at http://www.ohloh.net/p/acceleo-eclipse/analyses/latest

APIs

Metamodel definitions and interfaces are considered APIs.

Commitment to provide stand-alone code generation.

Non-API classes are separated from the exposed API through an "internal" namespace.

API Tooling is activated on all plugins to mark exceptions within the exposed API.

Non-API packages are exported with an internal visibility as such they are visible but with an illegal access warning.

Documentation

The documentation that comes with Acceleo 3.3 is available in the Help menu : Acceleo Documentation.

Each document of the documentation set deals with a different aspect of mastering Acceleo : There are a Plug-in Overview, a Quick Start, an Android Code Generation Tutorial, a User Guide, several short tutotials to create code generation projects, an Acceleo/OCL operations reference to describe the Acceleo/OCL library, and a Text Production Rules document.

The main documentation is the User Guide because it fully describes each and every feature of Acceleo. From the installation to the execution with a trip through the editing features, it gives an in-depth description of everything there is to know about Acceleo.

Basic Examples are available in the example category : UML to Java, and Ecore to Python.

There is also a basic information page on the Eclipse Wiki http://wiki.eclipse.org/Acceleo

Bugzilla

Note : these figures are subject to changes as the whole team is in the process of fixing bugs until the final release (this snapshot has been taken on Mai 22, 2011)‏

Tool usability

Localization : integrated into Babel

Standards

This implementation of Acceleo is based on the OMG MOF Model-To-Text OMG Standard : http://www.omg.org/spec/MOFM2T/1.0/

End of Life

There are no specific end of life concerns for this release.

Communities

Talks have been given on the following events:

• Acceleo at Code Generation 2011: http://www.codegeneration.net/cg2011/sessioninfo.php?session=24

Talks have been given during EclipseCon 2012.

Other medium:

• Activity on the M2T newsgroup (eclipse.modeling.m2t): more than 80 threads on Acceleo from June 2010 to May 2011
• Twitter account of the Acceleo project: http://twitter.com/acceleo
• Google+ account of the Acceleo project: https://plus.google.com/114651471803085159652
• Acceleo on stack overflow: http://stackoverflow.com/tags/acceleo/info

Committer Changes

None

Schedule

Acceleo 3.3 Release Plan

RC1	05/22/2012
RC2	05/29/2012
Final  06/05/2012
3.3    06/23/2012

Project Plan

The Acceleo 3.3 project plan is available at http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/m2t/acceleo/plan-juno.xml

What's next?

Legal Notices

Java and all Java-based trademarks are trademarks of Oracle, Inc. in the United States, other countries, or both.

UML, OMG, EMOF, OCL and XMI are trademarks of the Object Management Group.

Other company, product, or service names may be trademarks or service marks of others.