[prev in list] [next in list] [prev in thread] [next in thread]
List: gump
Subject: cvs commit: jakarta-gump/python/gump/document forrest.py
From: ajack () apache ! org
Date: 2004-01-29 18:11:56
Message-ID: 20040129181156.98960.qmail () minotaur ! apache ! org
[Download RAW message or body]
ajack 2004/01/29 10:11:56
Modified: src/documentation/content/xdocs site.xml index.xml why.xml
python/gump engine.py
template/forrest/src/documentation/content/xdocs site.xml
python/gump/utils launcher.py work.py
src/documentation/content/xdocs/metadata practices.xml
. status.xml
python/gump/document forrest.py
Log:
1) Respect some privacy. [Removed LSD info.]
2) Enabled descriptor location -> project in xref
3) Updated docs a tweak or two.
4) Updated status.xml (in order to get todo.html updated.)
Revision Changes Path
1.5 +4 -5 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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- site.xml 10 Dec 2003 11:21:52 -0000 1.4
+++ site.xml 29 Jan 2004 18:11:55 -0000 1.5
@@ -7,6 +7,7 @@
<source href="http://cvs.apache.org/viewcvs/jakarta-gump/" label="Source"/>
<faq href="faq.html" label="FAQ"/>
<gettingstarted href="gettingstarted.html" label="Getting Started"/>
+ <todo href="todo.html" label="Help Wanted"/>
</gump>
<results label="Results">
<nightly href="http://gump.covalent.net/log/" label="Nightly"/>
@@ -24,9 +25,9 @@
-->
<getinvolved label="Get Involved">
<overview href="http://jakarta.apache.org/site/getinvolved.html" \
label="Overview"/>
- <joinmailinglists href="http://jakarta.apache.org/getinvolved/mail.html" \
label="Join mailing lists"/>
- <searchmailinglists \
href="http://marc.theaimsgroup.com/?l=alexandria-dev&r=1&w=2" label="Search \
mailing lists"/>
- <browsemailinglists href="http://nagoya.apache.org/eyebrowse/" label="Browse \
mailing lists"/> + <joinmailinglists \
href="http://jakarta.apache.org/getinvolved/mail.html" label="Mailing List"/> + \
<searchmailinglists href="http://marc.theaimsgroup.com/?l=alexandria-dev&r=1&w=2" \
label="Search List"/> + <browsemailinglists \
href="http://nagoya.apache.org/eyebrowse/SummarizeList?listId=198" label="Browse \
List"/>
<wiki href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpProjectPages" \
label="Wiki"/> </getinvolved>
@@ -54,13 +55,11 @@
<traditional label="Traditional" tab="traditional">
<overview href="traditional/index.html" label="Overview"/>
<usage href="traditional/usage.html" label="Usage"/>
- <!-- index href="traditional/gettingstarted.html" label="Getting Started"/ \
--> </traditional>
<python label="Python" tab="python">
<overview href="python/index.html" label="Overview"/>
<usage href="python/usage.html" label="Usage"/>
- <!-- index href="python/gettingstarted.html" label="Getting Started"/ -->
</python>
<external-refs>
1.3 +24 -22 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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 26 Nov 2003 19:06:44 -0000 1.2
+++ index.xml 29 Jan 2004 18:11:55 -0000 1.3
@@ -9,6 +9,7 @@
<authors>
<person name="Sam Ruby" email="rubys AT us.ibm DOT com"/>
<person name="Adam Jack" email="ajack AT sybase DOT com"/>
+ <person name="Community" email="gump AT jakarta DOT apache DOT org"/>
</authors>
</header>
<body>
@@ -31,19 +32,18 @@
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>
+ <fixme author="Community">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?<br/> + Also, Gump is \
developing, and a has <link href="todo.html">outstanding TODOS</link> that + you \
could help with.<br/> +
+ Contact us on the
+ Gump <link href="mailto:gump@jakarta.apache.org">mailing list</link>
+ </fixme>
</section>
<section><title>How does Gump work?</title>
- <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
@@ -55,6 +55,12 @@
are then built on these outputs.
</p>
+ <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.) <strong>Please report any such findings to \
us</strong>. + </warning>
+
<p>
The commands use the actual build.xml files from the projects, but do
not use the scripts or jar files checked into CVS/SVN. Instead, the
@@ -92,8 +98,6 @@
<section><title>Where is Gump?</title>
<ul>
<li><link href="http://cvs.apache.org/viewcvs/jakarta-gump/">Source</link></li>
- <li><link href="http://cvs.apache.org/builds/gump/latest/">Latest \
Results</link></li>
- <li><link href="http://nagoya.apache.org/~rubys/gump/">Experimental \
runs</link></li> </ul>
</section>
@@ -120,12 +124,12 @@
<tr>
<td><link href="http://cvs.apache.org/builds/gump/latest">Rubix</link> \
</td> <td/>
- <td>Unavailable</td>
+ <td><strong>Unavailable</strong></td>
</tr>
<tr>
<td><link href="http://nagoya.apache.org/~rubys/gump/">Nagoya</link> </td>
<td/>
- <td>Unavailable</td>
+ <td><strong>Unavailable</strong></td>
</tr>
<tr>
<td><link href="http://gump.covalent.net/log/index.html">Covalent</link> \
</td> @@ -163,22 +167,20 @@
</p>
<p>
- This seemed oddly appropriate to me as much of the motivation I had
- derived from the frustrations I had building a project that I was and
- continue to be a big fan of - Cocoon. The
- <link href="http://xml.apache.org/cocoon/faqs.html#faq-whyname">FAQ</link> \
for + This seemed oddly appropriate as much of the motivation for Gump
+ derived from the frustrations building Cocoon. The FAQ for
that project indicate that the project was named after a movie that the
creator of that project was particularly fond of, so it seemed fitting
- that this effort would be named after a movie that I am fond of.
+ that this effort would be named after a movie.
</p>
<p>
- A number of other fortunate coincidences have convinced me that this
- was the right choice for a name. From the role of the feather in the
- opening and closing scenes (something I have adapted to the Apache
+ A number of other fortunate coincidences proved this was the right choice \
for a name. + From the role of the feather in the
+ opening and closing scenes (something adapted to the Apache
feature for the Gump icon), to the catch phase of "Stupid is as Stupid
does" - something that captures the spirit of a large number of build
- errors caught by this process. And most significantly to me - the
+ errors caught by this process. And most significantly (to some) - the
wisdom passed on from Gump's mother that "Life is like a box of
chocolates - you never know what you are going to get!". I can think
of no more apt description of a build process which takes the absolute
1.3 +3 -2 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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- why.xml 26 Nov 2003 19:06:44 -0000 1.2
+++ why.xml 29 Jan 2004 18:11:55 -0000 1.3
@@ -5,7 +5,8 @@
<header>
<title>Why was Gump written?</title>
- <authors><person name="Sam Ruby" email="rubys@us.ibm.com"/></authors></header>
+ <authors><person name="Sam Ruby" email="rubys@us.ibm.com"/>
+ <person name="Adam Jack" email="ajack AT sybase DOT com"/></authors></header>
<body>
@@ -122,7 +123,7 @@
</section>
<section><title>2003</title>
- <p>As a heavy user of a lot of OSS software, combining it into deep stacks,
+ <p>As a heavy user of OSS software, combining lots of 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.
1.50 +2 -3 jakarta-gump/python/gump/engine.py
Index: engine.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/engine.py,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -r1.49 -r1.50
--- engine.py 28 Jan 2004 22:54:49 -0000 1.49
+++ engine.py 29 Jan 2004 18:11:56 -0000 1.50
@@ -137,9 +137,8 @@
#
# Send Naggin E-mails
#
- if 1:
-# if run.getGumpSet().isFull() \
-# and run.getWorkspace().isNag():
+ if run.getGumpSet().isFull() \
+ and run.getWorkspace().isNag():
log.info('Nag about failures... ')
1.17 +1 -0 \
jakarta-gump/template/forrest/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/template/forrest/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- site.xml 23 Jan 2004 23:32:26 -0000 1.16
+++ site.xml 29 Jan 2004 18:11:56 -0000 1.17
@@ -63,6 +63,7 @@
<index label="by Package" href="gump_xref/package_project.html"/>
<index label="by Description" href="gump_xref/description_project.html"/>
<index label="by Output" href="gump_xref/output_project.html"/>
+ <index label="by Descriptor" href="gump_xref/descriptor_project.html"/>
</stats>
<external-refs>
1.10 +4 -4 jakarta-gump/python/gump/utils/launcher.py
Index: launcher.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/utils/launcher.py,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- launcher.py 28 Jan 2004 00:13:39 -0000 1.9
+++ launcher.py 29 Jan 2004 18:11:56 -0000 1.10
@@ -252,7 +252,7 @@
def overview(self,indent=''):
overview=indent+'Command Line: ' + self.formatCommandLine()+'\n'
if self.cwd:
- overview += indent+'CWD: ' + self.cwd + '\n'
+ overview += indent+'[Working Directory: ' + self.cwd + ']\n'
return overview
def dump(self,indent=''):
1.8 +3 -4 jakarta-gump/python/gump/utils/work.py
Index: work.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/utils/work.py,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- work.py 28 Jan 2004 00:13:39 -0000 1.7
+++ work.py 29 Jan 2004 18:11:56 -0000 1.8
@@ -102,8 +102,7 @@
self.message=message
def overview(self):
- overview='Work Name: ' + self.name +'\n'
- overview='Work Type: ' + workTypeName(self.type)+'\n'
+ overview='Work Name: ' + self.name +' (Type: ' + \
workTypeName(self.type)+')\n' overview+='State: ' + stateName(self.state)+'\n'
if self.message:
overview+=message+'\n'
1.6 +11 -5 \
jakarta-gump/src/documentation/content/xdocs/metadata/practices.xml
Index: practices.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/practices.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- practices.xml 16 Jan 2004 17:39:59 -0000 1.5
+++ practices.xml 29 Jan 2004 18:11:56 -0000 1.6
@@ -15,25 +15,31 @@
<section><title>Why good practices?</title>
<p>There are a number of reasons why an optimal Gump Descriptor ought be
a goal. Some are to be nice to Gump, and it's resources. Some are so
- Gump can be nice to your project.
- </p>
- <p>In short, don't ask Gump to do more than it needs, and don't put
+ Gump can be nice to your project. <strong>In short</strong>, don't ask Gump to \
do more than it needs, and don't put barriers in the way of the frequent Gumping of \
your project. </p>
</section>
<section><title>Ant</title>
<section><title>Selecting a minimal target</title>
- <p>Select an ant target (from your build) that minimally compiles the code, \
and creates output jars. + <p>Select an ant target (from your build.xml, or \
whichever) that minimally compiles the code, and creates output jars.
Try to avoid targets that create full distributions (in numerous formats), \
or perform unnecessary work like javadoc generation.
</p>
- <p>For your *-test project (see 'Separate Test Project') do unit tests \
only.</p> + <p>For your *-test project (see 'Use a separate Test Project') do \
unit tests only.</p> </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.
</p>
+ </section>
+ <section><title>Example</title>
+ <source>
+ <ant buildfile="build.xml" target="gump">
+ <property name="DATE_STAMP" value="@@DATE@@"/> \
+ </ant>
+
+ </source>
</section>
</section>
1.2 +47 -5 jakarta-gump/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/status.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- status.xml 25 Nov 2003 00:21:22 -0000 1.1
+++ status.xml 29 Jan 2004 18:11:56 -0000 1.2
@@ -1,19 +1,61 @@
<?xml version="1.0"?>
<status>
<developers>
- <person name="Gump" email="gump@jakarta.apache.org" id="Gump" />
+ <person name="Gump" email="gump@jakarta.apache.org" id="Gump" />
+ <person name="Community" email="gump@jakarta.apache.org" id="Community" \
/> + <person name="Administrators" email="gump@jakarta.apache.org" \
id="admins" /> + <person name="Adam Jack" email="ajack@apache.org" \
id="ajack" /> <!-- Add more people here -->
</developers>
<todo>
- <actions priority="high">
- <action context="docs" dev="JB">
- Make prettier w/ nice skin.
+ <actions priority="High Priority">
+ <action context="community" dev="community">
+ Keep project metadata clean/healthy, keep re-use strong.
</action>
+
+ <action context="community" dev="community">
+ Get more Gump hosts (for more cycles, smaller time windows).
+ </action>
+
+ <action context="docs" dev="ajack">
+ Ensure the subtle differences of Python Gump are correctly noted.
+ </action>
+
+ <action context="admin" dev="community">
+ Make it easier for folks to install/get started with local/private Gumps.
+ </action>
+
+ <action context="admin" dev="admins">
+ Make distributed management easier (e.g. manually, for legal reasons, \
rsynch packages from central repository.) + </action>
+
+ <action context="admin" dev="ajack">
+ Allow cascading Gumps, that 'download' jars from each other to save
+ cycles & increase "reach" to a wider community.
+ </action>
+
<action context="feedback" dev="Gump">
Mail <link
href="mailto:gump@jakarta.apache.org">gump@jakarta.apache.org</link>
- with feedback.
+ with feedback on usability (of the outputs, or providing the metadata).
+ </action>
+ </actions>
+
+ <actions priority="Medium Priority">
+ <action context="usability" dev="community">
+ Identify 'prebuilt' projects (visually, and in lists like 'Packages').
+ </action>
+
+ <action context="docs" dev="community">
+ Document gumpy.[bat|sh] and gump.[bat|sh].
+ </action>
+ </actions>
+
+ <actions priority="Futures">
+ <action context="scm" dev="community">
+ Add more interfaces to source control, and clean up the XML metadata
+ to be SCM agnostic.
</action>
</actions>
</todo>
1.60 +7 -7 jakarta-gump/python/gump/document/forrest.py
Index: forrest.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/document/forrest.py,v
retrieving revision 1.59
retrieving revision 1.60
diff -u -r1.59 -r1.60
--- forrest.py 29 Jan 2004 03:49:58 -0000 1.59
+++ forrest.py 29 Jan 2004 18:11:56 -0000 1.60
@@ -1867,10 +1867,10 @@
# Projects By Descriptor Location
- #pByDL=self.documentProjectsByDescriptorLocation(xref, run, workspace, \
gumpSet)
- #pxrefRow=pxrefTable.createRow()
- #pxrefRow.createData().createLink(pByDL, 'Projects By Descriptor \
Location')
- #pxrefRow.createData('The descriptor for the project.')
+ pByDL=self.documentProjectsByDescriptorLocation(xref, run, workspace, \
gumpSet) + pxrefRow=pxrefTable.createRow()
+ pxrefRow.createData().createLink(pByDL, 'Projects By Descriptor Location')
+ pxrefRow.createData('The descriptor for the project.')
document.serialize()
---------------------------------------------------------------------
To unsubscribe, e-mail: gump-unsubscribe@jakarta.apache.org
For additional commands, e-mail: gump-help@jakarta.apache.org
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic