From e261f69df32d431b3f1ef8ba28f902663b0aa4a1 Mon Sep 17 00:00:00 2001
From: Uwe Schindler <uschindler@apache.org>
Date: Fri, 28 Sep 2012 13:44:36 +0000
Subject: [PATCH] Cleanup build files a little bit: remove descriptions of
 Jenkins-targets. Expose Clover, add Eclipse cleanup

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1391461 13f79535-47bb-0310-9956-ffa450edef68
---
 build.xml         | 119 ++++++++++++++++++++++------------------------
 extra-targets.xml |   6 +--
 2 files changed, 59 insertions(+), 66 deletions(-)

diff --git a/build.xml b/build.xml
index 1984872964b..e39c382cd29 100644
--- a/build.xml
+++ b/build.xml
@@ -27,9 +27,7 @@
   </target>
 
   <target name="test-help" description="Test runner help">
-    <subant target="test-help" inheritall="false" failonerror="true">
-      <fileset dir="lucene" includes="build.xml" />
-    </subant>
+    <subant buildpath="lucene" target="test-help" inheritall="false" failonerror="true"/>
   </target>
 
   <target name="precommit" description="Run basic checks before committing"
@@ -44,7 +42,7 @@
     </sequential>
   </target>
 
-  <target name="pitest" description="Test both Lucene and Solr">
+  <target name="pitest" description="Run PITest on both Lucene and Solr">
     <sequential>
       <subant target="pitest" inheritall="false" failonerror="false">
         <fileset dir="lucene" includes="build.xml" />
@@ -97,27 +95,24 @@
   </target>
 	
   <target name="rat-sources" description="Runs rat across all sources and tests">
-    <sequential><subant target="rat-sources" inheritall="false" failonerror="true">
-        <fileset dir="lucene" includes="build.xml" />
-        <fileset dir="solr" includes="build.xml" />
-    </subant></sequential>
+    <subant target="rat-sources" inheritall="false" failonerror="true">
+      <fileset dir="lucene" includes="build.xml" />
+      <fileset dir="solr" includes="build.xml" />
+    </subant>
   </target>
 
   <target name="resolve" depends="clean-jars" description="Resolves all dependencies">
-    <sequential><subant target="resolve" inheritall="false" failonerror="true">
-        <fileset dir="lucene" includes="build.xml" />
-        <fileset dir="solr" includes="build.xml" />
-      </subant></sequential>
+    <subant target="resolve" inheritall="false" failonerror="true">
+      <fileset dir="lucene" includes="build.xml" />
+      <fileset dir="solr" includes="build.xml" />
+    </subant>
   </target>
 
   <target name="compile" description="Compile Lucene and Solr">
-    <sequential>
-
-      <subant target="compile" inheritall="false" failonerror="true">
-        <fileset dir="lucene" includes="build.xml" />
-        <fileset dir="solr" includes="build.xml" />
-      </subant>
-    </sequential>
+    <subant target="compile" inheritall="false" failonerror="true">
+      <fileset dir="lucene" includes="build.xml" />
+      <fileset dir="solr" includes="build.xml" />
+    </subant>
   </target>
 
   <property name="version" value="5.0-SNAPSHOT"/>
@@ -125,7 +120,7 @@
   <property name="maven-version" value="2.2.1"/>
   
   <target name="get-maven-poms"
-          description="Copy Maven POMs from dev-tools/maven/ to ${maven-build-dir}/">
+          description="Copy Maven POMs from dev-tools/maven/ to the working copy root">
     <copy todir="${maven-build-dir}" overwrite="true">
       <fileset dir="${basedir}/dev-tools/maven"/>
       <filterset begintoken="@" endtoken="@">
@@ -136,7 +131,7 @@
   </target>
 
   <target name="clean-maven-build"
-          description="Remove ">
+          description="Clean up Maven POMs in working copy">
     <delete failonerror="true" dir="${maven-build-dir}/"/>
   </target>
 
@@ -144,19 +139,16 @@
           description="Generate Maven Artifacts for Lucene and Solr">
     <property name="maven.dist.dir"  location="dist/maven" />
     <mkdir dir="${maven.dist.dir}" />
