List:Commits« Previous MessageNext Message »
From:mmatthews Date:January 18 2006 4:56pm
Subject:Connector/J commit: r4822 - branches/branch_3_1/connector-j
View as plain text  
Modified:
   branches/branch_3_1/connector-j/build.xml
Log:
Added descriptions to targets.

Modified: branches/branch_3_1/connector-j/build.xml
===================================================================
--- branches/branch_3_1/connector-j/build.xml	2006-01-18 16:55:41 UTC (rev 4821)
+++ branches/branch_3_1/connector-j/build.xml	2006-01-18 16:56:06 UTC (rev 4822)
@@ -147,7 +147,7 @@
 			depends="full-dist, -remove-sources, -make-packages"/>
 
 	<target name="full-dist" description="Builds driver, binary .jar file and docs, basically a distribution 'image'"
-		depends="dist-trace, dist, -bundle-docs"/>
+		depends="-dist-trace, dist, -bundle-docs"/>
 
 	<target name="package" depends="dist, -make-packages"/>
 
@@ -244,7 +244,8 @@
 		<checksum file="${distDir}/${fullProdName}.zip" forceOverwrite="yes" fileext=".md5"/>
 	</target>
 
-	<target name="dist" depends="init, compile">
+	<target name="dist" depends="init, compile"
+		description="Builds non-debug driver, and packages into .jar files, but does not package into .tar.gz or .zip, see target 'full-package' for this.">
 
 		<delete file="${buildDir}/${fullProdName}-bin.jar" />
 		<delete file="${distDir}/${fullProdName}.jar" />
@@ -273,7 +274,7 @@
 			manifest="${buildDir}/META-INF/MANIFEST.MF"/>
 	</target>
 
-	<target name="dist-trace" depends="init, compile-driver-trace">
+	<target name="-dist-trace" depends="init, -compile-driver-trace">
 
 		<delete file="${buildDir}/${fullProdName}-bin-g.jar"/>
 
@@ -527,10 +528,12 @@
 	</target>
 
 
-	<target name="compile" depends="init, -commercial-license, compile-driver, compile-testsuite, compile.integration">
+	<target name="compile" depends="init, -commercial-license, compile-driver, compile-testsuite, compile.integration"
+		description="Compiles the driver, testsuite, and integration classes.">
 	</target>
 
-	<target name="compile-trace" depends="init, -commercial-license, compile-driver-trace">
+	<target name="compile-trace" depends="init, -commercial-license, -compile-driver-trace"
+		description="Compiles the debug/trace variant of the driver.">
 	</target>
 
 	<!-- Compiles the driver itself -->
@@ -549,7 +552,7 @@
 
 	<!-- Compiles a version of the driver with AspectJ tracing -->
 
-	<target name="compile-driver-trace" depends="init">
+	<target name="-compile-driver-trace" depends="init">
 		<taskdef 
 			      resource="org/aspectj/tools/ant/taskdefs/aspectjTaskdefs.properties">
 			<classpath>
@@ -575,11 +578,13 @@
 		depends="compile-driver, 
 				 compile-integration-c3p0, 
 		         compile-integration-jboss,
-				 compile-integration-log4j"/>
+				 compile-integration-log4j"
+		description="Compiles integration classes for third-party software."/>
 
 	<target name="compile-integration-c3p0" 
 		depends="compile-driver"
-		if="com.mysql.jdbc.c3p0Present">
+		if="com.mysql.jdbc.c3p0Present"
+		description="Compiles integration classes for C3P0 connection pool.">
 		<javac srcdir="${buildDir}/${fullProdName}" 
 				destdir="${buildDir}/${fullProdName}" 
 				deprecation="off" 
@@ -591,7 +596,8 @@
 
 	<target name="compile-integration-jboss" 
 			depends="compile-driver"
-			if="com.mysql.jdbc.jbossPresent">
+			if="com.mysql.jdbc.jbossPresent"
+			description="Compiles integration classes for JBoss application server.">
 		<javac srcdir="${buildDir}/${fullProdName}" 
 					destdir="${buildDir}/${fullProdName}" 
 					deprecation="off" 
@@ -603,7 +609,8 @@
 
 	<target name="compile-integration-log4j" 
 			depends="compile-driver"
