Revised installation manual, cross-referenced optional tasks/types Project: http://git-wip-us.apache.org/repos/asf/ant/repo Commit: http://git-wip-us.apache.org/repos/asf/ant/commit/0da54795 Tree: http://git-wip-us.apache.org/repos/asf/ant/tree/0da54795 Diff: http://git-wip-us.apache.org/repos/asf/ant/diff/0da54795
Branch: refs/heads/master Commit: 0da54795ca415988a47f5061c850473fe24c8580 Parents: b3d141a Author: Gintas Grigelionis <[email protected]> Authored: Sat Jan 20 10:11:35 2018 +0100 Committer: Gintas Grigelionis <[email protected]> Committed: Sat Jan 20 10:11:35 2018 +0100 ---------------------------------------------------------------------- build.xml | 67 +- manual/Tasks/antlr.html | 3 + manual/Tasks/ejb.html | 2 +- manual/Tasks/image.html | 2 +- manual/Tasks/junitreport.html | 8 +- manual/Tasks/netrexxc.html | 3 + manual/Types/classfileset.html | 2 +- manual/Types/mapper.html | 4 +- manual/install.html | 1172 +++++++++++++++++------------------ 9 files changed, 592 insertions(+), 671 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/build.xml ---------------------------------------------------------------------- diff --git a/build.xml b/build.xml index a63e363..e7c5001 100644 --- a/build.xml +++ b/build.xml @@ -24,7 +24,6 @@ <property file="${user.home}/.ant.properties"/> <property environment="env"/> - <!-- =================================================================== Set the properties that control names and versions @@ -526,7 +525,6 @@ </condition> </target> - <!-- =================================================================== Prepare the build @@ -546,9 +544,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}"/> @@ -625,9 +622,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}"> @@ -763,8 +759,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"> @@ -874,8 +869,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}"/> @@ -937,14 +931,14 @@ </antcall> </target> - <target name="dist-javadocs" depends="javadocs" unless="javadoc.notrequired"> + <target name="dist-javadocs" depends="javadocs" + unless="javadoc.notrequired"> <mkdir dir="${dist.javadocs}"/> <copy todir="${dist.javadocs}" overwrite="true"> <fileset dir="${build.javadocs}"/> </copy> </target> - <macrodef name="checksums-mvn" description="only md5 and sha1 are needed for the maven directory structure"> <element name="resources" implicit="true"/> <sequential> @@ -1061,10 +1055,8 @@ <include name="${bootstrap.jar}"/> </fileset> </copy> - </target> - <!-- =================================================================== Target to create bootstrap build @@ -1076,7 +1068,6 @@ </antcall> </target> - <!-- =================================================================== Create the source distribution @@ -1412,8 +1403,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"/> @@ -1493,8 +1483,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" @@ -1562,8 +1551,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}"/> @@ -1577,13 +1565,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> @@ -1616,8 +1602,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} @@ -1793,8 +1779,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=""/> @@ -1936,8 +1921,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"/> @@ -1956,8 +1941,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"/> @@ -2025,10 +2010,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"/> <!-- =================================================================== @@ -2036,10 +2019,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"/> http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Tasks/antlr.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/antlr.html b/manual/Tasks/antlr.html index e7d4fdb..ca0bcde 100644 --- a/manual/Tasks/antlr.html +++ b/manual/Tasks/antlr.html @@ -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 http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Tasks/ejb.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/ejb.html b/manual/Tasks/ejb.html index 4911e14..f554498 100644 --- a/manual/Tasks/ejb.html +++ b/manual/Tasks/ejb.html @@ -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 http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Tasks/image.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/image.html b/manual/Tasks/image.html index ed7ed7e..077b372 100644 --- a/manual/Tasks/image.html +++ b/manual/Tasks/image.html @@ -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"> http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Tasks/junitreport.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/junitreport.html b/manual/Tasks/junitreport.html index 365920b..fea85e5 100644 --- a/manual/Tasks/junitreport.html +++ b/manual/Tasks/junitreport.html @@ -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> http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Tasks/netrexxc.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/netrexxc.html b/manual/Tasks/netrexxc.html index 8102b72..efdfa4d 100644 --- a/manual/Tasks/netrexxc.html +++ b/manual/Tasks/netrexxc.html @@ -58,6 +58,9 @@ supports most attributes of <code><fileset></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"> http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Types/classfileset.html ---------------------------------------------------------------------- diff --git a/manual/Types/classfileset.html b/manual/Types/classfileset.html index 6145d97..a83d266 100644 --- a/manual/Types/classfileset.html +++ b/manual/Types/classfileset.html @@ -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> http://git-wip-us.apache.org/repos/asf/ant/blob/0da54795/manual/Types/mapper.html ---------------------------------------------------------------------- diff --git a/manual/Types/mapper.html b/manual/Types/mapper.html index 1da85dc..b557360 100644 --- a/manual/Types/mapper.html +++ b/manual/Types/mapper.html @@ -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
