<?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="rubys@us.ibm.com"/></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> 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 &lt;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>
        <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 a 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>
</body>
</document>
