Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Sirius/Contributor Guide"
< Sirius
(→Getting the Sources) |
(→Development Environment) |
||
| Line 10: | Line 10: | ||
* ''Maven 3.0 or 3.1'', available from http://maven.apache.org/: required to build from the command-line (and make sure your changes will not break the build). | * ''Maven 3.0 or 3.1'', available from http://maven.apache.org/: required to build from the command-line (and make sure your changes will not break the build). | ||
* Optional: ''Git 1.8'' or later, available from http://git-scm.com/downloads, if you need/want to use the command-line for commit/push/merge/rebase/etc. | * Optional: ''Git 1.8'' or later, available from http://git-scm.com/downloads, if you need/want to use the command-line for commit/push/merge/rebase/etc. | ||
| − | * Optional: ''Target Platform Definition DSL and Generator 2.0 or later'', available from http://mbarbero.github.io/fr.obeo.releng.targetplatform/p2/latest/. | + | * Optional: ''Target Platform Definition DSL and Generator 2.0 or later'', available from http://mbarbero.github.io/fr.obeo.releng.targetplatform/p2/latest/ (Note: on Kepler you also need to add http://download.eclipse.org/modeling/tmf/xtext/updates/releases/ to get Xtext 2.5 which is not available by default on Kepler). This tools is needed only if you need to change the Target Platform definition files (<code>*.targetplatform</code> and <code>*.tpd</code>) and re-generate the <code>*.target</code> files. In normal development you do not need this and can simply use the generated <code>*.target</code> themselves. |
Of course you are free to use any additional tools you want to make your development experience more pleasant for you. However, do not commit anything which adds new requirements without getting approval from the development team. | Of course you are free to use any additional tools you want to make your development experience more pleasant for you. However, do not commit anything which adds new requirements without getting approval from the development team. | ||
Revision as of 06:56, 28 March 2014
Contents
Development Environment
The standard environment to develop Sirius itself is currently:
- Java 1.6. You can use a JRE 1.7 (or later) to run your Eclipse developement environement if you want, but you need a Java 1.6 installed and configured as the default in your Eclipse to make sure the Sirius code works with 1.6.
- Eclipse 4.3.2 (Kepler SR2) SDK, with the following additional plug-ins:
- EMF SDK 2.9.2, available from the Kepler update-site: required to manage our meta-models and generate the corresponding code.
- Eclipse CheckStyle Plug-in 5.6.1, available from http://eclipse-cs.sf.net/update/: required to make sure new code follows the CheckStyle-enforced rules.
- Mylyn WikiText, available from the Kepler update-site: required to re-generated the HTML documentation from the Textile sources.
- EGit 3.3.0: required to get the Sirius sources (not strictly required actually, if you prefer to use the command-line exclusively).
- Maven 3.0 or 3.1, available from http://maven.apache.org/: required to build from the command-line (and make sure your changes will not break the build).
- Optional: Git 1.8 or later, available from http://git-scm.com/downloads, if you need/want to use the command-line for commit/push/merge/rebase/etc.
- Optional: Target Platform Definition DSL and Generator 2.0 or later, available from http://mbarbero.github.io/fr.obeo.releng.targetplatform/p2/latest/ (Note: on Kepler you also need to add http://download.eclipse.org/modeling/tmf/xtext/updates/releases/ to get Xtext 2.5 which is not available by default on Kepler). This tools is needed only if you need to change the Target Platform definition files (
*.targetplatformand*.tpd) and re-generate the*.targetfiles. In normal development you do not need this and can simply use the generated*.targetthemselves.
Of course you are free to use any additional tools you want to make your development experience more pleasant for you. However, do not commit anything which adds new requirements without getting approval from the development team.
Getting the Sources
The source code for Sirius is visible at http://git.eclipse.org/c/sirius/org.eclipse.sirius.git. Note that this is a web page, not a Git repository. Do not try to clone using this URL, see instead the URLs at the bottom of that page.
A Team Project Set (*.psf) file which is normally kept up-to-date can be obtained from http://git.eclipse.org/c/sirius/org.eclipse.sirius.git/plain/releng/org.eclipse.sirius.settings/sirius.psf.
Once you have all the sources in your workspace:
- Make sure the "Missing API Baseline" does not cause compilation errors: Window > Preferences > Plug-in Development: Set "Missing API Baseline" to "Warning" (or "Ignore").
- Open one of the
.targetfiles from theorg.eclipse.sirius.targetsproject in the target editor and (once it is loaded) set it as the current target.