ajack       2003/12/08 08:34:14

  Modified:    python/gump engine.py
               src/documentation/content/xdocs gettingstarted.xml site.xml
               src/documentation/content/xdocs/python index.xml
               src/documentation/content/xdocs/metadata module.xml
                        profile.xml ant.xml project.xml
               python   .cvsignore
               python/gump/syndication rss.py
               .        gumpy.sh
               python/gump/document forrest.py
  Added:       src/documentation/content/xdocs/metadata practices.xml
               template/forrest/src/documentation/content/gump_images
                        apache.png
  Log:
  1) Gump Documentation updates
  2) Added 'apache.png' for RSS (an image to use)
  3) Made 'cvs update failure' be a warning, not an error.
  4) Various Output Documentation Tweaks.
  
  Revision  Changes    Path
  1.40      +13 -2     jakarta-gump/python/gump/engine.py
  
  Index: engine.py
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/python/gump/engine.py,v
  retrieving revision 1.39
  retrieving revision 1.40
  diff -u -r1.39 -r1.40
  --- engine.py 6 Dec 2003 18:01:48 -0000       1.39
  +++ engine.py 8 Dec 2003 16:34:14 -0000       1.40
  @@ -216,8 +216,19 @@
         
                   # Update Context w/ Results  
                   if not cmdResult.state==CMD_STATE_SUCCESS:              
  -                    log.error('Failed to update module: ' + module.name)        
  -                    module.changeState(STATE_FAILED,REASON_UPDATE_FAILED)
  +                    log.error('Failed to checkout/update module: ' + module.name)   
  +                    if not exists:     
  +                        module.changeState(STATE_FAILED,REASON_UPDATE_FAILED)
  +                    else:
  +                        module.addError('*** Failed to update from source control. 
Stale contents ***')
  +                        
  +                        # Black mark for this repository
  +                        repository=module.getRepository()
  +                        repository.addError('*** Failed to update %s from source 
control. Stale contents ***'        \
  +                                        % module.getName())
  +                                        
  +                        # Kinda bogus, but better than nowt (for now)
  +                        module.changeState(STATE_SUCCESS,REASON_UPDATE_FAILED)
                   else:
                       module.changeState(STATE_SUCCESS)
                       
  
  
  
  1.3       +3 -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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- gettingstarted.xml        26 Nov 2003 19:06:44 -0000      1.2
  +++ gettingstarted.xml        8 Dec 2003 16:34:14 -0000       1.3
  @@ -5,7 +5,9 @@
     <header>
       
       <title>Gump: Getting Started</title>
  -  <authors><person name="Adam R. B. Jack" email="[EMAIL 
PROTECTED]"/></authors></header>
  +  <authors>
  +     <person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
  +  </authors></header>
   
   <body>
   
  
  
  
  1.3       +1 -0      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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- site.xml  26 Nov 2003 19:06:44 -0000      1.2
  +++ site.xml  8 Dec 2003 16:34:14 -0000       1.3
  @@ -38,6 +38,7 @@
        <index href="metadata/module.html" label="Module"/>
            <index href="metadata/project.html" label="Project"/>
            <index href="metadata/ant.html" label="Ant"/>
  +         <index href="metadata/practices.html" label="Good Practices"/>
        </menu>
   
        <menu label="Traditional" tab="traditional">
  
  
  
  1.3       +11 -4     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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml 26 Nov 2003 19:06:44 -0000      1.2
  +++ index.xml 8 Dec 2003 16:34:14 -0000       1.3
  @@ -12,11 +12,18 @@
   <body>
     <section><title>Python Gump</title>
     <p>
  -    <link href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython";>
  -    See Background</link>.
  +    See the <link 
href="http://nagoya.apache.org/wiki/apachewiki.cgi?GumpPython";>background</link> on why
  +    the Python Gump re-write was initiated.
     </p>
  -      <section><title>GUI</title>
  -             <p>The Python viewer.</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.
  +  </note>
  +  
  +      <section><title>Python GUI</title>
  +             <p>The Python Gump metadata viewer/UI.</p>
                <p>
                        <img alt="GUI" src="../graphics/view.jpg"/>
                </p>
  
  
  
  1.2       +6 -1      jakarta-gump/src/documentation/content/xdocs/metadata/module.xml
  
  Index: module.xml
  ===================================================================
  RCS file: 
/home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/module.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- module.xml        25 Nov 2003 00:21:22 -0000      1.1
  +++ module.xml        8 Dec 2003 16:34:14 -0000       1.2
  @@ -28,9 +28,14 @@
           <td>Override the <link href="#cvs">cvs</link> tag to be used.</td>
           <td>No</td>
         </tr>
  +      <tr>
  +        <td>debug</td>
  +        <td>Set to "true" to turn on module debugging.</td>
  +        <td>No</td>
  +      </tr>
       </table>
   
  -    <p/>
  +    <warning>Only Python Gump supports &lt;module debug=&quot;true&quot;</warning>
   
       <section><title>url</title>
         <p>This is the homepage for the collection of projects contained in
  
  
  
  1.2       +2 -1      
jakarta-gump/src/documentation/content/xdocs/metadata/profile.xml
  
  Index: profile.xml
  ===================================================================
  RCS file: 
/home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/profile.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- profile.xml       25 Nov 2003 00:21:22 -0000      1.1
  +++ profile.xml       8 Dec 2003 16:34:14 -0000       1.2
  @@ -6,8 +6,9 @@
       <title>GOM : Profile</title>
     <authors>
        <person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
  +     <person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
        </authors>
  -     </header>
  +  </header>
   
   <body>
   
  
  
  
  1.2       +14 -4     jakarta-gump/src/documentation/content/xdocs/metadata/ant.xml
  
  Index: ant.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/src/documentation/content/xdocs/metadata/ant.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ant.xml   25 Nov 2003 00:21:22 -0000      1.1
  +++ ant.xml   8 Dec 2003 16:34:14 -0000       1.2
  @@ -5,7 +5,11 @@
     <header>
       
       <title>Gump</title>
  -  <authors><person name="Sam Ruby" email="[EMAIL PROTECTED]"/></authors></header>
  +     <authors>
  +     <person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
  +     <person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
  +     </authors>
  +  </header>
   
   <body>
   
  @@ -28,7 +32,7 @@
         </tr>
         <tr>
           <td>buildfile</td>
  -        <td>The ant build file to execute.  Defaults to build.xml.
  +        <td>The ant build file to execute.  Defaults to <strong>build.xml</strong>.
           </td>
           <td>No</td>
         </tr>
  @@ -37,9 +41,15 @@
           <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>
  +      </tr>
       </table>
  -    <p/>
  -
  +    
  +    <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>
   
  
  
  
  1.4       +3 -2      
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.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- project.xml       2 Dec 2003 22:36:46 -0000       1.3
  +++ project.xml       8 Dec 2003 16:34:14 -0000       1.4
  @@ -6,12 +6,13 @@
       <title>GOM :  Project</title>
        <authors>
                <person name="Sam Ruby" email="[EMAIL PROTECTED]"/>
  +             <person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
        </authors>
     </header>
   
   
   <body>
  -  <section><title>project"</title>
  +  <section><title>project</title>
       <p>A project is the atomic unit of integration.  It can describe an
       installable package or a buildable product.  The nested elements of
       a project definition fall into three different "groups", each optional:</p>
  @@ -63,7 +64,7 @@
         </tr>
       </table>
   
  -    <p/>
  +    <warning>vm is not currently implemented</warning>
   
       <section><title>ant</title>
         <p>Identifies this project as "buildable", and specifies the
  
  
  
  1.1                  
jakarta-gump/src/documentation/content/xdocs/metadata/practices.xml
  
  Index: practices.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
    <header>
      
      <title>GOM: Good Practices</title>
          <authors>
                <person name="Adam R. B. Jack" email="[EMAIL PROTECTED]"/>
          </authors>
        </header>
  
  <body>
        
        <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>Dependencies</title>
                <section><title>Use optional dependencies</title>
                <p>Use a <link href="project.html#option">property</link> instead of
                <link href="project.html#depend">property</link> when at all 
possible.</p>
                <p>The less mandatory dependencies a project has the more often it will
                        be Gumped, and the better <em>Fried Of Gump</em> it'll be, and
                        will make a much better dependency for downstream projects.</p>
                </section>
        </section>
        
        <section><title>Separate Test Project</title>
                <p>If at all possible, split your project into (at least) two -- one 
(named <em>your-project</em>) being the main
                        compilation/archive &amp; the other (named 
<em>your-project</em><strong>-test</strong>) that
                        just runs unit tests.
                </p>
                <p>This require only the second to depend upon <em>junit</em>, say 
&amp; reduces the dependenceis
                        of the first.
                </p>
                <p>This allows downstream dependees to select which of your projects 
they wish to depend upon. If they depend upon 
                        <em>your-project</em> (and <strong>perhaps optionally</strong> 
on <em>your-project-test</em>) then
                        if some obscure unit test fails still get Gumped &amp; don't 
mis a run.</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.
                                Try to avoid targets the do full distributions (in 
numerous formats), or does uneccessary work like
                                javadoc generation. 
                        </p>
                        <p>For your *-test project (see 'Separate Test Project') do 
unit tests only.</p>
                </section>
        </section>
        
  </body>
  </document>
  
  
  
  1.5       +2 -1      jakarta-gump/python/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/python/.cvsignore,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- .cvsignore        26 Nov 2003 20:01:15 -0000      1.4
  +++ .cvsignore        8 Dec 2003 16:34:14 -0000       1.5
  @@ -6,4 +6,5 @@
   work
   test
   tmp
  -x.txt
  \ No newline at end of file
  +x.txt
  +build
  \ No newline at end of file
  
  
  
  1.7       +1 -1      jakarta-gump/python/gump/syndication/rss.py
  
  Index: rss.py
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/python/gump/syndication/rss.py,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- rss.py    7 Dec 2003 17:49:13 -0000       1.6
  +++ rss.py    8 Dec 2003 16:34:14 -0000       1.7
  @@ -136,7 +136,7 @@
           </a><br clear><hr>""") % (self.rssUrl)
           
           # Mandatory Fields
  -        self.rssStream.write(('    <title>Gump: %s</title>\n') 
%(escape(self.title)))
  +        self.rssStream.write(('    <title>%s</title>\n') %(escape(self.title)))
           self.rssStream.write(('    <link>%s</link>\n') %(escape(self.link)))
           self.rssStream.write(('    <description>%s%s</description>\n') \
                   %(escape(self.description),escape(tagOn)))
  
  
  
  1.26      +9 -1      jakarta-gump/gumpy.sh
  
  Index: gumpy.sh
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/gumpy.sh,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- gumpy.sh  24 Nov 2003 20:25:04 -0000      1.25
  +++ gumpy.sh  8 Dec 2003 16:34:14 -0000       1.26
  @@ -35,7 +35,7 @@
   #
   # Calculated
   #
  -export GUMPY_VERSION="1.0.5"
  +export GUMPY_VERSION="1.0.6"
   export GUMP_PYTHON=$GUMP/python
   export GUMP_TMP=$GUMP/tmp
   export GUMP_WS_TMP=$GUMP_WS/tmp
  @@ -148,6 +148,14 @@
   python -V >> $GUMP_LOG 2>&1
   
   #
  +#
  +#
  +cd $GUMP_PYTHON
  +echo $SEPARATOR >> $GUMP_LOG
  +echo "Clean *.pyc files." >> $GUMP_LOG
  +find $GUMP_PYTHON -name '*.pyc' -exec rm {} \;
  +
  +#
   # Do the integration run
   #
   cd $GUMP_PYTHON
  @@ -203,6 +211,9 @@
   pkill -KILL -P $$ 
   
   # $Log$
  -# Revision 1.25  2003/11/24 20:25:04  ajack
  -# Allow command line argument passing to integrate.py
  +# Revision 1.26  2003/12/08 16:34:14  ajack
  +# 1) Gump Documentation updates
  +# 2) Added 'apache.png' for RSS (an image to use)
  +# 3) Made 'cvs update failure' be a warning, not an error.
  +# 4) Various Output Documentation Tweaks.
   #
  
  
  
  1.1                  
jakarta-gump/template/forrest/src/documentation/content/gump_images/apache.png
  
        <<Binary file>>
  
  
  1.32      +3 -0      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.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- forrest.py        6 Dec 2003 18:01:48 -0000       1.31
  +++ forrest.py        8 Dec 2003 16:34:14 -0000       1.32
  @@ -298,6 +298,9 @@
           #self.documentXML(document,workspace)
           
           detailsSection=document.createSection('Details')
  +        
  +        detailsSection.createNote('This install runs Python Gump, not Traditional 
Gump.')  
  +        
           detailsTable=detailsSection.createTable()
           detailsTable.createEntry("State : ", workspace.getStateDescription()) 
           
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to