moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

cleanup of build.xml

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@833603 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2009-11-06 23:40:53 +00:00
parent b592beedaa
commit 0108892c64
3 changed files with 12 additions and 5471 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5239
ant.dtd
View File

File diff suppressed because it is too large Load Diff

160
build.xml
View File

@ -17,7 +17,6 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations specific language governing permissions and limitations
under the License. under the License.
--> -->
<!DOCTYPE project PUBLIC "-//Ant//Project 1.5//EN" "ant.dtd">
<!-- <!--
POI Build System. Written by: POI Build System. Written by:
@ -35,8 +34,7 @@ under the License.
LIBRARY LOCATION LIBRARY LOCATION
======= ======== ======= ========
junit(3.8+) http://www.ibiblio.org/maven/junit/jars/ junit(3.8+) http://www.junit.org
jdepend http://www.ibiblio.org/maven/jdepend/jars/
The ant jar "optional.jar" should also be available otherwise the The ant jar "optional.jar" should also be available otherwise the
build will fail. build will fail.
@ -58,9 +56,7 @@ under the License.
--> -->
<project name="POI Build" default="help" basedir="."> <project name="POI Build" default="help" basedir=".">
<description> <description>The POI project Ant build.</description>
The POI project Ant build.
</description>
<property environment="env"/> <property environment="env"/>
@ -149,21 +145,16 @@ under the License.
<property name="build.site" location="build/tmp/site/build/site"/> <property name="build.site" location="build/tmp/site/build/site"/>
<property name="build.site.src" location="build/tmp/site"/> <property name="build.site.src" location="build/tmp/site"/>
<property name="junit.report.dir" location="${build.site}/junit"/> <property name="junit.report.dir" location="${build.site}/junit"/>
<property name="jdepend.report.dir" location="${build.site}/jdepend"/>
<property name="jdepend.report.out.dir" location="${build.site.src}/src/documentation/content/jdepend"/>
<property name="apidocs.report.dir" location="${build.site}/apidocs"/> <property name="apidocs.report.dir" location="${build.site}/apidocs"/>
<property name="dist.dir" location="build/dist"/> <property name="dist.dir" location="build/dist"/>
<property name="mavendist.ooxml.dir" location="build/maven-ooxml-dependencies"/> <property name="mavendist.ooxml.dir" location="build/maven-ooxml-dependencies"/>
<property name="apache.repository" value="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository"/> <property name="apache.repository" value="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository"/>
<property name="snapshots.repository" value="scp://people.apache.org/www/people.apache.org/repo/m2-snapshot-repository/"/>
<property name="jar.name" value="poi"/> <property name="jar.name" value="poi"/>
<property name="version.id" value="3.6-beta1"/> <property name="version.id" value="3.6-beta1"/>
<property name="halt.on.test.failure" value="true"/> <property name="halt.on.test.failure" value="true"/>
<property name="jdk.version.source" value="1.5" <property name="jdk.version.source" value="1.5" description="JDK version of source code"/>
description="JDK version of source code"/> <property name="jdk.version.class" value="1.5" description="JDK version of generated class files"/>
<property name="jdk.version.class" value="1.5"
description="JDK version of generated class files"/>
<path id="main.classpath"> <path id="main.classpath">
<fileset dir="${main.lib}"> <fileset dir="${main.lib}">
@ -250,31 +241,12 @@ under the License.
</echo> </echo>
</target> </target>
<target name="with.clover" if="clover.present">
<taskdef resource="clovertasks"/>
<clover-setup initString="mycoverage.db"/>
</target>
<target name="clover.html" depends="with.clover" if="clover.present">
<echo>Generating clover report</echo>
<clover-report>
<current outfile="build/tmp/site/build/site/clover_html">
<format type="html"/>
</current>
</clover-report>
</target>
<target name="init" depends="fetch-jars,fetch-ooxml-jars"> <target name="init" depends="fetch-jars,fetch-ooxml-jars">
<tstamp> <tstamp>
<format property="tstamp.year" pattern="yyyy"/> <format property="tstamp.year" pattern="yyyy"/>
</tstamp> </tstamp>
<available resource="clovertasks" property="clover.present"/>
<antcall target="with.clover"/>
<mkdir dir="build"/> <mkdir dir="build"/>
<mkdir dir="build/non-ant-classes"/> <mkdir dir="build/non-ant-classes"/>
<mkdir dir="${main.output.dir}"/> <mkdir dir="${main.output.dir}"/>
@ -292,8 +264,6 @@ under the License.
<mkdir dir="${contrib.reports.test}"/> <mkdir dir="${contrib.reports.test}"/>
<mkdir dir="${ooxml.reports.test}"/> <mkdir dir="${ooxml.reports.test}"/>
<mkdir dir="${junit.report.dir}"/> <mkdir dir="${junit.report.dir}"/>
<mkdir dir="${jdepend.report.dir}"/>
<mkdir dir="${jdepend.report.out.dir}"/>
<mkdir dir="${apidocs.report.dir}"/> <mkdir dir="${apidocs.report.dir}"/>
<mkdir dir="${ooxml.xsds.tmp.dir}" /> <mkdir dir="${ooxml.xsds.tmp.dir}" />
<mkdir dir="${dist.dir}"/> <mkdir dir="${dist.dir}"/>
@ -837,9 +807,6 @@ FORREST_HOME environment variable!</echo>
<copy todir="${build.site.src}/src/documentation/content/apidocs"> <copy todir="${build.site.src}/src/documentation/content/apidocs">
<fileset dir="${apidocs.report.dir}"/> <fileset dir="${apidocs.report.dir}"/>
</copy> </copy>
<copy
tofile="${build.site.src}/src/documentation/content/jdepend.ehtml"
file="${jdepend.report.dir}/index.html" failonerror="false"/>
<mkdir dir="${build.site.src}/src/documentation/content/junit"/> <mkdir dir="${build.site.src}/src/documentation/content/junit"/>
<copy todir="${build.site.src}/src/documentation/content/junit"> <copy todir="${build.site.src}/src/documentation/content/junit">
<fileset dir="${junit.report.dir}"/> <fileset dir="${junit.report.dir}"/>
@ -861,26 +828,6 @@ FORREST_HOME environment variable!</echo>
</touch> </touch>
</target> </target>
<!-- Checks whether reports are required to be run. If nothing has changed then they dont. -->
<target name="-check-reports">
<condition property="reports.notRequired">
<and>
<equals arg1="${main.test.notRequired}" arg2="true"/>
<equals arg1="${scratchpad.test.notRequired}" arg2="true"/>
<equals arg1="${contrib.test.notRequired}" arg2="true"/>
</and>
</condition>
</target>
<!-- Creates reports and API documentation -->
<target name="reports" unless="reports.notRequired" depends="-check-reports,
fail-unless-jdepend-is-available, test-ignore-failures, junitreport,
jdepend, javadocs, clover.html"
description="Creates various reports and the API documentation">
</target>
<!-- Runs all JUnit tests without aborting if one of the tests fails. --> <!-- Runs all JUnit tests without aborting if one of the tests fails. -->
<target name="test-ignore-failures" depends="init"> <target name="test-ignore-failures" depends="init">
@ -888,29 +835,6 @@ FORREST_HOME environment variable!</echo>
<param name="halt.on.test.failure" value="false"/> <param name="halt.on.test.failure" value="false"/>
</antcall> </antcall>
</target> </target>
<!-- Produces a report of the JUnit test results -->
<target name="junitreport"
depends="test-ignore-failures"
description="Produces a report of the JUnit test results">
<junitreport todir="${junit.report.dir}">
<fileset dir="${main.reports.test}">
<include name="TEST-*.xml"/>
</fileset>
<fileset dir="${scratchpad.reports.test}">
<include name="TEST-*.xml"/>
</fileset>
<fileset dir="${contrib.reports.test}">
<include name="TEST-*.xml"/>
</fileset>
<report format="frames" todir="${junit.report.dir}"/>
</junitreport>
</target>
<!-- Generates the API documentation. --> <!-- Generates the API documentation. -->
<target name="javadocs" depends="init" <target name="javadocs" depends="init"
description="Generates the API documentation"> description="Generates the API documentation">
@ -975,16 +899,15 @@ FORREST_HOME environment variable!</echo>
</group> </group>
</javadoc> </javadoc>
<antcall target="clover.html"/>
</target> </target>
<!-- Generates documentation and reports --> <!-- Generates documentation and reports -->
<target name="site" depends="reports, docs" <target name="site" depends="docs"
description="Generates POI's website's contents"/> description="Generates POI's website's contents"/>
<target name="maven-poms" depends="jar" description="Builds the POM files for a maven distribution, and copies these and the jars to the appropriate locations"> <target name="maven-poms" description="Builds the POM files for a maven distribution, and copies these and the jars to the appropriate locations">
<!-- TODO: Decide about source jars, and copy them if we have some --> <!-- TODO: Decide about source jars, and copy them if we have some -->
<!-- Build the org.apache.poi poms --> <!-- Build the org.apache.poi poms -->
@ -1145,6 +1068,7 @@ FORREST_HOME environment variable!</echo>
</zip> </zip>
<tar destfile="${dist.dir}/${jar.name}-bin-${version.id}-${DSTAMP}.tar.gz" <tar destfile="${dist.dir}/${jar.name}-bin-${version.id}-${DSTAMP}.tar.gz"
longfile="gnu"
compression="gzip"> compression="gzip">
<tarfileset dir="legal/" prefix="${zipdir}" /> <tarfileset dir="legal/" prefix="${zipdir}" />
<tarfileset dir="lib/" prefix="${zipdir}/lib" /> <tarfileset dir="lib/" prefix="${zipdir}/lib" />
@ -1159,6 +1083,7 @@ FORREST_HOME environment variable!</echo>
</tar> </tar>
<tar destfile="${dist.dir}/${jar.name}-src-${version.id}-${DSTAMP}.tar.gz" <tar destfile="${dist.dir}/${jar.name}-src-${version.id}-${DSTAMP}.tar.gz"
longfile="gnu"
compression="gzip"> compression="gzip">
<tarfileset dir="legal/" prefix="${zipdir}" /> <tarfileset dir="legal/" prefix="${zipdir}" />
<tarfileset dir="${build.site}" prefix="${zipdir}/docs"/> <tarfileset dir="${build.site}" prefix="${zipdir}/docs"/>
@ -1189,58 +1114,8 @@ FORREST_HOME environment variable!</echo>
<target name="gump" depends="test, jar"/> <target name="gump" depends="test, jar"/>
<!-- Generates the Ant document type definition (DTD) -->
<target name="dtd"
description="Generates the Ant document type definition (DTD)">
<antstructure output="ant.dtd"/>
</target>
<!-- Abort the build if JDepend is missing. -->
<target name="fail-unless-jdepend-is-available" depends="init">
<condition property="isAvailable.jdepend">
<available classname="jdepend.framework.JDepend"/>
</condition>
<antcall target="fail-jdepend"/>
</target>
<target name="fail-jdepend" unless="isAvailable.jdepend">
<echo>
JDepend is not available. You must download JDepend from
&lt;http://www.clarkware.com/software/JDepend.html&gt; and include the
JAR file in your classpath.
</echo>
<fail message="JDepend is not available."/>
</target>
<!-- Aborts the build if any of the required tools are missing. --> <!-- Aborts the build if any of the required tools are missing. -->
<target name="fail-unless-tools-are-available" <target name="fail-unless-tools-are-available"/>
depends="fail-unless-jdepend-is-available"/>
<!-- Runs jdepend to produce a report about package dependencies -->
<target name="jdepend" depends="fail-unless-jdepend-is-available"
description="Runs jdepend to produce a report about package dependencies">
<jdepend outputfile="${jdepend.report.dir}/jdepend.xml" format="xml">
<classespath>
<pathelement location="${main.output.dir}"/>
<pathelement location="${contrib.output.dir}"/>
<pathelement location="${scratchpad.output.dir}"/>
</classespath>
<classpath>
<path refid="main.classpath"/>
<path refid="contrib.classpath"/>
<path refid="scratchpad.classpath"/>
</classpath>
</jdepend>
<style basedir="${jdepend.report.dir}"
in="${jdepend.report.dir}/jdepend.xml"
out="${jdepend.report.out.dir}/index.html"
style="jdepend.xsl"/>
</target>
<target name="-require-filename" description="Ensure -Dfilename=... was given"> <target name="-require-filename" description="Ensure -Dfilename=... was given">
<fail unless="filename" message="A filename must be supplied with -Dfilename=, eg -Dfilename=test.xls" /> <fail unless="filename" message="A filename must be supplied with -Dfilename=, eg -Dfilename=test.xls" />
@ -1272,20 +1147,3 @@ FORREST_HOME environment variable!</echo>
</project> </project>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:nil
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