-
-    <sequential>
-      <ant dir="lucene" target="filter-pom-templates"/>
-      <subant target="generate-maven-artifacts" inheritall="false" failonerror="true">
-        <property name="maven.dist.dir"  location="${maven.dist.dir}" />
-        <property name="filtered.pom.templates.uptodate" value="true"/>
-        <fileset dir="lucene" includes="build.xml" />
-        <fileset dir="solr" includes="build.xml" />
-      </subant>
-    </sequential>
+    <ant dir="lucene" target="filter-pom-templates"/>
+    <subant target="generate-maven-artifacts" inheritall="false" failonerror="true">
+      <property name="maven.dist.dir"  location="${maven.dist.dir}" />
+      <property name="filtered.pom.templates.uptodate" value="true"/>
+      <fileset dir="lucene" includes="build.xml" />
+      <fileset dir="solr" includes="build.xml" />
+    </subant>
   </target>
 
-  <target name="validate-maven-dependencies" depends="generate-maven-artifacts" description="Validates maven dependencies, licenses, etc">
+  <target name="validate-maven-dependencies" depends="generate-maven-artifacts" description="Validates maven dependencies, licenses, etc.">
     <subant target="-validate-maven-dependencies" inheritall="false" failonerror="true">
       <property name="filtered.pom.templates.uptodate" value="true"/>
       <fileset dir="lucene" includes="build.xml"/>
@@ -165,11 +157,10 @@
   </target>
   
   <target name="run-maven-build" depends="get-maven-poms" description="Runs the Maven build using automatically generated POMs">
-    <subant target="run-maven-build" inheritall="false" failonerror="true">
+    <subant buildpath="." genericantfile="extra-targets.xml" target="-run-maven-build" inheritall="false" failonerror="true">
       <propertyset>
         <propertyref prefix="maven-"/>
       </propertyset>
-      <fileset dir="." includes="extra-targets.xml" />
     </subant>
   </target>
   
@@ -196,6 +187,14 @@
     </echo>
   </target>
 
+  <target name="clean-eclipse" description="Removes all Eclipse configuration files">
+    <delete dir=".settings" failonerror="true"/>
+    <delete failonerror="true">
+      <fileset dir="." includes=".classpath,.project"/>
+    </delete>
+    <delete dir="eclipse-build" failonerror="true"/>
+  </target>
+
   <target name="idea" depends="clean-jars, resolve" description="Setup IntelliJ IDEA configuration">
     <copy todir=".">
       <fileset dir="dev-tools/idea"/>
@@ -217,7 +216,7 @@
     <delete dir="idea-build" failonerror="true"/>
   </target>
 
-  <target name="clean" description="Clean Lucene and Solr">
+  <target name="clean" description="Clean Lucene and Solr build dirs">
     <delete dir="dist" />
     <sequential>
       <subant target="clean" inheritall="false" failonerror="true">
@@ -239,18 +238,14 @@
   </target>
 
   <target name="ivy-bootstrap" description="Download and install Ivy in the users ant lib dir">
-    <subant target="ivy-bootstrap" inheritall="false" failonerror="true">
-      <fileset dir="lucene" includes="build.xml" />
-    </subant>
+    <subant buildpath="lucene" target="ivy-boostrap" inheritall="false" failonerror="true"/>
   </target>
 
   <target name="jar-checksums" description="Recompute SHA1 checksums for all JAR files.">
-    <sequential>
-      <subant target="jar-checksums" inheritall="false" failonerror="true">
-        <fileset dir="lucene" includes="build.xml" />
-        <fileset dir="solr" includes="build.xml" />
-      </subant>
-    </sequential>
+    <subant target="jar-checksums" inheritall="false" failonerror="true">
+      <fileset dir="lucene" includes="build.xml" />
+      <fileset dir="solr" includes="build.xml" />
+    </subant>
   </target>
 
   <!-- define here, as common-build is not included! -->
@@ -315,24 +310,12 @@
    </sequential>
   </target>
   
-  <target name="check-svn-working-copy">
-    <subant target="check-svn-working-copy" inheritall="false" failonerror="true">
-      <fileset dir="." includes="extra-targets.xml" />
-    </subant>
+  <target name="check-svn-working-copy" description="Checks the status of the SVN working copy">
+    <subant buildpath="." genericantfile="extra-targets.xml" target="-check-svn-working-copy" inheritall="false" failonerror="true"/>
   </target>
 
