Einzelne Quellenproduktpakete

Das traditionelle Format der Quellenproduktpakete in Eclipse war ein Ordner, der src.zip-Dateien für alle in einem bestimmten Feature enthaltenen Plug-ins umfasste. In der Version 3.4 wird Eclipse jetzt mit einzelnen Quellenproduktpaketen bereitgestellt. Für jedes Produktpaket besteht ein entsprechendes Quellenproduktpaket, bei dem es sich um ein JAR handelt, das die Quelle für das Produktpaket enthält. Dies ermöglicht eine flexiblere Bereitstellung der Quelle und behebt zudem einige Probleme mit der der Pfadlänge, die auf einigen Plattformen auftreten konnten.

Eclipse-SourceBundle

Ein Quellenproduktpaket wird durch das Vorliegen des Headers Eclipse-SourceBundle in dem Manifest ermittelt. Das Format dieses Headers ist wie folgt:

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

Die Produktpaket-ID und die Version weisen darauf hin, dass der eingeschlossene Quellcode diesen entspricht. Die Stammverzeichnisanweisung weist auf die Ordner im Quellenproduktpaket, die tatsächlich den Quellcode enthalten. Wenn keine Stammverzeichnisanweisung angegeben ist, wird ein Wert von "." angenommen.

Klassendateibibliotheken werden den Quellenpositionen in einer vorhersehbaren Weise zugeordnet. Das Stammverzeichnis der Plug-in ist auf das Stammverzeichnis des Quellenproduktpakets abgestimmt. Dies gilt für die meisten Plug-ins mit JARs. Wenn das Plug-in zusätzliche Bibliotheken "foo/lib.jar" enthält, wird erwartet, dass die Quelle sich in den entsprechenden "foo/libsrc/"-Ordnern in den Quellenproduktpaketen befindet.

Einzelne Quellenproduktpakete generieren

PDE/Build kann automatisch einzelne Quellenproduktpakete generieren, allerdings nur in einem Build ohne GUI. Die Erstellung einzelner Quellenproduktpakete kann aktiviert werden, indem Folgendes angegeben wird:

individualSourceBundles=true

Dies muss in der Datei 'build.properties' der höchsten Ebene der Buildkonfiguration angegeben werden. Es kontrolliert die gesamte Quellengenerierung für diesen Build. Weitere Informationen über die Generierung traditioneller Quellen-Plug-ins und Features finden Sie im Abschnitt Quellen-Features und Plug-ins generieren. Für die übrige Seite werden Kenntnisse über die traditionelle Quellengeneration vorausgesetzt.

generate.feature

In der Datei build.properties des Features gibt die Eigenschaft generate.feature pde.build an, ein Quellen-Feature zu generieren.
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*

Bei der Generierung einzelner Quellenproduktpakete bleibt die Eigenschaft unverändert und unterstützt dieselben Attribute (z. B. Version, Entpacken, optional, usw.), die Differenz wird in dem resultierenden Quellen-Feature festgestellt. Zuvor hat das Quellen-Feature ein Quellen-Plug-in und ein Quellenfragment für jede integrierte Plattform eingeschlossen. In dem neuen Format schließt das Quellen-Feature ein Quellenproduktpaket für jedes im ursprünglichen Feature aufgelistete Plug-in/Fragment ein.

Plug-ins, die in dem Quellen-Feature über die Syntax plugin@ eingeschlossen sind, erhalten keine entsprechenden Quellenproduktpakete. Dies ist hilfreich für das Hinzufügen von doc-Plug-ins zum Quellen-Feature.

Der Eintrag exclude@ ist neu für die einzelne Quellengeneration. Einige Plug-ins, die in das ursprüngliche Feature eingeschlossen wurden (d. h. doc-Plug-ins oder Fragmente, die nur nativen Code enthalten) enthalten möglicherweise keine Quelle und sind aus dem generierten Quellen-Feature auszuschließen. Der Eintrag exclude@ unterstützt ein Attribut version.

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

Im alten Format generiert generate.plugin ein Quellen-Plug-in auf Grundlage des Inhalts eines bestimmten Features. Bei der Generation einzelner Quellenproduktpakete wird dies so geändert, dass es auf einem bestimmten Plug-in beruht:

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

Die Eigenschaft generate.plugin wurde von Features verwendet, um Quelle ohne ein Quellen-Features aufzunehmen (obwohl im Hintergrund ein gesamtes Quellen-Feature generiert wurde). Bei der Generation einzelner Quellenproduktpakete sind Features erforderlich, um ein *.Quellenproduktpaket für jedes Plug-in zusammen mit jeweils einer entsprechenden Eigenschaft generate.plugin einzuschließen.

Beispiel: Das Features sdk.examples lautete zuvor Folgendermaßen:

   	<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

Dies wird wie folgt geändert:

	<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

Bestimmte Plug-ins benötigen möglicherweise keine Quellenproduktpakete, da sie nicht tatsächlich Quellen enthalten. Dies kann bei plattformspezifischen Fragmenten auftreten, die nur eine native Bibliothek enthalten. In diesem Fall können die Produktpakete von dem Feature wie vorstehend unter generate.feature dargelegt ausgeschlossen werden.

Oder Produktpakete können explizit in ihrer eigenen Datei build.properties angeben, dass kein Quellenproduktpaket für sie generiert werden soll:

generateSourceBundle=false

Benutzerdefinierter Inhalt

Benutzerdefinierter Inhalt kann generierten Quellenproduktpaketen stets hinzugefügt werden, indem das benutzerdefinierte Callback post.gather.source im ursprünglichen Produktpaket verwendet wird. (Weitere Informationen finden Sie im Abschnitt Schritte zur Anpassung von Feature- und Plug-in-Builds).

Dabei legen Sie die Eigenschaft "src.additionalRoots" in der Datei build.properties des Plug-ins so fest, dass das generierte Quellenproduktpaket die richtige Stammverzeichnisanweisung zum Eclipse-SourceBundle-Header aufweist.

Beispiel:

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 des Quellen-Features

Früher diente das generierte Quellen-Plug-in als Branding-Plug-in für das generierte Quellen-Feature. Branding-Dateien (about.properties, eclipse32.gif, usw.) wurden mithilfe des Verzeichnisses sourceTemplatePlugin im ursprünglichen Feature bereitgestellt.

Bei der Generation einzelner Quellen-Produktpakete ist das Branding-Plug-in für das Quellen-Feature das Quellenproduktpaket, das dem ursprünglichen Branding-Plug-in entspricht. Dies bedeutet, dass die Branding-Dateien für das Branding-Plug-in des Quellen-Features mithilfe der Eigenschaft src.includes im ursprünglichen Branding-Plug-in beigetragen werden können.

Der Ordner sourceTemplatePlugin des Features, für den wir die Quelle generieren, trägt ebenfalls Dateien zum Branding-Plug-in bei.

sourceTemplatePlugin gegenüber sourceTemplateBundle

Früher wurde der Inhalt des Verzeichnisses sourceTemplatePlugin des ursprünglichen Feature in das Quellen-Plug-in kopiert. Bei der Generation einzelner Quellenproduktpakete trifft dies nur auf das Branding-Quellenproduktpaket zu (siehe oben).

Für alle übrigen Quellenproduktpakete wird der Inhalt eines Verzeichnisses sourceTemplateBundle kopiert.