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/07/16 01:40:44 UTC
cvs commit: avalon-sandbox/meta/site/xdocs/tools/tags index.xml navigation.xml
mcconnell 2003/07/15 16:40:44
Modified: meta/site project.xml
meta/site/xdocs/meta navigation.xml
meta/site/xdocs/meta/info navigation.xml
meta/site/xdocs/meta/info/attributes navigation.xml
meta/site/xdocs/meta/info/type navigation.xml
meta/site/xdocs/meta/info/type/context navigation.xml
meta/site/xdocs/meta/info/type/dependencies navigation.xml
meta/site/xdocs/meta/info/type/extensions navigation.xml
meta/site/xdocs/meta/info/type/loggers navigation.xml
meta/site/xdocs/meta/info/type/services navigation.xml
meta/site/xdocs/meta/info/type/stages navigation.xml
meta/site/xdocs/tools/maven index.xml navigation.xml
meta/site/xdocs/tools/tags index.xml navigation.xml
Added: meta/site/xdocs/meta/data index.xml navigation.xml
Removed: meta/site/xdocs/tools/maven deploy.xml meta.xml
replicate.xml
Log:
Updated to remove Merlin specific content and sync. with implementation.
Revision Changes Path
1.2 +1 -2 avalon-sandbox/meta/site/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project.xml 14 Jul 2003 20:22:17 -0000 1.1
+++ project.xml 15 Jul 2003 23:40:42 -0000 1.2
@@ -79,8 +79,7 @@
</packageGroup>
<packageGroup>
<title>Meta Model Services</title>
- <packages>org.apache.avalon.meta</packages>
- <packages>org.apache.avalon.meta.info.*</packages>
+ <packages>org.apache.avalon.*</packages>
</packageGroup>
</packageGroups>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:03 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:42 -0000 1.3
@@ -17,7 +17,7 @@
<item name="Getting Started" href="/tutorial/index.html"/>
<item name="Meta Model" href="/meta/index.html">
<item name="Descriptors" href="/meta/info/index.html"/>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.1 avalon-sandbox/meta/site/xdocs/meta/data/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Meta Data</title>
</properties>
<body>
<section name="Meta Data">
<subsection name="Overview">
<p>IN PREPARATION</p>
</subsection>
</section>
</body>
</document>
1.1 avalon-sandbox/meta/site/xdocs/meta/data/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Avalon Meta</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 Avalon Meta">
<item name="Overview" href="/index.html"/>
<item name="Getting Started" href="/tutorial/index.html"/>
<item name="Meta Model" href="/meta/index.html">
<item name="Descriptors" href="/meta/info/index.html"/>
<item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
</project>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -22,7 +22,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/attributes/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/attributes/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -24,7 +24,7 @@
<item name="Attribute" href="/meta/info/attributes/attribute.html"/>
</item>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -30,7 +30,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/context/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/context/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/dependencies/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/dependencies/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/extensions/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/extensions/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/loggers/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/loggers/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/services/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/services/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:43 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.3 +1 -1 avalon-sandbox/meta/site/xdocs/meta/info/type/stages/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/stages/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:44 -0000 1.3
@@ -32,7 +32,7 @@
<item name="Service" href="/meta/info/service.html"/>
<item name="Attributes" href="/meta/info/attributes/index.html"/>
</item>
- <item name="Directives" href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
+ <item name="Directives" href="/meta/data/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Javadoc" href="/api/index.html"/>
1.2 +117 -27 avalon-sandbox/meta/site/xdocs/tools/maven/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/maven/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ index.xml 15 Jul 2003 23:40:44 -0000 1.2
@@ -1,48 +1,138 @@
<?xml version="1.0"?>
<document>
-
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
- <title>Merlin Tools</title>
+ <title>Merlin Plugin for Maven</title>
</properties>
-
<body>
-
- <section name="Overview">
-
+ <section name="Merlin Plugin for Maven">
+ <subsection name="Meta Generation">
<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.
+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 name="Index">
+ </subsection>
+ <subsection name="Goals">
<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><th>Goal</th><th>Description</th></tr>
<tr>
- <td><a href="deploy.html">Component deployment</a></td>
+ <td>merlin:meta</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.
+ <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>**/*.x*</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>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+merlin.meta.format="xml"
+]]></source>
+ </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>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+merlin.meta.force="false"
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>merlin.meta.type.postfix</td>
+ <td>No</td>
+ <td>
+<p>
+Merlin will default to the deneration of XML type descriptors under
+the .xinfo file type. When generating meta-info descriptors targetted
+for deployment in both Merlin and Phoenix, the xinfo type will conflict
+with the Phoenix meta-info descriptor. Merlin provides support for
+generation of meta info under the alternative .xtype. To control the
+type of file generated, you can declare either "xinfo" or "xtype" under
+this property.
+</p>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+merlin.meta.type.postfix="xinfo"
+]]></source>
+<p>
+Alternative xtype behaviour:
+</p>
+<source><![CDATA[
+merlin.meta.type.postfix="xtype"
+]]></source>
+
+ </td>
+ </tr>
+ </table>
+ </subsection>
</section>
-
</body>
-
</document>
+
1.3 +1 -3 avalon-sandbox/meta/site/xdocs/tools/maven/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/maven/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:44 -0000 1.3
@@ -20,9 +20,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="Avalon Plugin for Maven" href="/tools/maven/index.html">
- <item name="Meta Generation" href="/tools/maven/meta.html"/>
- </item>
+ <item name="Avalon Plugin for Maven" href="/tools/maven/index.html"/>
</item>
<item name="Javadoc" href="/api/index.html"/>
</menu>
1.2 +6 -10 avalon-sandbox/meta/site/xdocs/tools/tags/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/tags/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 14 Jul 2003 20:22:21 -0000 1.1
+++ index.xml 15 Jul 2003 23:40:44 -0000 1.2
@@ -18,16 +18,12 @@
<subsection name="Tag List">
<table>
<tr><th>Tag</th><th>Scope</th><th>Description</th></tr>
- <tr><td><a href="version.html">@avalon.version</a></td>
- <td>class</td><td>Identifies a class or interface are a Type or Service.</td></tr>
+ <tr><td><a href="type.html">@avalon.type</a></td>
+ <td>class</td><td>Identifies a class as a Type.</td></tr>
<tr><td><a href="attribute.html">@avalon.attribute</a></td>
- <td>class</td><td>A attribute associated with a containing type or service.</td></tr>
- <tr><td><a href="name.html">@avalon.name</a></td>
- <td>class</td><td>Declaration of a component type name.</td></tr>
- <tr><td><a href="lifestyle.html">@avalon.lifestyle</a></td>
- <td>class</td><td>Declaration of the lifestyle policy.</td></tr>
+ <td>class</td><td>An attribute associated with a containing type or service.</td></tr>
<tr><td><a href="service.html">@avalon.service</a></td>
- <td>class</td><td>Service export declaration from a type.</td></tr>
+ <td>class</td><td>Service export declaration from a type (in a class) or Service declaration in a interface.</td></tr>
<tr><td><a href="stage.html">@avalon.stage</a></td>
<td>class</td><td>Lifecycle stage dependency declaration.</td></tr>
<tr><td><a href="extension.html">@avalon.extension</a></td>
@@ -48,7 +44,7 @@
<footer>
<legal>
- Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
+ Copyright (c) @year@ The Avalon Apache Project All rights reserved.
$Revision$ $Date$
</legal>
</footer>
1.3 +4 -6 avalon-sandbox/meta/site/xdocs/tools/tags/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/tags/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
+++ navigation.xml 15 Jul 2003 23:40:44 -0000 1.3
@@ -19,17 +19,15 @@
<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="Version" href="/tools/tags/version.html"/>
+ <item name="Type" href="/tools/tags/type.html"/>
<item name="Attribute" href="/tools/tags/attribute.html"/>
- <item name="Name" href="/tools/tags/name.html"/>
- <item name="Lifestyle" href="/tools/tags/lifestyle.html"/>
- <item name="Service" href="/tools/tags/service.html"/>
- <item name="Stage" href="/tools/tags/stage.html"/>
- <item name="Extension" href="/tools/tags/extension.html"/>
<item name="Logger" href="/tools/tags/logger.html"/>
<item name="Context" href="/tools/tags/context.html"/>
<item name="Entry" href="/tools/tags/entry.html"/>
+ <item name="Service" href="/tools/tags/service.html"/>
<item name="Dependency" href="/tools/tags/dependency.html"/>
+ <item name="Stage" href="/tools/tags/stage.html"/>
+ <item name="Extension" href="/tools/tags/extension.html"/>
</item>
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
<item name="Avalon Plugin for Maven" href="/tools/maven/index.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org