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 "Sphinx/environment"
< Sphinx
(→Setting the Eclipse environment) |
|||
| Line 1: | Line 1: | ||
| − | This page explains how to setup | + | 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. |
| − | ==Setting | + | ==Setting up an Eclipse IDE== |
| − | + | ||
| − | |||
[http://eclipse.org/downloads Download] and [http://wiki.eclipse.org/Eclipse/Installation install] the latest '''Eclipse Modeling Tools''' package. | [http://eclipse.org/downloads Download] and [http://wiki.eclipse.org/Eclipse/Installation install] the latest '''Eclipse Modeling Tools''' package. | ||
| − | == | + | ==Getting the source code== |
| − | ===Git repository | + | |
| − | + | ===Git repository access=== | |
| + | |||
| + | The source code of Sphinx is managed in a [http://git-scm.com Git] repository that can be accessed in one of the following ways: | ||
| + | |||
| + | Read-only access: | ||
* URL: git://git.eclipse.org/gitroot/mdt/org.eclipse.sphinx.git | * URL: git://git.eclipse.org/gitroot/mdt/org.eclipse.sphinx.git | ||
| − | * User: ''<empty>'' | + | * User name: ''<leave empty>'' |
| − | * Password: ''<empty>'' | + | * Password: ''<leave empty>'' |
| − | === | + | TODO list other access options |
| − | Open the ''Git Repository Exploring'' | + | |
| − | * Right-click on the | + | ===Cloning and importing the source code with EGit=== |
| − | * Click on ''Import Projects...'' | + | |
| + | The recommended way to clone and import the source code of Sphinx is to use [http://eclipse.org/egit EGit] - the Eclipse Team provider for Git: | ||
| + | * Open the ''Git Repository Exploring'' perspective | ||
| + | * TODO Add missing steps (Click on the Clone button, etc.) | ||
| + | * Right-click on the Sphinx Git repository clone | ||
| + | * Click on ''Import Projects...'', and the on ''Next'' | ||
| + | * Select all or a meaningful subset of Sphinx projects to be imported from your local Git clone into the Eclipse workspace | ||
| + | * Click on ''Finish'' | ||
==Setting the target platform== | ==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. | |
| − | Sphinx provides target platform definitions for the two | + | |
* Open the target definition file ''xxx.target'' that corresponds to the Eclipse release you want to work with; | * 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; | * 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). | * Click on link ''Set as Target Platform'' (in the upper right corner of the target editor). | ||
| − | |||
| − | |||
| − | |||
==Creating an EMF example library model== | ==Creating an EMF example library model== | ||
| Line 36: | Line 41: | ||
First, we have to install EMF SDK in the Eclipse environment. | First, we have to install EMF SDK in the Eclipse environment. | ||
* Open menu ''Help/Install New Software...''; | * Open menu ''Help/Install New Software...''; | ||
| − | * Select work with '' | + | * Select work with ''Juno''; |
* Install ''EMF - Eclipse Modeling Framework SDK'' in ''Modeling'' category. | * Install ''EMF - Eclipse Modeling Framework SDK'' in ''Modeling'' category. | ||
Revision as of 17:41, 8 January 2013
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.
Contents
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/mdt/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
- TODO Add missing steps (Click on the Clone button, etc.)
- Right-click on the Sphinx Git repository clone
- Click on Import Projects..., and the on Next
- Select all or a meaningful subset of Sphinx projects to be imported from your local Git clone into the Eclipse workspace
- Click on Finish
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.