avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject svn commit: rev 21290 - in avalon/trunk/central/site/src/xdocs/central/tools: . magic maven plugins plugins/meta
Date Tue, 15 Jun 2004 15:40:27 GMT
Author: mcconnell
Date: Tue Jun 15 08:40:26 2004
New Revision: 21290

Added:
   avalon/trunk/central/site/src/xdocs/central/tools/maven/
      - copied from rev 21170, avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/tools/plugins/navigation.xml
Modified:
   avalon/trunk/central/site/src/xdocs/central/tools/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/navigation.xml
Log:
move ant tasks and maven plugin related info out of runtime and collocate with tools

Modified: avalon/trunk/central/site/src/xdocs/central/tools/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/index.xml	Tue Jun 15 08:40:26 2004
@@ -7,8 +7,29 @@
   </properties> 
 
   <body>
-    <section name="Tools and Utilities">
-    </section>
+    <section name="Tools">
+
+      <p>
+      The Avalon project represents over 60 versioned artifacts
+      with many build, test and runtime interdependencies.  Across 
+      this codebase with have a single container application, a 
+      Eclipse plugin, a number of plugable platform facilities, 
+      plugins that load plugins, etc. resulting in a general 
+      complex build cycle.  Following experiments with Ant and 
+      Maven, the Avalon team extended the concept of a POM (Project
+      Object Model) with centralized version and dependency
+      management - and combined this model with the Ant platform
+      to provide a powerful, fast and robust build system code-named
+      <a href="magic/index.html">Magic</a>.
+      </p>
+
+      <p>
+      In addition to the Magic build solution, Avalon has developed
+      plugins supporting the Ant and Maven environments.
+      </p>
+
+    </section>
+
   </body>
 
 </document>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml	Tue Jun 15 08:40:26
2004
@@ -7,14 +7,22 @@
   </properties> 
 
   <body>
-    <section name="Magic">
+    <section name="Magic">
+
+      <p class="caption">
+        <i>"any sufficiently advanced technology is 
+        indistinguishable from magic"<br/>
+        Sir Arthur C Clarke.</i>
+      </p>
+
       <p>
       Avalon Magic is a build system based on Apache
       <a href="http://ant.apache.org">Ant</a>.  It provides 
       a project model abstraction layer enabling centralized version
       and dependency management, build task automation, and dynamic 
       plugin management.
-      </p>
+      </p>
+
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/navigation.xml	Tue Jun 15 08:40:26 2004
@@ -24,6 +24,8 @@
  <body>
     <menu>
       <item name="Magic" href="magic/index.html"/>
+      <item name="Magic Plugins" href="magic/index.html"/>
+      <item name="Maven Plugins" href="maven/index.html"/>
     </menu>
  </body>
 

Added: avalon/trunk/central/site/src/xdocs/central/tools/plugins/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/plugins/index.xml	Tue Jun 15 08:40:26
2004
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  under the  Apache License,  Version 2.0  (the "License");
+ you may not use  this file  except in  compliance with the License.
+ You may obtain a copy of the License at 
+ 
+   http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed  under the  License is distributed on an "AS IS" BASIS,
+ WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
+ implied.
+ 
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Merlin Runtime</title>
+  </properties>
+
+  <body>
+
+    <section name="Ant Tasks">
+      <subsection name="Index">
+        <table>
+          <tr><th>Topic</th><th>Summary</th></tr>
+          <tr>
+            <td><a href="meta/index.html">Meta-Info Generation</a></td>
+            <td>
+              Ant task supporting the automated generation of component
+              meta-info descriptors based on javadoc tag references.
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+
+  </body>
+
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/index.xml	Tue Jun 15 08:40:26
2004
@@ -0,0 +1,158 @@
+<?xml version="1.0"?>
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Meta-Info Ganerator Ant Task</title>
+  </properties>
+  <body>
+    <section name="Ant Meta-Info Generator Task">
+      <p>
+The meta info generator task scans sources files for the present of an avalon.meta tags and
based on the tag set specification, generates either XML or serialized meta-info descriptors.
+      </p>
+
+      <subsection name="Parameters">
+<table>
+  <tr>
+   <th>Parameter</th><th>Required</th><th>Value</th>
+  </tr>
+  <tr>
+    <td>destDir</td><td>true</td>
+    <td>The directory into which the generated type and service defintions wil be created.</td>
+  </tr>
+  <tr>
+    <td>format</td><td>false</td>
+    <td>The output format. May be one of <strong>xml</strong> or <strong>serial</strong>.
 The xml format is less compact but more portable.  The serial format is appropriate when
