Individuelle kildebunter

Det tradisjonelle formatet til kildebunter i Eclipse var en mappe som inneholdt src.zip for alle plugin-modulene i en gitt funksjon. Fra 3.4 av sendes Eclipse ut med individuelle kildebunter. For hver bunt er det en tilsvarende kildebunt som er en JAR-fil som inneholder kilden for bunten. Dette muliggjør mer fleksibel levering av kilde, og det løser også noen banelengdeproblemer som kan oppstå på enkelte plattformer.

Eclipse-SourceBundle

En kildebunt identifiseres ved tilstedeværelsen av startsekvensen Eclipse-SourceBundle i manifestet. Formatet til denne startsekvensen er:

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

Bunt-IDen og versjonen angir bunten som den inkluderte kildekoden tilsvarer. roots-direktivet angir mappene i kildebunten som faktisk inneholder kildekoden. Hvis ikke noe roots-direktiv angis, antas verdien ".".

Klassefilbiblioteker tilordnes til kildeplasseringer på en forutsigbar måte. Roten for plugin-modulen tilordnets til roten for kildebunten. Dette er hovedprinsippet for de fleste plugin-moduler i JAR-filer. Hvis plugin-modulen inneholder tilleggsbiblioteker som "foo/lib.jar", forventes kilden å være i tilsvarende "foo/libsrc/"-mapper i kildebuntene.

Generere individuelle kildebunter

PDE/Build kan automatisk generere individuelle kildebunter, men bare i en headless-bygging. Generering av individuelle kildebunter kan slås på ved å oppgi:

individualSourceBundles=true

Dette må spesifiseres i byggekonfigurasjonens build.properties-fil på toppnivå, og den styrer all kildegenerering for bygget. Se Generere kildefunksjoner og plugin-moduler hvis du vil vite mer om å generere tradisjonelle kilde-plugin-moduler og -funksjoner. Resten av denne siden antar at du er kjent med tradisjonell kildegenerering.

generate.feature

I en funksjons build.properties-fil gir egenskapen generate.feature beskjed til pde.build om å generere en kildefunksjon.
generate.feature@<kildefunksjons-id> = <feature id> [, feature@<funksjons-id>]* [, plugin@<plugin-id>]* [, exclude@<plugin-id>]*

Når individuelle kildebunter genereres, forblir denne egenskapen som den var, og støtter samme attributter (f.eks. version, unpack, optional, etc). Forskjellen merkes i kildefunksjonen. Tidligere hadde kildefunksjonen en kilde-plugin og et kildefragment for hver plattform som ble bygd. I det nye formatet vil kildefunksjonen inkludere en kildebunt for hver(t) plugin-funksjon/fragment som er oppført i den opprinnelige funksjonen.

Plugin-moduler som ble inkludert i kildefunksjonen via plugin@-syntaksen, får ikke tilsvarende kildebunter. Dette er nyttig ved tilføyelse av dokument-plugin-moduler i kildefunksjonen.

exclude@-oppføringen er ny for individuell kildegenerering. Noen plugin-moduler som ble inkludert i opprinnelsesfunksjonen (som DOC-plugin-moduler eller fragmenter som bare inneholder intern kode) har kanskje ikke kilde, og bør derfor utelukkes fra den genererte kildefunksjonen. exclude@-oppføringen støtter et version-attributt.

Eksempel:
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

I det gamle formatet genererer egenskapen generate.plugin en kilde-plugin på grunnlag av innholdet i en gitt funksjon. Ved generering av individuelle kildebunter endres dette til å baseres på en gitt plugin-modul:

generate.plugin@<kilde-plugin-id>=<plugin-id>

Egenskapen generate.plugin ble brukt av funksjoner til å inkludere kilder uten å ha en kildefunksjon (selv om det bak det hele ble generert en hel kildefunksjon). Ved generering av individuell kildebunt må funksjonene inkludere en *.source-bunt for hver plugin-modul sammen med en tilsvarende generate.plugin-egenskap for hver.

Eksempel: Funksjonen sdk.examples så tidligere slik ut:

   	<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

Dette er nå endret til:

	<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

Bestemte plugin-moduler krever kanskje ikke kildebunter fordi de ikke faktisk inneholder kilde. Dette kan skje med plattformspesifikke fragmenter som bare inneholder et internt bibliotek. I så fall kan buntene ekskluderes av funksjonen som antydet over i generate.feature.

Eller buntene kan eksplisitt angi i sin egen build.properties-fil at ingen kildebunt skal genereres for dem:

generateSourceBundle=false

Tilpasset innhold

Tilpasset innhold kan alltid legges til i genererte kildebunter ved hjelp av det tilpassede tilbakekallet post.gather.source i opprinnelsesbunten. (Se Trinn i tilpasset bygging).

Når du gjør dette, definerer du egenskapen "src.additionalRoots" i plugin-modulens build.properties-fil slik at den genererte kildebunten har riktig roots-direktiv på startsekvensen Eclipse-SourceBundle.

Eksempel:

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>

Merke kildefunksjonen

Tidligere fungerte den genererte kilde-plugin-modulen som en plugin-modul for merkevarebygging for den genererte kildefunksjonen. Merking av filer (about.properties, eclipse32.gif osv.) besørges ved hjelp av sourceTemplatePlugin-katalogen i den opprinnelige funksjonen.

Ved generering av individuelle kildebunter vil plugin-modulen for merkevarebygging for kildefunksjonen være den kildebunten som tilsvarer den opprinnelige plugin-modulen for merkevarebygging. Det betyr at merking av filer for kildefunksjonens plugin-modul for merkevarebygging kan bidras ved hjelp av egenskapen src.includes i den opprinnelige plugin-modulen for merkevarebygging.

sourceTemplatePlugin-mappen til funksjonen som vi genererer kilde for, bidrar også med filer til plugin-modulen for merkevarebygging.

sourceTemplatePlugin kontra sourceTemplateBundle

Tidligere ble innholdet i sourceTemplatePlugin-katalogen kopiert til kilde-plugin-modulen. Ved generering av individuelle kildebunter gjelder dette nå bare for merkekildebunten (se over).

For alle de andre kildebuntene kopieres innholdet i en sourceTemplateBundle-katalog over.