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 "EPP/Obsolete/Configuration File Format"
< EPP
(Initial description of the configuration file used to build EPP packages) |
|||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | {{warning|Note: The contents of this page is obsolete, but it may still contain some interesting tid-bits.}} | ||
+ | |||
+ | [[Category:EPP:Obsolete]] | ||
==Templates and Working EPP Configuration File Examples== | ==Templates and Working EPP Configuration File Examples== | ||
− | + | Note that this file is only used for generating the EPP website content, and please also note that most parts of the original file are note required any more! The content definition of a package is done in three projects, one of them is the branding plug-in, the other is the root feature that contains, and the last one contains the .product file for the actual build. | |
+ | |||
+ | By definition, this file is called <code>epp.website.xml</code> and located in the feature of each package. | ||
+ | |||
<code><pre> | <code><pre> | ||
− | + | git clone git://git.eclipse.org/gitroot/epp/org.eclipse.epp.packages.git | |
</pre></code> | </pre></code> | ||
+ | See [[EPP/Packaging Site]] with a description of the proposed additional information. | ||
==Example with Comments== | ==Example with Comments== | ||
Line 13: | Line 20: | ||
<!-- version: The RCP version to build. This is used to determine the file | <!-- version: The RCP version to build. This is used to determine the file | ||
name of the root file archives --> | name of the root file archives --> | ||
− | <rcp version="3. | + | <rcp version="3.5M7" /> |
<!-- name: The name of the product, used in naming the created files. | <!-- name: The name of the product, used in naming the created files. | ||
− | eclipseProductId: ID of the product for RCP builds | + | eclipseProductId: ID of the product for RCP builds (NOT USED ANY MORE) |
− | initialPerspectiveId: ID of the perspective that will be opened first --> | + | initialPerspectiveId: ID of the perspective that will be opened first (NOT USED ANY MORE) --> |
<product | <product | ||
name="eclipse-java-ganymede-M4" | name="eclipse-java-ganymede-M4" | ||
Line 23: | Line 30: | ||
initialPerspectiveId="org.eclipse.jdt.ui.JavaPerspective" /> | initialPerspectiveId="org.eclipse.jdt.ui.JavaPerspective" /> | ||
− | <!-- Collection of Eclipse Update Sites --> | + | <!-- Collection of Eclipse Update Sites (NOT USED ANY MORE) --> |
<updateSites> | <updateSites> | ||
<!-- url: The URL (without site.xml) that points to a valid Eclipse Update Site. | <!-- url: The URL (without site.xml) that points to a valid Eclipse Update Site. | ||
Line 31: | Line 38: | ||
</updateSites> | </updateSites> | ||
− | <!-- A list of root features that will put into the package --> | + | <!-- A list of root features that will put into the package (NOT USED ANY MORE) --> |
<requiredFeatures> | <requiredFeatures> | ||
− | <!-- A single | + | <!-- A single feature |
− | id: The feature ID | + | id: The feature ID (NOT USED ANY MORE) |
version: 'latest' will pick up the feature with the highest version number available | version: 'latest' will pick up the feature with the highest version number available | ||
− | on the update sites. Otherwise, the correct version number must be set. --> | + | on the update sites. Otherwise, the correct version number must be set. (NOT USED ANY MORE) --> |
<feature | <feature | ||
id="org.eclipse.platform" | id="org.eclipse.platform" | ||
Line 59: | Line 66: | ||
<!-- folder: Pointing to a folder containing the zipped root files for each of the target platforms. | <!-- folder: Pointing to a folder containing the zipped root files for each of the target platforms. | ||
− | May be specified relative to this configuration file. | + | May be specified relative to this configuration file. (NOT USED ANY MORE) |
EPP expects Eclipse Platform archives in there with a name derived from the 'rcp version' | EPP expects Eclipse Platform archives in there with a name derived from the 'rcp version' | ||
attribute above, e.g. eclipse-platform-3.4M4-linux-gtk.tar.gz --> | attribute above, e.g. eclipse-platform-3.4M4-linux-gtk.tar.gz --> | ||
Line 65: | Line 72: | ||
− | <!-- relativeFolder: Name of a subfolder where a local update site mirror will be created. --> | + | <!-- relativeFolder: Name of a subfolder where a local update site mirror will be created. (NOT USED ANY MORE) --> |
<extensionSite relativeFolder="extension_site"></extensionSite> | <extensionSite relativeFolder="extension_site"></extensionSite> | ||
<!-- Create archives for win32, linux, macosx platforms, antZip is default format --> | <!-- Create archives for win32, linux, macosx platforms, antZip is default format --> | ||
− | <!-- Define the target platforms that will be build --> | + | <!-- Define the target platforms that will be build (NOT USED ANY MORE) --> |
<targetPlatforms> | <targetPlatforms> | ||
<!-- Definition of a single platform | <!-- Definition of a single platform | ||
− | os: OS | + | os: OS (NOT USED ANY MORE) |
− | ws: Windowing System | + | ws: Windowing System (NOT USED ANY MORE) |
− | arch: CPU architecture --> | + | arch: CPU architecture (NOT USED ANY MORE) --> |
<platform os="win32" ws="win32" arch="x86"> | <platform os="win32" ws="win32" arch="x86"> | ||
Latest revision as of 21:29, 6 May 2021
Templates and Working EPP Configuration File Examples
Note that this file is only used for generating the EPP website content, and please also note that most parts of the original file are note required any more! The content definition of a package is done in three projects, one of them is the branding plug-in, the other is the root feature that contains, and the last one contains the .product file for the actual build.
By definition, this file is called epp.website.xml
and located in the feature of each package.
git clone git://git.eclipse.org/gitroot/epp/org.eclipse.epp.packages.git
See EPP/Packaging Site with a description of the proposed additional information.
Example with Comments
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- version: The RCP version to build. This is used to determine the file
name of the root file archives -->
<rcp version="3.5M7" />
<!-- name: The name of the product, used in naming the created files.
eclipseProductId: ID of the product for RCP builds (NOT USED ANY MORE)
initialPerspectiveId: ID of the perspective that will be opened first (NOT USED ANY MORE) -->
<product
name="eclipse-java-ganymede-M4"
eclipseProductId="org.eclipse.platform.ide"
initialPerspectiveId="org.eclipse.jdt.ui.JavaPerspective" />
<!-- Collection of Eclipse Update Sites (NOT USED ANY MORE) -->
<updateSites>
<!-- url: The URL (without site.xml) that points to a valid Eclipse Update Site.
The features that are given below are searched for on all sites. -->
<updateSite url="file:///home/data/httpd/download.eclipse.org/releases/ganymede/staging/" />
<updateSite url="file:///home/data/httpd/download.eclipse.org/technology/epp/updates/0.5milestones/" />
</updateSites>
<!-- A list of root features that will put into the package (NOT USED ANY MORE) -->
<requiredFeatures>
<!-- A single feature
id: The feature ID (NOT USED ANY MORE)
version: 'latest' will pick up the feature with the highest version number available
on the update sites. Otherwise, the correct version number must be set. (NOT USED ANY MORE) -->
<feature
id="org.eclipse.platform"
version="latest">
</feature>
<feature
id="org.eclipse.cvs"
version="latest">
</feature>
<feature
id="org.eclipse.jdt"
version="latest">
</feature>
<feature
id="org.eclipse.epp.usagedata.feature"
version="latest">
</feature>
</requiredFeatures>
<!-- folder: Pointing to a folder containing the zipped root files for each of the target platforms.
May be specified relative to this configuration file. (NOT USED ANY MORE)
EPP expects Eclipse Platform archives in there with a name derived from the 'rcp version'
attribute above, e.g. eclipse-platform-3.4M4-linux-gtk.tar.gz -->
<rootFileFolder folder="/home/data/httpd/download.eclipse.org/eclipse/downloads/drops/S-3.4M4-200712131700" />
<!-- relativeFolder: Name of a subfolder where a local update site mirror will be created. (NOT USED ANY MORE) -->
<extensionSite relativeFolder="extension_site"></extensionSite>
<!-- Create archives for win32, linux, macosx platforms, antZip is default format -->
<!-- Define the target platforms that will be build (NOT USED ANY MORE) -->
<targetPlatforms>
<!-- Definition of a single platform
os: OS (NOT USED ANY MORE)
ws: Windowing System (NOT USED ANY MORE)
arch: CPU architecture (NOT USED ANY MORE) -->
<platform os="win32" ws="win32" arch="x86">
<!-- Define the output archive format
format: antZip (default), tar (==tar.gz) -->
<archiveFormat format="antZip"></archiveFormat>
<!-- Content of the eclipse.ini file
path: Path to eclipse.ini within the archive (Mac OSX has a special requirement) -->
<eclipseIniFileContent path="/eclipse/">-showsplash
org.eclipse.platform
--launcher.XXMaxPermSize
256M
-vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms40m
-Xmx256m</eclipseIniFileContent>
</platform>
<platform os="linux" ws="gtk" arch="x86">
<archiveFormat format="tar" />
<eclipseIniFileContent path="/eclipse/">-showsplash
org.eclipse.platform
-vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms40m
-Xmx256m</eclipseIniFileContent>
</platform>
<platform os="linux" ws="gtk" arch="x86_64">
<archiveFormat format="tar" />
<eclipseIniFileContent path="/eclipse/">-showsplash
org.eclipse.platform
-vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms40m
-Xmx256m</eclipseIniFileContent>
</platform>
<platform os="macosx" ws="carbon" arch="ppc">
<archiveFormat format="tar" />
<eclipseIniFileContent path="/eclipse/Eclipse.app/Contents/MacOS/">-showsplash
org.eclipse.platform
-vmargs
-Xdock:icon=../Resources/Eclipse.icns
-XstartOnFirstThread
-Xms40m
-Xmx256m
-XX:MaxPermSize=256m
-Dosgi.requiredJavaVersion=1.5
-Dorg.eclipse.swt.internal.carbon.smallFonts</eclipseIniFileContent>
</platform>
</targetPlatforms>
</configuration>