usage is know to be in the context of the Avalon Meta API.  The serial format is a serialized
representation of the corresponding Task or Service instance.</td>
+  </tr>
+  <tr>
+    <td>force</td><td>false</td>
+    <td>A boolean flag to force regenerating of the meta-files. <strong>false</strong>
(default) will generate the meta-file if the source is newer than the exisiting meta-file
or if the meta-file does not exist. <strong>true</strong> will overwrite any existing
meta-file irrespective of the modification date.</td>
+  </tr>
+  <tr>
+    <td>postfix</td><td>false</td>
+    <td>Select between "xinfo" and "xtype" as the meta-info file type that is generated.
The xtype postfix is convinient when generating meta info descriptors that must cooexist with
the Phoenix platform.</td>
+  </tr>
+</table>
+      </subsection>
+      <subsection name="Nested Elements">
+<table>
+  <tr>
+   <th>Element</th><th>Required</th><th>Value</th>
+  </tr>
+  <tr>
+    <td>fileset</td><td>true</td>
+    <td>A fileset containing the defintion of the source files to be included in the
scanning phase.</td>
+  </tr>
+</table>
+      </subsection>
+
+      <subsection name="Ant Example">
+<source><![CDATA[
+  <target name="meta" description="Generates the XML descriptors" depends="build">
+    <mkdir dir="${meta.dir}" />
+    <taskdef name="meta" classname="org.apache.avalon.meta.info.ant.MetaTask">
+      <classpath refid="project.class.path" />
+    </taskdef>
+    <meta destDir="${meta.dir}" format="xml">
+      <fileset dir="${src}">
+        <include name="**/*.java"/>
+      </fileset>
+    </meta>
+  </target>
+]]></source>
+      </subsection>
+    </section>
+    <section name="Example">
+      <subsection name="Java source with Tag markup">
+<source><![CDATA[
+
+import java.io.File;
+
+import org.apache.avalon.framework.logger.Logger;
+import org.apache.avalon.framework.logger.AbstractLogEnabled;
+import org.apache.avalon.framework.service.Serviceable;
+import org.apache.avalon.framework.service.ServiceManager;
+import org.apache.avalon.framework.service.ServiceException;
+import org.apache.avalon.framework.context.Context;
+import org.apache.avalon.framework.context.Contextualizable;
+import org.apache.avalon.framework.context.ContextException;
+
+/**
+ * An example component containing meta info under javadoc tags.
+ *
+ * @avalon.component name="secondary-component" version="2.4" lifestyle="singleton"
+ * @avalon.service type="SecondaryService:0.1"
+ */
+public class Secondary extends AbstractLogEnabled 
+  implements Serviceable, SecondaryService, Contextualizable
+{
+    private Logger m_system = null;
+    private File m_home = null;
+    private PrimaryService m_primary = null;
+
+   /**
+    * Supply of a logging channel to the component.
+    * @param logger the logging channel
+    * @avalon.logger name="system"
+    */
+    public void enableLogging( Logger logger )
+    {
+        super.enableLogging( logger );
+        m_system = logger.getChildLogger( "system" );
+    }
+
+   /**
+    * Supply of the runtime context by the container.
+    * @param context the runtime context
+    * @avalon.entry key="home" type="java.io.File"
+    */
+    public void contextualize( Context context ) throws ContextException
+    {
+        m_home = (File) context.get("home");
+    }    
+
+   /**
+    * Supply of dependent services to this component by the container.
+    * @param manager the service manager
+    * @avalon.dependency type="PrimaryService" version="1.3" key="primary"
+    */
+    public void service( ServiceManager manager ) throws ServiceException
+    {
+        m_primary = (PrimaryService) manager.lookup( "primary" );
+        m_system.info( "resolved primary service reference" );
+    }
+}
+]]></source>
+      </subsection>
+      <subsection name="Generated meta-info descriptor">
+<source><![CDATA[
+<?xml version="1.0" ?>
+<!DOCTYPE type PUBLIC "-//AVALON/Type DTD Version 1.0//EN" 
+  "http://avalon.apache.org/dtds/meta/type_1_1.dtd" >
+
+<type>
+  <info>
+    <name>secondary-component</name>
+    <version>2.4.0</version>
+    <lifestyle>singleton</lifestyle>
+  </info>
+  <loggers>
+    <logger name="system"/>
+  </loggers>
+  <context>
+    <entry key="home" type="java.io.File"/>
+  </context>
+  <services>
+    <service type="SecondaryService" version="0.1.0"/>
+  </services>
+  <dependencies>
+    <dependency key="primary" type="PrimaryService" version="1.3.0"/>
+  </dependencies>
+</type>
+]]></source>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/plugins/meta/navigation.xml	Tue Jun
15 08:40:26 2004
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  under the  Apache License,  Version 2.0  (the "License");
+ you may not use  this file  except in  compliance with the License.
+ You may obtain a copy of the License at 
+ 
+   http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed  under the  License is distributed on an "AS IS" BASIS,
+ WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
+ implied.
+ 
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+    </menu>
+  </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/tools/plugins/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/plugins/navigation.xml	Tue Jun 15 08:40:26
2004
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  under the  Apache License,  Version 2.0  (the "License");
+ you may not use  this file  except in  compliance with the License.
+ You may obtain a copy of the License at 
+ 
+   http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed  under the  License is distributed on an "AS IS" BASIS,
+ WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
+ implied.
+ 
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+      <item name="Meta Generation" href="meta/index.html"/>
+    </menu>
+  </body>
+
+</project>

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org


Mime
View raw message