avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: avalon-sandbox/merlin/merlin-smp/xdocs/starting index.xml
Date Thu, 03 Apr 2003 14:39:53 GMT
mcconnell    2003/04/03 06:39:53

  Modified:    merlin/merlin-smp/xdocs/merlin/block index.xml packaging.xml
               merlin/merlin-smp/xdocs/merlin/kernel cli.xml jndi.xml
                        nt.xml
               merlin/merlin-smp/xdocs/meta/info/type navigation.xml
               merlin/merlin-smp/xdocs/meta/model/kernel categories.xml
                        engine.xml index.xml logging.xml system.xml
               merlin/merlin-smp/xdocs/starting index.xml
  Log:
  General cleaning up - link corrections and enhancing documentation consistency.
  
  Revision  Changes    Path
  1.3       +2 -2      avalon-sandbox/merlin/merlin-smp/xdocs/merlin/block/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/block/index.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	2 Apr 2003 21:57:58 -0000	1.2
  +++ index.xml	3 Apr 2003 14:39:52 -0000	1.3
  @@ -13,7 +13,7 @@
         <subsection name="Overview">
   
         <p>
  -      A block is a specialization of an <a href="appliance/index.html">Appliance</a>.
A block manages a container (a type of component).  In addition, a block exposes services
derived from the set of appliances that are managed by it's container.  As such, a block can
be view as a composite component.  A block may be contained within other blocks.
  +      A block is a specialization of an <a href="../appliance/index.html">Appliance</a>.
A block manages a container (a type of component).  In addition, a block exposes services
derived from the set of appliances that are managed by it's container.  As such, a block can
be view as a composite component.  A block may be contained within other blocks.
         </p>
         <p>
         A container manages a set of components declared within the containment scope.  As
such, a container represents a logical and structural partition within a containment heirachy.
 Each container is associated with a classloader.  The classloader parent is the classloader
of the parent container.  As such, a container (and component within the container) have access
to the services defined within the immediate container and all parent containers. 
  
  
  
  1.3       +13 -1     avalon-sandbox/merlin/merlin-smp/xdocs/merlin/block/packaging.xml
  
  Index: packaging.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/block/packaging.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- packaging.xml	2 Apr 2003 21:57:58 -0000	1.2
  +++ packaging.xml	3 Apr 2003 14:39:52 -0000	1.3
  @@ -10,7 +10,19 @@
     <body>
       <section name="Block">
         <subsection name="Block Packaging">
  -        <p>In preparation.</p>
  +        <p>
  +          During the scanning phase the Merlin Kernel looks though the 
  +          directory of a jar file for resources with the .xinfo, .xtype, 
  +          .xservice, .xconfig and .xprofile extensions.  These extensions
  +          declare to Merlin th available types (.xinf and .xtype), services
  +          (.xservice), deault type level confiurations (.xconfig), and packaged
  +          deployment profile templates (.xprofile).
  +        </p>
  +        <p>
  +          In addition, Merlin will attempt to read a block directive under the 
  +          jar resource pathof BLOCK-INF/block.xml.  If a resource exists, the 
  +          supplied jar file wil be consider as a block.
  +        </p>
         </subsection>
       </section>
     </body>
  
  
  
  1.2       +66 -1     avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/cli.xml
  
  Index: cli.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/cli.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- cli.xml	2 Apr 2003 15:51:57 -0000	1.1
  +++ cli.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -11,7 +11,72 @@
   
     <body>
       <section name="Merlin CLI (Command Line Interface)">
  -      <p>In preparation.</p>
  +      <subsection name="Overview">
  +      <p>
  +        Merlin CLI is the command line interface to the merlin system.
  +        It provides suppprt for the declaration of the root block
  +        directive, a working home directory, a kernel directive, 
  +        and other parameters qualifying debug output and language 
  +        policy.
  +      </p>
  +      <p>
  +        The prime objective the Merlin CLI is to lauch a root block 
  +        descriptor and facilitate the deployment of the block and as a 
  +        consequence, the deployment of subsidiary blocks, containers and
  +        components.
  +      </p>
  +      </subsection>
  +      <subsection name="Command Line">
  +        <p>
  +          The Merlin CLI takes a [block] argument as it's primary 
  +          argument.  The block may be a block XML file or a jar file
  +          containing a block directive.
  +        </p>
  +        <p>
  +          <i>Example of block deployment based on a supplied block
  +          directive.</i>
  +        </p>
  +<source><![CDATA[
  + $ merlin -help
  +usage: merlin [block] [-debug] [-config <file>] [-lang <code>] 
  +  [-system <directory>] [-kernel <file>] [-home <directory>] [-version]
[-help]
  +]]></source>
  +      </subsection>
  +      <subsection name="Command Line Qualifiers">
  +        <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>A two letter country code</td><td>Sets
