You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gump.apache.org by bo...@apache.org on 2009/02/18 11:20:47 UTC
svn commit: r745465 - in
/gump/trunk/src/documentation/content/xdocs/metadata: module.xml
repository.xml
Author: bodewig
Date: Wed Feb 18 10:20:47 2009
New Revision: 745465
URL: http://svn.apache.org/viewvc?rev=745465&view=rev
Log:
document git support
Modified:
gump/trunk/src/documentation/content/xdocs/metadata/module.xml
gump/trunk/src/documentation/content/xdocs/metadata/repository.xml
Modified: gump/trunk/src/documentation/content/xdocs/metadata/module.xml
URL: http://svn.apache.org/viewvc/gump/trunk/src/documentation/content/xdocs/metadata/module.xml?rev=745465&r1=745464&r2=745465&view=diff
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/module.xml (original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/module.xml Wed Feb 18 10:20:47 2009
@@ -97,10 +97,6 @@
<p>References the <link href="repository.html">repository</link> in which
this project resides. May also contain various overrides.</p>
- <p>Note: as the long term plans is to make Gump handle many different
- types of repository types, the name of this element should ultimately
- change</p>
-
<table>
<tr>
<th>Attribute</th>
@@ -147,8 +143,10 @@
<section><title>svn</title>
- <p>References a <link href="http://subversion.tigris.org">Subversion</link>
- repository in which this project resides.</p>
+ <p>References the
+ Subversion <link href="repository.html">repository</link> in
+ which this project resides. May also contain various
+ overrides.</p>
<table>
<tr>
@@ -157,16 +155,18 @@
<th>Required?</th>
</tr>
<tr>
- <td>url</td>
- <td>The url of the repository in which this module resides.</td>
+ <td>repository</td>
+ <td>The name of the repository in which this module resides.</td>
<td>Yes</td>
</tr>
+ <tr>
+ <td>dir</td>
+ <td>The subdirectory in which the svn module is present. Useful
+ for repositories like Apache's which organize related modules
+ into directories.</td>
+ <td>No</td>
+ </tr>
</table>
-
- <p>For example:</p>
- <source>
- <svn url="http://svn.collab.net/repos/svn/trunk" />
-</source>
</section>
<section><title>p4</title>
@@ -193,6 +193,34 @@
</source>
</section>
+ <section><title>git</title>
+
+ <p>References the
+ Git <link href="repository.html">repository</link> in
+ which this project resides. May also contain various
+ overrides.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>repository</td>
+ <td>The name of the repository in which this module resides.</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>dir</td>
+ <td>The subdirectory in which the svn module is present.
+ Useful for repositories which organize related modules into
+ directories.</td>
+ <td>No</td>
+ </tr>
+ </table>
+ </section>
+
<section><title>project</title>
<p>A definition of a <link href="project.html">project</link> which is
physically contained in this module.</p>
Modified: gump/trunk/src/documentation/content/xdocs/metadata/repository.xml
URL: http://svn.apache.org/viewvc/gump/trunk/src/documentation/content/xdocs/metadata/repository.xml?rev=745465&r1=745464&r2=745465&view=diff
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/repository.xml (original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/repository.xml Wed Feb 18 10:20:47 2009
@@ -44,7 +44,9 @@
<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>
+ <td><strong>cvs</strong>, <strong>svn</strong>, <strong>jars</strong>,
+ <strong>p4</strong>, <strong>git</strong> currently
+ supported.</td>
</tr>
<tr>
<td>compress</td>
@@ -211,6 +213,35 @@
</table>
</section>
</section>
+ <section>
+ <title>GIT Usage</title><note>This is for type='git' only.</note>
+
+ <p>This specifies all of the elements which are combined to
+ form an git command line 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>url</td>
+ <td>This is the base URL for all modules that reside
+ within this repository.
+ The <link href="module.html">module</link>'s
+ <git <strong>dir</strong> attribute if appended to
+ this base url.</td>
+ <td>Yes</td>
+ </tr>
+ </table>
</section>
+ </section>
</body>
</document>