Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

m (Development Environment)
 
(204 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
== Development Environment  ==
 
== Development Environment  ==
  
To ease the development on Papyrus, each member of the team works with basically the same configuration. <br>
+
To ease the development of Papyrus, each member of the team works with basically the same configuration.
Following is a description of the configuration for Eclipse Indigo and Eclipse Helios
+
There are two ways to get your development environment:
=== Eclipse Indigo ===
+
* downloading and installing Eclipse
*Can be used with the Papyrus Head.
+
* using the [[Eclipse Installer]] (by Oomph) to manage your Papyrus development workbench.
*[http://www.eclipse.org/downloads/packages/release/indigo/] The latest Eclipse Indigo Modeling release.
+
*GMF >= 3.4 . Use following update site: http://download.eclipse.org/modeling/gmp/updates/milestones/
+
*[http://www.eclipse.org/projects/project_summary.php?projectid=technology.subversive] SVN Subversive (or Subclipse)  
+
*[http://eclipse-cs.sourceforge.net/downloads.html] CheckStyle
+
*[http://jautodoc.sourceforge.net/] JAutoDoc
+
  
You can also use the target platform defined here:
+
=== Java Version ===
*http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/releng/TargetPlatform/Indigo_developers.target
+
OpenJDK 11 (or higher) is recommended.
  
=== Eclipse Helios ===
+
=== Downloading Eclipse ===
*Can be used with Papyrus 7.x branch.
+
You can download a fresh Eclipse Package release on this [https://www.eclipse.org/downloads/packages/ page].  
*[http://www.eclipse.org/downloads/packages/eclipse-modeling-tools-includes-incubating-components/heliossr1] Eclipse Modeling 3.6. GMF needs to be install on top of this release.
+
We advise you to download the Eclipse Committer version.
*[http://download.eclipse.org/tools/orbit/downloads/drops/S20100120144102/bundles/org.antlr.runtime_3.0.0.v200803061811.jar] ANTLR 3.0.0. Download this plug-in and put it into the dropins folder.  
+
*[http://www.eclipse.org/projects/project_summary.php?projectid=technology.subversive] SVN Subversive (or Subclipse)
+
*[http://eclipse-cs.sourceforge.net/downloads.html] CheckStyle
+
*[http://jautodoc.sourceforge.net/] JAutoDoc
+
  
== Development Plan  ==
+
=== Papyrus Oomph Setup Model ===
  
=== Specifications ===
+
The [[Eclipse Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
  
The specifications are available here&nbsp;: http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications
+
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse.  On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on.  Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like.  In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform.  This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
  
== Getting the code  ==
+
Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.
  
=== Connecting to the svn  ===
+
Amongst possibly other details, the setup model configures:
  
The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/  
+
* your IDE with all of the tools needed to edit and build the source projects you choose
 +
* your workspace with a Git clone and the source projects imported from it that you choose
 +
* a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
 +
* Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
 +
* Mylyn queries for the status of the latest Papyrus automated builds, including tests
 +
* Mylyn queries for open Gerrit reviews
 +
* preferences enforcing the Papyrus standard compiler and code formatter/template settings
  
=== Retrieve code  ===
+
Please report bugs if you see any problems in the setup configuration.
  
[[PSF]] Following files will allow you to import all Papyrus plugins used during build phase:
+
Follow the following link for a step by step installation guide: [[Papyrus_Developer_Guide/Papyrus_With_Oomph | Oomph setup guide]]
* Nightly Builds:
+
** for subversive plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subversive_N.psf PSF Subversive PSF]
+
** for subclipse plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subclipse_N.psf PSF Subclipse PSF]
+
  
=== Retrieve configuration files  ===
+
=== Installation Details ===
  
The Papyrus [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Code Templates] and [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Java Formatter] files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"<br> [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]<br> [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]<br> Checkstyle&nbsp;: available soon <br>
+
Following is a description of the basic configuration:  
  
[http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
+
*The latest Eclipse release pertinent to your use-cases (Modeling, Committer, java, etc)
 +
*the Papyrus release (matching your Eclipse version), installed from the relevant [https://www.eclipse.org/papyrus/download.html#main Papyrus update site]  
 +
** Papyrus SDK
 +
** Papyrus Toolsmiths
 +
** Papyrus Releng Tools
 +
** Papyrus User Examples
  
== Papyrus Generation  ==
+
===Additional Useful Tools===
 +
*[http://jautodoc.sourceforge.net/ JAutoDoc]
 +
* install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases)
  
*Papyrus generation mechanism is explained here&nbsp;: [[Papyrus Developer Guide/Papyrus diagram generation]]
+
==Configuration==
 +
*Configure the header template according to your company: Eclipse Preferences -&gt; Java -&gt; JAutodoc
 +
*Configure your Eclipse.ini file adding this line in the ''vmargs'':
 +
<pre>-Duser.name=FirstName LastName (Company) <user@email></pre>
 +
*Java 11:
 +
**Eclipse Preferences -&gt; Java -&gt; Compiler
 +
**Eclipse Preferences -&gt; Java -&gt; Installed JREs
 +
**VM Arguments for debug mode:
 +
<pre>-Dosgi.requiredJavaVersion=11 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
 +
</pre>
  
== Papyrus Code Standards ==
+
=== Gerrit Configuration ===
 +
*[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to configure Gerrit]]
  
*Java Doc - every class, method and field including private ones should be documented with Java Doc
+
=== API Management Configuration ===
*No abbreviations - the class, methods and variables should have meaningful names
+
There are two way to manage your code version:
*Formatting - the code should be formatted in accordance with format templates
+
*define yourself the API baseline for Papyrus using [https://help.eclipse.org/2020-06/index.jsp?nav=%2F4_2_3 Eclipse Preference API Baseline]
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!
+
*Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]]
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied&nbsp;: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...  
+
*In case of doubt - check existing code from those following the rules&nbsp;:-)
+
  
== Papyrus Coding guidelines  ==
+
*API Rules:
 +
**[[Evolving_Java-based_APIs]]
 +
**[[Evolving_Java-based_APIs_2]]
 +
**[[Evolving_Java-based_APIs_3]]
  
A few points may be a little tricky when coding for Papyrus. Among them&nbsp;:  
+
=== Apply Papyrus Configuration Files  ===
 +
Papyrus provides configuration files for Template, CleanUp, and Format for java code.
 +
Register these files into your Eclipse Preferences.
 +
The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/Papyrus%20Code%20templates.xml Code Templates], [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_cleanup.xml Java Cleanup] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_formatter.xml Java Formatter] files are available under the Papyrus repository in the folder '''releng/templates/''' and should be used for all your development on Papyrus.
  
*The usage of editing domains and gmf/gef/emf commands. See this detailed article [[Papyrus Developer Guide/Editing Domains and Commands]]
+
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
  
== Papyrus Bugzilla usage  ==
+
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
  
When adding a task to the buzilla, the following grammar should be used:
+
[https://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
  
*'[' ''Category'' ']' ''NameOfTheTask''<br>
+
== How To ...  ==
  
The category helps to filter the bugs for developers. There are already some existing categories: General, XXX Diagram, Common, Property View, etc.  
+
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
  
== Papyrus Log  ==
+
=== Clone Papyrus Git Repository ===
  
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]]
+
The Papyrus code and its documentations are located in a Git repository. In the website [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git] you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).
  
== Papyrus Build Process  ==
+
Follow this [[Papyrus_Developer_Guide/Papyrus_Git_Tutorial | quick tutorial]] if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.
  
*Papyrus build process on Athena is explained here [[Papyrus Developer Guide/Build Process]].<br>
+
=== Code Contributions and Reviews ===
  
== Papyrus Creation Type  ==
+
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]]
  
*mechanism of type creation used in the model explorer and in the property view is explained&nbsp;[[Papyrus_Developer_Guide\Type_Creation|Papyrus Developer Guide/Type Creation]] <br>
+
=== Papyrus Plug-ins and Features  ===
  
== Papyrus Command Execution, History, Undo/Redo  ==
+
* [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
The following document tries to explain how the differents Eclipse Command frameworks work and how they are related.
+
It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.
+
* http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/architecture/commandExecution.doc
+
<br>
+
  
Following UML model with code reverse can also be useful:
+
== Release Engineering ==
*http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.di
+
 
*http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.notation
+
=== Contributing To The Plan For The Release ===
*http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.uml
+
 
<br>
+
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
 +
 
 +
=== Release Process ===
 +
 
 +
*[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]].
 +
 
 +
=== API Evolution ===
 +
 
 +
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]
 +
 
 +
[[Category:Papyrus]]

Latest revision as of 11:09, 19 November 2020

Development Environment

To ease the development of Papyrus, each member of the team works with basically the same configuration. There are two ways to get your development environment:

  • downloading and installing Eclipse
  • using the Eclipse Installer (by Oomph) to manage your Papyrus development workbench.

Java Version

OpenJDK 11 (or higher) is recommended.

Downloading Eclipse

You can download a fresh Eclipse Package release on this page. We advise you to download the Eclipse Committer version.

Papyrus Oomph Setup Model

The Eclipse Installer provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.

Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand Eclipse.org / Papyrus to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).

Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.

Amongst possibly other details, the setup model configures:

  • your IDE with all of the tools needed to edit and build the source projects you choose
  • your workspace with a Git clone and the source projects imported from it that you choose
  • a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
  • Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
  • Mylyn queries for the status of the latest Papyrus automated builds, including tests
  • Mylyn queries for open Gerrit reviews
  • preferences enforcing the Papyrus standard compiler and code formatter/template settings

Please report bugs if you see any problems in the setup configuration.

Follow the following link for a step by step installation guide: Oomph setup guide

Installation Details

Following is a description of the basic configuration:

  • The latest Eclipse release pertinent to your use-cases (Modeling, Committer, java, etc)
  • the Papyrus release (matching your Eclipse version), installed from the relevant Papyrus update site
    • Papyrus SDK
    • Papyrus Toolsmiths
    • Papyrus Releng Tools
    • Papyrus User Examples

Additional Useful Tools

  • JAutoDoc
  • install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases)

Configuration

  • Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
  • Configure your Eclipse.ini file adding this line in the vmargs:
-Duser.name=FirstName LastName (Company) <user@email>
  • Java 11:
    • Eclipse Preferences -> Java -> Compiler
    • Eclipse Preferences -> Java -> Installed JREs
    • VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=11 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled

Gerrit Configuration

API Management Configuration

There are two way to manage your code version:

Apply Papyrus Configuration Files

Papyrus provides configuration files for Template, CleanUp, and Format for java code. Register these files into your Eclipse Preferences. The Papyrus Code Templates, Java Cleanup and Java Formatter files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.

FAQ How do I control the Java formatter

FAQ How can templates make me the fastest coder ever

The note explains how to install the templates in your environment.

How To ...

Each developer must follow the following rule in addition to the aforementioned Developer Charter.

Clone Papyrus Git Repository

The Papyrus code and its documentations are located in a Git repository. In the website http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).

Follow this quick tutorial if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.

Code Contributions and Reviews

Papyrus Plug-ins and Features

Release Engineering

Contributing To The Plan For The Release

Release Process

API Evolution

Back to the top