Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Sphinx/environment

< Sphinx
Revision as of 03:35, 28 April 2011 by Jftilman.laposte.net (Talk | contribs) (Setting the target platform: Remove the optional build of a local target platform)

This page aims at providing a procedure to get Sphinx sources and settle a development environment.

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. Subversive may be installed from the following update sites:

Install the following feature groups:

  • Subversive SVN Team Provider Plugin (Incubation)
  • Subversive SVN Connectors

SVN checkout

SVN repository configuration

Create a new SVN repository with the following attributes:

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

Patch of target platform items

Some components of the target platform have to be patched so as to incorporate bugs fixes and/or enhancements that are not yet available in the original versions of the same. The installation of these patches is automated by an Ant script:

  • Right click on file org.eclipse.sphinx.targetdefs/ant/apply-patches/Apply Target Platform Patches.launch;
  • Select Run As/Apply Target Platform Patches.

The script copies the patched plug-ins and features over their originals and rebuilds the full workspace. After completion, it is recommended to restart the workbench.

Related bugs

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 Helios;
  • Install EMF - Eclipse Modeling Framework SDK in Modeling category.

Creating the library model projects

  • Open menu File/New/Other...;
  • Select Examples/Eclipse Modeling Framework/Extended Library Model Example;
  • Finish the creation and rebuild if necessary the sources.

Back to the top