dion 02/04/15 01:26:25
Modified: xdocs project-descriptor.xml
Log:
Added docs on optional props as per schema/dtd
Revision Changes Path
1.19 +40 -7 jakarta-turbine-maven/xdocs/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/project-descriptor.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- project-descriptor.xml 10 Apr 2002 21:09:52 -0000 1.18
+++ project-descriptor.xml 15 Apr 2002 08:26:25 -0000 1.19
@@ -89,7 +89,7 @@
<tr>
<td>gumpRepositoryId</td>
<td>
- This is the Id of the Gump repository that this project is
+ Optional. This is the Id of the Gump repository that this project is
part of (assuming it participates in the Gump integration
effort).
</td>
@@ -104,7 +104,7 @@
<tr>
<td>description</td>
<td>
- A detailed description of the project. This element is
+ Optional. A detailed description of the project. This element is
usually specified as CDATA to enable the use of HTML tags
within the description. This description is used to
generate the <a href="build-file.html#docs">front page</a>
@@ -120,19 +120,19 @@
<tr>
<td>cvsWebUrl</td>
<td>
- The URL to the project's browsable CVS repository
+ Optional. The URL to the project's browsable CVS repository
</td>
</tr>
<tr>
<td>issueTrackingUrl</td>
<td>
- The URL to the project's issue tracking system.
+ Optional. The URL to the project's issue tracking system.
</td>
</tr>
<tr>
<td>siteAddress</td>
<td>
- The hostname of the web server that hosts the project's web
+ Optional. The hostname of the web server that hosts the project's web
site. This is used when the web site is <a
href="build-file.html#maven:deploy-site">deployed</a>.
</td>
@@ -140,7 +140,7 @@
<tr>
<td>siteDirectory</td>
<td>
- The directory on the web server where the public web site
+ Optional. The directory on the web server where the public web site
for this project resides. This is used when the web site is <a
href="build-file.html#maven:deploy-site">deployed</a>.
</td>
@@ -148,13 +148,20 @@
<tr>
<td>distributionDirectory</td>
<td>
- The directory on the web server where the final
+ Optional. The directory on the web server where the final
distributions will be published. This is used when the
distributions are
<a href="build-file.html#maven:deploy-dist">deployed</a>.
</td>
</tr>
<tr>
+ <td><a href="#distributions">distributions</a></td>
+ <td>
+ Optional. Contain information on previous distributions of the
+ project. This information is not currently used by Maven.
+ </td>
+ </tr>
+ <tr>
<td><a href="#mailingLists">mailingLists</a></td>
<td>
Contains information about a project's mailing lists. This
@@ -185,6 +192,32 @@
</td>
</tr>
</table>
+ </section>
+ <section name="distributions">
+ <p>This element describes each of the previous distributions of the
+ project. Each distribution is described by a <code>distribution</code>
+ element
+ </p>
+ <subsection name="distribution">
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>version</td>
+ <td>The external version number under which this release
+ was distributed. Examples include: <code>1.0</code>,
+ <code>1.1-alpha1</code>, <code>1.2-beta</code>,
+ <code>1.3.2</code> etc.
+ </td>
+ </tr>
+ <tr>
+ <td>tag</td>
+ <td>The name given in the version control system (e.g. cvs)
+ used by the project for the source code associated with the
+ release of this version of the project
+ </td>
+ </tr>
+ </table>
+ </subsection>
</section>
<section name="mailingLists">
<p>
