Browse Source

Revised installation manual, cross-referenced optional tasks/types

master
Gintas Grigelionis 7 years ago
parent
commit
972ae2ea74
9 changed files with 586 additions and 667 deletions
  1. +22
    -42
      build.xml
  2. +3
    -0
      manual/Tasks/antlr.html
  3. +1
    -1
      manual/Tasks/ejb.html
  4. +1
    -1
      manual/Tasks/image.html
  5. +5
    -3
      manual/Tasks/junitreport.html
  6. +3
    -0
      manual/Tasks/netrexxc.html
  7. +1
    -1
      manual/Types/classfileset.html
  8. +2
    -2
      manual/Types/mapper.html
  9. +548
    -617
      manual/install.html

+ 22
- 42
build.xml View File

@@ -24,7 +24,6 @@
<property file="${user.home}/.ant.properties"/>
<property environment="env"/>


<!--
===================================================================
Set the properties that control names and versions
@@ -538,7 +537,6 @@
</condition>
</target>


<!--
===================================================================
Prepare the build
@@ -558,9 +556,8 @@
Build the code
===================================================================
-->
<target name="build"
depends="prepare,check-optional-packages"
description="--> compiles the source code">
<target name="build" depends="prepare,check-optional-packages"
description="--> compiles the source code">
<mkdir dir="${build.dir}"/>
<mkdir dir="${build.classes}"/>
<mkdir dir="${build.lib}"/>
@@ -636,9 +633,8 @@
Create the all of the Apache Ant jars
===================================================================
-->
<target name="jars"
depends="build"
description="--> creates the Apache Ant jars">
<target name="jars" depends="build"
description="--> creates the Apache Ant jars">

<copy todir="${build.dir}">
<fileset dir="${basedir}">
@@ -773,8 +769,7 @@
</target>

<!-- Creates jar of test utility classes -->
<target name="test-jar"
depends="compile-tests"
<target name="test-jar" depends="compile-tests"
description="--> creates the Apache Ant Test Utilities jar">

<fail unless="junit.present">
@@ -883,8 +878,7 @@
Create the essential distribution that can run Apache Ant
===================================================================
-->
<target name="dist-lite"
depends="jars,test-jar"
<target name="dist-lite" depends="jars,test-jar"
description="--> creates a minimum distribution to run Apache Ant">

<mkdir dir="${dist.dir}"/>
@@ -948,7 +942,6 @@
</copy>
</target>


<macrodef name="checksums-mvn" description="only md5 and sha1 are needed for the maven directory structure">
<element name="resources" implicit="true"/>
<sequential>
@@ -1060,10 +1053,8 @@
<include name="${bootstrap.jar}"/>
</fileset>
</copy>

</target>


<!--
===================================================================
Target to create bootstrap build
@@ -1075,7 +1066,6 @@
</antcall>
</target>


<!--
===================================================================
Create the source distribution
@@ -1379,8 +1369,7 @@
Cleans everything
===================================================================
-->
<target name="allclean"
depends="clean"
<target name="allclean" depends="clean"
description="--> cleans up everything">
<delete file="${bootstrap.dir}/bin/antRun"/>
<delete file="${bootstrap.dir}/bin/antRun.bat"/>
@@ -1458,8 +1447,7 @@
</javadoc>
</target>

<target name="test-javadocs" depends="prepare,check-javadoc"
unless="tests.javadoc.notrequired"
<target name="test-javadocs" depends="prepare,check-javadoc" unless="tests.javadoc.notrequired"
description="--> creates the API documentation for test utilities">
<mkdir dir="${build.tests.javadocs}"/>
<javadoc useexternalfile="yes"
@@ -1527,8 +1515,7 @@

<target name="dump-info" depends="dump-sys-properties,run-which"/>

<target name="dump-sys-properties" unless="which.present"
depends="xml-check">
<target name="dump-sys-properties" depends="xml-check" unless="which.present">
<echo message="java.vm.info=${java.vm.info}"/>
<echo message="java.vm.name=${java.vm.name}"/>
<echo message="java.vm.vendor=${java.vm.vendor}"/>
@@ -1542,13 +1529,11 @@
</target>

<!-- helper class from Xalan2 to check for jar versioning of xml/xsl processors -->
<target name="xml-check" depends="check-optional-packages"
if="xalan.envcheck" unless="which.present">
<target name="xml-check" depends="check-optional-packages" if="xalan.envcheck" unless="which.present">
<java classname="org.apache.xalan.xslt.EnvironmentCheck"/>
</target>

<target name="run-which" depends="check-optional-packages"
if="which.present">
<target name="run-which" depends="check-optional-packages" if="which.present">
<java classname="org.apache.env.Which" taskname="which" classpathref="classpath"/>
</target>

@@ -1581,8 +1566,8 @@
</condition>
</target>

<target name="test" description="--> run unit tests and reports"
depends="junit-report,antunit-report,check-failed">
<target name="test"depends="junit-report,antunit-report,check-failed"
description="--> run unit tests and reports">
<fail if="tests.failed" unless="ignore.tests.failed">Unit tests failed; see:
${build.junit.reports}
${antunit.reports}
@@ -1748,8 +1733,7 @@ ${antunit.reports}

<target name="junit-tests" depends="junit-batch,junit-single-test"/>

<target name="junit-batch" depends="compile-tests,test-init"
if="junit.batch">
<target name="junit-batch" depends="compile-tests,test-init" if="junit.batch">

<property name="junit.includes" value="**/*Test*"/>
<property name="junit.excludes" value=""/>
@@ -1891,8 +1875,8 @@ ${antunit.reports}
</test-junit>
</target>

