You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@gump.apache.org by aj...@apache.org on 2003/11/26 20:06:44 UTC
cvs commit: jakarta-gump/src/documentation/content/xdocs/traditional usage.xml
ajack 2003/11/26 11:06:44
Modified: src/documentation/content/xdocs site.xml gettingstarted.xml
tabs.xml index.xml why.xml faq.xml
src/documentation/content/xdocs/python index.xml usage.xml
src/documentation/content/xdocs/metadata repository.xml
index.xml project.xml
src/documentation/content/xdocs/traditional usage.xml
Log:
Start of documentation updates.
Revision Changes Path
1.2 +50 -37 jakarta-gump/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- site.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ site.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -1,43 +1,56 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
-<site label="Gump" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
-<menu label="Gump">
- <index href="index.html" label="Home"/>
- <index href="status.html" label="Status"/>
- <index href="http://cvs.apache.org/viewcvs/jakarta-gump/" label="Source"/>
- <index href="faq.html" label="FAQ"/>
- <index href="gettingstarted.html" label="Getting Started"/>
-</menu>
-<menu label="Results">
- <index href="http://gump.covalent.net/log/" label="Nightly"/>
- <index href="http://gump.covalent.net/jars/" label="Jars"/>
-<!-- <index href="http://nagoya.apache.org/~rubys/gump/javadoc.html" label="Javadoc"/> -->
-</menu>
-<!--
-<menu label="Cross Reference">
- <index href="http://cvs.apache.org/builds/gump/latest/xref.html" label="By dependency"/>
- <index href="http://cvs.apache.org/builds/gump/latest/modxref.html" label="Modules by repository"/>
- <index href="http://cvs.apache.org/builds/gump/latest/packages.html" label="Installed packages"/>
- <index href="http://cvs.apache.org/builds/gump/latest/cvsjars.html" label="Jars by module"/>
- <index href="http://cvs.apache.org/builds/gump/latest/bypackage.html" label="By Java package Name"/>
-</menu>
--->
-<menu label="Object Model">
- <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"/>
-</menu>
-<menu label="Get Involved">
- <index href="/site/getinvolved.html" label="Overview"/>
- <index href="http://jakarta.apache.org/getinvolved/mail.html" label="Join mailing lists"/>
- <index href="http://marc.theaimsgroup.com/?l=alexandria-dev&r=1&w=2" label="Search mailing lists"/>
- <index href="http://nagoya.apache.org/eyebrowse/" label="Browse mailing lists"/>
- <index href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpProjectPages" label="Wiki"/>
-</menu>
+<site label="Gump" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="home">
+ <menu label="Gump">
+ <index href="index.html" label="Home"/>
+ <index href="status.html" label="Status"/>
+ <index href="http://cvs.apache.org/viewcvs/jakarta-gump/" label="Source"/>
+ <index href="faq.html" label="FAQ"/>
+ <index href="gettingstarted.html" label="Getting Started"/>
+ </menu>
+ <menu label="Results">
+ <index href="http://gump.covalent.net/log/" label="Nightly"/>
+ <index href="http://gump.covalent.net/jars/" label="Jars"/>
+ <!-- <index href="http://nagoya.apache.org/~rubys/gump/javadoc.html" label="Javadoc"/> -->
+ </menu>
+ <!--
+ <menu label="Cross Reference">
+ <index href="http://cvs.apache.org/builds/gump/latest/xref.html" label="By dependency"/>
+ <index href="http://cvs.apache.org/builds/gump/latest/modxref.html" label="Modules by repository"/>
+ <index href="http://cvs.apache.org/builds/gump/latest/packages.html" label="Installed packages"/>
+ <index href="http://cvs.apache.org/builds/gump/latest/cvsjars.html" label="Jars by module"/>
+ <index href="http://cvs.apache.org/builds/gump/latest/bypackage.html" label="By Java package Name"/>
+ </menu>
+ -->
+ <menu label="Get Involved">
+ <index href="/site/getinvolved.html" label="Overview"/>
+ <index href="http://jakarta.apache.org/getinvolved/mail.html" label="Join mailing lists"/>
+ <index href="http://marc.theaimsgroup.com/?l=alexandria-dev&r=1&w=2" label="Search mailing lists"/>
+ <index href="http://nagoya.apache.org/eyebrowse/" label="Browse mailing lists"/>
+ <index href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpProjectPages" label="Wiki"/>
+ </menu>
+ <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>
+
+ <menu label="Traditional" tab="traditional">
+ <index href="traditional/index.html" label="Overview"/>
+ <index href="traditional/usage.html" label="Usage"/>
+ <!-- index href="traditional/gettingstarted.html" label="Getting Started"/ -->
+ </menu>
+
+ <menu label="Python" tab="python">
+ <index href="python/index.html" label="Overview"/>
+ <index href="python/usage.html" label="Usage"/>
+ <!-- index href="python/gettingstarted.html" label="Getting Started"/ -->
+ </menu>
<external-refs>
<xml.apache.org href="http://xml.apache.org/">
1.2 +65 -1 jakarta-gump/src/documentation/content/xdocs/gettingstarted.xml
Index: gettingstarted.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/gettingstarted.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- gettingstarted.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ gettingstarted.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -9,6 +9,7 @@
<body>
+<!--
<section><title>Getting started with Gump</title>
<p>There are a number of ways to work with Gump, and
</p>
@@ -60,6 +61,69 @@
<section><title>developer</title>
<p/>
</section>
- </section>
+
+ -->
+
+ <section><title>Planning</title>
+ <p>The bare minimum required to get started is a JDK, a JAXP 1.1
+ compliant parser, a command prompt (bash or Windows NT/2K), and Perl.
+ Perl is only used at the moment for some of the publishing and
+ notification, so it can be omitted.</p>
+
+ <p>It is highly recommended at this point that you review the
+ description of the data definitions used by Gump, starting with
+ the <link href="/metadata/index.html">overview</link>.</p>
+
+ </section>
+
+ <section><title>Getting the source to Gump</title>
+ <source>
+ export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
+ cvs login
+ cvs co jakarta-gump
+ </source>
+
+ <p>If prompted for the password, enter <strong>anoncvs</strong></p>
+ </section>
+
+ <section><title>Defining your workspace</title>
+ <p>Two sample workspaces are provided, rubix and rubypad. Find the
+ one that is closest to your needs and make a copy of it. The suggested
+ name for the file you create is your host name.</p>
+
+ <p>Again, reference the <link href="../metadata/index.html">overview</link> to see
+ how you can add projects, define your own profiles, and the modify
+ which version of referenced projects you want to build.</p>
+
+ <p>You will also need to directly modify the <code>gen.bat</code>
+ or <code>gen.sh</code> scripts to specify where to find the JAXP
+ implementation to use. At the present time, recent releases of
+ Xalan are recommended for performance reasons; but the JAXP
+ reference implementation will likely catch up shortly.</p>
+
+ <p><strong>Note:</strong> Yes, it is tacky that you should have to modify this
+ file directly. Patches are welcome. Meanwhile, cvs does a fairly
+ good job of merging changes.</p>
+ </section>
+
+ <section><title>Installing Packages</title>
+ <p>Packages for which source is not easily accessible are not built by Gump.
+ Where such packages are required prerequisites for building other projects, Gump
+ allows binary versions of the package to be installed to satisfy the prerequisites.
+ Your workspace definition specifies where installed packages are to be found.
+ </p>
+
+ <p>A list of some of the packages you might want to install can be found
+ <link href="http://cvs.apache.org/builds/gump/latest/packages.html">
+ here</link>.</p>
+
+ <p><strong>JDK 1.4</strong> includes both <code>jaxp</code> and <code>jsse</code>
+ which were previously available as separately installable packaged.
+ The dependencies on these packages are now marked as optional. If you are
+ using a JDK prior to 1.4, the packages must be installed. For JDK 1.4 and
+ later the packages need not be installed and the version provided with the
+ JDK will be utilised.
+ </p>
+ </section>
</body>
</document>
1.2 +4 -4 jakarta-gump/src/documentation/content/xdocs/tabs.xml
Index: tabs.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/tabs.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tabs.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ tabs.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -6,9 +6,9 @@
copyright="Foo"
xmlns:xlink="http://www.w3.org/1999/xlink">
- <tab label="Home" dir=""/>
- <tab label="Object Model" dir="metadata/"/>
- <tab label="Traditional Gump" dir="traditional/"/>
- <tab label="Python Gump" dir="python/"/>
+ <tab id="home" label="Home" dir=""/>
+ <tab id="metadata" label="Object Model" dir="metadata/"/>
+ <tab id="traditional" label="Traditional Gump" dir="traditional/"/>
+ <tab id="python" label="Python Gump" dir="python/"/>
</tabs>
1.2 +43 -39 jakarta-gump/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ index.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -5,14 +5,18 @@
<header>
<title>Gump</title>
- <authors><person name="Sam Ruby" email="rubys@us.ibm.com"/></authors></header>
+ <authors>
+ <person name="Sam Ruby" email="rubys AT us.ibm DOT com"/>
+ <person name="Adam Jack" email="ajack AT sybase DOT com"/>
+ </authors>
+ </header>
<body>
<section><title>What is Gump?</title>
<p>
- Gump is a social experiment. The primary goal of Gump is to get diverse
+ <strong>Gump is a social experiment.</strong> The primary goal of Gump is to get diverse
projects to communicate early and often about integration, dependencies,
and versioning management. One way to think about it is that some of the
concepts of
@@ -21,35 +25,48 @@
<link href="http://www.martinfowler.com/articles/continuousIntegration.html">
Continuous Integration</link> on an unprecedented scale.
</p>
-
- <p>
- <link href="traditional/index.html">Traditional Gump</link> is undergoing re-write to <link href="python/index.html">Python</link>, see
- <link href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython">Python Gump</link>
- </p>
<p>
Essentially, the reasoning goes like this - if continuous integration is a
good thing on a small project, why not apply it recursively and include all
dependencies for which access to source is provided?
</p>
-
+ <note>The Gump team are looking for volunteers to extend Gump, to install/manage public/private/cascaded Gumps,
+ and generally spread Gump to an even broader section of the OSS community. Interested? Contact us on the
+ Gump <link href="mailto:gump@jakarta.apache.org">mailing list</link></note>
</section>
<section><title>How does Gump work?</title>
- <p>
- <link href="http://cvs.apache.org/viewcvs/jakarta-gump/project">
- Project</link> definitions are converted from XML to scripts native to the
- platform on which you are running. These scripts execute cvs update
+
+ <warning>
+ <link href="traditional/index.html">Traditional Gump</link> is undergoing a re-write into <link href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython">Python</link>, see
+ <link href="python/index.html">Python Gump</link>. Be aware that some of this documentation might be in transition,
+ or state traditional information (when Python information difers.) Please report any such findings to us.
+ </warning>
+
+ <p>
+ With Traditional Gump, <link href="http://cvs.apache.org/viewcvs/jakarta-gump/project">
+ project</link> definitions are converted from XML to scripts native to the
+ platform on which you are running. With Python Gump the XML is mapped into in memory
+ objects for processing. Scripts execute cvs or svn update
commands for every module which contains a project being built, and
invoke builds for each project in an order that ensures that dependencies
- are satisfied.
+ are satisfied. Build outputs are processed and, if successful, dependent projects
+ are then built on these outputs.
</p>
<p>
The commands use the actual build.xml files from the projects, but do
- not use the scripts or jar files checked into CVS. Instead, the
+ not use the scripts or jar files checked into CVS/SVN. Instead, the
CLASSPATH is set and properties are passed on the command line.
</p>
+
+ <note>
+ Gump set's Ant's <link href="http://ant.apache.org/manual/sysclasspath.html">build.sysclasspath</link> to <strong>only</strong> and manages the system classpath:<br/>
+ To quote Ant:<br/>
+ <em>Only the system classpath is used and classpaths specified in build files, etc are ignored.
+ This situation could be considered as the person running the build file knows more about the environment than the person writing the build file</em>
+ </note>
<p>
The net effect is that every project is built every day with the latest
@@ -96,51 +113,38 @@
<table>
<tr>
- <td/>
- <th>US, Pacific</th>
- <th>US, Eastern</th>
- <th>GMT</th>
- <th>Melbourne</th>
+ <th>Site</th>
+ <th>JVM</th>
<th>Comments</th>
</tr>
<tr>
<td><link href="http://cvs.apache.org/builds/gump/latest">Rubix</link> </td>
- <td>8 pm</td>
- <td>11 pm</td>
- <td>0400</td>
- <td>1 pm</td>
+ <td/>
<td>Unavailable</td>
</tr>
<tr>
<td><link href="http://nagoya.apache.org/~rubys/gump/">Nagoya</link> </td>
- <td>4 am</td>
- <td>7 am</td>
- <td>1200</td>
- <td>9 pm</td>
<td/>
+ <td>Unavailable</td>
</tr>
<tr>
<td><link href="http://gump.covalent.net/log/index.html">Covalent</link> </td>
- <td>Noon</td>
- <td>3 pm</td>
- <td>2000</td>
- <td>5 am</td>
+ <td/>
<td></td>
</tr>
<tr>
<td><link href="http://gump.cocoondev.org/">CocoonDev</link> </td>
- <td>3 pm</td>
- <td>6 pm</td>
- <td>2300</td>
- <td>8 am</td>
+ <td/>
<td/>
</tr>
<tr>
<td><link href="http://lsd.student.utwente.nl/gump/">LSD</link> </td>
- <td>5 pm</td>
- <td>8 pm</td>
- <td>0100</td>
- <td>10 am</td>
+ <td>1.4.2-b28</td>
+ <td>Python Gump</td>
+ </tr>
+ <tr>
+ <td><link href="http://gump.dotnot.org/">DotNot</link> </td>
+ <td>1.4.1_02-b06</td>
<td>Python Gump</td>
</tr>
</table>
1.2 +8 -3 jakarta-gump/src/documentation/content/xdocs/why.xml
Index: why.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/why.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- why.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ why.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -4,13 +4,11 @@
<header>
- <title>Gump</title>
+ <title>Why was Gump written?</title>
<authors><person name="Sam Ruby" email="rubys@us.ibm.com"/></authors></header>
<body>
- <section><title>Why was Gump written?</title>
-
<p>
I've read with great amusement the motivations attributed to why Gump
was originally written. The reasons were most definitely not altruistic.
@@ -123,6 +121,13 @@
used the one of your choosing.</p>
</section>
+ <section><title>2003</title>
+ <p>As a heavy user of a lot of OSS software, combining it into deep stacks,
+ <link href="http://www.krysalis.org/version/jar-hell.html">JAR Hell</link> became
+ a pet peave of <link href="http://www.apache.org/~ajack/">Adam Jack</link>.
+ Supporting heathly re-use became a passion.
+ </p>
+ <p>Gump keeps software re-use fresh and healthy and reduces JAR Hell.</p>
</section>
</body>
1.2 +49 -121 jakarta-gump/src/documentation/content/xdocs/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/faq.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ faq.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -1,18 +1,21 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
-
- <header>
-
+ <header>
<title>Gump - Frequently Asked Questions</title>
- <authors><person name="Sam Ruby" email="rubys@us.ibm.com"/></authors></header>
-
+
+ <authors>
+ <person name="Sam Ruby" email="rubys AT us.ibm DOT com"/>
+ <person name="Adam Jack" email="ajack AT sybase DOT com"/>
+ </authors>
+ </header>
<body>
- <section><title>Which version of Ant (or JUnit or log4j or...) does Gump use?</title>
- <p><strong>Answer: </strong>The latest from cvs.</p>
+ <section><title>Question: Which version of Ant (or JUnit or log4j or...) does Gump use?</title>
+ <p><strong>Answer: </strong>The latest from cvs (as of the instant of the Gump run).</p>
</section>
- <section><title>Gump is building the latest version of everything?</title>
+
+ <section><title>Question: Gump is building the latest version of everything?</title>
<p>That could never work, could it? How can you debug anything when
you have so many variables to deal with?</p>
<p><strong>Answer: </strong>It isn't as hard as it seems. Getting it to work initially
@@ -25,89 +28,46 @@
one by one until the problem reappears. I've used this technique
numerous times to produce test cases and patches to projects
that I know virtually nothing about their internal design.</p>
- </section>
- <section><title>I've just got a "nag" e-mail about a failure...what
+ </section>
+
+ <section><title>Question: I've just got a "nag" e-mail about a failure...what
should I do about it?</title>
<p><strong>Answer: </strong>This question deserves it's own
<link href="nagged.html">page</link>.</p>
</section>
- <section><title>I've got a fix, how do I get Gump to pick it up?</title>
+
+ <section><title>Question: I've got a fix, how do I get Gump to pick it up?</title>
<p><strong>Answer: </strong>Check it into cvs.</p>
</section>
-<!--
- <tr>
- <td id="5">5.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>I checked in a fix, how do I know if Gump picked it up?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>On the build log, click on the link marked <us>cvs</us>. It
+
+<section><title>Question: I checked in a fix, how do I know if Gump picked it up?</title>
+ <p><strong>Answer: </strong>On the build log, click on the link marked <code>cvs</code>. It
will tell you when the latest cvs update or checkout was
- performed and what source files were obtained in the process.</td>
- </tr>
- </table>
- </td>
- </tr>
-
- <tr>
- <td id="6">6.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>How do I get nagging to stop (or start)?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>If there is consensus on your project, send an e-mail to
+ performed and what source files were obtained in the process.</p>
+ </section>
+
+<section><title>Question: How do I get nagging to stop (or start)?</title>
+ <p><strong>Answer: </strong>If there is consensus on your project, send an e-mail to
<link href="mailto:gump@jakarta.apache.org">
gump@jakarta.apache.org</link> letting us know what
- the outcome was, and it will be respected.</td>
- </tr>
- </table>
- </td>
- </tr>
-
- <tr>
- <td id="7">7.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>My project depends on a specific version of a dependency,
- how can I get Gump to use that version?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>The combinatorics of building each project with distinct
+ the outcome was, and it will be respected.</p>
+ </section>
+
+<section><title>Question: My project depends on a specific version of a dependency,
+ how can I get Gump to use that version?</title>
+ <p><strong>Answer: </strong>The combinatorics of building each project with distinct
versions of its dependencies is a bit too much for me to track.
If the dependent project is undergoing a major revision, and the
prior version is still actively supported, exceptions may be made.
Otherwise, feel free to set up your own builds, with or without
using the codebase of Gump to track the set of dependencies that
- interest you.</td>
- </tr>
- </table>
- </td>
- </tr>
-
- <tr>
- <td id="8">8.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>I've got a change I would like to make to the project
+ interest you.</p>
+ </section>
+
+ <section><title>Question: I've got a change I would like to make to the project
definition for a project I'm a committer on...how do I get
- the change to be made?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>The
+ the change to be made?</title>
+ <p><strong>Answer: </strong>The
<link href="http://cvs.apache.org/viewcvs/jakarta-gump/">
gump cvs repository</link> is open to all ASF committers.
Simply check it out and commit your changes. It is highly
@@ -115,62 +75,30 @@
provided build.xml in order to verify that your changes
are syntatically correct. Don't be scared... this takes
only a minute and only requires that you have ant and JDK
- 1.4. (or ant + xerces + xalan + JDK 1.2 or later).
- </td>
- </tr>
- </table>
- </td>
- </tr>
+ 1.4. (or ant + xerces + xalan + JDK 1.2 or later).</p>
+ </section>
- <tr>
- <td id="9">9.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>How do I get a project to be added to Gump? Must it
- be an Apache project?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>Send an e-mail (preferably a patch) to
+ <section><title>Question: How do I get a project to be added to Gump? Must it
+ be an Apache project?</title>
+ <p><strong>Answer: </strong>Send an e-mail (preferably a patch) to
<link href="mailto:gump@jakarta.apache.org">
gump@jakarta.apache.org</link>. Being Apache related
(i.e, used by or a consumer of other Apache projects) helps,
but is not required. What is important is that your code be
publicly accessible via cvs and that it be buildable in an
- OS independent manner.</td>
- </tr>
- </table>
- </td>
- </tr>
-
- <tr>
- <td id="10">10.</td>
- <td>
- <table>
- <tr>
- <th>Q:</th>
- <td>Shouldn't the project definitions for a project be kept
- within the project itself?</td>
- </tr>
- <tr>
- <th>A:</th>
- <td>That's supported too, as long as your project supports
+ OS independent manner.</p>
+ </section>
+
+ <section><title>Question: Shouldn't the project definitions for a project be kept
+ within the project itself?</title>
+ <p><strong>Answer: </strong>That's supported too, as long as your project supports
viewcvs or equivalent. Simply put the URL of the project
definition in the
<link href="http://cvs.apache.org/viewcvs/jakarta-gump/profile/gump.xml?rev=HEAD&content-type=text/vnd.viewcvs-markup">
gump profile</link>. However, if you are an ASF committer, why
not consider leaving it in the gump cvs repository, that
way others can also help out too?
- </td>
- </tr>
- </table>
- </td>
- </tr>
-
- </table>
-
- -->
+ </p>
+ </section>
</body>
</document>
1.2 +6 -0 jakarta-gump/src/documentation/content/xdocs/python/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/python/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ index.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -15,6 +15,12 @@
<link href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython">
See Background</link>.
</p>
+ <section><title>GUI</title>
+ <p>The Python viewer.</p>
+ <p>
+ <img alt="GUI" src="../graphics/view.jpg"/>
+ </p>
+ </section>
</section>
</body>
</document>
1.2 +111 -126 jakarta-gump/src/documentation/content/xdocs/python/usage.xml
Index: usage.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/python/usage.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- usage.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ usage.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -9,133 +9,118 @@
<body>
- <section><title>Building projects for yourself using Gump</title>
+ <section><title>Getting Started</title>
+ <note>
+ Python Gump shares the first few steps with Traditional Gump,
+ so start <link href="../gettingstarted.html">here</link>
+ </note>
+ </section>
+
+ <section><title>Select your interface</title>
+ <p>
+ Python Gump has two primary usage interfaces:
+ </p>
+ <ul>
+ <li><strong>Graphic User Interface (human users)</strong><br/>
+ This leverages wxPython's wxWindows
+ </li>
+ <li><strong>Command Line (human and automatic users, e.g. cron)</strong><br/>
+ This provides the basics functions of existing gump (gen/update/build)
+ </li>
+ </ul>
+ </section>
+
+ <section><title>Graphical User Interface</title>
+
+ <ul>
+ <li>install gump as per <link href="../gettingstarted.html">here</link></li>
+ <li>install (or have available) Python 2.3 <fork href="http://www.activestate.com/Products/ActivePython/">e.g ActiveState Python</fork></li>
+ <li>install (or have available) <fork href="http://www.wxpython.org/">wxwindows</fork></li>
+ <li>open a shell and do or something equivalent:
+ </li>
+ </ul>
+ <source>
+SET PYTHONPATH=C:\jakarta-gump\python
+CD /d C:\jakarta-gump\python
+python gump\gui\view.py -w ..\myworkspace.xml
+ </source>
+ <source>
+cd /jakarta-gump/python
+export PYTHONPATH=`pwd`
+python gump/gui/view.py -w ../myworspace.xml
+ </source>
+ </section>
+
+ <section><title>GUI Usage</title>
+ <p>
+If you select a project, you can walk the project dependencies in both directions, see what prereqs aren't installed, see the actual classpath and properties used in the ant builds, and see what jars a project produces. One pane initially shows the fully expanded XML project definition (implicit dependencies added, properties resolved, etc).
+
+You actually can run a build from this tool. A typical scenario is to select the project that you are interested in, check the prereqs and dependencies tabs. If a dependency failed, you can click on it to go to that project. Press the 'run' icon to build it. If it succeeds, press the 'back' button to return to the project you started with and repeat.
+
+More detailed information on what is being done can be found in the console window which you can access by pressing the console icon.
+ </p>
+ </section>
+
+ <section><title>Command Line Tools:</title>
+ <ul>
+ <li>install gump as per <link href="../gettignstarted.html">here</link></li>
+ <li>install (or have available) Python 2.3 <fork href="http://www.activestate.com/Products/ActivePython/">e.f ActiveState Python</fork></li>
+ <li>install (or have available) <fork href="http://www.wxpython.org/">wxwindows</fork></li>
+ <li>open a shell and do or something equivalent:
+ </li>
+ </ul>
+ <source>
+SET PYTHONPATH=C:\jakarta-gump\python
+CD /d C:\jakarta-gump\python
+python gump\build.py -w ..\myworkspace.xml all
+ </source>
+ <source>
+cd /jakarta-gump/python
+export PYTHONPATH=`pwd`
+python gump/build.py -w ../myworkspace.xml all
+ </source>
+ <note>
+ There are some similar tools w/ similar command line arguments:
+ <br/><strong>update.py</strong> -- update project(s) from source control
+ <br/><strong>build.py</strong> -- build project(s)
+ <br/><strong>integrate.py</strong> -- does "the works" check/update/build/statistics/document/nag
+ </note>
+ <note>
+ The command line arguments accept a regular expression that resolves over project names <strong>NOT</strong> module names. "all" is converted to the regular expression "*". This is a new feature in Python Gump, and a mild divergence from traditional gump usage. When (say) updating a "list of modules" the utilities calculate the modules containing the requests projects, and hence translates for the user.
+ </note>
+</section>
+<!--
+== Automating the "integration process" using integrate.py ==
+
+* install 'regular' gump as per http://jakarta.apache.org/gump/usage.html
+* install [http://www.activestate.com/Products/ActivePython/ Python 2.2]
+* open a shell and do something similar to:
+<source>
+SET PYTHONPATH=C:\jakarta-gump\python
+CD /d C:\jakarta-gump\python
+python jakarta-gump\integrate.py -w ..\myworkspace.xml all
+</source>
+<source>
+cd /jakarta-gump/python
+export PYTHONPATH=`pwd`
+python jakarta-gump/integrate.py -w ../myworkspace.xml krysalis-*
+</source>
+
+This tool is intended for use from cron, or similar scheduling software. It does:
+
+* Reads the workspace and project information
+* Performs updates (from source control)
+* Performs synchronization (into build directory)
+* Performs builds
+* All results affect the per module/per project "state"
+* State and "work" is maintained in memory and files
+* Statistics (FOG Factor and others) are calculated from states & updated
+* Once complete the run is "documented" by creating xdocs (for Forrest)
+* Forrest is launched to convert this documentation to a site
+* Nag e-mails are sent as appropriate. [currently commented out]
- <section><title>Planning</title>
- <p>The bare minimum required to get started is a JDK, a JAXP 1.1
- compliant parser, a command prompt (bash or Windows NT/2K), and Perl.
- Perl is only used at the moment for some of the publishing and
- notification, so it can be omitted.</p>
-
- <p>It is highly recommended at this point that you review the
- description of the data definitions used by Gump, starting with
- the <link href="overview.html">overview</link>.</p>
-
- </section>
-
- <section><title>Getting the source to Gump</title>
- <source>
- export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
- cvs login
- cvs co jakarta-gump
- </source>
-
- <p>If prompted for the password, enter <strong>anoncvs</strong></p>
- </section>
-
- <section><title>Defining your workspace</title>
- <p>Two sample workspaces are provided, rubix and rubypad. Find the
- one that is closest to your needs and make a copy of it. The suggested
- name for the file you create is your host name.</p>
-
- <p>Again, reference the <link href="overview.html">overview</link> to see
- how you can add projects, define your own profiles, and the modify
- which version of referenced projects you want to build.</p>
-
- <p>You will also need to directly modify the <code>gen.bat</code>
- or <code>gen.sh</code> scripts to specify where to find the JAXP
- implementation to use. At the present time, recent releases of
- Xalan are recommended for performance reasons; but the JAXP
- reference implementation will likely catch up shortly.</p>
-
- <p><strong>Note:</strong> Yes, it is tacky that you should have to modify this
- file directly. Patches are welcome. Meanwhile, cvs does a fairly
- good job of merging changes.</p>
- </section>
-
- <section><title>Installing Packages</title>
- <p>Packages for which source is not easily accessible are not built by Gump.
- Where such packages are required prerequisites for building other projects, Gump
- allows binary versions of the package to be installed to satisfy the prerequisites.
- Your workspace definition specifies where installed packages are to be found.
- </p>
-
- <p>A list of some of the packages you might want to install can be found
- <link href="http://cvs.apache.org/builds/gump/latest/packages.html">
- here</link>.</p>
-
- <p><strong>JDK 1.4</strong> includes both <code>jaxp</code> and <code>jsse</code>
- which were previously available as separately installable packaged.
- The dependencies on these packages are now marked as optional. If you are
- using a JDK prior to 1.4, the packages must be installed. For JDK 1.4 and
- later the packages need not be installed and the version provided with the
- JDK will be utilised.
- </p>
- </section>
-
- <section><title>Generation</title>
- <p>For Unix and cygwin installations using bash:</p>
-
- <source>
- bash ./gen.sh
- </source>
-
- <p>For Windows NT and 2K installations:</p>
-
- <source>
- gen
- </source>
-
- <p>This process generates the update and build scripts used in
- subsequent steps. It also logs you onto any :pserver: cvs
- repository defined which you are not currently logged onto, and
- generates the various cross reference pages.</p>
- </section>
-
- <section><title>Update</title>
- <p>For Unix and cygwin installations using bash:</p>
-
- <source>
- bash ./update.sh ( all | module ... )
- </source>
-
- <p>For Windows NT and 2K installations:</p>
-
- <source>
- update ( all | module ... )
- </source>
-
- <p>With this command you can specify you either want to update all or a
- specified list or modules. If the module had not been previously
- checked out (or the target cvs directory has been removed) then a
- checkout is done instead. If <code>all</code> is specified then a
- web page containing the logs for each update is produced, as well as
- a summary page. If specific modules are listed, then the output comes
- to the screen.</p>
- </section>
-
- <section><title>Build</title>
- <p>For Unix and cygwin installations using bash:</p>
-
- <source>
- bash ./build.sh ( all | clean | ( project [ target ... ] ) )
- </source>
-
- <p>For Windows NT and 2K installations:</p>
-
- <source>
- build ( all | clean | ( project [ target ... ] ) )
- </source>
-
- <p>With this command you can specify you either want to build all or a
- specified project. If <code>all</code> is specified then a
- web page containing the logs for each build is produced, as well as
- a summary page. If <code>clean</code> is specified then the only
- action that is performed is to synchronize the build directories from
- the cvs directories. If a project is specified, then the output comes
- to the screen, using the target you provide.</p>
- </section>
- </section>
+See: http://lsd.student.utwente.nl/gump/
+-->
</body>
</document>
1.2 +2 -1 jakarta-gump/src/documentation/content/xdocs/metadata/repository.xml
Index: repository.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/repository.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- repository.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ repository.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -28,7 +28,7 @@
<tr>
<td>type</td>
<td>Type of repository.</td>
- <td>Yes, though cvs is the only type supported currently.</td>
+ <td><strong>cvs</strong>,<strong>svn</strong>,<strong>jars</strong> currently supported.</td>
</tr>
<tr>
<td>compress</td>
@@ -69,6 +69,7 @@
<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
a CVSROOT. They are split out into separate entities so that each
can be individually overridden in a workspace definition. When an
1.2 +0 -2 jakarta-gump/src/documentation/content/xdocs/metadata/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ index.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -8,7 +8,6 @@
<body>
- <section><title>Gump Object Model (GOM) -- Data Definition Overview</title>
<p>The data definitions for Gump are organized around the various
roles a developer may perform. The overall approach is that elements
(e.g. project definitions) can be repeated in multiple contexts (e.g.,
@@ -93,6 +92,5 @@
contained.</p>
</section>
- </section>
</body>
</document>
1.2 +1 -1 jakarta-gump/src/documentation/content/xdocs/metadata/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ project.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -243,7 +243,7 @@
<p>The home directory for a project is the directory which contains the
files referenceable by another project. In many cases, it is possible
for another project element by the same name (see the
- <link href="overview.html">overview</link>) to extend a project definition
+ <link href="index.html">overview</link>) to extend a project definition
for an installable package in such a way that the result actually builds
the project.</p>
1.2 +4 -63 jakarta-gump/src/documentation/content/xdocs/traditional/usage.xml
Index: usage.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/traditional/usage.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- usage.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ usage.xml 26 Nov 2003 19:06:44 -0000 1.2
@@ -9,68 +9,10 @@
<body>
- <section><title>Building projects for yourself using Gump</title>
-
- <section><title>Planning</title>
- <p>The bare minimum required to get started is a JDK, a JAXP 1.1
- compliant parser, a command prompt (bash or Windows NT/2K), and Perl.
- Perl is only used at the moment for some of the publishing and
- notification, so it can be omitted.</p>
-
- <p>It is highly recommended at this point that you review the
- description of the data definitions used by Gump, starting with
- the <link href="overview.html">overview</link>.</p>
-
- </section>
-
- <section><title>Getting the source to Gump</title>
- <source>
-
- export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
- cvs login
- cvs co jakarta-gump</source>
-
- <p>If prompted for the password, enter <strong>anoncvs</strong></p>
- </section>
-
- <section><title>Defining your workspace</title>
- <p>Two sample workspaces are provided, rubix and rubypad. Find the
- one that is closest to your needs and make a copy of it. The suggested
- name for the file you create is your host name.</p>
-
- <p>Again, reference the <link href="overview.html">overview</link> to see
- how you can add projects, define your own profiles, and the modify
- which version of referenced projects you want to build.</p>
-
- <p>You will also need to directly modify the <code>gen.bat</code>
- or <code>gen.sh</code> scripts to specify where to find the JAXP
- implementation to use. At the present time, recent releases of
- Xalan are recommended for performance reasons; but the JAXP
- reference implementation will likely catch up shortly.</p>
-
- <p><strong>Note:</strong> Yes, it is tacky that you should have to modify this
- file directly. Patches are welcome. Meanwhile, cvs does a fairly
- good job of merging changes.</p>
- </section>
-
- <section><title>Installing Packages</title>
- <p>Packages for which source is not easily accessible are not built by Gump.
- Where such packages are required prerequisites for building other projects, Gump
- allows binary versions of the package to be installed to satisfy the prerequisites.
- Your workspace definition specifies where installed packages are to be found.
- </p>
-
- <p>A list of some of the packages you might want to install can be found
- <link href="http://cvs.apache.org/builds/gump/latest/packages.html">
- here</link>.</p>
-
- <p><strong>JDK 1.4</strong> includes both <code>jaxp</code> and <code>jsse</code>
- which were previously available as separately installable packaged.
- The dependencies on these packages are now marked as optional. If you are
- using a JDK prior to 1.4, the packages must be installed. For JDK 1.4 and
- later the packages need not be installed and the version provided with the
- JDK will be utilised.
- </p>
+ <section><title>Getting Started</title>
+ <note>
+ Traditional Gump shares the first few steps with Python Gump, so start <link href="../gettingstarted.html">here</link>
+ </note>
</section>
<section><title>Generation</title>
@@ -135,7 +77,6 @@
the cvs directories. If a project is specified, then the output comes
to the screen, using the target you provide.</p>
</section>
- </section>
</body>
</document>