dion 2003/08/19 16:19:53
Modified: xdocs/reference project-descriptor.xml
Log:
make docs match the schema
Revision Changes Path
1.23 +92 -45 maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- project-descriptor.xml 19 Aug 2003 04:46:11 -0000 1.22
+++ project-descriptor.xml 19 Aug 2003 23:19:53 -0000 1.23
@@ -180,12 +180,26 @@
</td>
</tr>
<tr>
+ <td>distributionSite</td>
+ <td>
+ Optional. The server server where the final
+ distributions will be published. This is used when the
+ distributions are
+ <a href="plugins/dist/index.html">deployed</a>.
+ <p>
+ If this isn't defined, the central repository is used instead as
+ determined by <code>maven.repo.central</code> and
+ <code>maven.repo.central.directory</code>
+ </p>
+ </td>
+ </tr>
+ <tr>
<td>distributionDirectory</td>
<td>
Optional. The directory on the web server where the final
distributions will be published. This is used when the
distributions are
- <a href="plugins/site/index.html">deployed</a>.
+ <a href="plugins/dist/index.html">deployed</a>.
</td>
</tr>
<tr>
@@ -363,8 +377,17 @@
<p>As an example, the settings for an Apache project are usually:
<pre>scm:cvs:pserver:[EMAIL
PROTECTED]:/home/cvspublic:module-name</pre>
</p>
- <p>Currently CVS is the only supported scm. Others will be added
- as soon as possible</p>
+ <p>
+ Currently CVS, Starteam and SubVersion are the only supported scm's.
+ Others will be added as soon as possible
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>developerConnection</td>
+ <td>
+ Optional. Just like connection, but for developers, i.e. this scm
connection
+ will not be read only.
</td>
</tr>
<tr>
@@ -501,10 +524,6 @@
<td>The organization to which the developer belongs.</td>
</tr>
<tr>
- <td>url</td>
- <td>The URL for the homepage of the developer</td>
- </tr>
- <tr>
<td>roles</td>
<td>
The roles the developer plays in the project. Each role is
@@ -512,6 +531,17 @@
role name.
</td>
</tr>
+ <tr>
+ <td>url</td>
+ <td>The URL for the homepage of the developer</td>
+ </tr>
+ <tr>
+ <td>timezone</td>
+ <td>
+ The timezone the developer is in. This is a number in the range
+ -14 to 14.
+ </td>
+ </tr>
</table>
</subsection>
</section>
@@ -546,6 +576,17 @@
role name.
</td>
</tr>
+ <tr>
+ <td>url</td>
+ <td>The URL for the homepage of the contributor</td>
+ </tr>
+ <tr>
+ <td>timezone</td>
+ <td>
+ The timezone the contributor is in. This is a number in the range
+ -14 to 14.
+ </td>
+ </tr>
</table>
</subsection>
@@ -572,8 +613,12 @@
<tr>
<td>distribution</td>
<td>The primary method by which this project may be distributed.
- repo: may be downloaded from the Maven repository. manual: user
- must manually download and install the dependency.
+ <dl>
+ <dt>repo</dt>
+ <dd>may be downloaded from the Maven repository</dd>
+ <dt>manual</dt>
+ <dd>user must manually download and install the dependency.</dd>
+ </dl>
</td>
</tr>
</table>
@@ -681,6 +726,16 @@
</p>
</td>
</tr>
+ <tr>
+ <td>properties</td>
+ <td>
+ Properties about the dependency. Various plugins allow you to
+ <code>mark</code> dependencies with properties. For example the
+ <a href="plugins/war/index.html">war</a> plugin looks for a
+ <code>war.bundle</code> property, and if found will include the
dependency
+ in <code>WEB-INF/lib</code>. For example syntax, check the war plugin
docs.
+ </td>
+ </tr>
</table>
</subsection>
</section>
@@ -693,14 +748,6 @@
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td>name</td>
- <td>
- The full name of the project. This value is used when
- generating <a href="build-file.html#maven:javadocs">JavaDoc</a>
- titles.
- </td>
- </tr>
- <tr>
<td>nagEmailAddress</td>
<td>
An address to which notifications regarding the status of builds
@@ -712,6 +759,21 @@
</td>
</tr>
<tr>
+ <td><a name="sourceDirectory">sourceDirectory</a></td>
+ <td>
+ This element specifies a directory containing the source
+ of the project. The generated build system will compile
+ the source in this directory when the project is built.
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#sourceModifications">sourceModifications</a></td>
+ <td>
+ This element specifies how source code will be excluded or included
+ depending on the presence of a given class.
+ </td>
+ </tr>
+ <tr>
<td>unitTestSourceDirectory</td>
<td>
This element specifies a directory containing the unit test
@@ -731,21 +793,6 @@
</td>
</tr>
<tr>
- <td><a name="sourceDirectory">sourceDirectory</a></td>
- <td>
- This element specifies a directory containing the source
- of the project. The generated build system will compile
- the source in this directory when the project is built.
- </td>
- </tr>
- <tr>
- <td><a href="#sourceModifications">sourceModifications</a></td>
- <td>
- This element specifies how source code will be excluded or included
- depending on the presence of a given class.
- </td>
- </tr>
- <tr>
<td>aspectSourceDirectory</td>
<td>
This element specifies a directory containing Aspect
@@ -803,10 +850,6 @@
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td><a href="#resources">resources</a></td>
- <td>Describe the resources associated with unit tests</td>
- </tr>
- <tr>
<td><a href="#includes">includes</a></td>
<td>Describe the includes unit tests</td>
</tr>
@@ -814,6 +857,10 @@
<td><a href="#excludes">excludes</a></td>
<td>Describe the excludes unit tests</td>
</tr>
+ <tr>
+ <td><a href="#resources">resources</a></td>
+ <td>Describe the resources associated with unit tests</td>
+ </tr>
</table>
</subsection>
<subsection name="resources">
@@ -839,14 +886,6 @@
<td>Describe the directory where the resource is stored.</td>
</tr>
<tr>
- <td><a href="#includes">includes</a></td>
- <td>Describe the includes files to the project</td>
- </tr>
- <tr>
- <td><a href="#excludes">excludes</a></td>
- <td>Describe the excludes files to the project</td>
- </tr>
- <tr>
<td>targetPath</td>
<td>
Describe the resource target path. For example, if you want that
resource
@@ -855,8 +894,16 @@
</td>
</tr>
<tr>
+ <td><a href="#includes">includes</a></td>
+ <td>Describe the includes files to the project</td>
+ </tr>
+ <tr>
+ <td><a href="#excludes">excludes</a></td>
+ <td>Describe the excludes files to the project</td>
+ </tr>
+ <tr>
<td>filtering</td>
- <td>Boolean. Describe if resources are filtering or not.</td>
+ <td>Boolean. Describe if resources are filtered or not.</td>
</tr>
</table>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
