Ant-scripts worden meestal gegenereerd met PDE (Plug-in Development Environment), maar het is ook mogelijk om ze
handmatig of met behulp van andere scripts te genereren.
PDE bevat diverse Ant-taken om verschillende buildscripts te genereren.
De faciliteiten voor het genereren van buildscripts
maken deel uit van de volgende taken. Tevens zijn voor elke taak de bijbehorende parameters afgebeeld.
| elementen: |
het item dat wordt opgehaald. De verwachte indeling is type@id[,versie] zoals aangegeven in de directorybestandsindeling; |
| buildDirectory: |
de directory waarin ophaalscripts worden gegenereerd en waarin features en pluginprojecten worden uitgecheckt. |
| directory: |
het pad naar een directorybestand; |
| onderliggende items: |
optioneel, geeft aan of de scriptgenereeropdracht voor ingesloten plugins en fragmenten moet worden aangeroepen. De standaardinstelling is 'true' (waar). |
| cvspassfile: |
optioneel, de naam van een CVS-wachtwoordbestand. |
| fetchTag: |
optioneel, vervangt de code in het directorybestand door de opgegeven waarde. |
| configInfo: |
optioneel, een door en-tekens gescheiden lijst met configuraties die de doelconfiguratie aangeeft. De standaardinstelling is platformonafhankelijk. |
| recursiveGeneration: |
optioneel, geef op of u ophaalscripts wilt genereren voor geneste features. De standaardinstelling is 'true' (waar). |
| elementen: |
het item dat wordt gebouwd. Het item wordt verwacht in de vorm type@id[,versie] zoals opgegeven in de directorybestandsindeling; |
| buildDirectory: |
De directory met de te bouwen features en plugins. Plugins en features moeten zich respectievelijk bevinden in de mappen plugins en features; |
| onderliggende items: |
optioneel, geeft aan of de scriptgenereeropdracht voor ingesloten plugins en fragmenten moet worden aangeroepen. De standaardinstelling is 'true' (waar). |
| recursiveGeneration: |
optioneel, geeft aan of de scriptgenereeropdracht voor ingesloten features moet worden aangeroepen. De standaardinstelling is 'true' (waar). |
| devEntries: |
optioneel, een door komma's gescheiden lijst met directory's die moeten worden doorgegeven aan het compileerklassenpad; |
| buildingOSGi: |
optioneel, geeft aan of het doel 3.x. of 2.1 is. De standaardwaarde is 'true' (waar); |
| baseLocation: |
optioneel, geeft een Eclipse-doelinstallatiemap met de subdirectory's features/ en plugins/ aan; |
| configInfo: |
optioneel, een door en-tekens gescheiden lijst met configuraties die de doelconfiguratie aangeeft. De standaardinstelling is platformonafhankelijk. |
| pluginPath: |
optioneel, een door bestandsscheidingstekens gescheiden lijst van locaties met aanvullende plugins; |
| archivesFormat : |
optioneel, een door en-tekens gescheiden lijst met configuraties en de verwachte indeling van de bijbehorende uitvoer. De indeling moet van de configuratie worden gescheiden door een streepje (-). Geldige waarden zijn: folder, tar, zip en antZip. Deze betekenen respectievelijk: niet archiveren, TAR-archief maken, op het platform beschikbare versie van info-zip gebruiken en Ant-zip-bestand gebruiken. De standaardwaarde is antZip; |
| product: |
optioneel, een door '/'-tekens gescheiden pad naar de locatie van een RCP-product dat u wilt bouwen. Het eerste segment van het pad moet verwijzen naar het plugin-ID van een plugin met het product-bestand; |
| signJars: |
optioneel, geeft aan of JAR's voor features en plugins moeten worden voorzien van een handtekening door de gegenereerde scripts. De standaardinstelling is onwaar. De parameters voor de sign-taak worden bestuurd via de volgende Ant-eigenschappen: sign.alias, sign.keystore en sign.storepass worden respectievelijk doorgegeven aan de parameters alias, keystore en storepass van de Ant-taak signJar. De standaardwaarde is false; |
| generateJnlp: |
optioneel, geeft aan of er een jnlp-bestand moet worden gegenereerd voor alle features die worden gebouwd; |
| outputUpdateJars: |
optioneel, genereert plugins en features in de indeling van de updatesite. De standaardinstelling is onwaar. Merk op dat het bestand site.xml niet wordt gegenereerd of bijgewerkt; |
| groupConfiguration: |
optioneel, geeft aan of alle configuraties die worden gebouwd moeten worden gegroepeerd in één archief; |
| generateVersionsLists: |
optioneel, geeft aan of er eigenschappenbestanden moeten worden gegenereerd met de versies van de gebouwde features en plugins; |
| filteredDependencyCheck : |
optioneel, beperkt de set plugins en features die in aanmerking
komen tijdens de build tot de plugins en features die bereikbaar zijn vanuit de features; |
| filterP2Base : |
optioneel, beperkt de set plugins en features die in aanmerking
komen vanuit de baseLocation tot die die in aanmerking komen voor installatie door p2; |
| generateFeatureVersionSuffix: | optioneel, geeft aan of de featureversiesuffix al dan niet wordt gegenereerd. Zie ook Versiekwalificaties; |
| generatedVersionLength : |
optioneel, de lengte van het gegenereerde suffix voor de featureversie. De standaardinstelling is 28. Zie ook Versiekwalificaties; |
| significantVersionDigits : |
optioneel, het aantal significante cijfers dat moet worden gebruikt bij het genereren van suffixen voor featureversies.
Zie ook Versiekwalificaties; |
| forceContextQualifier: |
optioneel, gebruikt de opgegeven waarde om de .qualifier te vervangen door plugins en features. Zie ook Versiekwalificaties; |
| featureId: |
het ID dat aan de gegenereerde feature wordt gegeven. |
| buildDirectory: |
De directory waarin de op te nemen features en plugins (in de subdirectory's /features en /plugins) zich bevinden. De gegenereerde feature wordt in de subdirectory
/features subdirectory geplaatst. |
| baseLocation: |
optioneel, geeft een map met geïnstalleerde features en plugins aan. |
| productFile: |
optioneel, een productbestand waarop de gegenereerde feature wordt gebaseerd. |
| verify: |
geeft aan of de omzetter al dan niet wordt gebruikt om te controleren of de opgegeven plugins en features beschikbaar zijn. Dit bepaalt ook of de feature wel of niet platformspecifieke fragmenten en plugins kan verwerken die in JAR-bestanden zijn ingepakt. Als alle in de feature op te nemen elementen lokaal beschikbaar zijn, moet verify worden ingesteld op 'true' (waar). Als de elementen moeten worden opgehaald uit een repository, stelt u verify in op 'false", gebruikt u de resulterende feature om de vereiste plugins en features op te halen en genereert u de containerfeature vervolgens opnieuw met behulp van verify = True (waar). |
| pluginPath: |
optioneel, een met een platformbestandsscheidingsblad afgescheiden lijst van locaties waarin aanvullende plugins kunnen worden gevonden. |
| configInfo: |
optioneel, een door en-tekens gescheiden lijst met configuraties die de doelconfiguratie aangeeft. De standaardinstelling is platformonafhankelijk. |
| pluginList: |
optioneel, een door komma's gescheiden lijst met plugin-ID's die in de gegenereerde feature moeten worden opgenomen. (Verderop in dit document vindt u de ondersteunde kenmerken) |
| featureList: |
optioneel, een door komma's gescheiden lijst van feature-ID's
die moeten worden opgenomen in de gegenereerde feature. (Verderop in dit document vindt u de ondersteunde kenmerken) |
| fragmentList: |
optioneel, een door komma's gescheiden lijst met fragment-ID's die in de gegenereerde feature moeten worden opgenomen. (Verderop in dit document vindt u de ondersteunde kenmerken) |
| buildPropertiesFile : |
optioneel, de locatie van een eigenschappenbestand waarvan de
inhoud moet worden gebruikt als build.properties van de gegenereerde feature. |
| includeLaunchers : |
optioneel, om aan te geven of de equinox-startprogramma's moeten worden opgenomen. De standaardwaarde is "true". |
Alle pluginList-, featureList- en fragmentList-argumenten van de taak eclipse.generateFeature ondersteunen kenmerken. Deze parameters hebben de notatie:
List = <element-id>[;<kenmerk>=<waarde>]* [,<element-id>[;<kenmerk>=<waarde>]*]*
Elk paar van kenmerk=waarde wordt ingevoegd in de gegenereerde xml, aan de hand van het aangegeven element. Voorbeeld:
featureList = org.eclipse.feature;optional=true
pluginList = org.eclipse.plugin.A;unpack=true
fragmentList=org.eclipse.fragment.a;os=win32,org.eclipse.fragment.b;os=linux;ws=gtk;arch=x86
<feature ...>
...
<includes id="org.eclipse.feature" version="0.0.0" optional="true" />
...
<plugin id="org.eclipse.plugin.A" version="0.0.0" unpack="true" />
<plugin id="org.eclipse.fragment.a" version="0.0.0" os="win32" fragment="true" />
<plugin id="org.eclipse.fragment.b" version="0.0.0" os="linux" ws="gtk" arch="x86" fragment="true" />
...
</feature>
<eclipse.fetch elements="bundle@org.eclipse.osgi"
buildDirectory="c:\toBuild"
directory="directory.txt"
configInfo="win32,win32,x86 & linux, motif, x86"
/>
<eclipse.buildScript elements="bundle@org.eclipse.osgi"
buildDirectory="c:\toBuild"
archivesFormat="macosx, carbon, ppc - tar"/>
De eerder beschreven taken functioneren alleen als Eclipse wordt uitgevoerd. In het specifieke scenario waarbij Ant-scripts worden uitgevoerd met behulp van Eclipse-taken, moeten de scripts worden uitgevoerd via de Eclipse-toepassing antRunner. De opdrachtregel hiervoor luidt als volgt:
java -jar plugins/org.eclipse.equinox.launcher_<versie>.jar -application org.eclipse.ant.core.antRunner -buildfile build.xml
Opmerking: de parameters na de toepassing zijn de parameters die worden doorgegeven aan Ant.