ajack 2004/06/07 08:48:30
Modified: src/documentation/content/xdocs/metadata ant.xml
repository.xml
src/documentation/content/xdocs/python index.xml
src/documentation/content/xdocs site.xml
src/documentation/content/xdocs/traditional index.xml
Added: src/documentation/content/xdocs/metadata maven.xml
builder.xml
Log:
1) Split ant.xml into ant.xml and builder.xml (ant references builder.xml)
2) Added maven.xml (maven references builder.xml)
3) Few more doc tweaks. Really ought do a lot more, but not Monday morning...
Revision Changes Path
1.6 +8 -182 gump/src/documentation/content/xdocs/metadata/ant.xml
Index: ant.xml
===================================================================
RCS file: /home/cvs/gump/src/documentation/content/xdocs/metadata/ant.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ant.xml 6 Apr 2004 07:17:00 -0000 1.5
+++ ant.xml 7 Jun 2004 15:48:30 -0000 1.6
@@ -19,7 +19,7 @@
<header>
- <title>Gump</title>
+ <title>Gump:Ant</title>
<authors>
<person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
<person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
@@ -38,196 +38,22 @@
<th>Required?</th>
</tr>
<tr>
- <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.
- </td>
- <td>No</td>
- </tr>
- <tr>
<td>buildfile</td>
<td>The ant build file to execute. Defaults to <strong>build.xml</strong>.
</td>
- <td>No</td>
+ <td>No Defaults to <strong>build.xml</strong>.</td>
</tr>
<tr>
<td>target</td>
- <td>The ant target to invoke.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>debug</td>
- <td>Set to "true" to turn on ant debugging.</td>
- <td>No</td>
+ <td>
+ The ant target to invoke. <em>This can be a space separated list.</em>
+ </td>
+ <td>No Defaults to <strong>gump</strong>.</td>
</tr>
</table>
- <warning>Only Python Gump supports <ant debug="true"</warning>
-
- <section><title>property</title>
- <p>Property overrides to be passed to the Ant command</p>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required?</th>
- </tr>
- <tr>
- <td>name</td>
- <td>Name of the property to set.</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>value</td>
- <td>Desired value</td>
- <td>No</td>
- </tr>
- <tr>
- <td>project</td>
- <td>The name of the referenced project. Required if the reference
- attribute is "home", "jar", "jarpath", or "srcdir".</td>
- <td>No</td>
- </tr>
- <tr>
- <td>reference</td>
- <td>
- One of the following values:<br/>
- <strong>home:</strong> the home directory for the referenced
project<br/>
- <strong>jar:</strong> the simple name (path relative to home) of the
jar in a
- referenced project.<br/>
- <strong>jarpath:</strong> the fully qualified path of the jar in a
referenced
- project.<br/>
- <strong>srcdir:</strong> the srcdir for the module containing the
project.<br/>
- </td>
- <td>No</td>
- </tr>
- <tr>
- <td>path</td>
- <td>a path which is to be interpreted relative to the srcdir for the
module containing
- the project if specified, or this project otherwise. This option is
- ignored if reference is specified.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>id</td>
- <td>Specifies which jar is desired. Required only for projects which
- define more than one jar.</td>
- <td>No</td>
- </tr>
- </table>
- </section>
-
- <section><title>depend</title>
- <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>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required?</th>
- </tr>
- <tr>
- <td>property</td>
- <td>The name of the property which will receive the full jarpath
- of the specified jar.</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>project</td>
- <td>The name of the project depended on.</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>id</td>
- <td>Specifies which jar is desired. Required only for projects which
- define more than one jar.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>runtime</td>
- <td>Specifies whether this dependency is needed at runtime.
- Choices are "true" and "false" with the default being false.</td>
- <td>No</td>
- </tr>
- </table>
- </section>
-
- <section><title>jvmarg</title>
- <p>Additional command line parameters to pass to the Java
- Virtual Machine running Ant.</p>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required?</th>
- </tr>
- <tr>
- <td>value</td>
- <td>The parameter to pass to the command line. This will be
- passed verbatim without any additional quotes.</td>
- <td>Yes</td>
- </tr>
- </table>
- </section>
-
- <section><title>sysproperty</title>
- <p>Java system property to be passed to the Java Virtual Machine.</p>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required?</th>
- </tr>
- <tr>
- <td>name</td>
- <td>Name of the property to set.</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>value</td>
- <td>Desired value</td>
- <td>No</td>
- </tr>
- <tr>
- <td>project</td>
- <td>The name of the referenced project. Required if the reference
- attribute is "home", "jar", "jarpath", or "srcdir".</td>
- <td>No</td>
- </tr>
- <tr>
- <td>reference</td>
- <td>
- One of the following values:<br/>
- <strong>home:</strong> the home directory for the referenced
project<br/>
- <strong>jar:</strong> the simple name (path relative to home) of the
jar in a
- referenced project.<br/>
- <strong>jarpath:</strong> the fully qualified path of the jar in a
referenced
- project.<br/>
- <strong>srcdir:</strong> the srcdir for the module containing the
project.<br/>
- </td>
- <td>No</td>
- </tr>
- <tr>
- <td>path</td>
- <td>a path which is to be interpreted relative to the srcdir for the
module containing
- the project if specified, or this project otherwise. This option is
- ignored if reference is specified.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>id</td>
- <td>Specifies which jar is desired. Required only for projects which
- define more than one jar.</td>
- <td>No</td>
- </tr>
- </table>
+ <section><title>Ant as a Builder</title>
+ <p><ant is an extension of the <link href="builder.html">"Generic
Builder"</link> and supports those attributes/sub-elements.</p>
</section>
</section>
1.4 +12 -5 gump/src/documentation/content/xdocs/metadata/repository.xml
Index: repository.xml
===================================================================
RCS file: /home/cvs/gump/src/documentation/content/xdocs/metadata/repository.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- repository.xml 27 Feb 2004 09:38:56 -0000 1.3
+++ repository.xml 7 Jun 2004 15:48:30 -0000 1.4
@@ -72,7 +72,12 @@
</tr>
<tr>
<td>cvsweb</td>
- <td>Web interface to the repository</td>
+ <td>Web interface to the repository. <strong>To be deprecated, see
<web.</strong></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>web</td>
+ <td>Web interface to the repository. (More approprice for multiple
types).</td>
<td>No</td>
</tr>
<tr>
@@ -83,9 +88,11 @@
</table>
<p/>
- <section><title>root</title>
- <note>This is for type='cvs' only.</note>
- <p>This specifies all of the elements which are combined to form
+ <section>
+ <title>CVS Usage</title>
+ <section><title>root</title>
+ <note>This is for type='cvs' only.</note>
+ <p>This specifies all of the elements which are combined to
form
a CVSROOT. They are split out into separate entities so that each
can be individually overridden in a workspace definition. When an
entity is listed a required below, it means that when all of the
@@ -126,7 +133,7 @@
</tr>
</table>
</section>
-
+ </section>
</section>
</body>
</document>
1.1 gump/src/documentation/content/xdocs/metadata/maven.xml
Index: maven.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Copyright 2003-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>Gump:Maven</title>
<authors>
<person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
<person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section><title>maven</title>
<p>Specifies the arguments to be passed to <fork
href="http://maven.apache.org";>Maven</fork>.</p>
<warning>This is an experimental component, changes may occur.
Only Python Gump supports <maven.
The biggest known limitation of this component is the naming of artefacts; how
Maven knows them, how Gump knows them, and if those two worldviews
intersect.</warning>
<p>
The <fork href="http://maven.apache.org";>Maven</fork> component of Gump
(<maven) is experiment, and uses a <strong>pre-installed</strong>
version of <fork href="http://maven.apache.org";>Maven</fork>, is does
<strong>NOT</strong> bootstrap Maven from CVS HEAD. This is
hopefully something that will be added in the future.
</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 space separated
list.</em></td>
<td>No. Defaults to <strong>jar</strong>.</td>
</tr>
</table>
<section><title>Maven as a Builder</title>
<p><maven is an extension of the <link href="builder.html">"Generic
Builder"</link> and supports those attributes/sub-elements.</p>
</section>
</section>
</body>
</document>
1.1 gump/src/documentation/content/xdocs/metadata/builder.xml
Index: builder.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Copyright 2003-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>Gump</title>
<authors>
<person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
<person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section><title>Generic Builder</title>
<p>Specifies the arguments to be passed to all builders</p>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required?</th>
</tr>
<tr>
<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.
</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>
<td>No</td>
</tr>
</table>
<warning>Only Python Gump supports <ant debug="true"</warning>
<section><title>property</title>
<p>Property overrides to be passed to the Ant command</p>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required?</th>
</tr>
<tr>
<td>name</td>
<td>Name of the property to set.</td>
<td>Yes</td>
</tr>
<tr>
<td>value</td>
<td>Desired value</td>
<td>No</td>
</tr>
<tr>
<td>project</td>
<td>The name of the referenced project. Required if the reference
attribute is "home", "jar", "jarpath", or "srcdir".</td>
<td>No</td>
</tr>
<tr>
<td>reference</td>
<td>
One of the following values:<br/>
<strong>home:</strong> the home directory for the referenced project<br/>
<strong>jar:</strong> the simple name (path relative to home) of the jar
in a
referenced project.<br/>
<strong>jarpath:</strong> the fully qualified path of the jar in a
referenced
project.<br/>
<strong>srcdir:</strong> the srcdir for the module containing the
project.<br/>
</td>
<td>No</td>
</tr>
<tr>
<td>path</td>
<td>a path which is to be interpreted relative to the srcdir for the
module containing
the project if specified, or this project otherwise. This option is
ignored if reference is specified.</td>
<td>No</td>
</tr>
<tr>
<td>id</td>
<td>Specifies which jar is desired. Required only for projects which
define more than one jar.</td>
<td>No</td>
</tr>
</table>
</section>
<section><title>depend</title>
<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>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required?</th>
</tr>
<tr>
<td>property</td>
<td>The name of the property which will receive the full jarpath
of the specified jar.</td>
<td>Yes</td>
</tr>
<tr>
<td>project</td>
<td>The name of the project depended on.</td>
<td>Yes</td>
</tr>
<tr>
<td>id</td>
<td>Specifies which jar is desired. Required only for projects which
define more than one jar.</td>
<td>No</td>
</tr>
<tr>
<td>runtime</td>
<td>Specifies whether this dependency is needed at runtime.
Choices are "true" and "false" with the default being false.</td>
<td>No</td>
</tr>
</table>
</section>
<section><title>jvmarg</title>
<p>Additional command line parameters to pass to the Java
Virtual Machine running Ant.</p>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required?</th>
</tr>
<tr>
<td>value</td>
<td>The parameter to pass to the command line. This will be
passed verbatim without any additional quotes.</td>
<td>Yes</td>
</tr>
</table>
</section>
<section><title>sysproperty</title>
<p>Java system property to be passed to the Java Virtual Machine.</p>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required?</th>
</tr>
<tr>
<td>name</td>
<td>Name of the property to set.</td>
<td>Yes</td>
</tr>
<tr>
<td>value</td>
<td>Desired value</td>
<td>No</td>
</tr>
<tr>
<td>project</td>
<td>The name of the referenced project. Required if the reference
attribute is "home", "jar", "jarpath", or "srcdir".</td>
<td>No</td>
</tr>
<tr>
<td>reference</td>
<td>
One of the following values:<br/>
<strong>home:</strong> the home directory for the referenced project<br/>
<strong>jar:</strong> the simple name (path relative to home) of the jar
in a
referenced project.<br/>
<strong>jarpath:</strong> the fully qualified path of the jar in a
referenced
project.<br/>
<strong>srcdir:</strong> the srcdir for the module containing the
project.<br/>
</td>
<td>No</td>
</tr>
<tr>
<td>path</td>
<td>a path which is to be interpreted relative to the srcdir for the
module containing
the project if specified, or this project otherwise. This option is
ignored if reference is specified.</td>
<td>No</td>
</tr>
<tr>
<td>id</td>
<td>Specifies which jar is desired. Required only for projects which
define more than one jar.</td>
<td>No</td>
</tr>
</table>
</section>
</section>
</body>
</document>
1.5 +4 -4 gump/src/documentation/content/xdocs/python/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/gump/src/documentation/content/xdocs/python/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 27 Feb 2004 09:38:57 -0000 1.4
+++ index.xml 7 Jun 2004 15:48:30 -0000 1.5
@@ -27,18 +27,18 @@
<body>
<section><title>Python Gump</title>
<p>
- See the <link
href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython";>background</link> on why
+ See the <link href="http://wiki.apache.org/gump/GumpPython";>background</link>
on why
the Python Gump re-write was initiated.
</p>
<note>
- Python Gump has matured to the point it is live, and generating builds.
Current activity is
- primarily towards maturing the outputs (documentation, syndicated
micro-content, etc.) Next
- phases are increasing the capabilities of Gump.
+ Python Gump has matured to the point it is the live run, and will soon replace
Traditional
+ all together.
</note>
<section><title>Python GUI</title>
<p>The Python Gump metadata viewer/UI.</p>
+ <warning>This GUI is a work in progress (that hasn't progressed
recently).</warning>
<p>
<img alt="GUI" src="../graphics/view.jpg"/>
</p>
1.16 +1 -10 gump/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/gump/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- site.xml 25 May 2004 22:46:01 -0000 1.15
+++ site.xml 7 Jun 2004 15:48:30 -0000 1.16
@@ -60,18 +60,9 @@
<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"/>
<goodpractices href="metadata/practices.html" label="Good Practices"/>
</om>
-
- <menu label="Object Model" tab="metadata">
- <index href="metadata/index.html" label="Overview"/>
- <index href="metadata/workspace.html" label="Workspace"/>
- <index href="metadata/profile.html" label="Profile"/>
- <index href="metadata/repository.html" label="Repository"/>
- <index href="metadata/module.html" label="Module"/>
- <index href="metadata/project.html" label="Project"/>
- <index href="metadata/ant.html" label="Ant"/>
- </menu>
<traditional label="Traditional" tab="traditional">
<overview href="traditional/index.html" label="Overview"/>
1.3 +2 -0 gump/src/documentation/content/xdocs/traditional/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/gump/src/documentation/content/xdocs/traditional/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 27 Feb 2004 09:38:57 -0000 1.2
+++ index.xml 7 Jun 2004 15:48:30 -0000 1.3
@@ -30,6 +30,8 @@
<link
href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython";>Python</link>.
</p>
<p>Traditional Gump is written in shell (BASH/DOS), XSLT, and Perl.</p>
+ <warning>Traditional Gump will likely soon be retired from service, since
+ extension (added to Python Gump) would be non-trivial to
support.</warning>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