the default language country code to the supplied value.</td>
  +          </tr>
  +          <tr>
  +            <td>-version</td><td></td>
  +            <td>Prints Merlin version information.</td>
  +          </tr>
  +          <tr>
  +            <td>-debug</td><td></td>
  +            <td>Instructs Merlin to issue internal system debug messages.</td>
  +          </tr>
  +          <tr>
  +            <td>-home</td><td>directory</td>
  +            <td>A relative or absolute path to a working home directory. If not suppled,
the system will default to the current directory. If the resolved home path does not exist
it will be created.</td>
  +          </tr>
  +          <tr>
  +            <td>-kernel</td><td>file</td>
  +            <td>The filename of a kernel configuration overriding the default kernel
directive.  The value defaults to the system kernel.xml file.</td>
  +          </tr>
  +          <tr>
  +            <td>-config</td><td>file</td>
  +            <td>A configuration file containing a set of target qualified configuration
fragements that will override configuration entries defined under a block.</td>
  +          </tr>
  +          <tr>
  +            <td>-system</td><td>file</td>
  +            <td>Override the MERLIN_HOME installation directory with an alternative
system directory.</td>
  +          </tr>
  +        </table>
  +      </subsection>
       </section>
     </body>
   
  
  
  
  1.2       +2 -1      avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/jndi.xml
  
  Index: jndi.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/jndi.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- jndi.xml	2 Apr 2003 15:51:57 -0000	1.1
  +++ jndi.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -11,7 +11,8 @@
   
     <body>
       <section name="Merlin JNDI (Java Naming and Directory Interface)">
  -      <p>In preparation.</p>
  +      <p>Information concernig the Merlin JDNI Interace is availabole 
  +        under the <a href="../../extensions/jndi/index.html">JNDI Extension</a>
documentation.</p>
       </section>
     </body>
   
  
  
  
  1.2       +41 -1     avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/nt.xml
  
  Index: nt.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/nt.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- nt.xml	2 Apr 2003 15:51:57 -0000	1.1
  +++ nt.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -11,7 +11,47 @@
   
     <body>
       <section name="Merlin NT Service">
  -      <p>In preparation.</p>
  +      <p>
  +      The Merlin installation includes support for the running of 
  +      a Merlin Kernel as an Windows(TM) NT4 Service.
  +      </p>
  +      <p>
  +        <img src="../../images/service.gif"/>
  +      </p>
  +      <subsection name="Service Installation">
  +        <p>Installation of the service is achieved using the following
  +        command:</p>
  +        <source>
  + $ cd %MERLIN_HOME%\bin
  + $ InstallService-NT.bat
  +        </source>
  +        <p>
  +        After installation please check the service startup parameters
  +        by using the Service manager in the Windows Control Panel.
  +        </p>
  +        <p>
  +        <img src="../../images/service-dialog.gif"/>
  +        </p>
  +      </subsection>
  +
  +      <subsection name="Service Configuration">
  +        <p>Please make sure that the service is correctly assigned with 
  +        a user or system account.  If you are using Merlin under the system 
  +        account you must ensure that the MERLIN_HOME environment variable
  +        is declared in system scope. </p>
  +        <p>
  +        <img src="../../images/merlin-service-dialog.gif"/>
  +        </p>
  +      </subsection>
  +
  +      <subsection name="Service Removal">
  +        <p>Deinstallation of the service is achieved using the following
  +        command:</p>
  +        <source>
  + $ cd %MERLIN_HOME%\bin
  + $ UninstallService-NT.bat
  +        </source>
  +      </subsection>
       </section>
     </body>
   
  
  
  
  1.3       +1 -1      avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/navigation.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- navigation.xml	2 Apr 2003 21:57:59 -0000	1.2
  +++ navigation.xml	3 Apr 2003 14:39:52 -0000	1.3
  @@ -17,7 +17,7 @@
         <item name="Meta Model" href="/meta/index.html">
           <item name="Meta Info" href="/meta/info/index.html">
             <item name="Type" href="/meta/info/type/index.html">
  -            <item name="Logging" href="/meta/info/type/logging.html"/>
  +            <item name="Loggers" href="/meta/info/type/loggers.html"/>
               <item name="Context" href="/meta/info/type/context.html"/>
               <item name="Dependencies" href="/meta/info/type/dependencies.html"/>
               <item name="Services" href="/meta/info/type/services.html"/>
  
  
  
  1.2       +1 -11     avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/categories.xml
  
  Index: categories.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/categories.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- categories.xml	2 Apr 2003 15:52:13 -0000	1.1
  +++ categories.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -11,19 +11,9 @@
   
     <body>
       <section name="Kernel">
  -      <subsection name="System Logging Categories">
  +      <subsection name="Kernel Logging Categories">
   
   <p>Logging channels used by the Merlin system (internal) may be qualified by the
