incubator-easyant-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jlboud...@apache.org
Subject svn commit: r1383534 - in /incubator/easyant/core/trunk/src/documentation: ref/anttasks/Parametertask.html ref/anttasks/SubModuletask.html ref/anttasks/easyant.html ref/anttasks/menugenerator.html ref/anttasks/registerartifact.html toc.json
Date Tue, 11 Sep 2012 18:49:46 GMT
Author: jlboudart
Date: Tue Sep 11 18:49:45 2012
New Revision: 1383534

URL: http://svn.apache.org/viewvc?rev=1383534&view=rev
Log:
Update task documentation round 2

Removed:
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html
Modified:
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
    incubator/easyant/core/trunk/src/documentation/toc.json

Modified: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html?rev=1383534&r1=1383533&r2=1383534&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html Tue Sep
11 18:49:45 2012
@@ -33,7 +33,7 @@ parameter tasks is used to :
 <li>check if properties / paths</li>
 <li>set default values if properties are not set</li>
 </ul>
-This could be useful in precondition of each modules, to check if property/phase/path are
set. And much more useful to document our modules.
+This could be useful in precondition of each modules, to check if property/path are set.
And much more useful to document our modules.
 </p>
 
 <h2>Arguments</h2>
@@ -49,11 +49,11 @@ This could be useful in precondition of 
     </tr>
     <tr id="mandatory">
       <td>property</td>
-      <td>give a description to the property / path / phase</td>
+      <td>specify the property to check</td>
     </tr>
     <tr id="mandatory">
       <td>description</td>
-      <td>specify the path id to check</td>
+      <td>give a description to the property / path</td>
       <td>true</td>
     </tr>
     <tr>

Modified: incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html?rev=1383534&r1=1383533&r2=1383534&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html Tue Sep
11 18:49:45 2012
@@ -37,13 +37,9 @@ This task is used to manage orchestratio
   </thead>
   <tbody>
     <tr id="mandatory">
-      <td>buildpath</td>
-      <td>the buildpath to be used to find sub-projects.</td>
-      <td rowspan="2">one of these</td>
-    </tr>
-    <tr id="mandatory">
       <td>buildpathRef</td>
       <td>Buildpath to use, by reference</td>
+      <td>true if no nested buildpath element</td>
     </tr>
     <tr>
       <td>useBuildRepository</td>
@@ -53,7 +49,7 @@ This task is used to manage orchestratio
 
     <tr>
       <td>overwrite</td>
-      <td>Specify if publication in build repository should overwrite existing artifacts
(default value : true)</td>
+      <td>Specify if publication in build repository should overwrite existing artifacts<br/><i>Default
: true</i></td>
       <td> </td>
     </tr>
     <tr>
@@ -63,17 +59,58 @@ This task is used to manage orchestratio
     </tr>
     <tr>
       <td>verbose</td>
-      <td>Enable/ disable verbose log messages showing when each sub-build path is
entered/ exited (default value : false)</td>
+      <td>Enable/ disable verbose log messages showing when each sub-build path is
entered/ exited<br/><i>Default : false</i></td>
       <td> </td>
     </tr>
     <tr>
       <td>failOnError</td>
-      <td>Sets whether to fail with a build exception on error, or go on (default value
: true)</td>
+      <td>Sets whether to fail with a build exception on error, or go on<br/><i>Default
: true</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>inheritRefs</td>
+      <td>If true, pass all references to the new Ant project<br/><i>Default
: false</i></td>
       <td> </td>
     </tr>
   </tbody>
 </table>
 
+<h2>Nested Elements</h2>
+<h3>buildpath</h3>
+<p>
+Buildpath to be used to find sub-projects.
+Mandatory if no buildpathref argument is specified.
+</p>
+
+<h3>reference</h3>
+
+<p>
+Used to choose references that shall be copied into the new project, optionally changing
their id.
+</p>
+<table class="sortable">
+  <thead>
+    <tr>
+      <th>Attribute</th>
+      <th class="unsortable">Description</th>
+      <th>Required</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>refid</td>
+      <td>The id of the reference in the calling project.</td>
+      <td>true</td>
+    </tr>
+    <tr>
+      <td>torefid</td>
+      <td>The id of the reference in the new project.<br/><i>Default to
the value of refid</i></td>
+      <td>false</td>
+    </tr>
+  </tbody>
+</table>
+
+<h3>propertyset</h3>
+<p>You can specify a set of properties to be copied into the new project with propertysets.</p>
 
 <h2>Example</h2>
 <code type="xml">

Modified: incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html?rev=1383534&r1=1383533&r2=1383534&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html Tue Sep 11 18:49:45
2012
@@ -84,10 +84,10 @@ If no target attribute is supplied, the 
 </table>
 
 <h2>Example</h2>
-Run package phase in a separated context (forked)
+Run package phase in current context
 <code type="xml">
-  <ea:easyant targets="package" />
-<code>
+    <ea:easyant fork="false" targets="package"/>
+</code>
 
 Run default targets in a separated context (forked)
 <code type="xml">
@@ -106,7 +106,7 @@ Import easyant build types and plugins i
 
 Suppose you have the following build.xml
 <code type="xml">
-<project name="myAntProject"
+<project name="myAntProject">
   <ea:easyant fork="false"/>
 </project>
 </code>

Modified: incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html?rev=1383534&r1=1383533&r2=1383534&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html Tue
Sep 11 18:49:45 2012
@@ -59,7 +59,7 @@ registerartifact is a PostResolveTask
       <td>No, defaults to type</td>
     </tr>
     <tr>
-      <td>conf</td>
+      <td>confs</td>
       <td>comma separated list of public configurations in which this artifact is published.
'*' wildcard can be used to designate all public configurations of this module.</td>
       <td>No, defaults to defaultconf attribute value on parent publications elements</td>
     </tr>

Modified: incubator/easyant/core/trunk/src/documentation/toc.json
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/toc.json?rev=1383534&r1=1383533&r2=1383534&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/toc.json (original)
+++ incubator/easyant/core/trunk/src/documentation/toc.json Tue Sep 11 18:49:45 2012
@@ -195,13 +195,6 @@
                             ]
                         },
                         {
-                          "id":"ref/anttasks/menugenerator",
-                          "title":"menugenerator",
-                          "children": [
-
-                            ]
-                        },
-                        {
                           "id":"ref/anttasks/LoadModuletask",
                           "title":"loadmodule",
                           "children": [



Mime
View raw message