gump-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r111709 - in gump/trunk/src/documentation/content/xdocs: . metadata
Date Mon, 13 Dec 2004 13:02:02 GMT
Author: bodewig
Date: Mon Dec 13 05:01:59 2004
New Revision: 111709

URL: http://svn.apache.org/viewcvs?view=rev&rev=111709
Log:
Document the new builders, change documentation structure to be less Ant centric
Removed:
   gump/trunk/src/documentation/content/xdocs/metadata/ant.xml
   gump/trunk/src/documentation/content/xdocs/metadata/maven.xml
Modified:
   gump/trunk/src/documentation/content/xdocs/metadata/builder.xml
   gump/trunk/src/documentation/content/xdocs/metadata/practices.xml
   gump/trunk/src/documentation/content/xdocs/metadata/project.xml
   gump/trunk/src/documentation/content/xdocs/site.xml

Deleted: /gump/trunk/src/documentation/content/xdocs/metadata/ant.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/metadata/ant.xml?view=auto&rev=111708
==============================================================================

Modified: gump/trunk/src/documentation/content/xdocs/metadata/builder.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/metadata/builder.xml?view=diff&rev=111709&p1=gump/trunk/src/documentation/content/xdocs/metadata/builder.xml&r1=111708&p2=gump/trunk/src/documentation/content/xdocs/metadata/builder.xml&r2=111709
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/builder.xml	(original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/builder.xml	Mon Dec 13 05:01:59 2004
@@ -28,6 +28,15 @@
 
 <body>
 
+  <section><title>More on builders</title>
+
+    <p>Gump supports building projects with a wide variety of tools.
+    These tools are described using their own elements, all of them
+    support a common set of attributes and nested elements.  The
+    common structure is described in the next section, followed by
+    tool-specific sections later on.</p>
+  </section>
+
   <section><title>Generic Builder</title>
     <p>Specifies the arguments to be passed to all builders</p>
 
@@ -41,21 +50,24 @@
         <td>basedir</td>
         <td>The base directory in which the build is executed.  The generated
           build script will make this directory the current working directory
-          prior to invoking Ant.
+          prior to invoking the real builder.
         </td>
         <td>No. Defaults to <em>project basedir</em>.</td>
       </tr>
-	  <tr>
-        <td>debug</td>
-        <td>Set to "true" to turn on ant debugging.</td>
+      <tr>
+        <td>debug (Ant/Maven/NAnt only)</td>
+        <td>Set to "true" to turn on debugging.</td>
         <td>No</td>
       </tr>
     </table>
     
-    <warning>Only Python Gump supports &lt;ant debug=&quot;true&quot;</warning>
-     
-    <section><title>property</title>
-      <p>Property overrides to be passed to the Ant command</p>
+    <section><title>property/arg</title>
+
+      <p>Java Property overrides to be passed to the Ant/Maven command
+      or command line arguments passed to Script/Configure/Make.  The
+      Java builders Ant and Maven as well as NAnt use &lt;property&gt;
+      while Script, Configure and Make use &lt;arg&gt; as the name of
+      the nested element.</p>
 
       <table>
         <tr>
@@ -112,7 +124,9 @@
       <p>This is equivalent to a property reference="jarpath" as well as a
       dependency element in the enclosing project.  This was introduced as
       that has become a common enough practice that it makes sense to
-      introduce this element</p>
+      introduce this element.</p>
+
+      <p>Depend is only supported by the Java builders Ant and Maven.</p>
 
       <table>
         <tr>
@@ -148,7 +162,7 @@
 
     <section><title>jvmarg</title>
       <p>Additional command line parameters to pass to the Java
-          Virtual Machine running Ant.</p>
+      Virtual Machine running Ant or Maven.</p>
 
       <table>
         <tr>
@@ -168,6 +182,9 @@
     <section><title>sysproperty</title>
       <p>Java system property to be passed to the Java Virtual Machine.</p>
 
+      <p>Sysproperty is only supported by the Java builders Ant and
+      Maven.</p>
+
       <table>
         <tr>
           <th>Attribute</th>
@@ -219,6 +236,176 @@
       </table>
     </section>
 
+  </section>
+
+  <section><title>script</title>
+
+    <p>Specifies a script to be executed in order to make build a
+    project.</p>
+
+    <p>The assumption is that the script can be invoked in a platform
+    independent manner, though the contents of the script may be
+    platform specific.  Specifically, if the name of the script is
+    "name" and no file with the name "name" exists in the project's
+    basedir, it will be invoked as follows:</p>
+
+    <ul>
+      <li>On Windows/batch, "call .\name.bat"</li>
+      <li>On Unix/bash, "./name.sh"</li>
+    </ul>
+
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>name</td>
+        <td>The name of the script to execute.</td>
+        <td>Yes</td>
+      </tr>
+    </table>
+
+    <p>Additional command line arguments can be specified using nested
+    &lt;arg&gt; elements.  If the name of an arg start with "--" or
+    doesn't start with "-", then a single argument gets created from
+    one &lt;arg&gt; element, using "=" to join name and value.  If it
+    starts with a single "-", two arguments get created, one for the
+    name and one for the value.  For example:</p>
+
+    <source>
+      &lt;script name="foo"&gt;
+        &lt;arg name="--double-dash" value="1"/&gt;
+        &lt;arg name="-single-dash" value="2"/&gt;
+        &lt;arg name="no-dash" value="3"/&gt;
+      &lt;/script&gt;
+    </source>
+      <p>becomes</p>
+    <source>
+      ./foo --double-dash=1 -single-dash 2 no-dash=3
+    </source>
+  </section>
+
+  <section><title>ant</title>
+    <p>Specifies the arguments to be passed to <fork
+    href="http://ant.apache.org/">Ant</fork>.</p>
+
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>buildfile</td>
+        <td>The ant build file to execute.  Defaults to
+        <strong>build.xml</strong>.
+        </td>
+        <td>No Defaults to <strong>build.xml</strong>.</td>
+      </tr>
+      <tr>
+        <td>target</td>
+        <td>The ant target to invoke. <em>This can be a comma
+        separated list. Spaces are preserved.</em></td>
+        <td>No. Defaults to the default target defined by the build file.</td>
+      </tr>
+    </table>
+  </section>
+
+  <section><title>maven</title>
+    <p>Specifies the arguments to be passed to <fork
+    href="http://maven.apache.org/">Maven</fork>.</p>
+    
+    <p>The <fork href="http://maven.apache.org/">Maven</fork>
+    component of Gump (&lt;maven&gt;) uses a
+    <strong>pre-installed</strong> version of <fork
+    href="http://maven.apache.org">Maven</fork>, it does
+    <strong>NOT</strong> bootstrap Maven from CVS HEAD, yet. This is
+    hopefully something that will be added in the future.</p>
+    
+    <p>Gump generates a <strong>build.properties</strong> file for
+    Maven, in which it specifies the jar <link
+    href="http://maven.apache.org/reference/user-guide.html#Overriding_Stated_Dependencies">overrides</link>,
+    and also any <link href="project.html#property">properties</link>
+    that are passes into the &lt;maven element.</p>
+    
+    <p>Currently Gump does <strong>not</strong> read the Maven
+    project.xml (POM) to attempt to determine dependencies, the Gump
+    descriptor needs to have them. The 'gump' goal in Maven ought
+    generate such a file.</p>
+    
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>goal</td>
+        <td>The Maven goal to invoke.  <em>This can be a comma
+        separated list. Spaces are preserved.</em></td>
+        <td>No. Defaults to <strong>jar</strong>.</td>
+      </tr>
+    </table>
+  </section>
+
+  <section><title>configure</title>
+
+    <p>Is a specialized version of <link href="#script">script</link>
+    with the fixed script name of "configure".</p>
+
+  </section>
+
+  <section><title>make</title>
+
+    <p>Specifies the arguments to be passed to make.</p>
+
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>makefile</td>
+        <td>The make file to execute.  Defaults to <strong>Makefile</strong>.
+        </td>
+        <td>No Defaults to <strong>Makefile</strong>.</td>
+      </tr>
+      <tr>
+        <td>target</td>
+        <td>The make target to invoke. <em>This can be a comma
+        separated list. Spaces are preserved.</em></td>
+        <td>No. Defaults to <strong>ALL</strong>.</td>
+      </tr>
+    </table>
+  </section>
+
+  <section><title>nant</title>
+    <p>Specifies the arguments to be passed to <fork
+    href="http://nant.sourceforge.org/">NAnt</fork>.</p>
+
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>buildfile</td>
+        <td>The NAnt build file to execute.  Defaults to
+        <strong>NAnt.build</strong>.
+        </td>
+        <td>No Defaults to <strong>NAnt.build</strong>.</td>
+      </tr>
+      <tr>
+        <td>target</td>
+        <td>The NAnt target to invoke. <em>This can be a comma
+        separated list. Spaces are preserved.</em></td>
+        <td>No. Defaults to the default target defined by the build file.</td>
+      </tr>
+    </table>
   </section>
 
 </body>

Deleted: /gump/trunk/src/documentation/content/xdocs/metadata/maven.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/metadata/maven.xml?view=auto&rev=111708
==============================================================================

Modified: gump/trunk/src/documentation/content/xdocs/metadata/practices.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/metadata/practices.xml?view=diff&rev=111709&p1=gump/trunk/src/documentation/content/xdocs/metadata/practices.xml&r1=111708&p2=gump/trunk/src/documentation/content/xdocs/metadata/practices.xml&r2=111709
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/practices.xml	(original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/practices.xml	Mon Dec 13 05:01:59
2004
@@ -45,7 +45,7 @@
   		</section>  	
 	  	<section><title>Let Gump set your final jar name</title>
 	  		<p>Gump runs set @@DATE@@, which ought be set into the
-	  		jar name. Use a <link href="ant.html#property">property</link> for this.
+	  		jar name. Use a <link href="builder.html#property">property</link> for this.
   			</p>
 	  	</section>
 	  	<section><title>Example</title>	  		

Modified: gump/trunk/src/documentation/content/xdocs/metadata/project.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/metadata/project.xml?view=diff&rev=111709&p1=gump/trunk/src/documentation/content/xdocs/metadata/project.xml&r1=111708&p2=gump/trunk/src/documentation/content/xdocs/metadata/project.xml&r2=111709
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/project.xml	(original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/project.xml	Mon Dec 13 05:01:59 2004
@@ -33,8 +33,10 @@
     a project definition fall into three different "groups", each optional:</p>
 
     <ul>
-    <li>Build instructions: &lt;ant&gt; and &lt;script&gt;.  Describes
how to
-    produce the outputs from the inputs.</li>
+    <li><link href="builder.html">Build instructions</link>:
+    &lt;ant&gt;, &lt;nant&gt;, &lt;maven&gt;, &lt;configure&gt;,
+    &lt;make&gt; and &lt;script&gt;.<br/>
+          Describes how to produce the outputs from the inputs.</li>
     <li>Inputs: &lt;depend&gt;, &lt;option&gt;, and &lt;work&gt;.
 Describes
     where to find the inputs (primarily jar files, but can be directories and
     files).</li>
@@ -60,12 +62,12 @@
       </tr>
       <tr>
         <td>target</td>
-        <td>Override the <link href="ant.html">ant</link> target to be
used.</td>
+        <td>Override the <link href="builder.html#ant">ant</link> target
to be used.</td>
         <td>No</td>
       </tr>
       <tr>
         <td>buildfile</td>
-        <td>Override the <link href="ant.html">ant</link> build file to
be used.</td>
+        <td>Override the <link href="builder.html#ant">ant</link> build
file to be used.</td>
         <td>No</td>
       </tr>
       <tr>
@@ -81,47 +83,6 @@
     </table>
 
     <warning>vm is not currently implemented</warning>
-
-    <section><title>ant</title>
-      <p>Identifies this project as "buildable", and specifies the
-      target to build and the properties to be passed to ant.  The full
-      description of this XML element can be found
-      <link href="ant.html">here</link></p>
-
-      <p><link href="http://ant.apache.org/">Apache Ant</link> is the
-      defacto build tool used by a large number of Open Source Java
-      projects.</p>
-    </section>
-
-    <section><title>script</title>
-      <p>Identifies this project as "buildable", and specifies the
-      script to be executed in order to make this happen.  The assumption
-      is that the script can be invoked in a platform independent manner,
-      though the contents of the script may be platform specific.
-      Specifically, if the name of the script is "name", it will be
-      invoked as follows:</p>
-
-      <p>At the present time, the only use of this is during the bootstrap
-      process for Ant.</p>
-
-      <ul>
-        <li>On Windows/batch, "call .\name.bat"</li>
-        <li>On Unix/bash, "./name.sh"</li>
-      </ul>
-
-      <table>
-        <tr>
-          <th>Attribute</th>
-          <th>Description</th>
-          <th>Required?</th>
-        </tr>
-        <tr>
-          <td>name</td>
-          <td>The name of the script to execute.</td>
-          <td>Yes</td>
-        </tr>
-      </table>
-    </section>
 
     <section><title>depend</title>
       <p>Specifies the name of a required prerequisite project.  If a

Modified: gump/trunk/src/documentation/content/xdocs/site.xml
Url: http://svn.apache.org/viewcvs/gump/trunk/src/documentation/content/xdocs/site.xml?view=diff&rev=111709&p1=gump/trunk/src/documentation/content/xdocs/site.xml&r1=111708&p2=gump/trunk/src/documentation/content/xdocs/site.xml&r2=111709
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/site.xml	(original)
+++ gump/trunk/src/documentation/content/xdocs/site.xml	Mon Dec 13 05:01:59 2004
@@ -60,8 +60,7 @@
 	    <repository href="metadata/repository.html" label="Repository"/>
     	    <module href="metadata/module.html" label="Module"/>
 	    <project href="metadata/project.html" label="Project"/>
-	    <ant href="metadata/ant.html" label="Ant"/>
-	    <maven href="metadata/maven.html" label="Maven"/>
+	    <builder href="metadata/builder.html" label="Builder"/>
 	    <goodpractices href="metadata/practices.html" label="Good Practices"/>
 	</om>
 

Mime
View raw message