leosimons    2003/02/20 06:03:50

  Modified:    instrument build.xml
               instrument/src/xdocs abstract-instrumentable-howto.xml
                        index.xml instrumentable-howto.xml
                        instrumentables.xml instruments.xml overview.xml
  Added:       instrument/src/xdocs book.xml
  Removed:     instrument/src/xdocs menu.xml
  Log:
  forrestize
  
  Revision  Changes    Path
  1.47      +3 -3      avalon-excalibur/instrument/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/avalon-excalibur/instrument/build.xml,v
  retrieving revision 1.46
  retrieving revision 1.47
  diff -u -r1.46 -r1.47
  --- build.xml 29 Jan 2003 14:07:40 -0000      1.46
  +++ build.xml 20 Feb 2003 14:03:49 -0000      1.47
  @@ -13,10 +13,10 @@
       <path id="project.class.path">
           <pathelement location="${build.classes}"/>
           <pathelement location="${checkstyle.jar}"/>
  -        
  +
           <!-- Optional jars -->
           <pathelement location="${avalon-framework.jar}"/>
  -        
  +
           <pathelement path="${java.class.path}"/>
       </path>
   
  @@ -419,7 +419,7 @@
         <mkdir dir="${build.dir}/work"/>
   
         <!-- Base pointers for non-xdocs documentation. Override these in 
.ant.properties to link to local docs -->
  -      <ant antfile="../cocoonbuild.xml"/>
  +      <ant antfile="${basedir}/../forrestbuild.xml"/>
   
         <copy todir="${docs.dir}">
           <fileset dir="${build.docs}">
  
  
  
  1.2       +2 -2      
avalon-excalibur/instrument/src/xdocs/abstract-instrumentable-howto.xml
  
  Index: abstract-instrumentable-howto.xml
  ===================================================================
  RCS file: 
/home/cvs/avalon-excalibur/instrument/src/xdocs/abstract-instrumentable-howto.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- abstract-instrumentable-howto.xml 1 Oct 2002 15:24:00 -0000       1.1
  +++ abstract-instrumentable-howto.xml 20 Feb 2003 14:03:50 -0000      1.2
  @@ -8,10 +8,10 @@
           </authors>
       </header>
       <body>
  -        <s1 title="AbstractInstrumentable How-Tos">
  +        <section><title>AbstractInstrumentable How-Tos</title>
               <p>
                   To do.
               </p>
  -        </s1>
  +        </section>
       </body>
   </document>
  
  
  
  1.4       +3 -3      avalon-excalibur/instrument/src/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon-excalibur/instrument/src/xdocs/index.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- index.xml 26 Sep 2002 06:34:54 -0000      1.3
  +++ index.xml 20 Feb 2003 14:03:50 -0000      1.4
  @@ -9,7 +9,7 @@
       </authors>
     </header>
     <body>
  -    <s1 title="Introduction">
  +    <section><title>Introduction</title>
         <p>
           Excalibur Instrument is an instrumentation utility that allows you
           to attach a separate JVM to your running application to determine its
  @@ -20,10 +20,10 @@
         </p>
         <p>
           In order to use this in your projects, you need to set up your 
