You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ni...@apache.org on 2004/01/04 13:09:08 UTC
cvs commit: avalon/merlin/platform/xdocs/meta/kernel/parameters index.xml navigation.xml parameter.xml
niclas 2004/01/04 04:09:08
Modified: merlin/platform/xdocs/meta/kernel index.xml navigation.xml
merlin/platform/xdocs/meta/kernel/logging navigation.xml
Added: merlin/platform/xdocs/meta/kernel/parameters index.xml
navigation.xml parameter.xml
Log:
Updated the documentatin with information about setting kernel parameters.
Revision Changes Path
1.2 +4 -0 avalon/merlin/platform/xdocs/meta/kernel/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/kernel/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Sep 2003 09:35:06 -0000 1.1
+++ index.xml 4 Jan 2004 12:09:08 -0000 1.2
@@ -72,6 +72,10 @@
<td><a href="repository/index.html">repository</a></td><td>0..1</td>
<td>Defintion of the repository sub-system including proxy settings, cache directory and remote host list.</td>
</tr>
+ <tr>
+ <td><a href="parameters/index.html">parameters</a></td><td>0..1</td>
+ <td>For kernel-level parameterization.</td>
+ </tr>
</table>
</subsection>
1.5 +1 -0 avalon/merlin/platform/xdocs/meta/kernel/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/kernel/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 23 Dec 2003 17:30:32 -0000 1.4
+++ navigation.xml 4 Jan 2004 12:09:08 -0000 1.5
@@ -70,6 +70,7 @@
<item name="kernel.xml" href="/meta/kernel/index.html">
<item name="logging" href="/meta/kernel/logging/index.html"/>
<item name="repository" href="/meta/kernel/repository/index.html"/>
+ <item name="parameters" href="/meta/kernel/parameters/index.html">
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
1.5 +1 -0 avalon/merlin/platform/xdocs/meta/kernel/logging/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/kernel/logging/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 23 Dec 2003 17:30:32 -0000 1.4
+++ navigation.xml 4 Jan 2004 12:09:08 -0000 1.5
@@ -73,6 +73,7 @@
<item name="category" href="/meta/kernel/logging/category.html"/>
</item>
<item name="repository" href="/meta/kernel/repository/index.html"/>
+ <item name="parameters" href="/meta/kernel/parameters/index.html" />
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
1.1 avalon/merlin/platform/xdocs/meta/kernel/parameters/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>Kernel Parameters</title>
<authors>
<person name="Niclas Hedhman" email="niclas@apache.org"/>
</authors>
</header>
<body>
<section name="Kernel Parameters">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td>parameter</td><td>0..n</td>
<td>
Each parameter has a <strong>name</strong> and a <strong>value<strong>
attribute. The parameters that are available can be found below.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
Parameters have been introduced to allow for the internals of the
kernel to be tuned for different purposes. Initially, the number
parameters available is fairly small, but we expect this number to
grow steadily.
</p>
<p>
Parameters that are currently available is;
</p>
<table>
<tr><th>Name</th><th>Default</th><th>Description</th></tr>
<tr>
<td>deployment-timeout</td>
<td>5000</td>
<td>
The time in millisecond within which the deployment of any
component and any container must complete. Once this time
limit has been reached, the deployment system will try to
interrupt() the thread. If that succeeds, the deployment
the container will fail, but other containers may still be
deployed. If the interrupt() fails, the whole JVM must be
considered unstable, and should terminate.
</td>
</tr>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<kernel>
<parameters>
<!-- Declaration that deployment should allow for 2500ms for
any component or container to start-up, before interrupting
or failing. -->
<parameter name="deployment-timeout" value="500" />
</parameters>
</kernel>
]]></source>
</subsection>
</section>
</body>
</document>
1.1 avalon/merlin/platform/xdocs/meta/kernel/parameters/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="Meta Model" href="/meta/index.html">
<item name="kernel.xml" href="/meta/kernel/index.html">
<item name="logging" href="/meta/kernel/logging.html"/>
<item name="repository" href="/meta/kernel/repository/index.html">
<item name="parameters" href="/meta/kernel/parameters/index.html">
<item name="parameter" href="/meta/kernel/repository/parameter.html"/>
</item>
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
</item>
<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>
<menu name="Related Projects">
<item name="Meta" href="http://avalon.apache.org/meta"/>
<item name="Utilities" href="http://avalon.apache.org/util"/>
<item name="Repository" href="http://avalon.apache.org/repository"/>
</menu>
</body>
</project>
1.1 avalon/merlin/platform/xdocs/meta/kernel/parameters/parameter.xml
Index: parameter.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>Kernel Parameters</title>
<authors>
<person name="Niclas Hedhman" email="niclas@apache.org"/>
</authors>
</header>
<body>
<section name="Parameter">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>name</td><td>yes</td>
<td>
The name of the parameter.
</td>
</tr>
<tr>
<td>value</td><td>yes</td>
<td>
The value of the named parameter.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
A general-purpose mechanism to pass parameters to the kernel and
internal subsystems.
</p>
<p>
See <a href="index.html">parameters</a> for a complete list of the
available parameters.
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<kernel>
<parameters>
<parameter name="deployment-timeout" value="2500" />
</parameters>
</kernel>
]]></source>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org