Individuella källsamlingspaket

Det traditionella formatet på källsamlingspaket i Eclipse var en mapp som innehåller src.zip-filer för alla insticksprogram som ingick i en viss funktion. Från och med 3.4, levereras Eclipse ny med individuella källsamlingspaket. För varje samlingspaket finns det ett motsvarande källsamlingspaket som består av en jar-fil innehållande källan för det samlingspaketet. Det gör det möjligt för mer flexibel leverans av källkod och underlättar dessutom vissa problem med sökvägslängd som kan uppstå på vissa plattformar.

Eclipse-SourceBundle

Ett källsamlingspaket identifieras av närvaron av rubriken Eclipse-SourceBundle i manifestet. Rubriken har följande format:

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

Bundle-id och version ange det samlingspaketet som den inkluderade källkoden motsvarar. Roots-direktivet anger de mappar i källsamlingspaketet som faktiskt innehåller källkod. Om inget roots-direktiv anges, antas värdet "." gälla.

Klassfilsbibliotek kopplas till källplatser på ett förutsägbart sätt. Insticksprogrammet rot kopplas till källsamlingspaketets rot. Detta är det främsta fallet för de flesta insticksprogram i jar-filer. Om insticksprogrammet innehåller ytterligare "foo/lib.jar"-bibliotek, förväntas källan finnas i motsvarande"foo/libsrc/"-mappar i källsamlingspaketen.

Genererar individuella källsamlingspaket

PDE/Build kan automatiskt generera individuella källsamlingspaket, men bara i ett konsollöst bygge. Du kan aktivera generering av individuella källsamlingspaket genom att ange:

individualSourceBundles=true

Detta måste anges i byggkonfigurationsfilen build.properties på den översta nivån. Det styr sedan all källgenerering för det bygget. I Generera källfunktioner och insticksprogram finns mer information om hur du genererar traditionella källinsticksprogram och funktioner. Återstoden av denna sida förutsätter att du är bekant med traditionell källgenerering.

generate.feature

I filen build.properties för en funktion anger egenskapen generate.feature att pde.build ska generera en källfunktion.
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*

När du genererar individuella källsamlingspaket förblir denna egenskap som tidigare och hanterar samma attribut (t.ex.version, unpack, optional etc), skillnaden märks i den resulterande källfunktionen. Tidigare skulle källfunktionen ha inkluderat 1 källinsticksprogram + ett källfragment för varje plattform som byggs. I det nya formatet inkluderar källfunktionen ett källsamlingspaket för varje insticksprogram/fragment som listas i ursprungliga funktionen.

Insticksprogram som inkluderades i källfunktionen via plugin@-syntaxen får inte motsvarande källsamlingspaket. Detta är användbart när du vill lägga till doc-insticksprogram i källfunktionen.

Posten exclude@ är ny för generering av individuella källor. Vissa insticksprogram som inkluderades i ursprungsfunktionen (dvs. doc-insticksprogram eller fragment som bara innehåller ursprunglig kod) har kanske inte källa och bör exkluderas från den genererade källfunktionen. Posten exclude@ hanterar ett version-attribut.

Exempel:
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 gamla formatet genererade egenskapen generate.plugin ett källinsticksprogram baserat på innehållet i en given funktion. När du genererar individuella källsamlingspaket ändras detta till att baseras på ett givet insticksprogram:

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

Egenskapen generate.plugin användes av funktioner till att inkludera källa utan att ha en källfunktion (även om en hel källfunktion genererades bakom kulisserna). När du genererar enskilda källsamlingspaket, måste funktioner inkludera ett *.source-samlingspaket för varje insticksprogram med en motsvarande generate.plugin-egenskap för var och en av dem.

Exempel: funktionen sdk.examples brukade ser ut så här:

   	<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

Detta ändras till:

	<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

Specifika insticksprogram kräver ev. inte källsamlingspaket eftersom de faktiskt inte innehåller källa. Detta kan inträffa med plattformsspecifika fragment som bara innehåller ett ursprungligt bibliotek. I det här fallet kan samlingspaketen exkluderas av funktionen, som beskrivet ovan i generate.feature.

Eller så kan samlingspaket explicit ange i sina egna build.properties-filer att inget källsamlingspaket ska genereras för dem:

generateSourceBundle=false

Anpassat innehåll

Anpassat innehåll kan alltid läggas till i genererade källsamlingspaket med hjälp av det anpassade motanropet post.gather.source i det ursprungliga samlingspaketet. (Se Anpassa byggsteg för funktioner och insticksprogram).

När du gör detta anger du egenskapen "src.additionalRoots" i insticksprogrammet build.properties-fil så att det genererade källsamlingspaketet har rätt roots-direktiv i Eclipse-SourceBundle-rubriken.

Exempel:

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>

Märka källfunktionen

Tidigare fungerade det genererade källsamlingspaketet som ett märkande insticksprogram för den genererade källfunktionen. Märkning av filer (about.properties, eclipse32.gif etc) tillhandahölls med katalogen sourceTemplatePlugin i den ursprungliga funktionen.

När du genererar individuella källsamlingspaketet blir det märkande insticksprogrammet för källfunktionen det källsamlingspaket som motsvarar det ursprungliga märkande insticksprogrammet. Det betyder att märkningsfilerna för källfunktionens märkande insticksprogram kan bidras med hjälp av egenskapen src.includes i det ursprungliga märkande insticksprogrammet.

Mappen sourceTemplatePlugin i den funktion för vilken vi genererar källa bidrar även med filer till det märkande insticksprogrammet.

sourceTemplatePlugin jämfört med sourceTemplateBundle

Tidigare kopierades innehållet i katalogen sourceTemplatePlugin för den ursprungliga funktionen till källinsticksprogrammet. När du genererar individuella källsamlingspaket förblir detta bara sant för det märkande källsamlingspaketet (se ovan).

För alla övriga källsamlingspaket kopieras innehållet i en sourceTemplateBundle-katalog över.