Create reference documentation in maven build
* Replace the `antrunner.sh` script with the tycho-eclipse-run plugin.
-> No reference to an external eclipse installation required anymore.
* Move the reference build from the build project directly to the pom
file of the doc project.
-> All files needed for the reference build kept in the same bundle.
* Generated reference files in target/reference, copy them into the
bundle jar from there.
-> Source code is not modified by the build anymore.
* Remove outdated readme and todo files.
Resolves bug 422143
diff --git a/bundles/org.eclipse.rap.doc/build.properties b/bundles/org.eclipse.rap.doc/build.properties
index 420e3b8..6f2c112 100644
--- a/bundles/org.eclipse.rap.doc/build.properties
+++ b/bundles/org.eclipse.rap.doc/build.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2007, 2012 Innoopract Informationssysteme GmbH and others.
+# Copyright (c) 2007, 2013 Innoopract Informationssysteme GmbH and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@@ -17,4 +17,6 @@
plugin.xml,\
about.html
src.includes = guide/,\
- about.html
+ about.html,\
+ reference-build/,\
+ pom.xml
diff --git a/bundles/org.eclipse.rap.doc/guide/reference/.gitignore b/bundles/org.eclipse.rap.doc/guide/reference/.gitignore
deleted file mode 100644
index 8c6492c..0000000
--- a/bundles/org.eclipse.rap.doc/guide/reference/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-api/
diff --git a/bundles/org.eclipse.rap.doc/pom.xml b/bundles/org.eclipse.rap.doc/pom.xml
index b0950ec..4b188b5 100644
--- a/bundles/org.eclipse.rap.doc/pom.xml
+++ b/bundles/org.eclipse.rap.doc/pom.xml
@@ -14,16 +14,90 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
- <groupId>org.eclipse.rap</groupId>
- <artifactId>org.eclipse.rap.doc</artifactId>
- <version>2.3.0-SNAPSHOT</version>
- <packaging>eclipse-plugin</packaging>
-
<parent>
<groupId>org.eclipse.rap</groupId>
<artifactId>org.eclipse.rap.tools-parent</artifactId>
<version>2.3.0-SNAPSHOT</version>
- <relativePath>../../releng/org.eclipse.rap.tools.build/pom.xml</relativePath>
+ <relativePath>../../releng/org.eclipse.rap.tools.build</relativePath>
</parent>
+ <artifactId>org.eclipse.rap.doc</artifactId>
+ <version>2.3.0-SNAPSHOT</version>
+ <packaging>eclipse-plugin</packaging>
+
+ <properties>
+ <eclipserun-repo>http://download.eclipse.org/releases/juno</eclipserun-repo>
+ <runtimeSourceDir>${project.basedir}/../../../org.eclipse.rap</runtimeSourceDir>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.eclipse.tycho.extras</groupId>
+ <artifactId>tycho-eclipserun-plugin</artifactId>
+ <version>${tycho-version}</version>
+ <configuration>
+ <appArgLine>
+ -application org.eclipse.ant.core.antRunner \
+ -buildfile reference-build/build.xml \
+ -DbaseDir=${project.basedir} \
+ -DtargetDir=${project.build.directory}/reference/guide/reference \
+ -DruntimeSourceDir=${runtimeSourceDir} \
+ -data ${project.build.directory}/workspace
+ </appArgLine>
+ <dependencies>
+ <dependency>
+ <artifactId>org.apache.ant</artifactId>
+ <type>eclipse-plugin</type>
+ </dependency>
+ <dependency>
+ <artifactId>org.eclipse.ant.core</artifactId>
+ <type>eclipse-plugin</type>
+ </dependency>
+ <dependency>
+ <artifactId>org.eclipse.help.base</artifactId>
+ <type>eclipse-plugin</type>
+ </dependency>
+ <dependency>
+ <artifactId>org.eclipse.pde.core</artifactId>
+ <type>eclipse-plugin</type>
+ </dependency>
+ </dependencies>
+ <repositories>
+ <repository>
+ <id>eclipse</id>
+ <layout>p2</layout>
+ <url>${eclipserun-repo}</url>
+ </repository>
+ </repositories>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>eclipse-run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
+ <groupId>org.eclipse.tycho</groupId>
+ <artifactId>tycho-packaging-plugin</artifactId>
+ <version>${tycho-version}</version>
+ <configuration>
+ <additionalFileSets>
+ <fileSet>
+ <directory>${project.build.directory}/reference</directory>
+ <includes>
+ <include>**/*</include>
+ </includes>
+ </fileSet>
+ </additionalFileSets>
+ </configuration>
+ </plugin>
+
+ </plugins>
+ </build>
+
</project>
diff --git a/bundles/org.eclipse.rap.doc/readme.txt b/bundles/org.eclipse.rap.doc/readme.txt
deleted file mode 100644
index cf9f8ef..0000000
--- a/bundles/org.eclipse.rap.doc/readme.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-toc.xml
-
-The table of contents of the help plug-in (help/toc.xml) may contain several
-entries about non-existing files. The most of them can be found in the
-"Reference" category. The referenced html files will be generated at build time.
-
-See "org.eclipse.rap.releng/tooling" for more informations how these files are
-generated during the automated build.
\ No newline at end of file
diff --git a/releng/org.eclipse.rap.tools.build/reference/build.xml b/bundles/org.eclipse.rap.doc/reference-build/build.xml
similarity index 78%
rename from releng/org.eclipse.rap.tools.build/reference/build.xml
rename to bundles/org.eclipse.rap.doc/reference-build/build.xml
index 8d7e424..bf87f7f 100755
--- a/releng/org.eclipse.rap.tools.build/reference/build.xml
+++ b/bundles/org.eclipse.rap.doc/reference-build/build.xml
@@ -7,12 +7,12 @@
<target name="buildExtensionPointReference">
<pde.convertSchemaToHTML
manifest="${runtimeSourceDir}/bundles/org.eclipse.rap.ui/plugin.xml"
- destination="${toolsSourceDir}/bundles/org.eclipse.rap.doc/guide/reference/extension-points" />
+ destination="${targetDir}/extension-points" />
</target>
<target name="buildApiReference">
<javadoc
- destdir="${toolsSourceDir}/bundles/org.eclipse.rap.doc/guide/reference/api"
+ destdir="${targetDir}/api"
encoding="UTF-8"
charset="UTF-8"
author="false"
@@ -49,19 +49,19 @@
</header>
<link href="http://download.oracle.com/javase/1.5.0/docs/api/"
offline="true"
- packagelistLoc="${toolsSourceDir}/releng/org.eclipse.rap.tools.build/reference/javadoc-packages/javase-1.5.0" />
+ packagelistLoc="${baseDir}/reference-build/javadoc-packages/javase-1.5.0" />
<link href="http://www.osgi.org/javadoc/r4v43/"
offline="true"
- packagelistLoc="${toolsSourceDir}/releng/org.eclipse.rap.tools.build/reference/javadoc-packages/osgi-r4v43" />
+ packagelistLoc="${baseDir}/reference-build/javadoc-packages/osgi-r4v43" />
</javadoc>
</target>
<target name="buildThemingReference" description="creates the RWT theming reference">
- <ant dir="${toolsSourceDir}/releng/org.eclipse.rap.tools.build/reference/theming">
+ <ant dir="${baseDir}/reference-build/theming">
<property name="src.dir"
value="${runtimeSourceDir}/bundles/org.eclipse.rap.rwt/" />
<property name="dest.dir"
- value="${toolsSourceDir}/bundles/org.eclipse.rap.doc/guide/reference/theming" />
+ value="${targetDir}/theming" />
</ant>
</target>
diff --git a/releng/org.eclipse.rap.tools.build/reference/javadoc-packages/javase-1.5.0/package-list.txt b/bundles/org.eclipse.rap.doc/reference-build/javadoc-packages/javase-1.5.0/package-list.txt
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/javadoc-packages/javase-1.5.0/package-list.txt
rename to bundles/org.eclipse.rap.doc/reference-build/javadoc-packages/javase-1.5.0/package-list.txt
diff --git a/releng/org.eclipse.rap.tools.build/reference/javadoc-packages/osgi-r4v43/package-list.txt b/bundles/org.eclipse.rap.doc/reference-build/javadoc-packages/osgi-r4v43/package-list.txt
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/javadoc-packages/osgi-r4v43/package-list.txt
rename to bundles/org.eclipse.rap.doc/reference-build/javadoc-packages/osgi-r4v43/package-list.txt
diff --git a/releng/org.eclipse.rap.tools.build/reference/theming/build.xml b/bundles/org.eclipse.rap.doc/reference-build/theming/build.xml
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/theming/build.xml
rename to bundles/org.eclipse.rap.doc/reference-build/theming/build.xml
diff --git a/releng/org.eclipse.rap.tools.build/reference/theming/index-part.xsl b/bundles/org.eclipse.rap.doc/reference-build/theming/index-part.xsl
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/theming/index-part.xsl
rename to bundles/org.eclipse.rap.doc/reference-build/theming/index-part.xsl
diff --git a/releng/org.eclipse.rap.tools.build/reference/theming/index.xsl b/bundles/org.eclipse.rap.doc/reference-build/theming/index.xsl
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/theming/index.xsl
rename to bundles/org.eclipse.rap.doc/reference-build/theming/index.xsl
diff --git a/releng/org.eclipse.rap.tools.build/reference/theming/theme.xsl b/bundles/org.eclipse.rap.doc/reference-build/theming/theme.xsl
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/theming/theme.xsl
rename to bundles/org.eclipse.rap.doc/reference-build/theming/theme.xsl
diff --git a/releng/org.eclipse.rap.tools.build/reference/theming/theming-ref-toc.xsl b/bundles/org.eclipse.rap.doc/reference-build/theming/theming-ref-toc.xsl
similarity index 100%
rename from releng/org.eclipse.rap.tools.build/reference/theming/theming-ref-toc.xsl
rename to bundles/org.eclipse.rap.doc/reference-build/theming/theming-ref-toc.xsl
diff --git a/bundles/org.eclipse.rap.doc/todo.txt b/bundles/org.eclipse.rap.doc/todo.txt
deleted file mode 100644
index 64fe17c..0000000
--- a/bundles/org.eclipse.rap.doc/todo.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-- examples.html OUTDATED!?
-
-- Splashscreen
-- Service Handler/Download
-- Hello World Template
-- Session.exec example
diff --git a/releng/org.eclipse.rap.tools.build/scripts/ant-runner.sh b/releng/org.eclipse.rap.tools.build/scripts/ant-runner.sh
deleted file mode 100755
index d249c77..0000000
--- a/releng/org.eclipse.rap.tools.build/scripts/ant-runner.sh
+++ /dev/null
@@ -1,54 +0,0 @@
-#!/bin/bash
-#
-# This script executes the PDE antRunner with the given parameters
-# Usage example:
-# ant-runner.sh -buildfile comp-repo.xml -DrepoDir=$repoDir target
-
-if [ $# == 0 ]; then
- echo "Missing parameters"
- echo "Usage:"
- echo " ant-runner.sh <buildfile> [parameters]"
- echo "Example:"
- echo " ant-runner.sh build.xml -DrepoDir=\"\$repoDir\" target"
- exit 0
-fi
-
-if [ -z "$JAVA_HOME" ]; then
- echo "Missing JAVA_HOME"
- exit 1
-elif [ ! -f "$JAVA_HOME/bin/java" ]; then
- echo "Invalid JAVA_HOME: '$JAVA_HOME'"
- exit 1
-fi
-
-java=$JAVA_HOME/bin/java
-
-if [ -z "$ECLIPSE_HOME" ]; then
- echo "Missing ECLIPSE_HOME"
- exit 1
-elif [ ! -d "$ECLIPSE_HOME/plugins" ]; then
- echo "Invalid ECLIPSE_HOME: '$ECLIPSE_HOME'"
- exit 1
-fi
-
-# Find Equinox launcher
-launcher=$(ls -1 $ECLIPSE_HOME/plugins/org.eclipse.equinox.launcher_*.jar | tail -n 1)
-
-if [ -z "$launcher" ]; then
- echo "No Equinox launcher found"
- exit 1
-elif [ ! -f "$launcher" ]; then
- echo "Invalid Equinox launcher: '$launcher'"
- exit 1
-fi
-
-echo "Using Equinox launcher: $launcher"
-
-buildfile=$1
-shift
-
-exec $java -cp $launcher org.eclipse.core.launcher.Main \
- -application org.eclipse.ant.core.antRunner \
- -buildfile $buildfile \
- "$@"
-
diff --git a/releng/org.eclipse.rap.tools.build/scripts/build-environment.sh b/releng/org.eclipse.rap.tools.build/scripts/build-environment.sh
deleted file mode 100755
index 05d30f4..0000000
--- a/releng/org.eclipse.rap.tools.build/scripts/build-environment.sh
+++ /dev/null
@@ -1,16 +0,0 @@
-# This script sets up environment variables for the RAP builds
-#
-
-echo "***********************************************************************"
-
-export MVN=${MVN:-"/opt/public/common/apache-maven-3.0.4/bin/mvn"}
-echo "Maven path: ${MVN}"
-
-export ECLIPSE_HOME=${ECLIPSE_HOME:-"/shared/rt/rap/build-runtimes/eclipse"}
-echo "Eclipse location: ${ECLIPSE_HOME}"
-
-export SIGNING_LOCATION=${SIGNING_LOCATION:-"/opt/public/download-staging.priv/rt/rap"}
-echo "Signing location: ${SIGNING_LOCATION}"
-
-export MAVEN_LOCAL_REPO_PATH=${MAVEN_LOCAL_REPO_PATH:-"/shared/rt/rap/m2/repository"}
-echo "Local Maven repository location: ${MAVEN_LOCAL_REPO_PATH}"
diff --git a/releng/org.eclipse.rap.tools.build/scripts/tools-build.sh b/releng/org.eclipse.rap.tools.build/scripts/tools-build.sh
index 0245253..7a0618f 100755
--- a/releng/org.eclipse.rap.tools.build/scripts/tools-build.sh
+++ b/releng/org.eclipse.rap.tools.build/scripts/tools-build.sh
@@ -5,7 +5,8 @@
# See Job -> Configure... -> This build is parameterized
SCRIPTS_DIR=$(dirname $(readlink -nm $0))
-. $SCRIPTS_DIR/build-environment.sh
+MVN=${MVN:-"/opt/public/common/apache-maven-3.0.4/bin/mvn"}
+MAVEN_LOCAL_REPO_PATH=${MAVEN_LOCAL_REPO_PATH:-"/shared/rt/rap/m2/repository"}
if [ "${BUILD_TYPE:0:1}" == "S" ]; then
sign=true
@@ -27,15 +28,6 @@
done
######################################################################
-# Generate reference documentation
-
-cd "$WORKSPACE/org.eclipse.rap.tools"
-echo "Generating reference documentation"
-$SCRIPTS_DIR/ant-runner.sh releng/org.eclipse.rap.tools.build/reference/build.xml \
- -DruntimeSourceDir="${WORKSPACE}/org.eclipse.rap" \
- -DtoolsSourceDir="${WORKSPACE}/org.eclipse.rap.tools" || exit 1
-
-######################################################################
# Build RAP Tools
cd "$WORKSPACE/org.eclipse.rap.tools/releng/org.eclipse.rap.tools.build" || exit 1
