From 94de41433691d12a8dae71c5a274f40283dded52 Mon Sep 17 00:00:00 2001
From: Jonathan Ellis <jbellis@apache.org>
Date: Sat, 18 Sep 2010 21:08:05 +0000
Subject: [PATCH] add descriptions to ant tasks.  patch by Erik Onnen; reviewed
 by jbellis for CASSANDRA-1120

git-svn-id: https://svn.apache.org/repos/asf/cassandra/trunk@998541 13f79535-47bb-0310-9956-ffa450edef68
---
 build.xml | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/build.xml b/build.xml
index 9f3074191b..4f102aae14 100644
--- a/build.xml
+++ b/build.xml
@@ -109,7 +109,7 @@
         <mkdir dir="${build.src.gen-java}"/>
     </target>
 
-    <target name="clean">
+    <target name="clean" description="Remove all locally created artifacts">
         <delete dir="${build.test.dir}" />
         <delete dir="${build.classes}" />
         <delete dir="${build.src.gen-java}" />
@@ -225,10 +225,10 @@
        Cassandra depends on it, and python because that is what the system
        tests run.
     -->
-    <target name="gen-thrift-java" depends="rat-init">
+    <target name="gen-thrift-java" depends="rat-init" description="Generate Thrift Java artifacts">
       <echo>Generating Thrift Java code from ${basedir}/interface/cassandra.thrift ....</echo>
       <exec executable="thrift" dir="${basedir}/interface">
-        <arg line="--gen java" />
+        <arg line="--gen java:hashcode" />
         <arg line="-o ${interface.thrift.dir}" />
         <arg line="cassandra.thrift" />
       </exec>
@@ -240,7 +240,7 @@
         <arg value="interface/thrift" />
       </java>
     </target>
-    <target name="gen-thrift-py">
+    <target name="gen-thrift-py" description="Generate Thrift Python artifacts">
       <echo>Generating Thrift Python code from ${basedir}/interface/cassandra.thrift ....</echo>
       <exec executable="thrift" dir="${basedir}/interface">
         <arg line="--gen py" />
@@ -261,9 +261,9 @@
 	The build target builds all the .class files
     -->
     <target name="build"
-        depends="ivy-retrieve-build,avro-generate,build-subprojects,build-project"/>
-    <target name="build-subprojects"/>
-    <target name="codecoverage" depends="cobertura-instrument,test,cobertura-report"/>
+        depends="ivy-retrieve-build,avro-generate,build-subprojects,build-project" description="Compile Cassandra classes"/>
+    <target name="build-subprojects" description="Compile Cassandra contrib projects"/>
+    <target name="codecoverage" depends="cobertura-instrument,test,cobertura-report" description="Create code coverage report"/>
     	
     <target depends="init,avro-generate,gen-cli-grammar" name="build-project">
         <echo message="${ant.project.name}: ${ant.file}"/>
@@ -289,7 +289,7 @@
     <!--
 	The jar target makes cassandra.jar output.
     -->
-    <target name="jar" depends="build">
+    <target name="jar" depends="build" description="Assemble Cassandra JAR files">
       <mkdir dir="${build.classes}/META-INF"/>
       <copy file="LICENSE.txt" tofile="${build.classes}/META-INF/LICENSE.txt"/>
       <copy file="NOTICE.txt" tofile="${build.classes}/META-INF/NOTICE.txt"/>
@@ -307,7 +307,7 @@
     </target>
 
     <!-- creates a release tarball -->	
-    <target name="release" depends="jar,javadoc,rat-init">
+    <target name="release" depends="jar,javadoc,rat-init" description="Create a full Cassandra binary distribution including tar.gz">
       <mkdir dir="${dist.dir}"/>
       <copy todir="${dist.dir}/lib">
         <fileset dir="${build.lib}"/>
@@ -386,7 +386,7 @@
       </rat:report>
     </target>
 
-  <target name="build-test" depends="build" description="Build the Cassandra classes">
+  <target name="build-test" depends="build" description="Compile test classes">
     <javac
      debug="true"
      debuglevel="${debuglevel}"
@@ -432,11 +432,11 @@
     </sequential>
   </macrodef>
 
-  <target name="test" depends="build-test">
+  <target name="test" depends="build-test" description="Execute unit tests">
     <testmacro suitename="unit" inputdir="${test.unit.src}" timeout="60000" />
   </target>
 
-  <target name="long-test" depends="build-test">
+  <target name="long-test" depends="build-test" description="Execute functional tests">
     <testmacro suitename="long" inputdir="${test.long.src}" timeout="300000" />
   </target>
 	
@@ -509,7 +509,7 @@
     </java>
   </target>
 	
-  <target name="javadoc" depends="init">
+  <target name="javadoc" depends="init" description="Create javadoc">
     <tstamp>
       <format property="YEAR" pattern="yyyy"/>
     </tstamp>