Difference between revisions of "Sphinx/environment"

Revision as of 04:38, 11 September 2015

This page explains how to setup an environment required for developing Sphinx. It consists of a minimal Eclipse IDE, an appropriate target platform and the source code of Sphinx.

Recommended: Automated setup

1. Download and start Eclipse Installer (Oomph).
2. Download the installer configuration for Sphinx Sphinx.setup.
3. On the initial page, click on the Switch to advanced mode button in the top right.
4. On the Product page, select Eclipse Modeling Tools.
5. Drag and Drop the Sphinx.setup file into the Projects Page.
6. On the Projects page, double-click <user>/Sphinx.
7. Choose your preferred installation settings on the Variables page.
8. Finish the wizard, drink a cup of coffee, and watch how your Sphinx development environment is assembled.

The Sphinx.setup will provide:

• The Eclipse IDE
• Source Code
• Configuration of Mylyn Queries (Tasks and Build)
• Working Sets
• Initial Target configuration (which should be refined later)

Alternative: Manual setup

If you don't like the magic of the Eclipse Installer, you can set up the Eclipse IDE and get the source code manually:

Setting up an Eclipse IDE

Download and install the latest Eclipse Modeling Tools package.

Getting the source code

Git repository access

The source code of Sphinx is managed in a Git repository that can be accessed in one of the following ways:

Read-only access:

• URL: git://git.eclipse.org/gitroot/sphinx/org.eclipse.sphinx.git
• User name: <leave empty>
• Password: <leave empty>

TODO list other access options

Cloning and importing the source code with EGit

The recommended way to clone and import the source code of Sphinx is to use EGit - the Eclipse Team provider for Git:

• Open the Git Repository Exploring perspective
• Click on the Clone a Git Repository and add the clone to this view button
• Enter the Git repository access data using one of the options indicated above, and then click on Next
• Select the relevant Git repository branches (e.g. master), and then click on Next
• Make sure that Import all existing projects after clone finishes is checked and then click on Finish
• Wait until the cloning process has been completed and go back to the Plug-in Development perspective

Setting the target platform

Sphinx provides target platform definitions for the two latest 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).

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 Juno;
• 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.

Building Shinx

cd releng/org.eclipse.sphinx.releng.builds
mvn clean install -Dplatform.version.name=mars