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/12/20 23:29:59 UTC
cvs commit: avalon/merlin/platform/xdocs/merlin/kernel/embedding index.xml navigation.xml
mcconnell 2003/12/20 14:29:59
Modified: merlin INSTALLATION.TXT maven.xml
merlin/kernel/plugin/src/java/org/apache/avalon/merlin/tools
MerlinBean.java
merlin/platform/xdocs/merlin/kernel cli.xml navigation.xml
Added: merlin/platform/xdocs/merlin/kernel/embedding index.xml
navigation.xml
Log:
Doc updates and housekeeping.
Revision Changes Path
1.7 +86 -86 avalon/merlin/INSTALLATION.TXT
Index: INSTALLATION.TXT
===================================================================
RCS file: /home/cvs/avalon/merlin/INSTALLATION.TXT,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- INSTALLATION.TXT 20 Dec 2003 09:07:15 -0000 1.6
+++ INSTALLATION.TXT 20 Dec 2003 22:29:59 -0000 1.7
@@ -1,86 +1,86 @@
-
-PROJECT: Merlin 3.2-dev
-====================================================================
-
-DESCRIPTION:
-------------
-
-This directory contains the merlin system installation and related
-resources.
-
- /merlin
- /bin
- /config
- /ext
- /system
- README.TXT
- LICENSE.TXT
- INSTALLATION.TXT
- /plugins
- avalon-meta-plugin-1.2.jar
- merlin-plugin-3.2.1-dev.jar
-
-
-Installing Merlin.
-------------------
-
-To use Merlin command line support or the Merlin NT Service
-you will need to define the MERLIN_HOME environment
-variable for your system and include MERLIN_HOME/bin in
-your system path. The MERLIN_HOME environment variable
-should point to the merlin directory.
-
-Under Lunix you can do this as follows:
-
- $ echo '
- > # set location of merlin
- > export MERLIN_HOME=/opt/merlin
- > # include it in the path
- > export PATH=$PATH:$MERLIN_HOME/bin
- > ' >> ~/.bash_profile
- $ source ~/.bash_profile
-
-Under Windows you can set environment variables by selecting the
-Environment Tab from the System Control Panel.
-
-Versions of Merlin prior to the 3.2-dev 20031210 build maintained
-a local repository of jar files under the %MERLIN_HOME%/repository
-directory. As of the 20031210 build the repository is maintained
-under AVALON_HOME which defaults to ${user.home}/.avalon. To
-override this behaviour you can either define a AVALON_HOME
-environment variable or you can add a merlin.properties file to
-${user.home} containing the "merlin.repository" property key and
-a value point to you preferred repository location.
-
-To confirm that your environment variables are correct, you
-should open a new command window and invoke the Merlin
-CLI application.
-
-Under DOS:
-
- $ merlin -version
-
-Under Lunix:
-
- $ merlin.sh -version
-
-The installation of Merlin is now complete, however, two plugins are
-provided with the installation supporting merlin development under the
-Maven platform. These plugins should be placed in the Maven plugin
-directory (${maven.home.local}\plugins).
-
- [YOUR-MAVEN-HOME]\plugins\avalon-meta-plugin-1.2.jar
- [YOUR-MAVEN-HOME]\plugins\merlin-plugin-3.2.1-dev.jar
-
-Please note that if you are upgrading an existing installation you must
-delete the following two directories:
-
- [YOUR-MAVEN-HOME]\plugins\avalon-meta-plugin-*
- [YOUR-MAVEN-HOME]\plugins\merlin-plugin-*
-
-Replace the existing avalon-meta and merlin plugin jar files with the supplied
-versions. Finally, delete all *.cache files in the Maven plugin directory.
-
-You now have everything in place to start using the Merlin Tutorial or
-building you own components. If you have any problems, please subscribe
-and post a message to users@avalon.apache.org.
+
+PROJECT: Merlin 3.2-dev
+====================================================================
+
+DESCRIPTION:
+------------
+
+This directory contains the merlin system installation and related
+resources.
+
+ /merlin
+ /bin
+ /config
+ /ext
+ /system
+ README.TXT
+ LICENSE.TXT
+ INSTALLATION.TXT
+ /plugins
+ avalon-meta-plugin-1.2.jar
+ merlin-plugin-3.2.1-dev.jar
+
+
+Installing Merlin.
+------------------
+
+To use Merlin command line support or the Merlin NT Service
+you will need to define the MERLIN_HOME environment
+variable for your system and include MERLIN_HOME/bin in
+your system path. The MERLIN_HOME environment variable
+should point to the merlin directory.
+
+Under Lunix you can do this as follows:
+
+ $ echo '
+ > # set location of merlin
+ > export MERLIN_HOME=/opt/merlin
+ > # include it in the path
+ > export PATH=$PATH:$MERLIN_HOME/bin
+ > ' >> ~/.bash_profile
+ $ source ~/.bash_profile
+
+Under Windows you can set environment variables by selecting the
+Environment Tab from the System Control Panel.
+
+Versions of Merlin prior to the 3.2-dev 20031210 build maintained
+a local repository of jar files under the %MERLIN_HOME%/repository
+directory. As of the 20031210 build the repository is maintained
+under AVALON_HOME which defaults to ${user.home}/.avalon. To
+override this behaviour you can either define a AVALON_HOME
+environment variable or you can add a merlin.properties file to
+${user.home} containing the "merlin.repository" property key and
+a value point to you preferred repository location.
+
+To confirm that your environment variables are correct, you
+should open a new command window and invoke the Merlin
+CLI application.
+
+Under DOS:
+
+ $ merlin -version
+
+Under Lunix:
+
+ $ merlin.sh -version
+
+The installation of Merlin is now complete, however, two plugins are
+provided with the installation supporting merlin development under the
+Maven platform. These plugins should be placed in the Maven plugin
+directory (${maven.home.local}\plugins).
+
+ [YOUR-MAVEN-HOME]\plugins\avalon-meta-plugin-1.2.jar
+ [YOUR-MAVEN-HOME]\plugins\merlin-plugin-3.2.1-dev.jar
+
+Please note that if you are upgrading an existing installation you must
+delete the following two directories:
+
+ [YOUR-MAVEN-HOME]\plugins\avalon-meta-plugin-*
+ [YOUR-MAVEN-HOME]\plugins\merlin-plugin-*
+
+Replace the existing avalon-meta and merlin plugin jar files with the supplied
+versions. Finally, delete all *.cache files in the Maven plugin directory.
+
+You now have everything in place to start using the Merlin Tutorial or
+building you own components. If you have any problems, please subscribe
+and post a message to users@avalon.apache.org.
1.24 +1 -0 avalon/merlin/maven.xml
Index: maven.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/maven.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- maven.xml 18 Dec 2003 01:11:07 -0000 1.23
+++ maven.xml 20 Dec 2003 22:29:59 -0000 1.24
@@ -389,6 +389,7 @@
<goal name="avalon:build" prereqs="merlin:install"/>
<goal name="avalon:dist" prereqs="merlin:dist"/>
<goal name="avalon:clean" prereqs="merlin:clean"/>
+ <goal name="avalon:site" prereqs="merlin:site"/>
<goal name="merlin-clean" prereqs="merlin:clean"/>
<goal name="merlin-dist" prereqs="avalon:dist"/>
1.11 +6 -6 avalon/merlin/kernel/plugin/src/java/org/apache/avalon/merlin/tools/MerlinBean.java
Index: MerlinBean.java
===================================================================
RCS file: /home/cvs/avalon/merlin/kernel/plugin/src/java/org/apache/avalon/merlin/tools/MerlinBean.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- MerlinBean.java 14 Dec 2003 20:07:45 -0000 1.10
+++ MerlinBean.java 20 Dec 2003 22:29:59 -0000 1.11
@@ -150,6 +150,11 @@
try
{
+ InitialContext context =
+ new DefaultInitialContext(
+ getMavenRepositoryDirectory(),
+ m_hosts );
+
Artifact artifact =
DefaultBuilder.createImplementationArtifact(
classloader,
@@ -157,11 +162,6 @@
getBaseDirectory(),
MERLIN_PROPERTIES,
IMPLEMENTATION_KEY );
-
- InitialContext context =
- new DefaultInitialContext(
- getMavenRepositoryDirectory(),
- m_hosts );
Builder builder =
new DefaultBuilder( context, artifact );
1.3 +56 -39 avalon/merlin/platform/xdocs/merlin/kernel/cli.xml
Index: cli.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/merlin/kernel/cli.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cli.xml 10 Dec 2003 09:10:01 -0000 1.2
+++ cli.xml 20 Dec 2003 22:29:59 -0000 1.3
@@ -79,10 +79,10 @@
</p>
<source><![CDATA[
$ merlin -help
-usage: merlin [block] [-lang <code>] [-install <url>] [-library
- <directory>] [-help] [-version] [-home <directory>] [-impl <artifact>]
+usage: merlin [block] [-lang <code>] [-library <directory>]
+ [-help] [-version] [-home <directory>] [-impl <artifact>]
[-debug] [-info] [-config <url>] [-context <directory>] [-system
- <directory>] [-execute] [-repository <directory>] [-kernel <url>]
+ <directory>] [-execute] [-repository <directory>] [-kernel <url>]
]]></source>
</subsection>
@@ -90,68 +90,85 @@
<table>
<tr><th>Qualifier</th><th>Parameter</th><th>Description</th></tr>
<tr>
- <td>-help</td><td></td><td>Prints the help message.</td>
- </tr>
- <tr>
- <td>-lang</td>
+ <td>lang</td>
<td>A two letter country code</td>
<td>Sets the default language country code to the supplied value.</td>
</tr>
<tr>
- <td>-version</td>
+ <td>library</td>
+ <td>directory</td>
+ <td>Override the default anchor directory for jar extension references
+ and classpath include relative file references.</td>
+ </tr>
+ <tr>
+ <td>help</td><td></td><td>Prints the help message.</td>
+ </tr>
+ <tr>
+ <td>version</td>
<td></td>
<td>Prints Merlin version information and exit.</td>
</tr>
<tr>
- <td>-info</td>
- <td></td>
- <td>Lists deployment parameters on startup.</td>
+ <td>home</td>
+ <td>directory</td>
+ <td>Overide the ${merlin.dir} directory. This is a relative
+ or absolute path to a working directory. If not suppled,
+ the system will default to ${user.dir}.</td>
</tr>
<tr>
- <td>-debug</td>
+ <td>impl</td>
+ <td>artifact-spec</td>
+ <td>Override the ${merlin.implementation} artifact spec. The specification
+ is the formal of [group]:[artifact];[version] and is used to direct the
+ boostrap system to load an alternative kernel implementation.</td>
+ </tr>
+ <tr>
+ <td>debug</td>
<td></td>
<td>Instructs Merlin to issue internal system debug messages.</td>
</tr>
<tr>
- <td>-home</td>
+ <td>info</td>
+ <td></td>
+ <td>Lists deployment parameters on startup.</td>
+ </tr>
+ <tr>
+ <td>config</td><td>url</td>
+ <td>A configuration source containing a set of target configuration fragements that will override configuration entries defined under a block. This value overrides any ${merlin.override} property value. If the supplied argument is a file (relative or absolute) Merlin will convert the file to a url. Relative file references are resolved relative to ${merlin.dir}.</td>
+ </tr>
+ <tr>
+ <td>context</td>
<td>directory</td>
- <td>A relative or absolute path to a working home directory. If not suppled, the system will default to ${user.dir}/home.</td>
+ <td>Overide the ${merlin.context} directory. This is a relative
+ or absolute path to a working context directory. If not suppled,
+ the system will default to ${merlin.dir}/home.</td>
</tr>
<tr>
- <td>-kernel</td><td>url</td>
- <td>A url of a kernel configuration overriding the default kernel directive. The value defaults to ${merlin.home}/config/kernel.xml.</td>
+ <td>system</td>
+ <td>directory</td>
+ <td>Overide the ${merlin.system} directory. This is a relative
+ or absolute path to the merlin system repository. The default
+ value resolves to ${merlin.home}/system.</td>
</tr>
<tr>
- <td>-config</td><td>url</td>
- <td>A configuration source containing a set of target configuration fragements that will override configuration entries defined under a block.</td>
+ <td>execute</td>
+ <td></td>
+ <td>Forces ${merlin.server} to false resulting in the immediate shutdown
+ of the kernel on completion of the deployment phase. If not included merlin
+ will apply the default ${merlin.server} mode of 'true'.</td>
</tr>
<tr>
- <td>-repository</td><td>file</td>
- <td>Declaration of a local repository. If not suppplied Merlin will default to ${avalon.home}.</td>
+ <td>repository</td><td>file</td>
+ <td>Declaration of a local repository cache directory. If not
+ suppplied Merlin will default to ${avalon.home}/repository.</td>
</tr>
- </table>
- </subsection>
-
- <subsection name="Command Line Qualifiers (non-standard)">
-
- <p>
-Non-standard command line arguments should be considered as experimental
-and subject to change. Usage without a good understanding of the internals
-of the Merlin platform is not recommended.
- </p>
-
- <table>
- <tr><th>Qualifier</th><th>Parameter</th><th>Description</th></tr>
<tr>
- <td>-install</td>
- <td>url</td>
- <td>
-Installation of a block archive (.bar file) into the local repository and exists. The -repository argument may be used to select the destination repository for the installation. Resource will be included relative to the bar file group identifier. Existing resources with a modification date equal to or later than the archived entry will be ignored.
- </td>
+ <td>kernel</td><td>url</td>
+ <td>A url of a kernel configuration overriding the default kernel
+ directive. The value defaults to ${merlin.config}/kernel.xml.</td>
</tr>
</table>
</subsection>
-
</section>
</body>
1.4 +3 -2 avalon/merlin/platform/xdocs/merlin/kernel/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/merlin/kernel/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 10 Dec 2003 09:10:01 -0000 1.3
+++ navigation.xml 20 Dec 2003 22:29:59 -0000 1.4
@@ -67,9 +67,10 @@
<item name="Getting Started" href="/starting/index.html"/>
<item name="Merlin System" href="/merlin/index.html">
<item name="Kernel" href="/merlin/kernel/index.html">
+ <item name="Embedding" href="/merlin/kernel/embedding/index.html"/>
<item name="Properties" href="/merlin/kernel/properties.html"/>
- <item name="CLI" href="/merlin/kernel/cli.html"/>
- <item name="NT" href="/merlin/kernel/nt.html"/>
+ <item name="CLI Handler" href="/merlin/kernel/cli.html"/>
+ <item name="NT Service" href="/merlin/kernel/nt.html"/>
</item>
<item name="Block" href="/merlin/block/index.html"/>
<item name="Appliance" href="/merlin/appliance/index.html"/>
1.1 avalon/merlin/platform/xdocs/merlin/kernel/embedding/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<document>
<header>
<title>Merlin Kernel Embedding</title>
<authors>
<person name="Stephen McConnell" email="mcconnell@apache.org"/>
</authors>
</header>
<body>
<section name="Merlin Kernel Embedding">
<p>
The Merlin Kernel is designed first and foremost as an embeddable
container. The 3.2 release introduced several improvements to the
embedding strategy through leverage of the avalon-repository
boostrapping system, and added comprehensive support for the
management of properties anabling complete configuration of a new
kernel instance programatically or via property resolution.
</p>
<subsection name="Embedded Example">
<source>
//in preparation
</source>
</subsection>
</section>
</body>
</document>
1.1 avalon/merlin/platform/xdocs/merlin/kernel/embedding/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<project>
<title>Merlin</title>
<body>
<links>
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/product/framework/"/>
<item name="Containers" href="http://avalon.apache.org/product/containers/"/>
<item name="Components" href="http://avalon.apache.org/product/components/"/>
</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="Kernel" href="/merlin/kernel/index.html">
<item name="Embedding" href="/merlin/kernel/embedding/index.html"/>
<item name="Properties" href="/merlin/kernel/properties.html"/>
<item name="CLI Handler" href="/merlin/kernel/cli.html"/>
<item name="NT Service" href="/merlin/kernel/nt.html"/>
</item>
<item name="Block" href="/merlin/block/index.html"/>
<item name="Appliance" href="/merlin/appliance/index.html"/>
</item>
<item name="Meta Model" href="/meta/index.html"/>
<item name="Tools" href="/tools/index.html"/>
</menu>
<menu name="Resources">
<item name="Javadoc" href="/api/index.html"/>
<item name="Download" href="/resources/download.html"/>
<item name="Roadmap" href="/resources/roadmap/index.html"/>
<item name="DPML" href="/dpml/index.html"/>
</menu>
</body>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org