You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/06/10 07:10:42 UTC
cvs commit: avalon-sandbox/merlin/merlin-platform/xdocs/tools/tags navigation.xml
mcconnell 2003/06/09 22:10:42
Modified: merlin/merlin-platform/xdocs/resources notebook.xml
roadmap.xml
merlin/merlin-platform/xdocs/tools index.xml navigation.xml
merlin/merlin-platform/xdocs/tools/tags navigation.xml
Added: merlin/merlin-platform/xdocs/tools/maven deploy.xml
index.xml meta.xml navigation.xml replicate.xml
Removed: merlin/merlin-platform/xdocs/tools maven.xml
Log:
Doc updates on the Merlin Plugin for Maven together with updates on priority actions and roadmap.
Revision Changes Path
1.2 +21 -19 avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml
Index: notebook.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notebook.xml 10 Jun 2003 02:14:25 -0000 1.1
+++ notebook.xml 10 Jun 2003 05:10:41 -0000 1.2
@@ -23,31 +23,33 @@
<li>will enable classic binary downloads for people without CVS access</li>
</ul>
+
+ </subsection>
+ <subsection name="Action List">
+
<p>
Some of the actions that should be taken before a release include the following:
</p>
- <ul>
- <li>additional tutorials covering
- <ul>
- <li>custom contextualization</li>
- <li>dynamic components</li>
- </ul>
- </li>
- <li>complete the documentation about the James example</li>
- <li>add documentation concerning the Merlin/Maven plugin</li>
- <li>resolve a manifest generation problem that is currently
- preventing the proper management of extensions</li>
- <li>either release Excalibur Extension or include a fork
- under the Merlin project</li>
- <li>make sure everything is in sync with the recent
- Excalibur releases</li>
- <li>tag the CVS</li>
- <li>vote on a release</li>
- </ul>
+ <table>
+ <tr><th>Action</th><th>Status</th></tr>
+ <tr><td>custom contextualization tutorials</td><td>DONE</td></tr>
+ <tr><td>dynamic componentstutorials</td><td>PENDING</td></tr>
+ <tr><td>complete the documentation about the James example</td><td>PENDING</td></tr>
+ <tr><td>add documentation concerning the Merlin/Maven plugin</td><td>DONE</td></tr>
+ <tr><td>resolve a manifest generation problem that is currently
+ preventing the proper management of extensions</td><td>PENDING</td></tr>
+ <tr><td>either release Excalibur Extension or include a fork
+ under the Merlin project</td><td>PENDING</td></tr>
+ <tr><td>test and validation</td><td>ONGOING</td></tr>
+ <tr><td>tag the CVS</td><td>PENDING</td></tr>
+ <tr><td>vote on a release</td><td>PENDING</td></tr>
+ </table>
+ </subsection>
+ <subsection name="Voluntees">
<p>
-Any volunteers out there willing to help with release preparation - please post a not to the avalon dev or useds list. Help can be in all sorts of areas - validating documentation, packaging, testing, etc.
+Any volunteers out there willing to help with release preparation - please post a note to the avalon dev or users list. Help can be in all sorts of areas - validating documentation, packaging, testing, etc.
</p>
</subsection>
</section>
1.2 +4 -1 avalon-sandbox/merlin/merlin-platform/xdocs/resources/roadmap.xml
Index: roadmap.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/roadmap.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- roadmap.xml 10 Jun 2003 02:14:25 -0000 1.1
+++ roadmap.xml 10 Jun 2003 05:10:41 -0000 1.2
@@ -19,8 +19,11 @@
managed delopment, decommissioning and redeployment.</td>
</tr>
<tr>
+ <td>MGR</td><td>A Merlin Management console for JMX interaction.</td>
+ </tr>
+ <tr>
<td>JNDI</td><td>Implementation of a full JNDI provider
- deliveing URL based access to services eliminating the need
+ delivering URL based access to services eliminating the need
to reference the Merlin Kernel API.</td>
</tr>
<tr>
1.2 +1 -1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/tools/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 10 Jun 2003 02:14:37 -0000 1.1
+++ index.xml 10 Jun 2003 05:10:41 -0000 1.2
@@ -35,7 +35,7 @@
</td>
</tr>
<tr>
- <td><a href="maven.html">Maven Plugin</a></td>
+ <td><a href="maven/index.html">Maven Plugin</a></td>
<td>
The Merlin plugin for Maven that provides support for
meta infor generation when building with the Maven tool.
1.2 +1 -1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/tools/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:38 -0000 1.1
+++ navigation.xml 10 Jun 2003 05:10:41 -0000 1.2
@@ -21,7 +21,7 @@
<item name="Tools" href="/tools/index.html">
<item name="Javadoc Tags Reference" href="/tools/tags/index.html"/>
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
- <item name="Merlin Plugin for Maven" href="/tools/maven.html"/>
+ <item name="Merlin Plugin for Maven" href="/tools/maven/index.html"/>
</item>
<item name="Resources" href="/resources/index.html"/>
</menu>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/maven/deploy.xml
Index: deploy.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Merlin Plugin for Maven</title>
</properties>
<body>
<section name="Merlin Plugin for Maven">
<subsection name="Deployment">
<p>
The Merlin Plugin for Maven includes two goals supporting simulated and actual deployment of a block within Maven.
</p>
</subsection>
<subsection name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>merlin:simulate</td>
<td>
<p>Initiates the deployment of a block based on a block.xml directive
contained in the maven.conf directory using the target/classes
as the source of components and meta-info.</p>
</td>
</tr>
<tr>
<td>merlin:deploy</td>
<td>
<p>Initiates the deployment of a block based on a block.xml directive
contained in the generated jar file. The jar file is impliicity
included within the deployment classpath.</p>
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/maven/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Merlin Tools</title>
</properties>
<body>
<section name="Overview">
<p>
The Merlin Plugin for Maven includes a number of developer requirements covering meta-info generation, simulated and actual component deployment, and maven to merlin repository replication.
</p>
<subsection name="Index">
<table>
<tr><th>Topic</th><th>Summary</th></tr>
<tr>
<td><a href="meta.html">Meta Generation</a></td>
<td>
Goals supporting the automated generation of Merlin meta info.
</td>
</tr>
<tr>
<td><a href="deploy.html">Component deployment</a></td>
<td>
Goals supporting simulated and operational component
deployment within Maven.
</td>
</tr>
<tr>
<td><a href="replicate.html">Maven to Merlin repository replication</a></td>
<td>
A goal supporting the replication of a Maven artifact to the
Merlin repository.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/maven/meta.xml
Index: meta.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Merlin Plugin for Maven</title>
</properties>
<body>
<section name="Merlin Plugin for Maven">
<subsection name="Meta Generation">
<p>
The Merlin Plugin for Maven provides support for developers in the management of Maven based projects that leverage the Avalon component model. This plugin will be progressively extended with Merlin and related sub-system utilities. Currently the plugin provides support for a meta info generation process based on javadoc tags within class and interface source files.
</p>
</subsection>
<subsection name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>merlin:meta</td>
<td>
<p>Generates meta info descriptors for service and component types
based on javadoc tags within the java source files. Source files
are scanned for the presence of an @avalon.version tag and if
present, a meta descriptor is generated. If the version tag is
within an interface defintion, a new Service defintion is created
otherwise a Type defintion is created.</p>
<p>Meta info generation process includes:</p>
<ul>
<li>Scan source files for avalon.meta tags</li>
<li>Build Type and Service descriptors</li>
<li>Externalize descriptors to serial or xml format</li>
</ul>
<p>Resulting meta info descriptors are placed int the ${basedir}/target/src directory. Typical application scenario is to define a preGoal to handle meta-info generation under the maven.xml file and inclusion of the output meta info under the project.xml jar resources.</p>
<p><i>maven.xml example</i></p>
<source><![CDATA[
<project default="jar:jar">
<preGoal name="jar:jar">
<attainGoal name="merlin:meta"/>
</preGoal>
</project>
]]></source>
<p><i>project.xml example</i></p>
<source><![CDATA[
<project>
<!-- other stuff -->
<build>
<!-- more stuff -->
<resources>
<!-- include the generated metainfo descriptors into you jar file -->
<resource>
<directory>${basedir}/target/src</directory>
<includes>
<include>**/*.xinfo</include>
<include>**/*.xservice</include>
</includes>
</resource>
</resources>
</build>
</project>
]]></source>
</td>
</tr>
</table>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>Property name</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>merlin.meta.format</td>
<td>Yes</td>
<td>
<p>Output format specification. Valid values include 'xml' or 'serial'.
The xml value instructs the meta generator to create meta descriptions
in an XML format whereas the 'serial' value generates a serialized
description of the descriptor. Serial format is more efficient. The
XML format is more portable.</p>
</td>
</tr>
<tr>
<td>merlin.meta.force</td>
<td>Yes</td>
<td>
<p>Policy controlling the regeneration of meta descriptors independently
of the descriptor data. This value default to false. </p>
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/maven/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Merlin</title>
<body>
<links>
<item name="Home" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/framework/"/>
<item name="Components" href="http://avalon.apache.org/components"/>
<item name="Containers" href="http://avalon.apache.org/containers/"/>
<item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
</links>
<menu name="About Merlin">
<item name="Overview" href="/about/index.html"/>
<item name="Getting Started" href="/starting/index.html"/>
<item name="Merlin System" href="/merlin/index.html"/>
<item name="Meta Model" href="/meta/index.html"/>
<item name="Tools" href="/tools/index.html">
<item name="Javadoc Tags Reference" href="/tools/tags/index.html"/>
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
<item name="Merlin Plugin for Maven" href="/tools/maven/index.html">
<item name="Meta Generation" href="/tools/maven/meta.html"/>
<item name="Deployment" href="/tools/maven/deploy.html"/>
<item name="Replication" href="/tools/maven/replicate.html"/>
</item>
</item>
<item name="Resources" href="/resources/index.html"/>
</menu>
<menu name="Extensions">
<item name="JNDI" href="/extensions/jndi/index.html"/>
<item name="Servlet" href="/extensions/servlet/index.html"/>
</menu>
</body>
</project>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/maven/replicate.xml
Index: replicate.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Merlin Plugin for Maven</title>
</properties>
<body>
<section name="Merlin Plugin for Maven">
<subsection name="Utilities">
<p>
The Merlin Plugin for Maven includes a utility goal supporting the replication of jar artifacts form the Maven repository to the Merlin repository.
</p>
</subsection>
<subsection name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>merlin:replicate</td>
<td>
<p>Creates a duplicate of the project jar artifact contained in the
Maven repository and includes it under the Merlin repository.</p>
</td>
</tr>
<tr>
<td>merlin:install</td>
<td>
<p>Is equivalent to jar:install followed by merlin:replicate.</p>
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.2 +1 -1 avalon-sandbox/merlin/merlin-platform/xdocs/tools/tags/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/tools/tags/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:39 -0000 1.1
+++ navigation.xml 10 Jun 2003 05:10:42 -0000 1.2
@@ -34,7 +34,7 @@
<item name="Dependency" href="/tools/tags/dependency.html"/>
</item>
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
- <item name="Merlin Plugin for Maven" href="/tools/maven.html"/>
+ <item name="Merlin Plugin for Maven" href="/tools/maven/index.html"/>
</item>
<item name="Resources" href="/resources/index.html"/>
</menu>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org