Author: ajack Date: Fri Sep 10 11:56:54 2004 New Revision: 43684 Modified: gump/trunk/src/documentation/content/xdocs/metadata/repository.xml gump/trunk/src/documentation/content/xdocs/metadata/workspace.xml Log: Updated documentation, for workspace#database.
Modified: gump/trunk/src/documentation/content/xdocs/metadata/repository.xml ============================================================================== --- gump/trunk/src/documentation/content/xdocs/metadata/repository.xml (original) +++ gump/trunk/src/documentation/content/xdocs/metadata/repository.xml Fri Sep 10 11:56:54 2004 @@ -1,180 +1,180 @@ -<?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]"/></authors></header> - -<body> - - <section><title>repository</title> - <p>This represents the location from which modules can be obtained.</p> - - <table> - <tr> - <th>Attribute</th> - <th>Description</th> - <th>Required?</th> - </tr> - <tr> - <td>name</td> - <td>Name by which this repository will be referenced by module - definitions. - </td> - <td>Yes</td> - </tr> - <tr> - <td>type</td> - <td>Type of repository.</td> - <td><strong>cvs</strong>,<strong>svn</strong>,<strong>jars</strong>,<strong>p4</strong> currently supported.</td> - </tr> - <tr> - <td>compress</td> - <td>Set the compression level. Some CVS client/server combinations - will not work with compression.</td> - <td>No, defaults to <code>-z3</code>.</td> - </tr> - </table> - <p/> - - <table> - <tr> - <th>Entity</th> - <th>Description</th> - <th>Required?</th> - </tr> - <tr> - <td>title</td> - <td>Descriptive name for the repository</td> - <td>No</td> - </tr> - <tr> - <td>home-page</td> - <td>Where to find out more information about the repository</td> - <td>No</td> - </tr> - <tr> - <td>cvsweb</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 appropriate for multiple types).</td> - <td>No</td> - </tr> - <tr> - <td>redistributable</td> - <td>Are the outputs of this build redistributable?</td> - <td>No</td> - </tr> - </table> - <p/> - - <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 as required below, it means that when all of the - definitions are combined the entity must have a value - a workspace - or profile, for example, only needs to contain the values which it - overrides.</p> - - <table> - <tr> - <th>Entity</th> - <th>Description</th> - <th>Required?</th> - </tr> - <tr> - <td>method</td> - <td/> - <td>Yes</td> - </tr> - <tr> - <td>user</td> - <td/> - <td>No</td> - </tr> - <tr> - <td>password</td> - <td/> - <td>No</td> - </tr> - <tr> - <td>hostname</td> - <td/> - <td>No</td> - </tr> - <tr> - <td>path</td> - <td/> - <td>Yes</td> - </tr> - </table> - </section> - </section> - <section> - <title>Perforce Usage</title> - <section><title>root</title> - <note>This is for type='p4' only.</note> - <p>This specifies all of the elements which are combined to communicate - with a Perforce server. They are split out into separate entities - so that each can be individually overridden in a workspace definition. - When an entity is listed as required below, it means that when all of - the definitions are combined the entity must have a value - a workspace - or profile, for example, only needs to contain the values which it - overrides.</p> - - <table> - <tr> - <th>Entity</th> - <th>Description</th> - <th>Required?</th> - </tr> - <tr> - <td>clientspec</td> - <td>A Perforce clientspec is a set of mappings from server paths to local paths. The Perforce server keeps track of what files are "current" in a particular clientspec; as a result, a clientspec cannot be shared across Gump instances. It is recommended to set the <samp>allwrite</samp> option in the clientspec.</td> - <td>Yes</td> - </tr> - <tr> - <td>user</td> - <td>Defaults to user running Gump</td> - <td>No</td> - </tr> - <tr> - <td>password</td> - <td/> - <td>No</td> - </tr> - <tr> - <td>hostname</td> - <td>Defaults to perforce:1666</td> - <td>No</td> - </tr> - </table> - </section> - </section> - </section> -</body> -</document> +<?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]"/></authors></header> + +<body> + + <section><title>repository</title> + <p>This represents the location from which modules can be obtained.</p> + + <table> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required?</th> + </tr> + <tr> + <td>name</td> + <td>Name by which this repository will be referenced by module + definitions. + </td> + <td>Yes</td> + </tr> + <tr> + <td>type</td> + <td>Type of repository.</td> + <td><strong>cvs</strong>,<strong>svn</strong>,<strong>jars</strong>,<strong>p4</strong> currently supported.</td> + </tr> + <tr> + <td>compress</td> + <td>Set the compression level. Some CVS client/server combinations + will not work with compression.</td> + <td>No, defaults to <code>-z3</code>.</td> + </tr> + </table> + <p/> + + <table> + <tr> + <th>Entity</th> + <th>Description</th> + <th>Required?</th> + </tr> + <tr> + <td>title</td> + <td>Descriptive name for the repository</td> + <td>No</td> + </tr> + <tr> + <td>home-page</td> + <td>Where to find out more information about the repository</td> + <td>No</td> + </tr> + <tr> + <td>cvsweb</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 appropriate for multiple types).</td> + <td>No</td> + </tr> + <tr> + <td>redistributable</td> + <td>Are the outputs of this build redistributable?</td> + <td>No</td> + </tr> + </table> + <p/> + + <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 as required below, it means that when all of the + definitions are combined the entity must have a value - a workspace + or profile, for example, only needs to contain the values which it + overrides.</p> + + <table> + <tr> + <th>Entity</th> + <th>Description</th> + <th>Required?</th> + </tr> + <tr> + <td>method</td> + <td/> + <td>Yes</td> + </tr> + <tr> + <td>user</td> + <td/> + <td>No</td> + </tr> + <tr> + <td>password</td> + <td/> + <td>No</td> + </tr> + <tr> + <td>hostname</td> + <td/> + <td>No</td> + </tr> + <tr> + <td>path</td> + <td/> + <td>Yes</td> + </tr> + </table> + </section> + </section> + <section> + <title>Perforce Usage</title> + <section><title>root</title> + <note>This is for type='p4' only.</note> + <p>This specifies all of the elements which are combined to communicate + with a Perforce server. They are split out into separate entities + so that each can be individually overridden in a workspace definition. + When an entity is listed as required below, it means that when all of + the definitions are combined the entity must have a value - a workspace + or profile, for example, only needs to contain the values which it + overrides.</p> + + <table> + <tr> + <th>Entity</th> + <th>Description</th> + <th>Required?</th> + </tr> + <tr> + <td>clientspec</td> + <td>A Perforce clientspec is a set of mappings from server paths to local paths. The Perforce server keeps track of what files are "current" in a particular clientspec; as a result, a clientspec cannot be shared across Gump instances. It is recommended to set the <samp>allwrite</samp> option in the clientspec.</td> + <td>Yes</td> + </tr> + <tr> + <td>user</td> + <td>Defaults to user running Gump</td> + <td>No</td> + </tr> + <tr> + <td>password</td> + <td/> + <td>No</td> + </tr> + <tr> + <td>hostname</td> + <td>Defaults to perforce:1666</td> + <td>No</td> + </tr> + </table> + </section> + </section> + </section> +</body> +</document> Modified: gump/trunk/src/documentation/content/xdocs/metadata/workspace.xml ============================================================================== --- gump/trunk/src/documentation/content/xdocs/metadata/workspace.xml (original) +++ gump/trunk/src/documentation/content/xdocs/metadata/workspace.xml Fri Sep 10 11:56:54 2004 @@ -345,11 +345,8 @@ </section> <section><title>nag</title> - <p>Gump will create a file called naglist in the work - subdirectory that can be used together with nag.pl to send email - reports of build failures to a list of recipients. - <strong>Note:</strong> reports will not be sent automatically, you have to - run nag.pl yourself.</p> + <p>Gump will send email reports of first time build successes/failures to a list of recipients. + <strong>Note:</strong> reminder failure reports will be sent on <strong>--oficial</strong> runs.</p> <p>A nag element in the workspace can be used to override some values in project's <link href="project.html#nag">nag</link> @@ -364,7 +361,13 @@ </tr> <tr> <td>to</td> - <td>Overrides the to attributes of the nag elements in all + <td>Overrides the <strong>to</strong> attributes of the nag elements in all + projects.</td> + <td>No</td> + </tr> + <tr> + <td>from</td> + <td>Overrides the <strong>from</strong> attributes of the nag elements in all projects.</td> <td>No</td> </tr> @@ -372,6 +375,51 @@ <td>prefix</td> <td>A prefix to put into the subject of all generated nag mails, defaults to "[GUMP]".</td> + <td>No</td> + </tr> + </table> + </section> + + + <section><title>database</title> + <p>Gump will utilize a <fork href="http://mysql.org";>MySQL</fork> database + for storing statistics and run information. Without this element Gump + will default to using a DBM database (not currently available on with Python on Microsoft ™ platforms) + for statistics. + + <strong>Note:</strong> MySQL SQL scripts for creating the database tables + are to be found in ./mysql.</p> + + + <table> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Default</th> + <th>Required?</th> + </tr> + <tr> + <td>host</td> + <td>The hostname that the MySQL server resides upon</td> + <td>localhost</td> + <td>No</td> + </tr> + <tr> + <td>user</td> + <td>The username Gump uses to log in with</td> + <td>root</td> + <td>No</td> + </tr> + <tr> + <td>passwd</td> + <td>The passwd Gump uses to log in with</td> + <td></td> + <td>No</td> + </tr> + <tr> + <td>database</td> + <td>The database Gump uses</td> + <td>gump</td> <td>No</td> </tr> </table> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
