stefano 02/05/12 17:03:19 Modified: . build.xml Log: removed the description comments from the subtargets to make "ant -projecthelp" much more useful and descriptive also removed the Sun XDoclet since it doesn't belong here Revision Changes Path 1.207 +106 -112 xml-cocoon2/build.xml Index: build.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/build.xml,v retrieving revision 1.206 retrieving revision 1.207 diff -u -r1.206 -r1.207 --- build.xml 8 May 2002 10:11:41 -0000 1.206 +++ build.xml 13 May 2002 00:03:19 -0000 1.207 @@ -213,7 +213,6 @@ <property name="build.docs.loglevel" value="INFO"/> <property name="build.war" value="${build.dir}/webapp"/> <property name="build.javadocs" value="${build.dir}/javadocs"/> - <property name="build.xjavadocs" value="${build.dir}/xjavadocs"/> <property name="build.context" value="${build.dir}/documentation"/> <property name="build.scratchpad" value="${build.dir}/scratchpad"/> <property name="build.scratchpad.src" value="${build.scratchpad}/src"/> @@ -269,7 +268,7 @@ <!-- =================================================================== --> <!-- Try other builds that could go into this core build --> <!-- =================================================================== --> - <target name="try" depends="init" description="Builds to try before including in main build"> + <target name="try" depends="init"> <ant target="${try.task}" antfile="build-t.xml"/> </target> @@ -277,7 +276,7 @@ <!-- Installs Cocoon war file in a specified directory --> <!-- =================================================================== --> <target name="installwar" depends="init" - description="* Installs the war package in a specified directory"> + description="Installs the WAR package (without the scratchpad) in a specified directory"> <taskdef name="user-input" classname="UserInputTask" classpath="./tools/anttasks"/> <property name="include.webapp.libs" value="true"/> @@ -291,7 +290,7 @@ <!-- Installs Cocoon war with scratchpad stuff in a specified directory --> <!-- =================================================================== --> <target name="installscratchpadwar" depends="init" - description="* Installs the war package in a specified directory"> + description="Installs the WAR package (with the scratchpad) in a specified directory"> <echo message=" This contains SCRATCHPAD BUILDS. It is not guaranteed to work."/> <echo message=" You have been warned. "/> @@ -317,8 +316,7 @@ <!-- =================================================================== --> <!-- Test for optional components --> <!-- =================================================================== --> - <target name="optional-tests" depends="init" - description="Tests for optional classes missing to the environment"> + <target name="optional-tests" depends="init"> <!-- A simple task to test for a class --> <taskdef name="class-available" classname="ClassAvailableTask" @@ -486,7 +484,7 @@ <!-- =================================================================== --> <!-- Macro for optional warnings --> <!-- =================================================================== --> - <target name="op-warning" description="General waring target (used by other targets)" unless="omit.opt.warnings"> + <target name="op-warning" unless="omit.opt.warnings"> <echo>**********************************************</echo> <echo>*</echo> <echo>* Classes of the optional package ${thing} are not </echo> @@ -503,18 +501,20 @@ <!-- =================================================================== --> <!-- Warnings --> <!-- =================================================================== --> - <target name="bsf-warn" unless="bsf.present" depends="optional-tests" - description="Outputs a warning if com.ibm.bsf.* classes are missing during compilation"> + + <!-- Outputs a warning if com.ibm.bsf.* classes are missing during compilation --> + <target name="bsf-warn" unless="bsf.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="BSF"/> <param name="recovery" value="Get the BSF package from http://oss.software.ibm.com/developerworks/projects/bsf/ and place the jar in the lib/optional dir"/> - <param name="message" + <param name="message" value="BSF is required for the script action."/> </antcall> </target> - <target name="rhino-warn" unless="rhino.interpreter.present" depends="optional-tests" - description="Outputs a warning if org.mozilla.javascript.* classes are missing during compilation"> + + <!-- Outputs a warning if org.mozilla.javascript.* classes are missing during compilation --> + <target name="rhino-warn" unless="rhino.interpreter.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Rhino"/> <param name="recovery" @@ -522,9 +522,10 @@ <param name="message" value="Rhino is required for the scripts and XSP in Javascript."/> </antcall> - </target> - <target name="python-warn" unless="python.present" depends="optional-tests" - description="Outputs a warning if org.python.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.python.* classes are missing during compilation --> + <target name="python-warn" unless="python.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="jython"/> <param name="recovery" @@ -532,9 +533,10 @@ <param name="message" value="Jython is required for the scripts in Python."/> </antcall> - </target> - <target name="jfor-warn" unless="jfor.present" depends="optional-tests" - description="Outputs a warning if org.jfor.jfor.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.jfor.jfor.* classes are missing during compilation --> + <target name="jfor-warn" unless="jfor.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="JFOR"/> <param name="recovery" @@ -542,9 +544,10 @@ <param name="message" value="JFOR is required for the fo2rtf serializer."/> </antcall> - </target> - <target name="xmldb-warn" unless="xmldb.present" depends="optional-tests" - description="Outputs a warning if org.xmldb.api.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.xmldb.api.* classes are missing during compilation --> + <target name="xmldb-warn" unless="xmldb.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="XMLDB"/> <param name="recovery" @@ -552,9 +555,10 @@ <param name="message" value="XMLDB is required for the xmldb and xmldbcollection generator."/> </antcall> - </target> - <target name="xt-warn" unless="xt.present" depends="optional-tests" - description="Outputs a warning if com.jclark.xsl.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if com.jclark.xsl.* classes are missing during compilation --> + <target name="xt-warn" unless="xt.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="XT"/> <param name="recovery" @@ -562,9 +566,10 @@ <param name="message" value="XT is required for the xt transformer."/> </antcall> - </target> - <target name="php-warn" unless="php.present" depends="optional-tests" - description="Outputs a warning if net.php.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if net.php.* classes are missing during compilation --> + <target name="php-warn" unless="php.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="PHP"/> <param name="recovery" @@ -572,9 +577,10 @@ <param name="message" value="PHP is required for the php generator."/> </antcall> - </target> - <target name="naming-warn" unless="naming.present" depends="optional-tests" - description="Outputs a warning if javax.naming.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if javax.naming.* classes are missing during compilation --> + <target name="naming-warn" unless="naming.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="JNDI"/> <param name="recovery" @@ -582,9 +588,10 @@ <param name="message" value="JNDI is required for the ldap generator and the parentcm generator."/> </antcall> - </target> - <target name="svg-warn" unless="svg.present" depends="optional-tests" - description="Outputs a warning if org.apache.batik.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.apache.batik.* classes are missing during compilation --> + <target name="svg-warn" unless="svg.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Batik"/> <param name="recovery" @@ -592,9 +599,10 @@ <param name="message" value="Batik is required for the svg serializers."/> </antcall> - </target> - <target name="fop-warn" unless="fop.present" depends="optional-tests" - description="Outputs a warning if org.apache.fop.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.apache.fop.* classes are missing during compilation --> + <target name="fop-warn" unless="fop.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="FOP"/> <param name="recovery" @@ -602,9 +610,10 @@ <param name="message" value="FOP is required for the fo2pdf, fo2ps and fo2pcl serializer."/> </antcall> - </target> - <target name="tidy-warn" unless="tidy.present" depends="optional-tests" - description="Outputs a warning if org.w3c.tidy.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.w3c.tidy.* classes are missing during compilation --> + <target name="tidy-warn" unless="tidy.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="JTidy"/> <param name="recovery" @@ -612,9 +621,10 @@ <param name="message" value="JTidy is required for the html generator."/> </antcall> - </target> - <target name="maybeupload-warn" unless="maybeupload.present" depends="optional-tests" - description="Outputs a warning if uk.co.weft.maybeupload.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if uk.co.weft.maybeupload.* classes are missing during compilation --> + <target name="maybeupload-warn" unless="maybeupload.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="MaybeUpload"/> <param name="recovery" @@ -622,9 +632,10 @@ <param name="message" value="MaybeUpload simplifies the handling of uploaded files."/> </antcall> - </target> - <target name="lucene-warn" unless="lucene.present" depends="optional-tests" - description="Outputs a warning if org.apache.lucene.* classes are missing during compilation"> + </target> + + <!-- Outputs a warning if org.apache.lucene.* classes are missing during compilation --> + <target name="lucene-warn" unless="lucene.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Lucene"/> <param name="recovery" @@ -633,8 +644,9 @@ value="Lucene is required for the Cocoon searches."/> </antcall> </target> - <target name="deli-warn" unless="deli.present" depends="optional-tests" - description="Outputs a warning if com.hp.hpl.deli.* classes are missing during compilation"> + + <!-- Outputs a warning if com.hp.hpl.deli.* classes are missing during compilation --> + <target name="deli-warn" unless="deli.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Deli"/> <param name="recovery" @@ -643,8 +655,9 @@ value="Deli is required for ..."/> </antcall> </target> - <target name="velocity-warn" unless="velocity.present" depends="optional-tests" - description="Outputs a warning if org.apache.velocity.* classes are missing during compilation"> + + <!-- Outputs a warning if org.apache.velocity.* classes are missing during compilation --> + <target name="velocity-warn" unless="velocity.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Velocity"/> <param name="recovery" @@ -653,8 +666,9 @@ value="Velocity is required for the velocity generator."/> </antcall> </target> - <target name="hsqldb-warn" unless="hsqldb.present" depends="optional-tests" - description="Outputs a warning if org.hsqldb.* classes are missing during compilation"> + + <!-- Outputs a warning if org.hsqldb.* classes are missing during compilation --> + <target name="hsqldb-warn" unless="hsqldb.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="hsqldb"/> <param name="recovery" @@ -663,8 +677,9 @@ value="hsqldb is required for the sql examples."/> </antcall> </target> - <target name="resolver-warn" unless="resolver.present" depends="optional-tests" - description="Outputs a warning if org.apache.xml.resolver.* classes are missing during compilation"> + + <!-- Outputs a warning if org.apache.xml.resolver.* classes are missing during compilation --> + <target name="resolver-warn" unless="resolver.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Resolver"/> <param name="recovery" @@ -673,8 +688,9 @@ value="The resolver allows entity resolving."/> </antcall> </target> - <target name="jisp-warn" unless="jisp.present" depends="optional-tests" - description="Outputs a warning if com.coyotegulch.jisp.* classes are missing during compilation"> + + <!-- Outputs a warning if com.coyotegulch.jisp.* classes are missing during compilation --> + <target name="jisp-warn" unless="jisp.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="jisp"/> <param name="recovery" @@ -683,8 +699,9 @@ value="jisp is required for the JispFilesystemStore."/> </antcall> </target> - <target name="pizza-warn" unless="pizza.present" depends="optional-tests" - description="Outputs a warning if net.sf.pizzacompiler.compiler.* classes are missing during compilation"> + + <!-- Outputs a warning if net.sf.pizzacompiler.compiler.* classes are missing during compilation --> + <target name="pizza-warn" unless="pizza.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Pizza"/> <param name="recovery" @@ -693,8 +710,9 @@ value="Pizza is the alternative Java compiler."/> </antcall> </target> - <target name="poi-warn" unless="poi.present" depends="optional-tests" - description="Outputs a warning if org.apache.poi.* classes are missing during compilation"> + + <!-- Outputs a warning if org.apache.poi.* classes are missing during compilation --> + <target name="poi-warn" unless="poi.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="POI"/> <param name="recovery" @@ -703,8 +721,9 @@ value="POI is required for the POI sitemap components."/> </antcall> </target> - <target name="commons-logging-warn" unless="commons.logging.present" depends="optional-tests" - description="Outputs a warning if org.apache.commons.logging.* classes are missing during compilation"> + + <!-- Outputs a warning if org.apache.commons.logging.* classes are missing during compilation --> + <target name="commons-logging-warn" unless="commons.logging.present" depends="optional-tests"> <antcall target="op-warning"> <param name="thing" value="Jakarta Commons Logging"/> <param name="recovery" @@ -719,8 +738,7 @@ <!-- Print out warnings for optional components --> <!-- =================================================================== --> <target name="optional-warnings" - depends="bsf-warn, rhino-warn, jfor-warn, xmldb-warn, xt-warn, php-warn, naming-warn, svg-warn, fop-warn, tidy-warn, maybeupload-warn, lucene-warn, deli-warn, velocity-warn, hsqldb-warn, resolver-warn, jisp-warn, pizza-warn, poi-warn, commons-logging-warn" - description="Outputs warnings if some optional jars are missing from the environment"> + depends="bsf-warn, rhino-warn, jfor-warn, xmldb-warn, xt-warn, php-warn, naming-warn, svg-warn, fop-warn, tidy-warn, maybeupload-warn, lucene-warn, deli-warn, velocity-warn, hsqldb-warn, resolver-warn, jisp-warn, pizza-warn, poi-warn, commons-logging-warn"> </target> @@ -926,9 +944,9 @@ <!-- =================================================================== --> <!-- Creates the jar file --> <!-- =================================================================== --> - <target name="all" depends="package" description="Default target"/> + <target name="all" depends="package" description="Default target (calls the 'package' target)"/> - <target name="package" depends="compile" description="Generates the jar package"> + <target name="package" depends="compile" description="Generates the jar packages"> <jar jarfile="${build.dir}/${name}.jar" manifest="${build.src}/Manifest.mf"> <fileset dir="${build.dest}"> <include name="org/**"/> @@ -947,7 +965,7 @@ <!-- =================================================================== --> <!-- Target called by Gump --> <!-- =================================================================== --> - <target name="gump" depends="docs, javadocs, test, package" description="Gump target"/> + <target name="gump" depends="docs, javadocs, test, package" description="[admin] Target called by Gump"/> <!-- =================================================================== --> <!-- Prepares the docs --> @@ -1019,7 +1037,7 @@ <target name="docs" depends="package, prepare-docs, docs_check, docs_done" unless="docs.notrequired" - description="* Generates the documentation"> + description="Builds the documentation"> <java classname="org.apache.cocoon.Main" fork="true" dir="${build.context}" failonerror="true"> <arg value="-c."/> @@ -1233,7 +1251,7 @@ <!-- =================================================================== --> <!-- Creates the war file --> <!-- =================================================================== --> - <target name="webapp" depends="prepare-war" description="* Generates the war package"> + <target name="webapp" depends="prepare-war" description="Builds the war package"> <!-- A task to create manifest for webapp. --> <taskdef name="manifest-tool" classname="ManifestToolTask" classpath="${tools.dir}/anttasks"/> @@ -1248,7 +1266,7 @@ <!-- Creates a local webapp directly useable as a servlet context --> <!-- =================================================================== --> <target name="webapp-local" depends="prepare-webapp, prepare-webapp-scratchpad, copy-webapp-libs, copy-scratchpad-libs" - description="Generates a local webapp directory usable as servlet context for quicker turn around"> + description="Builds a local webapp directory usable as servlet context for quicker turn around"> <copy todir="${build.war}/WEB-INF/classes"> <fileset dir="${build.dest}"/> <fileset dir="${build.scratchpad.dest}"/> @@ -1265,7 +1283,8 @@ <!-- =================================================================== --> <!-- Installs Cocoon file --> <!-- =================================================================== --> - <target name="install" depends="package, webapp, remove-webapp" if="install.war" description="* Installs the war package"> + <target name="install" depends="package, webapp, remove-webapp" if="install.war" + description="Installs the WAR package"> <copy file="${build.dir}/${name}.war" tofile="${install.war}/${name}.war"/> </target> @@ -1295,7 +1314,7 @@ <!-- =================================================================== --> <target name="announcement" depends="prepare-docs" - description="* Creates the announcement for new releases"> + description="[admin] Creates the announcement for new releases"> <copy file="announcement.xml" tofile="${build.context}\xdocs\announcement.xml" filtering="on"/> @@ -1335,7 +1354,7 @@ <!-- =================================================================== --> <target name="printer-docs" depends="package, prepare-printer-docs, printer-docs_check, printer-docs_done" unless="printer-docs.notrequired" - description="* Generates printer-friendly documentation"> + description="Builds printer-friendly documentation"> <mkdir dir="${build.docs.printer}"/> <java classname="org.apache.cocoon.Main" fork="true" dir="${build.dir}/printer_documentation" failonerror="true"> @@ -1360,7 +1379,7 @@ <!-- Creates the web site --> <!-- =================================================================== --> <target name="site" depends="docs, javadocs" - description="Generates the web site (for site maintainers only)"> + description="[admin] Builds the web site"> <mkdir dir="${site}"/> <copy todir="${site}" filtering="off"> <fileset dir="${build.docs}"> @@ -1396,7 +1415,7 @@ <!-- =================================================================== --> <target name="javadocs" depends="prepare-src-main, javadocs_check, javadocs_done" unless="javadocs.notrequired" - description="* Generates the API documentation"> + description="Builds the API documentation (javadocs)"> <mkdir dir="${build.javadocs}"/> <javadoc packagenames="${packages}" sourcepath="${build.src}" @@ -1414,29 +1433,9 @@ </target> <!-- =================================================================== --> - <!-- Creates the API documentation (using the Sun XML doclet) --> - <!-- =================================================================== --> - <target name="xjavadocs" depends="prepare-src-main, javadocs_check, javadocs_done" - unless="javadocs.notrequired" - description="* Generates the API documentation (using the Sun XML doclet)"> - <mkdir dir="${build.xjavadocs}"/> - <javadoc packagenames="${packages}" - sourcepath="${build.src}" - destdir="${build.xjavadocs}" - author="true" - version="true" - use="false" - doclet="com.sun.xml.XmlDoclet" - docletpathref="classpath"> - <classpath refid="classpath"/> - </javadoc> - </target> - - <!-- =================================================================== --> - <!-- Creates the source distribution --> + <!-- Prepares the source distribution --> <!-- =================================================================== --> - <target name="dist-src" depends="docs, javadocs" - description="Prepares the source distribution"> + <target name="dist-src" depends="docs, javadocs"> <!-- Simply copy all and add the html docs --> <mkdir dir="${dist.root}"/> <mkdir dir="${dist.src.dir}"/> @@ -1554,8 +1553,7 @@ <!-- =================================================================== --> <!-- Packages the source distribution as .zip --> <!-- =================================================================== --> - <target name="dist-src-zip" depends="dist-src" - description="Generates the source distribution as a .zip file"> + <target name="dist-src-zip" depends="dist-src"> <zip zipfile="${dist.target}/${dist.name}-src.zip" basedir="${dist.root}/source"/> </target> @@ -1563,8 +1561,7 @@ <!-- =================================================================== --> <!-- Packages the source distribution with .tar.gzip --> <!-- =================================================================== --> - <target name="dist-src-tgz" depends="dist-src" - description="Generates the source distribution as a .tar.gz file"> + <target name="dist-src-tgz" depends="dist-src"> <tar tarfile="${dist.target}/${dist.name}-src.tar" basedir="${dist.root}/source" longfile="gnu"/> @@ -1573,10 +1570,9 @@ </target> <!-- =================================================================== --> - <!-- Creates the source distribution --> + <!-- Prepares the binary distribution --> <!-- =================================================================== --> - <target name="dist-bin" depends="package, webapp, docs, javadocs" - description="Prepares the binary distribution"> + <target name="dist-bin" depends="package, webapp, docs, javadocs"> <!-- Copy webapp and the html docs --> <mkdir dir="${dist.root}"/> <mkdir dir="${dist.bin.dir}"/> @@ -1645,8 +1641,7 @@ <!-- =================================================================== --> <!-- Packages the binary distribution as .zip --> <!-- =================================================================== --> - <target name="dist-bin-zip" depends="dist-bin" - description="Generates the binary distribution as a .zip file"> + <target name="dist-bin-zip" depends="dist-bin"> <zip zipfile="${dist.target}/${dist.name}-bin.zip" basedir="${dist.root}/bin"/> </target> @@ -1654,8 +1649,7 @@ <!-- =================================================================== --> <!-- Packages the binary distribution with .tar.gzip --> <!-- =================================================================== --> - <target name="dist-bin-tgz" depends="dist-bin" - description="Generates the binary distribution as a .tar.gz file"> + <target name="dist-bin-tgz" depends="dist-bin"> <tar tarfile="${dist.target}/${dist.name}-bin.tar" basedir="${dist.root}/bin" longfile="gnu"/> @@ -1684,17 +1678,17 @@ <!-- =================================================================== --> <target name="dist" depends="dist-info, dist-bin-tgz, dist-bin-zip, dist-src-tgz, dist-src-zip" - description="* Generates all distributions (source/binary)"> + description="[admin] Builds the distributions"> </target> <!-- =================================================================== --> <!-- Clean targets --> <!-- =================================================================== --> - <target name="clean" depends="init" description="* Cleans the build directories"> + <target name="clean" depends="init" description="Cleans the build directories"> <delete dir="${build.dir}"/> </target> - <target name="distclean" depends="clean" description="* Cleans everything to the original state"> + <target name="distclean" depends="clean" description="Cleans everything to the original state"> <delete dir="${build.root}"/> <delete file="${dist.target}/${Name}-${version}.tar.gz"/> <delete file="${dist.target}/${Name}-${version}.tar"/> @@ -1711,7 +1705,7 @@ <!-- =================================================================== --> <!-- Test targets --> <!-- =================================================================== --> - <target name="test" depends="compile" description="Perform jUnit tests"> + <target name="test" depends="compile" description="[admin] Perform jUnit tests"> <mkdir dir="${build.test}"/> <!-- Copy test files to build test dir --> <copy todir="${build.test}" filtering="on"> @@ -1751,7 +1745,7 @@ <!-- =================================================================== --> <!-- Fix line endings in src --> <!-- =================================================================== --> - <target name="fixsrclf" depends="init" description="Fix lf in src directory (internal use only!)"> + <target name="fixsrclf" depends="init"> <fixcrlf srcdir="${java.dir}" includes="**/*.java" eol="lf"/> </target>
---------------------------------------------------------------------- In case of troubles, e-mail: [EMAIL PROTECTED] To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]