Hi guys,
Since some days I'm working on modello / maven-model / m1-core.
Here is the current status. If you have some comments ... feel free
Modello
To resolve relative entities in the POM (to keep the compatibility with
maven 1.0.x) I had to update the STAX-RI plugin to add a new read method (
http://jira.codehaus.org/browse/MODELLO-77) with a path as parameter
(instead of a stream).
Modello plugin for maven 1.
I updated the maven-modello-plugin for m1 to use the latest versions of
modello.
I also updated (created) a documentation for it :
http://maven.apache.org/maven-1.x/plugins/modello/
If some of you can take some minutes to review it (my english particularly
;-) )
I'm not sure, but it could be possible when we'll release it to move it
out from the sandbox ? It could be a new plugin in the m1 distribution, even
if I'm not sure that it will have a lot of users ;-) (Note that this is a
really little plugin to maintain)
Maven-model
I built the documentation from modello :
http://maven.apache.org/maven-1.x/reference/maven-model/3.0.2-SNAPSHOT/maven.html
The problem is that we manually updated the previous documentation build
from the model by Brett.
I propose that now we always use (as in m2) the documentation (and the
site) generated by modello.
We'll update the model documentation if necessary.
We have to fix in the maven.mdo the documentation which was updated in the
generated xdoc and not in the real model.
I attached the patch which lists changes from the previous generation.
The problem is to merge changes in links and in some comments for m1.
In a modello model we can't have some notes for a given version of the
model ?
I continue to test m1 with the new model which uses a stax reader/writer.
Arnaud
Index: project-descriptor.xml
===================================================================
--- project-descriptor.xml (revision 191806)
+++ project-descriptor.xml (revision 433066)
@@ -108,7 +108,7 @@
<logo/>
</organization>
<properties/>
- <packageName/>
+ <package/>
<<a href="#class_Build">build</a>>
<nagEmailAddress/>
<sourceDirectory/>
@@ -173,8 +173,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -206,9 +206,9 @@
<code>id</code>
</td>
<td>
- The short name of the project. This value is used when naming
- <a href="/plugins/java/index.html">jars</a> and
- <a href="/plugins/dist/index.html">distribution files</a>.
+ The short name of the project.
+ <strong>DEPRECATED</strong>:
+ use <code><groupId></code> and <code><artifactId></code>.
</td>
</tr>
<tr>
@@ -218,7 +218,7 @@
<td>
The short name of the project group. This value is used to group
all jars for a project in one directory. For more info look at the
- <a href="/user-guide.html#Naming%20Conventions">user guide</a>.
+ <a href="conventions.html">user guide</a>.
</td>
</tr>
<tr>
@@ -228,8 +228,8 @@
<td>
The short name of the project. This value is used in conjunction
with <code>groupId</code>
- when naming <a href="/plugins/java/index.html">jars</a> and
- <a href="/plugins/dist/index.html">distribution files</a>.
+ when naming <a href="http://maven.apache.org/maven-1.x/plugins/java/index.html";>jars</a> and
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";>distribution files</a>.
</td>
</tr>
<tr>
@@ -238,7 +238,7 @@
</td>
<td>
The full name of the project. This value is used when
- generating <a href="/plugins/javadoc/index.html">JavaDoc</a>
+ generating <a href="http://maven.apache.org/maven-1.x/plugins/javadoc/index.html";>JavaDoc</a>
titles.
</td>
</tr>
@@ -248,8 +248,8 @@
</td>
<td>
The current version of the project. This value is used when
- naming <a href="/plugins/java/index.html">jars</a> and
- <a href="/plugins/dist/index.html">distribution files</a>.
+ naming <a href="http://maven.apache.org/maven-1.x/plugins/java/index.html";>jars</a> and
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";>distribution files</a>.
</td>
</tr>
<tr>
@@ -268,7 +268,8 @@
<td>
Optional. A detailed description of the project.
This description is used as the default to generate the
- <a href="/plugins/site/index.html">Mailing Lists</a> of the project's
+ <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>Mailing Lists</a>
+ of the project's
web site, and is shown when <code>maven --usage</code> is called on
the project. While this element can be specified as CDATA to enable
the use of HTML tags within the description, you are encouraged to
@@ -311,7 +312,7 @@
<td>
The year of the project's inception specified with 4 digits.
This value is used when generating
- <a href="/plugins/javadoc/index.html">JavaDoc</a> copyright notices.
+ <a href="http://maven.apache.org/maven-1.x/plugins/javadoc/index.html";>JavaDoc</a> copyright notices.
</td>
</tr>
<tr>
@@ -331,7 +332,7 @@
<td>
Optional. The hostname of the web server that hosts the project's web
site. This is used when the web site is
- <a href="/plugins/site/index.html">deployed</a>.
+ <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>deployed</a>.
</td>
</tr>
<tr>
@@ -341,7 +342,7 @@
<td>
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="/plugins/site/index.html">deployed</a>.
+ <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>deployed</a>.
</td>
</tr>
<tr>
@@ -352,7 +353,7 @@
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>.
+ <a href="http://maven.apache.org/maven-1.x/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
@@ -368,7 +369,7 @@
Optional. The directory on the web server where the final
distributions will be published. This is used when the
distributions are
- <a href="/plugins/dist/index.html">deployed</a>.
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";>deployed</a>.
</td>
</tr>
<tr>
@@ -377,7 +378,7 @@
</td>
<td>
Contains information about a project's mailing lists. This
- is used to generate the <a href="/plugins/site/index.html">front
+ is used to generate the <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>front
page</a> of the site's web site.
</td>
</tr>
@@ -387,7 +388,7 @@
</td>
<td>
Describes the committers to a project. This is used to
- generate the <a href="/plugins/site/index.html">Project Team</a>
+ generate the <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>Project Team</a>
page of the project's web site.
</td>
</tr>
@@ -397,7 +398,7 @@
</td>
<td>
Describes the contributors to a project. This is used to generate
- the <a href="/plugins/site/index.html">Project Team</a> page of
+ the <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>Project Team</a> page of
the project's web site.
</td>
</tr>
@@ -421,7 +422,7 @@
<td>
Optional. Contains information on previous versions of the
project. This information is used when invoking the
- <a href="/plugins/dist/index.html"><code>maven:dist</code></a>
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";><code>maven:dist</code></a>
target.
</td>
</tr>
@@ -432,7 +433,7 @@
<td>
Optional. Contains information on branches of the
project. This information is used when invoking the
- <a href="/plugins/dist/index.html"><code>maven:dist</code></a>
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";><code>maven:dist</code></a>
target.
</td>
</tr>
@@ -476,11 +477,11 @@
</tr>
<tr>
<td>
- <code>packageName</code>
+ <code>package</code>
</td>
<td>
The Java package name of the project. This value is used
- when generating <a href="/plugins/javadoc/index.html">JavaDoc</a>.
+ when generating <a href="http://maven.apache.org/maven-1.x/plugins/javadoc/index.html";>JavaDoc</a>.
</td>
</tr>
<tr>
@@ -506,7 +507,7 @@
</p>
<p>
Maven can automatically download these dependencies from a
- <a href="/user-guide.html#Remote%20Repository%20Layout">remote repository</a>.
+ <a href="../using/repositories.html">remote repository</a>.
</p>
<p>
The filename that Maven downloads from the repository is
@@ -559,8 +560,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -627,8 +628,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -703,8 +704,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -768,14 +769,14 @@
<subsection name="license">
<p>
Describes the licenses for this project. This is used to generate
- the <a href="/plugins/site/index.html">License</a> page of
+ the <a href="http://maven.apache.org/maven-1.x/plugins/site/index.html";>License</a> page of
the project's web site. Typically the licenses listed for the project
are that of the project itself, and not of dependencies.
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -822,8 +823,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -853,7 +854,7 @@
<td>
A unique identifier for a version. This ID is
used to specify the version that
- <a href="/plugins/dist/index.html">
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";>
<code>maven:dist</code>
</a> builds.
</td>
@@ -865,12 +866,12 @@
<p>
Optional. Contains information on branches of the project. This
information is used when invoking the
- <a href="/plugins/dist/index.html"><code>maven:dist</code></a> target.
+ <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";><code>maven:dist</code></a> target.
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -886,22 +887,26 @@
</subsection>
<a name="class_PackageGroup"/>
<subsection name="packageGroup">
+ <p>
+ Javadoc allows related packages to be gathered together into logical 'groups'.
+ Groups of packages appear under a common subheading in the javadoc overview documentation.
+ </p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
<code>title</code>
</td>
- <td>the description</td>
+ <td>The title that appears as a subheading in the javadoc overview page.</td>
</tr>
<tr>
<td>
<code>packages</code>
</td>
- <td>the description</td>
+ <td>The packages that should be grouped together.</td>
</tr>
</table>
</subsection>
@@ -909,8 +914,8 @@
<subsection name="repository">
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -920,13 +925,14 @@
<p>
Optional. The source configuration management system URL
that describes the repository and how to connect to the
- repository. This is used by Maven when <a href="/plugins/dist/index.html">building versions</a>
+ repository. This is used by Maven when <a href="http://maven.apache.org/maven-1.x/plugins/dist/index.html";>building versions</a>
from specific ID.
</p>
<p>
The format of this element is as follows:
</p>
- <pre>scm:<provider>:<provider-parameters></pre>
+ <source>scm:<provider><delimiter><provider-parameters></source>
+ <p>where <code><delimiter></code> can be either ':' (colon) or '|' (pipe).</p>
<p>For cvs, the format for pserver repositories should be:</p>
<div class="source">
<pre>scm:cvs:pserver:[EMAIL PROTECTED]:/cvs/root:module-name</pre>
@@ -953,7 +959,7 @@
Here's an example using CVS NT and ntserver:
</p>
<div class="source">
- <pre>scm|cvs|ntserver|[EMAIL PROTECTED]|e:\cvs|Deployment</pre>
+ <pre>scm:cvs|ntserver|[EMAIL PROTECTED]|e:\cvs|Deployment</pre>
</div>
Note the use of the vertical bar as delimiter as the repository has a
@@ -1022,8 +1028,8 @@
<p>Specifies the organization who produces this project.</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -1055,8 +1061,8 @@
<subsection name="build">
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="40%">Element</th>
+ <th width="60%">Description</th>
</tr>
<tr>
<td>
@@ -1067,7 +1073,7 @@
for this project can be sent. This is intended for use by tools
which do unattended builds, for example those providing for
continuous integration. Currently this is used by the
- <a href="/plugins/gump/">gump plugin</a>
+ <a href="http://maven.apache.org/maven-1.x/plugins/gump/";>gump plugin</a>
target.
</td>
</tr>
@@ -1103,8 +1109,8 @@
sources of the project. The generated build system will
compile the Aspects in this directory when the project is
built if Aspects have been enabled (see the
- <a
- href="/plugins/aspectj/goals.html">Aspectj goals</a> document).
+ <a href="http://maven.apache.org/maven-1.x/plugins/aspectj/goals.html";>Aspectj goals</a>
+ document).
The path given is relative to the project descriptor.
</td>
</tr>
@@ -1112,9 +1118,13 @@
<td>
<code>integrationUnitTestSourceDirectory</code>
</td>
- <td>
- This element specifies a directory containing integration test
- sources of the project.
+ <td>
+ This element is <strong>deprecated</strong> and should no longer be used.
+ Initially it was used by the first Cactus plugin. Now
+ the location of the Cactus test sources is defined
+ through a plugin property. See the Cactus plugin
+ <a href="http://jakarta.apache.org/cactus/integration/maven/properties.html";>properties</a>
+ page.
</td>
</tr>
<tr>
@@ -1172,8 +1182,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -1190,7 +1200,7 @@
<td>
<code>property</code>
</td>
- <td>the description</td>
+ <td>An optional property.</td>
</tr>
<tr>
<td>
@@ -1205,13 +1215,13 @@
<td>
<code>includes</code>
</td>
- <td>the description</td>
+ <td>Files to include.</td>
</tr>
<tr>
<td>
<code>excludes</code>
</td>
- <td>the description</td>
+ <td>Files to exclude.</td>
</tr>
</table>
</subsection>
@@ -1219,26 +1229,26 @@
<subsection name="unitTest">
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
<code>resources</code>
</td>
- <td>the description</td>
+ <td>Resources needed to run the unit tests.</td>
</tr>
<tr>
<td>
<code>includes</code>
</td>
- <td>the description</td>
+ <td>Files to include.</td>
</tr>
<tr>
<td>
<code>excludes</code>
</td>
- <td>the description</td>
+ <td>Files to exclude.</td>
</tr>
</table>
</subsection>
@@ -1253,8 +1263,8 @@
</p>
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -1286,13 +1296,13 @@
<td>
<code>includes</code>
</td>
- <td>the description</td>
+ <td>Resources to include.</td>
</tr>
<tr>
<td>
<code>excludes</code>
</td>
- <td>the description</td>
+ <td>Resources to exclude.</td>
</tr>
</table>
</subsection>
@@ -1300,8 +1310,8 @@
<subsection name="dependency">
<table>
<tr>
- <th>Element</th>
- <th>Description</th>
+ <th width="20%">Element</th>
+ <th width="80%">Description</th>
</tr>
<tr>
<td>
@@ -1380,7 +1390,7 @@
<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
+ <a href="http://maven.apache.org/maven-1.x/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.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
