Jump to: navigation, search

Difference between revisions of "Acceleo/ReleaseReview"

Line 82: Line 82:
  
 
Each document of the documentation set deals with a different aspect of mastering Acceleo :
 
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 (description of the Acceleo/OCL library), and a Text Production Rules documentation.
+
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.
  
Acceleo Plug-ins Features Overview
+
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.
This document provides an overview of the user-visible features of the Acceleo plug-ins which make it easy to develop and run Acceleo modules inside Eclipse
+
  
Acceleo Tutorials
+
Basic Examples are available in the example category : UML to Java and Ecore to Python.
Create a new module
+
Create a new plug-in to launch the module
+
  
Basic Examples
+
There is also a basic information page on the Eclipse Wiki http://wiki.eclipse.org/Acceleo
UML to Java
+
Ecore to Python
+
  
Basic Page on the Eclipse Wiki http://wiki.eclipse.org/Acceleo
+
==Bugzilla==
 +
 
 +
Note : these figure is subject to change as the whole team is in the process of fixing bugs until the final release (this snapshot has been taken on May 26, 2010)‏
 +
 
 +
==Tool usability==
 +
Localization : integrated into Babel
 +
 
 +
==Standards==
 +
This implementation of Acceleo is based on the OMG MOF Model-To-Text Standard : TODO lien

Revision as of 06:02, 26 May 2010

Helios Release Review - Acceleo 3.0

Helios Simultaneous Release

Release Review and Graduation Review

Jonathan Musset (jonathan.musset@obeo.fr)

Release Review : June 11, 2010

Communication Channel : eclipse.modeling.m2t newsgroup

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

Project Plan : http://www.eclipse.org/modeling/m2t/acceleo/plan-helios.xml

Helios Release Highlights

Graduation

Acceleo graduates with its Helios release. This usually means the plugin grows from version 0.x to version 1.0. However, Acceleo already has a version history and an existing adopter community. In order not to unsettle this community and to stay coherent with our history, Acceleo will jump under eclipse from version 0.8 to version 3.0 (as the last released version on Acceleo.org was 2.x).

New and noteworthy

Quality of APIs

The component lead certifies that the requirements for Eclipse Quality APIs have been met for this release. All non-API code in "internal" packages.

End of Life Issues

None

Committer Diversity

4 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.

CQ 2518 - The Content includes items that have been sourced from the OMG MTL 1.0 specification : http://www.omg.org/spec/MOFM2T/1.0/

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 significant contributions of the IP log are written 100% by employees of the same employer (Obeo) as the Submitting Committer (http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).

All contribution Questionnaires have been completed.

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

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 Acceleo IP log is located at http://www.eclipse.org/projects/ip_log.php?projectid=modeling.m2t.acceleo

Non-Code Aspects

Unit tests

706 unit tests launched on every build. 1219 unit tests launched on every day.

Code coverage is about : - 71 % of the code generation engine - 84 % of the compiler - 29 % of the UI

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 46% of the Java source code.

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

APIs

Metamodel definitions and corresponding implementations are considered APIs.

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

Commitment to provide stand-alone code generation.

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

Documentation

The documentation that comes with Acceleo 3.0 is available in the Help menu : Acceleo Model To Text Transformation Language.

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 figure is subject to change as the whole team is in the process of fixing bugs until the final release (this snapshot has been taken on May 26, 2010)‏

Tool usability

Localization : integrated into Babel

Standards

This implementation of Acceleo is based on the OMG MOF Model-To-Text Standard : TODO lien