<target name="interactive-tests" description="--> runs interactive tests"
depends="compile-tests">
<target name="interactive-tests" depends="compile-tests"
description="--> runs interactive tests">
<java classpathref="tests-runtime-classpath"
classname="org.apache.tools.ant.taskdefs.TestProcess"
fork="true"/>
@@ -1911,8 +1895,8 @@ ${antunit.reports}
<echo>AntUnit tests must be run with ${bootstrap.dir} (or ${dist.dir}), not ${ant.home}. Try './build.sh antunit-tests' for example.</echo>
</target>

<target name="antunit-tests" depends="build,test-init,-antunit-warn-location"
if="run.antunit" description="--> run the antunit tests">
<target name="antunit-tests" depends="build,test-init,-antunit-warn-location" if="run.antunit"
description="--> run the antunit tests">
<condition property="antunit.includes" value="${antunit.testcase}"
else="**/test.xml,**/*-test.xml">
<isset property="antunit.testcase"/>
@@ -1980,10 +1964,8 @@ ${antunit.reports}
Main target - runs dist-lite by default
===================================================================
-->
<target name="main"
description="--> creates a minimum distribution in ./dist"
depends="dist-lite"/>

<target name="main" depends="dist-lite"
description="--> creates a minimum distribution in ./dist"/>

<!--
===================================================================
@@ -1991,10 +1973,8 @@ ${antunit.reports}
the WiX toolset and the dotnet Antlib.
===================================================================
-->
<target name="msi"
description="--> creates an MSI file for Ant, requires WiX and the dotnet Antlib"
depends="dist-internal"
xmlns:dn="antlib:org.apache.ant.dotnet">
<target name="msi" depends="dist-internal" xmlns:dn="antlib:org.apache.ant.dotnet"
description="--> creates an MSI file for Ant, requires WiX and the dotnet Antlib">

<property name="msi.dir" value="${build.dir}"/>
<property name="msi.name" value="${name}-${project.version}.msi"/>


+ 3
- 0
manual/Tasks/antlr.html View File

@@ -42,6 +42,9 @@
supergrammar specified by the glib attribute) is newer than the
generated files.
</p>
<p><strong>Note:</strong> This task depends on external libraries not
included in the Apache Ant distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a>
for more information.</p>
<p>Antlr 2.7.1 Note:
<i>
To successfully run ANTLR, your best option is probably to build the whole


+ 1
- 1
manual/Tasks/ejb.html View File

@@ -593,7 +593,7 @@ any of these files are newer than the jar file the jar will be rebuilt otherwise
a message is logged that the jar file is up to date.</p>

<p>The task uses the
<a href="http://commons.apache.org/bcel/"> BCEL </a> framework
<a href="http://commons.apache.org/bcel/">BCEL</a> <a href="../install.html#librarydependencies">library</a>
to extract all dependent classes. This
means that, in addition to the classes that are mentioned in the
deployment descriptor, any classes that these depend on are also


+ 1
- 1
manual/Tasks/image.html View File

@@ -27,7 +27,7 @@
<h2><a name="image">Image</a></h2>
<h3>Description</h3>
<p>Applies a chain of image operations on a set of files.</p>
<p>Requires Java Advanced Image API from Sun.</p>
<p>Requires <a href="../install.html#librarydependencies">Java Advanced Image API</a> from Sun.</p>

<h5>Overview of used datatypes</h5>
<img src="image-classdiagram.gif" border="0" alt="Class-Diagram">


+ 5
- 3
manual/Tasks/junitreport.html View File

@@ -23,12 +23,14 @@
<body>

<h2><a name="junitreport">JUnitReport</a></h2>
<h3>Description</h3>
Merge the individual XML files generated by the JUnit task and eventually apply
a stylesheet on the resulting merged document to provide a browsable report of
the testcases results.
<p><strong>Note:</strong> This task depends on external libraries not included in
the Apache Ant distribution. See <a href="../install.html#librarydependencies">
Library Dependencies</a> for more information.</p>

<p><strong>Note:</strong> This task depends on external libraries not
included in the Apache Ant distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a>
for more information.</p>

<h3>Requirements</h3>



+ 3
- 0
manual/Tasks/netrexxc.html View File

@@ -58,6 +58,9 @@ supports most attributes of <code>&lt;fileset&gt;</code>
or from the command line as<br>
<code>ant -Dant.netrexxc.verbose=noverbose ...</code>
</p>
<p><strong>Note:</strong> This task depends on external libraries not
included in the Apache Ant distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a>
for more information.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">


+ 1
- 1
manual/Types/classfileset.html View File

@@ -34,7 +34,7 @@ classfilesets are typically used by reference. They are declared with an
is expected.
</p>
<p>
This type requires the <code>BCEL</code> library.
This type requires the <code>BCEL</code> <a href="../install.html#librarydependencies">library</a>.
</p>




+ 2
- 2
manual/Types/mapper.html View File

@@ -383,8 +383,8 @@ href="http://www.crocodile.org/~sts/Rex/" target="_top">gnu.rex</a> with Ant, se
href="http://marc.theaimsgroup.com/?l=ant-dev&m=97550753813481&w=2" target="_top">this</a>
article.</p>

<p>If you want to use one of the regular expression
libraries other than <code>java.util.regex</code> you need to also use
<p>If you want to use one of the <a href="../install.html#librarydependencies">regular expression
libraries</a> other than <code>java.util.regex</code> you need to also use
the corresponding <code>ant-[apache-oro, apache-regexp].jar</code>
from the Ant release you are using.
Make sure, both will be loaded from the same


+ 548
- 617
manual/install.html
File diff suppressed because it is too large
View File


Loading…
Cancel
Save