Sphinx/environment

This page explains how to setup a development environment for Sphinx and get the Sphinx sources.

Setting the Eclipse environment

Before getting Sphinx, the first step consists in setting the required Eclipse environment. The principle consists in using a minimal environment for the edition, and an adapted target platform to compile and run Sphinx.

Install Eclipse

No comments.

Install a Subversion client

We recommend the use of Subversive.

1. Install the feature group Subversive SVN Team Provider (Incubation);
2. Restart Eclipse;
3. Open the SVN Repository Exploring perspective;
4. When asked, install the Subversive SVN Connectors SVN Kit 1.3.5.

SVN checkout

SVN repository configuration

Create a new SVN repository with the following attributes:

• URL: https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.sphinx (caution: https, not http)
• User: <empty>
• Password: <empty>

Import the project set

Sphinx provides a project set that lists all the Sphinx plug-ins/projects.

• Browse the SVN repository
• Check-out the project trunk/tools/org.eclipse.sphinx.psf

Import the sources

Once the project set is downloaded, it is easy to check-out the whole Sphinx project sources.

• Browse the org.eclipse.sphinx.psf project in your workspace
• Right-click on file all-subversive.psf
• Click on Import Project Set...

All the projects of Sphinx are then checked out in your workspace. They are automatically organized into several working sets.

Setting the target platform

Download of the target platform

Sphinx provides target platform definitions for the two last Eclipse releases. These target definitions are in the project org.eclipse.sphinx.targetdefs which is part of the Tools working set.

• Open the target definition file xxx.target that corresponds to the Eclipse release you want to work with;
• Wait for the completion of the Resolving Target Definition operation. This may take a while, in particular at the first time, because all directly and indirectly required target platform plug-ins and features are being downloaded or updated as necessary during that operation. If errors occur, try to close and reopen the target definition file so as to re-trigger the target platform resolution;
• Click on link Set as Target Platform (in the upper right corner of the target editor).

Related bugs

• https://bugs.eclipse.org/bugs/show_bug.cgi?id=340589

Creating an EMF example library model

The example project that is provided with Sphinx makes use of the library model coming from EMF. Thus, we have to get it to be able to compile everything.

Installing EMF SDK

First, we have to install EMF SDK in the Eclipse environment.

• Open menu Help/Install New Software...;
• Select work with Indigo;
• Install EMF - Eclipse Modeling Framework SDK in Modeling category.

Creating the library model projects

• Open menu File/New/Example...;
• Select Eclipse Modeling Framework/Extended Library Model Example;
• Finish the creation and wait until the workspace has been rebuilt.