From: David North <dnorth@apache.org>
Date: Mon, 5 Oct 2015 12:23:07 +0000 (+0000)
Subject: Clean up a bit and move some comments into descriptions for the benefit of ant -p
X-Git-Tag: REL_3_14_BETA1~268
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=0e05a940822986a3cc206b613e4195f23a6d41d8;p=poi.git

Clean up a bit and move some comments into descriptions for the benefit of ant -p

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1706822 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/build.xml b/build.xml
index b9116d6701..3cb599b2c2 100644
--- a/build.xml
+++ b/build.xml
@@ -389,7 +389,7 @@ under the License.
         <format property="tstamp.year" pattern="yyyy"/>
     </tstamp>
 
-    <target name="init" depends="fetch-jars,fetch-ooxml-jars">
+    <target name="init" depends="fetch-jars,fetch-ooxml-jars" description="Initialization run before other targets.">
         <mkdir dir="build"/>
         <mkdir dir="${main.output.dir}"/>
         <mkdir dir="${main.output.test.dir}"/>
@@ -413,7 +413,7 @@ under the License.
         <echo message="Using Java: ${java.version}/${java.runtime.version}/${java.vm.version}/${java.vm.name} from ${java.vm.vendor} on ${os.name}: ${os.version}" />
     </target>
 
-    <target name="clean">
+    <target name="clean" description="Remove generated artefacts">
         <delete dir="build"/>
     </target>
 
@@ -1687,11 +1687,7 @@ under the License.
       </sequential>
     </macrodef>
 
-    <!--
-      Install POI artifacts into the local repository.
-      Invoking this command is equivalent to 'mvn install' in Maven-driven projects.
-    -->
-    <target name="mvn-install" depends="maven.ant.tasks-check,jar,maven-poms">
+    <target name="mvn-install" depends="maven.ant.tasks-check,jar,maven-poms" description="Install POI artifacts into the local repository. Equivalent of 'mvn install'">
       <m2-install artifactId="poi"/>
       <m2-install artifactId="poi-scratchpad"/>
       <m2-install artifactId="poi-ooxml"/>
@@ -1700,9 +1696,7 @@ under the License.
       <m2-install artifactId="poi-excelant"/>
     </target>
 
-    <!-- Runs the Apache Creadur Rat check against the source code, to -->
-    <!--  spot any files which are missing the correct license headers -->
-    <target name="rat-check" depends="init">
+    <target name="rat-check" depends="init" description="Runs the Apache Creadur Rat check against the source code, to spot any files which are missing the correct license headers">
        <mkdir dir="${rat.reportdir}" />
 
        <typedef resource="org/apache/rat/anttasks/antlib.xml"
@@ -1758,7 +1752,7 @@ under the License.
         </forbiddenapis>
     </target>
 
-    <target name="findbugs"><!-- depends="assemble" -->
+    <target name="findbugs">
         <antcall target="downloadfile">
             <param name="sourcefile" value="http://prdownloads.sourceforge.net/findbugs/findbugs-noUpdateChecks-2.0.3.zip?download"/>
             <param name="destfile" value="${main.lib}/findbugs-noUpdateChecks-2.0.3.zip"/>