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.
Difference between revisions of "Sphinx/getting"
(→Getting the last build) |
(Add explaination about the use of the update archive file for a target platform) |
||
| Line 6: | Line 6: | ||
Once downloaded, unzip the archive file in an empty directory. Then unjar each feature file that is contained in the ''features'' subdirectory. | Once downloaded, unzip the archive file in an empty directory. Then unjar each feature file that is contained in the ''features'' subdirectory. | ||
| + | |||
| + | ==Getting the last update contents== | ||
| + | The previous [https://hudson.eclipse.org/hudson/job/buckminster-sphinx-0.7-helios/ download site] also offers an up-to-date archive file that consists in the contents of an update site. This file is called <code>mdt-sphinx-Update-x.y.z.yymmdd-hhmm.zip</code>. | ||
| + | This file is perfect for people who develop tools based on Sphinx but do not modify Sphinx itself. Indeed, it can be used in a target definition, as explained below. | ||
| + | |||
| + | Suppose that your project uses the plug-in <code>org.eclipse.sphinx.emf.explorer</code>. You need to add Sphinx in your target platform to build your project. | ||
| + | * Create a project called <code>contribs</code> in your workspace and copy the Sphinx update archive there. This archive is called <code>mdt-sphinx-Update-0.7.0.20120418-1100.zip</code> in this example; | ||
| + | * Edit your target definition file and add the following lines: | ||
| + | <location includeAllPlatforms="false" includeMode="planner" includeSource="true" type="InstallableUnit"> | ||
| + | <unit id="org.eclipse.sphinx.emf" version="0.7.0.20120418-1100"/> | ||
| + | <unit id="org.eclipse.sphinx.emf.explorer" version="0.7.0.20120418-1100"/> | ||
| + | <repository location="jar:file:/${workspace_loc}/contribs/mdt-sphinx-Update-0.7.0.20120418-1100.zip!/"/> | ||
| + | </location> | ||
| + | * Set this file as target platform. | ||
==Getting Sphinx through an update site== | ==Getting Sphinx through an update site== | ||
The update site of Sphinx is not yet settled. | The update site of Sphinx is not yet settled. | ||
| + | A workaround consists in using the archive file with the contents of such an update site, as explained before. | ||
Revision as of 08:21, 15 May 2012
This page is for developers of tools based on Sphinx. It aims at providing a procedure to get Sphinx for this purpose. People who want to get Sphinx sources to modify it may read this page.
Getting the last build
Builds are periodically performed. The last successful build can be downloaded from this page: https://hudson.eclipse.org/hudson/job/buckminster-sphinx-0.7-helios/
Once downloaded, unzip the archive file in an empty directory. Then unjar each feature file that is contained in the features subdirectory.
Getting the last update contents
The previous download site also offers an up-to-date archive file that consists in the contents of an update site. This file is called mdt-sphinx-Update-x.y.z.yymmdd-hhmm.zip.
This file is perfect for people who develop tools based on Sphinx but do not modify Sphinx itself. Indeed, it can be used in a target definition, as explained below.
Suppose that your project uses the plug-in org.eclipse.sphinx.emf.explorer. You need to add Sphinx in your target platform to build your project.
- Create a project called
contribsin your workspace and copy the Sphinx update archive there. This archive is calledmdt-sphinx-Update-0.7.0.20120418-1100.zipin this example; - Edit your target definition file and add the following lines:
<location includeAllPlatforms="false" includeMode="planner" includeSource="true" type="InstallableUnit">
<unit id="org.eclipse.sphinx.emf" version="0.7.0.20120418-1100"/>
<unit id="org.eclipse.sphinx.emf.explorer" version="0.7.0.20120418-1100"/>
<repository location="jar:file:/${workspace_loc}/contribs/mdt-sphinx-Update-0.7.0.20120418-1100.zip!/"/>
</location>
- Set this file as target platform.
Getting Sphinx through an update site
The update site of Sphinx is not yet settled. A workaround consists in using the archive file with the contents of such an update site, as explained before.