84
src/documentation/content/xdocs/howtobuild.xml
View File

@ -41,11 +41,11 @@
The POI build system requires two components to perform a The POI build system requires two components to perform a
build. build.
<link href="ext:ant.apache.org/">Ant</link> and <link href="ext:ant.apache.org/">Ant</link> and
<link href="ext:xml.apache.org/forrest">forrest</link>. <link href="ext:xml.apache.org/forrest">Forrest</link>.
</p> </p>
<p> <p>
Specifically the build has been tested to work with Ant version Specifically the build has been tested to work with Ant version
1.5.3 and Forrest 0.4. To install these products download 1.7.1 and Forrest 0.5. To install these products download
the distributions and follow the instructions in their the distributions and follow the instructions in their
documentation. Make sure you don't forget to set the documentation. Make sure you don't forget to set the
environment variables FORREST_HOME and ANT_HOME. The environment variables FORREST_HOME and ANT_HOME. The
@ -62,19 +62,7 @@
</tr> </tr>
<tr> <tr>
<td>junit</td> <td>junit</td>
<td>http://www.ibiblio.org/maven/junit/jars/</td> <td>http://www.junit.org</td>
</tr>
<tr>
<td>xerces</td>
<td>http://www.ibiblio.org/maven/xerces/jars/</td>
</tr>
<tr>
<td>jdepend</td>
<td>http://www.ibiblio.org/maven/jdepend/jars/</td>
</tr>
<tr>
<td>xalan</td>
<td>http://www.ibiblio.org/maven/xalan/jars/</td>
</tr> </tr>
</table> </table>
<p> <p>
@ -85,59 +73,6 @@
</section> </section>
<section> <section>
<title>Running the Build</title> <title>Running the Build</title>
<p>
On the first run the ant build system will download all
the jars required by the project to build ant. If you're
behind a firewall this may cause some problems. Should you
need to it's possible to manually put the jars in the
correct directories. These can be obtained from here:
</p>
<table>
<tr>
<th>JAR</th>
<th>Location</th>
</tr>
<tr>
<td>/commons-logging/jars/commons-logging-1.0.1.jar</td>
<td>lib</td>
</tr>
<tr>
<td>/log4j/jars/log4j-1.2.8.jar</td>
<td>lib</td>
</tr>
<tr>
<td>/commons-beanutils/jars/commons-beanutils-1.6.jar</td>
<td>src/contrib/lib</td>
</tr>
<tr>
<td>/commons-collections/jars/commons-collections-2.1.jar</td>
<td>src/contrib/lib</td>
</tr>
<tr>
<td>/commons-lang/jars/commons-lang-1.0-b1.jar</td>
<td>src/contrib/lib</td>
</tr>
<tr>
<td>/junit/jars/junit-3.8.1.jar</td>
<td>lib</td>
</tr>
<tr>
<td>/dom4j/jars/dom4j-1.6.1.jar</td>
<td>ooxml-lib</td>
</tr>
<tr>
<td>/org.apache.xmlbeans/jars/xmlbeans-2.3.0.jar</td>
<td>ooxml-lib</td>
</tr>
<tr>
<td>/xmlbeans/jars/jsr173_1.0_api.jar</td>
<td>ooxml-lib</td>
</tr>
<tr>
<td>/org.apache.poi/jars/ooxml-schemas-1.0.jar</td>
<td>ooxml-lib</td>
</tr>
</table>
<p> <p>
The main targets of interest to our users are: The main targets of interest to our users are:
</p> </p>
@ -163,15 +98,6 @@
<td>docs</td> <td>docs</td>
<td>Generate all documentation for the system</td> <td>Generate all documentation for the system</td>
</tr> </tr>
<tr>
<td>generate-records</td>
<td>Generate records from the XML record defintitions</td>
</tr>
<tr>
<td>generate-types</td>
<td>Generate types from the XML type definitions (this is
for HWPF).</td>
</tr>
<tr> <tr>
<td>jar</td> <td>jar</td>
<td>Produce jar files</td> <td>Produce jar files</td>
@ -180,10 +106,6 @@
<td>dist</td> <td>dist</td>
<td>Create a distribution.</td> <td>Create a distribution.</td>
</tr> </tr>
<tr>
<td>clean-dist</td>
<td>Runs clean before creating the distribution.</td>
</tr>
</table> </table>
</section> </section>
</body> </body>