addition of category entries within the kernel defintion.</p>
  -
  -        <p><strong>Nested Elements</strong></p>
  -
  -        <table>
  -          <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
  -          <tr>
  -            <td>category</td><td>n</td>
  -            <td>Logging category directive.</td>
  -          </tr>
  -        </table>
   
           <p><strong>Sample XML</strong></p>
   
  
  
  
  1.2       +7 -6      avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/engine.xml
  
  Index: engine.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/engine.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- engine.xml	2 Apr 2003 15:52:13 -0000	1.1
  +++ engine.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -10,17 +10,18 @@
     </header>
   
     <body>
  -    <section name="Kernel">
  -      <subsection name="Engine Declaration">
  +    <section name="Engine Directive">
  +      <subsection name="Specification">
  +        <p>
  +           Please see the Block defintion for the complete 
  +           <a href="../block/container/engine/index.html">Engine</a> specification.
  +        </p>
  +
           <p>
              The engine element is the declaration of the root system classloader used 
              within the Merlin system.  It is not normally necessary to modify this 
              defintion.  Client applications should include modifications at the level 
              of container defintions within blocks.
  -        </p>
  -        <p>
  -           For details concerning the engine declaration please see corresponding details
  -           provided under the block/container/engine reference.
           </p>
   
           <p><strong>Sample XML</strong></p>
  
  
  
  1.2       +2 -2      avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	2 Apr 2003 15:52:13 -0000	1.1
  +++ index.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -10,9 +10,9 @@
     </header>
   
     <body>
  -    <section name="Kernel Directive">
  +    <section name="Kernel">
   
  -      <subsection name="Kernel XML">
  +      <subsection name="Specification">
           <p>
             The kernel element declares a root Merlin kernel that is used
             to establish core services.
  
  
  
  1.2       +2 -2      avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/logging.xml
  
  Index: logging.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/logging.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- logging.xml	2 Apr 2003 15:52:13 -0000	1.1
  +++ logging.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -10,8 +10,8 @@
     </header>
   
     <body>
  -    <section name="Kernel">
  -      <subsection name="Logging Directive">
  +    <section name="Logging Directive">
  +      <subsection name="Specification">
   
   <p>Logging services build above the Avalon framework abstract logging infrastructure.
 Merlin provides the mechanisms through which logging hierarchies can be created, logging
priorities assigned, and definition of log event output targets.  Logging directives may be
includes at the kernel, container and component levels.</p>
   
  
  
  
  1.2       +2 -2      avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/system.xml
  
  Index: system.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/kernel/system.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- system.xml	2 Apr 2003 15:52:13 -0000	1.1
  +++ system.xml	3 Apr 2003 14:39:52 -0000	1.2
  @@ -10,8 +10,8 @@
     </header>
   
     <body>
  -    <section name="Kernel">
  -      <subsection name="System Declaration">
  +    <section name="System Directive">
  +      <subsection name="Specification">
           <p>
              The system declaration is used by Merlin when constructing URLs.
           </p>
  
  
  
  1.3       +2 -2      avalon-sandbox/merlin/merlin-smp/xdocs/starting/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/starting/index.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	2 Apr 2003 17:13:27 -0000	1.2
  +++ index.xml	3 Apr 2003 14:39:53 -0000	1.3
  @@ -16,11 +16,11 @@
               <td>Installation instructions including build and verification procedures.</td>
             </tr>
             <tr>
  -            <td><a href="hello/index.html">Using Merlin.</a></td>
  +            <td><a href="hello/index.html">Using Merlin</a></td>
               <td>A short introduction to using Merlin based on a Hello Block example
that takes your though the defintion of a block, subsequent deployment, and general aspects
concerning configuration, contextualization, service publication, and service dependency management.</td>
             </tr>
             <tr>
  -            <td><a href="hello/index.html">Advanced Features.</a></td>
  +            <td><a href="hello/index.html">Advanced Features</a></td>
               <td>Advanced Merlin features covering aspects related to component default
configurations, deployment templates (profiles), using profile selectors, import blocks, exporting
services, custom appliance handlers and blocks, and custom contextualization possibilities.</td>
             </tr>
           </table>
  
  
  

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


Mime
View raw message