Afzonderlijke bronbundels

De traditionele indeling van bronbundels in Eclipse was een map met src.zip's voor alle plugins die in een bepaalde feature waren opgenomen. Met ingang van 3.4 wordt Eclipse geleverd met afzonderlijke bronbundels. Elke bundel heeft een bijbehorende bronbundel: een JAR-bestand met de bron voor die bundel. Hierdoor kan levering van de bron flexibeler verlopen en doen zich bovendien minder problemen voor met de padlengte op sommige platformen.

Eclipse-SourceBundle

Een bronbundel wordt geïdentificeerd door de aanwezigheid van de header Eclipse-SourceBundle in zijn manifest. De indeling van deze header is:

Eclipse-SourceBundle: <bundle-id>;version=<version>;roots:="root1, root2"

Het bundel-ID en de versie geven de bundel aan waarbij de opgenomen broncode hoort. De roots-instructie geeft de mappen binnen de bronbundel aan die werkelijk broncode bevatten. Als er geen roots-instructie is opgegeven, wordt de waarde "." als standaardoptie gebruikt.

Bibliotheken van klassenbestanden worden op voorspelbare wijze toegewezen aan bronlocaties. De hoofdmap van de plugin verwijst naar de hoofdmap van de bronbundel. Voor de meeste plugins die zijn opgenomen in JAR-bestanden is dit het geval. Als de plugin aanvullende "foo/lib.jar"-bibliotheken bevat, wordt verwacht dat de bron zich bevindt in de bijbehorende "foo/libsrc/"-mappen in de bronbundels.

Afzonderlijke bronbundels genereren

PDE/Build kan automatisch afzonderlijke bronbundels genereren, maar alleen in een naamloze build. Het genereren van afzonderlijke bronbundels kan worden ingeschakeld door het volgende op te geven:

individualSourceBundles=true

Geef dit op in het buildconfiguratiebestand build.properties op het hoogste niveau. Dit bestand bestuurt het genereren van alle bronnen voor die build. Raadpleeg Bronfeatures en -plugins genereren voor meer informatie over het genereren van traditionele bronplugins en -features. Op de rest van deze pagina wordt verondersteld dat u bekend bent met traditionele brongeneratie.

generate.feature

In het bestand build.properties van een feature geeft de eigenschap generate.feature aan pde.build door dat een bronfeature moet worden gegenereerd.
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*

Bij het genereren van afzonderlijke bronbundels blijft deze eigenschap gehandhaafd en ondersteunt deze dezelfde kenmerken (bijvoorbeeld version, unpack, optional). Het verschil wordt duidelijk in de resulterende bronfeature. Voorheen bevatte de bronfeature één bronplugin en een bronfragment voor elk te bouwen platform. In de nieuwe indeling bevat de bronfeature een bronbundel voor elke plugin of elk fragment opgenomen in de oorspronkelijke feature.

Plugins die zijn opgenomen in de bronfeature via de plugin@-syntaxis krijgen geen bijbehorende bronbundels. Dit is handig voor het toevoegen van doc-plugins aan de bronfeature.

Het item exclude@ is nieuw voor het genereren van afzonderlijke bronnen. Het kan zijn dat sommige plugins die in de oorspronkelijke feature waren opgenomen (bijvoorbeeld doc-plugins of fragmenten die alleen native code bevatten) geen bron hebben en moeten worden uitgesloten van de gegenereerde bronfeature. Het item exclude@ ondersteunt een version-kenmerk.

Voorbeeld:
generate.feature@org.eclipse.jdt.source=org.eclipse.jdt, plugin@org.eclipse.jdt.doc.isv;unpack="false",exclude@org.eclipse.jdt.doc.user

generate.plugin

In de oude indeling genereert de eigenschap generate.plugin een bronplugin op basis van de inhoud van een bepaalde feature. Bij het genereren van afzonderlijke bronbundels verandert dit en wordt een bronplugin gegeneerd op basis van een bepaalde plugin:

generate.plugin@<source plug-in id>=<plug-in id>