project
  -        using an Instrument aware container (<link 
href="../fortress/">Fortress</link>
  +        using an Instrument aware container (<link 
href="http://avalon.apache.org/excalibur/fortress/";>Fortress</link>
           is one of them), and set up your components according to the 
specifications
           <link href="instrumentables.html">here</link>.
         </p>
  -    </s1>
  +    </section>
     </body>
   </document>
  
  
  
  1.2       +2 -2      
avalon-excalibur/instrument/src/xdocs/instrumentable-howto.xml
  
  Index: instrumentable-howto.xml
  ===================================================================
  RCS file: 
/home/cvs/avalon-excalibur/instrument/src/xdocs/instrumentable-howto.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- instrumentable-howto.xml  1 Oct 2002 15:24:00 -0000       1.1
  +++ instrumentable-howto.xml  20 Feb 2003 14:03:50 -0000      1.2
  @@ -8,10 +8,10 @@
           </authors>
       </header>
       <body>
  -        <s1 title="Instrumentable How-Tos">
  +        <section><title>Instrumentable How-Tos</title>
               <p>
                   To do.
               </p>
  -        </s1>
  +        </section>
       </body>
   </document>
  
  
  
  1.4       +2 -2      avalon-excalibur/instrument/src/xdocs/instrumentables.xml
  
  Index: instrumentables.xml
  ===================================================================
  RCS file: 
/home/cvs/avalon-excalibur/instrument/src/xdocs/instrumentables.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- instrumentables.xml       1 Oct 2002 15:24:00 -0000       1.3
  +++ instrumentables.xml       20 Feb 2003 14:03:50 -0000      1.4
  @@ -8,7 +8,7 @@
           </authors>
       </header>
       <body>
  -        <s1 title="Instrumentables">
  +        <section><title>Instrumentables</title>
               <p>
                   The Instrumentable interface is required to be able to 
register a component with
                   an InstrumentManager.  The interface makes it possible for 
the InstrumentManager
  @@ -56,6 +56,6 @@
                   for an example.  An example of the 
AbstractLogEnabledInstrumentable helper class is
                   not included as its usage is identical to 
AbstractInstrumentable.
               </p>
  -        </s1>
  +        </section>
       </body>
   </document>
  
  
  
  1.2       +2 -2      avalon-excalibur/instrument/src/xdocs/instruments.xml
  
  Index: instruments.xml
  ===================================================================
  RCS file: /home/cvs/avalon-excalibur/instrument/src/xdocs/instruments.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- instruments.xml   1 Oct 2002 15:24:00 -0000       1.1
  +++ instruments.xml   20 Feb 2003 14:03:50 -0000      1.2
  @@ -8,7 +8,7 @@
           </authors>
       </header>
       <body>
  -        <s1 title="Instruments">
  +        <section><title>Instruments</title>
               <p>
                   Instruments are the actual hooks used by a component to make 
profiling or
                   instrumentation information available to the outside world.  
Instruments are
  @@ -42,6 +42,6 @@
                   memory usage of the JVM, etc.   ValueInstruments provide a 
single method,
                   setValue( value ).
               </p>
  -        </s1>
  +        </section>
       </body>
   </document>
  
  
  
  1.2       +15 -15    avalon-excalibur/instrument/src/xdocs/overview.xml
  
  Index: overview.xml
  ===================================================================
  RCS file: /home/cvs/avalon-excalibur/instrument/src/xdocs/overview.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- overview.xml      1 Oct 2002 15:24:00 -0000       1.1
  +++ overview.xml      20 Feb 2003 14:03:50 -0000      1.2
  @@ -8,7 +8,7 @@
           </authors>
       </header>
       <body>
  -        <s1 title="Why Instrument Was Created">
  +        <section><title>Why Instrument Was Created</title>
               <p>
                   Instrument was created out of a desire to provide a standard 
API for adding
                   profiling or instrumentation hooks into an application or 
class.  As any
  @@ -26,8 +26,8 @@
                   collect information over time to be able to monitor 
quantities like memory usage,
                   pool sizes, counts, and durations over time.
               </p>
  -        </s1>
  -        <s1 title="When To Use Instrument">
  +        </section>
  +        <section><title>When To Use Instrument</title>
               <p>
                   Instrument is an API for enabling the collection of 
qualitative information from a
                   component.  The API itself has no dependencies on the Avalon 
framework and can thus
  @@ -42,8 +42,8 @@
                   can be used to monitor the resources consumed by the 
application as well as the
                   loads that are placed on it over time.
               </p>
  -        </s1>
  -        <s1 title="Portability">
  +        </section>
  +        <section><title>Portability</title>
               <p>
                   The Instrument API has been carefully designed in such a way 
as to remove any
                   limitations on where components making use of the API can be 
used.  Most logger
  @@ -59,8 +59,8 @@
                   will work identically even if run in an environment which is 
completely unaware
                   of the Instrument API.  This should remove all portability 
fears.
               </p>
  -        </s1>
  -        <s1 title="Performance">
  +        </section>
  +        <section><title>Performance</title>
               <p>
                   Another concern with any tool like this is performance.  
Many users ask, "How will
                   instrumenting my component affect its performance."  The 
answer is that the
  @@ -80,8 +80,8 @@
                   of the output.  However, the collection of data points has 
been designed to avoid
                   affecting performance as much as possible.
               </p>
  -        </s1>
  -        <s1 title="Core Concepts">
  +        </section>
  +        <section><title>Core Concepts</title>
               <p>
                   When working with the Instrument API, there are two main 
classes that you need to
                   be aware of.
  @@ -110,7 +110,7 @@
                   interfaces.   The InstrumentManager interface must be 
implemented by any class
                   which wishes to act as an InstrumentManager.  In most cases 
the
                   DefaultInstrumentManager can be used.  It is provided by the
  -                <link href="../instrument-manager/">Instrument 
Manager</link> project.
  +                <link 
href="http://avalon.apache.org/excalibur/instrument-manager/";>Instrument 
Manager</link> project.
               </p>
               <p>
                   The InstrumentManageable interface should be implemented by 
any component which
  @@ -121,8 +121,8 @@
                   In order to make use of the Instrumentation added to 
components, they must be
                   registered with an Instrument Manager.  If an Instrument 
Manager aware container
                   is used, this will be automatic.  Currently, both the
  -                <link href="../component/">Excalibur Component 
Manager</link> and
  -                <link href="../fortress/">Excalibur Fortress</link> know how 
to manage and register
  +                <link 
href="http://avalon.apache.org/excalibur/component/";>Excalibur Component 
Manager</link> and
  +                <link 
href="http://avalon.apache.org/excalibur/fortress/";>Excalibur Fortress</link> 
know how to manage and register
                   Instrumentable components.
               </p>
               <p>
  @@ -130,11 +130,11 @@
                   InstrumentManager and request instrumentation output from 
any registered
                   Instrument in the application.  The most common method of 
connecting to an
                   InstrumentManager is to make use of the
  -                <link href="../instrument-client/">Instrument Client</link>. 
 The Instrument
  +                <link 
href="http://avalon.apache.org/excalibur/instrument-client/";>Instrument 
Client</link>.  The Instrument
                   Client provides a Swing based GUI that makes it easy to 
monitor several Instruments
                   at once.   For other options read over the documentation of 
the
  -                <link href="../instrument-manager/">Instrument 
Manager</link>.
  +                <link 
href="http://avalon.apache.org/excalibur/instrument-manager/";>Instrument 
Manager</link>.
               </p>
  -        </s1>
  +        </section>
       </body>
   </document>
  
  
  
  1.3       +28 -22    avalon-excalibur/instrument/src/xdocs/book.xml
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to