svn commit: r534835 - /incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml

[mb...@apache.org]

Author: mbaessler
Date: Thu May  3 06:00:33 2007
New Revision: 534835

URL: http://svn.apache.org/viewvc?view=rev&rev=534835
Log:
UIMA-384

update example for the pear packaging ANT task

JIRA ticket https://issues.apache.org/jira/browse/UIMA-384

Added:
    incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml
      - copied, changed from r534802, incubator/uima/sandbox/trunk/PearPackagingAntTask/buildSample.xml

Copied: incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml (from r534802, incubator/uima/sandbox/trunk/PearPackagingAntTask/buildSample.xml)
URL: http://svn.apache.org/viewvc/incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml?view=diff&rev=534835&p1=incubator/uima/sandbox/trunk/PearPackagingAntTask/buildSample.xml&r1=534802&p2=incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml&r2=534835
==============================================================================
--- incubator/uima/sandbox/trunk/PearPackagingAntTask/buildSample.xml (original)
+++ incubator/uima/sandbox/trunk/PearPackagingAntTask/packageExample.xml Thu May  3 06:00:33 2007
@@ -1,22 +1,31 @@
 <?xml version="1.0"?>
 <project name="PearPackagingTask" default="pearPackagingSample" basedir=".">
 
-	<!-- define the classpath settings for the pear packaging task. 
-		 uimaj-pear-task.jar and uima-core.jar is needed -->
+	<!-- define the classpath settings for the pear packaging ANT task. 
+		 uimaj-pear-task.jar and uima-core.jar is necessary -->
 	<path id="pearTask.classpath">
 	    <fileset dir="/home/apache-uima/lib/" includes="uimaj-pear-task.jar"/>
 		<fileset dir="/home/apache-uima/lib/" includes="uima-core.jar"/>
 	</path>
 	
-	<!-- pear packaging sample target -->
+	<!-- pear packaging example target -->
 	<target name="pearPackagingSample">
 	  	
-		<!-- Define pear packaging task -->
+		<!-- Define custom pear packaging ANT task using 'packagePear' as task name -->
 		<taskdef name="packagePear" 
 	  		        classname="org.apache.uima.pear.tools.PearPackagingAntTask"
 			  		classpathref="pearTask.classpath"/>
 
-		<!-- Sample pear packaging -->
+		<!-- Example pear packaging 
+			componentID = the main component ID of the UIMA component that should be packaged
+			mainComponentDesc = main component descriptor that should be used to run the pear package content
+			classpath = specify the classpath that must be used to run the pear package content - use $main_root macros
+			datapath = sepcify the datapath that must be set to run the pear package content - use $main_root macros
+			mainComponentDir = main component directory that contains the pear package content
+			targetDir = target directory where the created pear package is written to
+
+			optionally specify some environment variable <envVar> settings that must be set to run the pear package content
+		-->
 	    <packagePear componentID="SampleAnnotator"
 	    	mainComponentDesc="desc/mainComponentDesc.xml" 
 	    	classpath="$main_root/pearClasspahtEntry;$main_root/anotherPearClasspahtEntry" 
@@ -26,6 +35,8 @@
 	    	<envVar name="ENV_VAR_NO1" value="value1"/>
 	    	<envVar name="ENV_VAR_NO2" value="value2"/>
 		</packagePear>
+
+		<!-- the pear package was created in the target directory with the filename <componetID>.pear -->
 	  </target>
 
 </project>