svn commit: r1431929 - in /incubator/easyant/plugins/trunk: abstract-compile/src/main/resources/ abstract-package/src/main/resources/ abstract-provisioning/src/main/resources/ abstract-test/src/main/resources/

[jl...@apache.org]

Author: jlboudart
Date: Fri Jan 11 08:07:19 2013
New Revision: 1431929

URL: http://svn.apache.org/viewvc?rev=1431929&view=rev
Log:
Start documenting some important filesets, classpath

Modified:
    incubator/easyant/plugins/trunk/abstract-compile/src/main/resources/abstract-compile.ant
    incubator/easyant/plugins/trunk/abstract-package/src/main/resources/abstract-package.ant
    incubator/easyant/plugins/trunk/abstract-provisioning/src/main/resources/abstract-provisioning.ant
    incubator/easyant/plugins/trunk/abstract-test/src/main/resources/abstract-test.ant

Modified: incubator/easyant/plugins/trunk/abstract-compile/src/main/resources/abstract-compile.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/abstract-compile/src/main/resources/abstract-compile.ant?rev=1431929&r1=1431928&r2=1431929&view=diff
==============================================================================
--- incubator/easyant/plugins/trunk/abstract-compile/src/main/resources/abstract-compile.ant (original)
+++ incubator/easyant/plugins/trunk/abstract-compile/src/main/resources/abstract-compile.ant Fri Jan 11 08:07:19 2013
@@ -33,9 +33,9 @@
         description="defines the compile step" />
 	
 	<!-- Creates a empty classpath for compilation if it doesn't exist yet -->
-    <ea:path pathid="compile.main.classpath" overwrite="false" />
+    <ea:path pathid="compile.main.classpath" overwrite="false" description="classpath for main sources"/>
 
-    <path id="compile.test.classpath">
+    <path id="compile.test.classpath" description="classpath for tests sources">
         <pathelement location="${target.main.classes}" />
         <path refid="compile.main.classpath" />
     </path>

Modified: incubator/easyant/plugins/trunk/abstract-package/src/main/resources/abstract-package.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/abstract-package/src/main/resources/abstract-package.ant?rev=1431929&r1=1431928&r2=1431929&view=diff
==============================================================================
--- incubator/easyant/plugins/trunk/abstract-package/src/main/resources/abstract-package.ant (original)
+++ incubator/easyant/plugins/trunk/abstract-package/src/main/resources/abstract-package.ant Fri Jan 11 08:07:19 2013
@@ -35,7 +35,7 @@
             description="Pattern describing files excluded in the META-INF of the package" />
 
         <fileset id="package.metainf.fileset" dir="${package.metainf.basedir}" includes="${package.metainf.includes.pattern}"
-            excludes="${package.metainf.excludes.pattern}" />
+            excludes="${package.metainf.excludes.pattern}" description="content of metainf in future archives"/>
     </target>
 
     <target name="abstract-package:register-main-artifact" extensionOf="abstract-package:package" unless="${skip.register.main.artifact}">

Modified: incubator/easyant/plugins/trunk/abstract-provisioning/src/main/resources/abstract-provisioning.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/abstract-provisioning/src/main/resources/abstract-provisioning.ant?rev=1431929&r1=1431928&r2=1431929&view=diff
==============================================================================
--- incubator/easyant/plugins/trunk/abstract-provisioning/src/main/resources/abstract-provisioning.ant (original)
+++ incubator/easyant/plugins/trunk/abstract-provisioning/src/main/resources/abstract-provisioning.ant Fri Jan 11 08:07:19 2013
@@ -26,7 +26,7 @@
     <ea:parameter property="lib.test" default="${basedir}/lib/test" description="directory where test libraries are picked up" />
     <ea:parameter property="lib.provided" default="${basedir}/lib/provided" description="directory where provided libraries are picked up" />
 
-    <fileset id="lib.main.fileset" dir="${lib.main}" erroronmissingdir="false" />
-    <fileset id="lib.test.fileset" dir="${lib.test}" erroronmissingdir="false" />
-    <fileset id="lib.provided.fileset" dir="${lib.provided}" erroronmissingdir="false" />
+    <fileset id="lib.main.fileset" dir="${lib.main}" erroronmissingdir="false" description="content of lib main, usually used to build a classpath from a lib directory"/>
+    <fileset id="lib.test.fileset" dir="${lib.test}" erroronmissingdir="false" description="content of lib test, usually used to build a classpath from a lib directory"/>
+    <fileset id="lib.provided.fileset" dir="${lib.provided}" erroronmissingdir="false" description="content of lib provided, usually used to build a classpath from a lib directory"/>
 </project>
\ No newline at end of file

Modified: incubator/easyant/plugins/trunk/abstract-test/src/main/resources/abstract-test.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/abstract-test/src/main/resources/abstract-test.ant?rev=1431929&r1=1431928&r2=1431929&view=diff
==============================================================================
--- incubator/easyant/plugins/trunk/abstract-test/src/main/resources/abstract-test.ant (original)
+++ incubator/easyant/plugins/trunk/abstract-test/src/main/resources/abstract-test.ant Fri Jan 11 08:07:19 2013
@@ -67,12 +67,12 @@
         <ea:parameter property="target.test.integration.classes" default="${target}/integration-test/classes"
             description="destination directory for compiled integration test classes" />
 
-        <ea:path pathid="run.test.classpath" overwrite="append-if-not-exist">
+        <ea:path pathid="run.test.classpath" overwrite="append-if-not-exist" description="defines test runtime classpath, usually a good place to plug instrumented classes for coverage tool">
             <pathelement location="${target.test.classes}" />
             <path refid="compile.test.classpath" />
         </ea:path>
 
-        <ea:path pathid="run.test.integration.classpath" overwrite="append-if-not-exist">
+        <ea:path pathid="run.test.integration.classpath" overwrite="append-if-not-exist" description="defines integration-test runtime classpath, usually a good place to plug instrumented classes for coverage tool">
             <pathelement location="${target.test.integration.classes}" />
             <path refid="compile.test.classpath" />
         </ea:path>