De eigenschap generate.plugin werd door features gebruikt om een bron op te nemen zonder een bronfeature te hebben (ofschoon achter de schermen een volledige bronfeature werd gegenereerd). Bij het genereren van afzonderlijke bronbundels, moeten features een *.-bronbundel opnemen voor elke plugin en een bijbehorende generate.plugin-eigenschap.

Voorbeeld: De feature sdk.examples zag er voorheen als volgt uit:

   	<feature id="org.eclipse.sdk.examples"  ... > 
		....
		<plugin id="org.eclipse.sdk.examples.source"  version="0.0.0"/>
		<plugin id="org.eclipse.sdk.examples.source.win32.win32.x86" version="0.0.0"/>
	</feature>

generate.plugin@org.eclipse.sdk.examples.source=org.eclipse.sdk.examples

Dit verandert in:

	<feature id="org.eclipse.sdk.examples" ...>
		...
		<plugin id="org.eclipse.compare.examples.source"  version="0.0.0"/>
		<plugin id="org.eclipse.debug.examples.core.source" version="0.0.0"/>
		<plugin id="org.eclipse.swt.examples.source" version="0.0.0"/>
	</feature>

generate.plugin@org.eclipse.compare.examples.source=org.eclipse.compare.examples generate.plugin@org.eclipse.debug.examples.core.source=org.eclipse.debug.examples.core generate.plugin@org.eclipse.swt.examples.source=org.eclipse.swt.examples

generateSourceBundle

Voor bepaalde plugins zijn bronbundels mogelijk niet nodig omdat deze niet werkelijk bronnen bevatten. Dit kan voorkomen bij platform-specifieke fragmenten die alleen een native bibliotheek bevatten. In dit geval kan de feature bundels uitsluiten, zoals hierboven is beschreven bij generate.feature.

Ook kan voor bundels in hun eigen build.properties-bestand expliciet zijn opgegeven dat er voor de bundels geen bronbundels worden gegenereerd:

generateSourceBundle=false

Aangepaste inhoud

Aangepaste inhoud kan altijd worden toegevoegd aan gegenereerde bronbundels met de post.gather.source custom callback in de oorspronkelijke bundel. (Raadpleeg Aangepaste buildstappen voor features en plugins).

Wanneer u dit doet, stelt u de eigenschap "src.additionalRoots" in het bestand build.properties van de plugin in zodat de gegenereerde bronbundel de juiste roots-instructie heeft in de header Eclipse-SourceBundle.

Voorbeeld:

org.junit4 :
   build.properties
      src.includes = about.html,junitsrc.zip
      src.additionalRoots=junitsrc
      customBuildCallbacks=customBuildCallbacks.xml

   customBuildCallbacks.xml
    	<target name="post.gather.sources" >
		<mkdir dir="${target.folder}/junitsrc"/>
		<unzip src="${target.folder}/junitsrc.zip" dest="${target.folder}/junitsrc" overwrite="false"/>
		<delete file="${destination.temp.folder}/junitsrc.zip" />		
	</target>

Branding van de bronfeature

Voorheen diende de gegenereerde bronplugin als een branding-plugin voor de gegenereerde bronfeature. Branding-bestanden (bijvoorbeeld about.properties, eclipse32.gif) werden beschikbaar gesteld via de directory sourceTemplatePlugin in de oorspronkelijke feature.

Bij het genereren van afzonderlijke bronbundels zal de branding-plugin voor de bronfeature de bronbundel zijn die hoort bij de oorspronkelijke branding-plugin. Dit betekent dat branding-bestanden voor de branding-plugin van de bronfeature kunnen worden toegevoegd met de eigenschap src.includes van de oorspronkelijke branding-plugin.

De map sourceTemplatePlugin van de feature waarvoor bronnen worden gemaakt, voegt ook bestanden toe aan de branding-plugin.

sourceTemplatePlugin of sourceTemplateBundle

Voorheen werd de inhoud van de directory sourceTemplatePlugin van de oorspronkelijke feature gekopieerd naar de bronplugin. Bij het genereren van afzonderlijke bronbundels blijft dit alleen gelden voor de branding-bronbundel (zie hierboven).

Voor alle andere bronbundels wordt de inhoud van de directory sourceTemplateBundle gekopieerd.