-  <!-- Calls only generate-clover-reports on Lucene, as Solr's is just a clone with other target; the database itsself is fixed -->
-  <target name="generate-clover-reports">
-    <subant target="generate-clover-reports" inheritall="false" failonerror="true">
-      <fileset dir="." includes="extra-targets.xml" />
-    </subant>
-  </target>
-
-  <!-- Jenkins tasks -->
-  <target name="jenkins-hourly" depends="clean,test,validate,-jenkins-documentation-lint,jar-checksums,check-svn-working-copy" description="Runs the Jenkins hourly test runs"/>
-  
-  <target name="jenkins-clover" description="Runs nightly clover builds on Jenkins">
-    <antcall target="-jenkins-clover">
+  <target name="run-clover" description="Runs all tests to measure coverage and generates report (pass &quot;ANT_ARGS=-Xmx1536M&quot; as environment)" depends="clean">
+    <antcall>
       <param name="run.clover" value="true"/>
       <!-- must be 1, as clover does not like parallel test runs: -->
       <param name="tests.jvms" value="1"/>
@@ -343,12 +326,22 @@
       <param name="tests.badapples" value="true"/>
       <!-- The idea behind Clover is to determine test coverage, so be immune to failing tests: -->
       <param name="tests.haltonfailure" value="false"/>
+      
+      <target name="test"/>
+      <target name="-generate-clover-reports"/>
     </antcall>
   </target>
-  <target name="-jenkins-clover" depends="clean,test,generate-clover-reports"/>
 
-  <target name="jenkins-maven-nightly" depends="clean,remove-maven-artifacts,run-maven-build,generate-maven-artifacts,validate-maven-dependencies"
-    description="Runs the nightly Maven build on Jenkins, including artifact deployment"/>
+  <target name="-generate-clover-reports">
+    <subant buildpath="." genericantfile="extra-targets.xml" target="-generate-clover-reports" inheritall="false" failonerror="true"/>
+  </target>
+
+  <!-- Jenkins tasks -->
+  <target name="jenkins-hourly" depends="clean,test,validate,-jenkins-documentation-lint,jar-checksums,check-svn-working-copy"/>
+  
+  <target name="jenkins-maven-nightly" depends="clean,remove-maven-artifacts,run-maven-build,generate-maven-artifacts,validate-maven-dependencies"/>
+  
+  <target name="jenkins-clover" depends="run-clover"/>
   
   <!-- we need this extra condition, as we want to match only on "true", not solely if property is set: -->
   <property name="disable.documentation-lint" value="false" />
diff --git a/extra-targets.xml b/extra-targets.xml
index e597f782788..e160bd1698a 100644
--- a/extra-targets.xml
+++ b/extra-targets.xml
@@ -31,7 +31,7 @@
    This target is in a separate file, as it needs to include common-build.xml,
    but must run from top-level!
    -->
-  <target name="generate-clover-reports" depends="clover">
+  <target name="-generate-clover-reports" depends="clover">
     <fail unless="run.clover">Clover not enabled!</fail>
     <mkdir dir="${clover.report.dir}"/>
     <fileset dir="." id="clover.test.result.files">
@@ -51,7 +51,7 @@
     <echo>You can find the merged Lucene/Solr Clover report in '${clover.report.dir}'.</echo>
   </target>
 
-  <target name="run-maven-build" depends="install-maven-tasks">
+  <target name="-run-maven-build" depends="install-maven-tasks">
     <mvn xmlns="antlib:org.apache.maven.artifact.ant" pom="${maven-build-dir}/pom.xml"
       mavenVersion="${maven-version}" failonerror="true" fork="true">
       <arg value="-fae"/>
@@ -59,7 +59,7 @@
     </mvn>
   </target>
 
-  <target xmlns:ivy="antlib:org.apache.ivy.ant" name="check-svn-working-copy" depends="ivy-availability-check,ivy-fail,ivy-configure,resolve-groovy">
+  <target xmlns:ivy="antlib:org.apache.ivy.ant" name="-check-svn-working-copy" depends="ivy-availability-check,ivy-fail,ivy-configure,resolve-groovy">
     <ivy:cachepath organisation="org.tmatesoft.svnkit" module="svnkit" revision="1.7.5-v1"
       inline="true" conf="default" type="jar" transitive="true" pathid="svnkit.classpath"/>
     <script language="groovy" taskname="svn">