Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Tiede2015-04-29 09:33:40 +0000
committerMarkus Tiede2015-04-29 09:33:40 +0000
commitbb55b0056adaa6e93d662f08799da955ca0bc2bc (patch)
tree7d6091904b98d5bfc74f9aada1c970041b38e62c /org.eclipse.jubula.documentation/developerManual
parent767d91eabfaa9710f2aececac2f87ba19c0dfcdf (diff)
downloadorg.eclipse.jubula.core-bb55b0056adaa6e93d662f08799da955ca0bc2bc.tar.gz
org.eclipse.jubula.core-bb55b0056adaa6e93d662f08799da955ca0bc2bc.tar.xz
org.eclipse.jubula.core-bb55b0056adaa6e93d662f08799da955ca0bc2bc.zip
Sprint task - document how to use API as an OSGi dependency
Diffstat (limited to 'org.eclipse.jubula.documentation/developerManual')
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml59
1 files changed, 51 insertions, 8 deletions
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
index 551f39df7..135d4e9ea 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
@@ -304,8 +304,10 @@
</itemizedlist>
</listitem>
</orderedlist>
- <para>You can find the artifacts in different shapes (plain JAR, maven artifact and OSGi bundles) within
- the <emphasis>ITEInstallationFolder/development/api</emphasis> folder.</para>
+ <para>You can find the artifacts in different shapes (plain JAR and maven artifact) within
+ the <emphasis>&lt;ITEInstallationFolder&gt;/development/api</emphasis> folder. To define OSGi dependencies to the API artifacts
+ you can simply include the <emphasis>&lt;ITEInstallationFolder&gt;/development/org.eclipse.jubula.repo.zip</emphasis> in
+ your target platform (definition).</para>
</section>
<section>
@@ -320,10 +322,51 @@
</figure>
<para>A fully executable example setup for the RCP toolkit showing a basic SimpleAdder AUT start - see <xref linkend="start-aut" /> -
and test run - see <xref linkend="test-execution" /> - can be found in the git-Repository contained within every ITE installation. It's located in
- <emphasis>ITEInstallationFolder/development/git/org.eclipse.jubula.core.git</emphasis>. Simply create a clone
- of that repository and checkout the Eclipse project <emphasis>org.eclipse.jubula.examples.api.adder.rcp.m2</emphasis>.
- You still have to adjust the path to the local maven repository within the pom.xml of that project and point to the
- one included in the installation: <emphasis>ITEInstallationFolder/development/api/m2-repo</emphasis>.</para>
+ <emphasis>&lt;ITEInstallationFolder&gt;/development/git/org.eclipse.jubula.core.git</emphasis>. Simply create a clone
+ of that repository and checkout the Eclipse projects <emphasis>org.eclipse.jubula.examples.api.adder.rcp.*</emphasis>.
+ There is an individual preconfigured project for all of the three shapes the API may be consumed as:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="strong">plain JAR:</emphasis>
+ The project for this example setup is
+ <emphasis>org.eclipse.jubula.examples.api.adder.rcp.jar
+ </emphasis>
+ . You still have to adjust the path to the (by default linked to
+ relative / local artifacts located within the git-clone itself)
+ library-directory (lib). Simply adjust this path to point to
+ e.g.
+ <emphasis>&lt;ITEInstallationFolder&gt;/development/api/JARs/</emphasis>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="strong">m2 / maven:</emphasis>
+ The project for this example setup is
+ <emphasis>org.eclipse.jubula.examples.api.adder.rcp.m2
+ </emphasis>
+ . You still have to adjust the path to the local maven
+ repository within the pom.xml of that project and point to the
+ one included in the installation:
+ <emphasis>&lt;ITEInstallationFolder&gt;/development/api/m2-repo
+ </emphasis>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="strong">OSGi:</emphasis>
+ The project for this example setup is
+ <emphasis>org.eclipse.jubula.examples.api.adder.rcp.osgi
+ </emphasis>
+ . You still have to add the (e.g. local) Jubula p2-repository and its
+ artifacts to your target platform:
+ <emphasis>&lt;ITEInstallationFolder&gt;/development/org.eclipse.jubula.repo.zip
+ </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
<figure xml:id="test-execution">
<title>Exectuing a first test</title>
<mediaobject>
@@ -332,7 +375,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>However the usage of maven is not mandatory - you can also simply setup a plain Java project using the artifacts as plain JARs on the classpath.</para>
</section>
-<xi:include href="sectionConverter.xml"/>
+
+ <xi:include href="sectionConverter.xml"/>
</chapter> \ No newline at end of file

Back to the top