-			if="com.mysql.jdbc.log4jPresent">
+			if="com.mysql.jdbc.log4jPresent"
+			description="Compiles integration classes for Log4j logging framework.">
 		<javac srcdir="${buildDir}/${fullProdName}" 
 				destdir="${buildDir}/${fullProdName}" 
 				deprecation="off" 
@@ -615,7 +622,8 @@
 
 	<!-- Compiles the JUnit testsuite -->
 
-	<target name="compile-testsuite" depends="init, compile-driver">
+	<target name="compile-testsuite" depends="init, compile-driver"
+		description="Compiles the testsuite.">
 		<javac 
 			srcdir="${buildDir}/${fullProdName}" 
 			destdir="${buildDir}/${fullProdName}" 
@@ -627,7 +635,8 @@
 		</javac>
 	</target>
 
-	<target name="real-clean">
+	<target name="real-clean"
+		description="Removes all output artifiacts.">
 		<delete dir="${buildDir}"/>
 		<delete>
 			<fileset dir="${distDir}" 
@@ -635,7 +644,9 @@
 		</delete>
 	</target>
 
-	<target name="clean" unless="com.mysql.jdbc.noCleanBetweenCompiles">
+	<target name="clean" unless="com.mysql.jdbc.noCleanBetweenCompiles"
+		description="Removes build artifacts, but not packaging artifacts.">
+		
 		<delete dir="${buildDir}"/>
 	</target>
 
@@ -703,7 +714,7 @@
 	     http://emma.sourceforge.net/
 	-->
 
-	<target name="emma" description="turns on EMMA instrumentation/reporting" >
+	<target name="emma" description="Turns on EMMA instrumentation/reporting" >
 		<!-- directory that contains emma.jar and emma_ant.jar: -->
 		<property name="emma.dir" value="${sourceDir}/lib-coverage" />
 
@@ -718,8 +729,8 @@
 		<property name="emma.coverage.dir" value="${buildDir}/${fullProdName}-coverage" />
 	</target>
 
-	<target name="instrument" depends="init, compile" 
-		description="runs the examples" >
+	<target name="-instrument" depends="init, compile" 
+		description="Instruments the bytecode with emma for coverage testing." >
 
 		<emma enabled="${emma.enabled}" >
 			<instr instrpathref="built.driver.only.classpath"
@@ -761,7 +772,7 @@
 	</target>
 
 
-	<target name="test-coverage" depends="instrument">
+	<target name="test-coverage" depends="-instrument">
 		<property name="com.mysql.jdbc.testsuite.jvm" value="java"/>
 		<mkdir dir="${junit.results}"/>
 		<echo message="Running unit tests against ${com.mysql.jdbc.testsuite.url} with jvm ${com.mysql.jdbc.testsuite.jvm}"/>
@@ -812,7 +823,7 @@
 		</junitreport>
 	</target>
 
-	<target name="test-coverage-compliance" depends="instrument">
+	<target name="test-coverage-compliance" depends="-instrument">
 		<property name="com.mysql.jdbc.test.jvm" value="java"/>
 		<mkdir dir="${junit.results}"/>
 		<echo message="Running compliance tests against ${com.mysql.jdbc.compliance.url} with jvm ${com.mysql.jdbc.testsuite.jvm}"/>
@@ -913,7 +924,7 @@
 	<!-- Runs compliance testsuite against multiple JVMs and 
 	     server configs, and produces coverage reports -->
 
-	<target name="test-coverage-multijvm" depends="instrument">
+	<target name="test-coverage-multijvm" depends="-instrument">
 		<for list="1,2,3,4,5,6,7,8" param="jvm.number">
 			<sequential>
 				<if>
@@ -954,7 +965,7 @@
 	<!-- Runs compliance testsuite against multiple JVMs and server configs, collecting
 	       coverage data -->
 
-	<target name="test-coverage-compliance-multijvm" depends="instrument">
+	<target name="test-coverage-compliance-multijvm" depends="-instrument">
 		<for list="1,2,3,4,5,6,7,8" param="jvm.number"  xmlns:ac="antlib:net.sf.antcontrib">
 			<sequential>
 				<if>

Thread
Connector/J commit: r4822 - branches/branch_3_1/connector-jmmatthews18 Jan