[jboss-cvs] JBoss Profiler SVN: r556 - in branches/JBossProfiler2/doc/userguide/en: modules and 1 other directory.

[jboss-cvs-commits at lists.jboss.org]

Author: jesper.pedersen
Date: 2009-06-24 11:17:45 -0400 (Wed, 24 Jun 2009)
New Revision: 556

Added:
   branches/JBossProfiler2/doc/userguide/en/modules/embedded.xml
Modified:
   branches/JBossProfiler2/doc/userguide/en/master.xml
Log:
[JBPROFILER-86] Embedded documentation

Modified: branches/JBossProfiler2/doc/userguide/en/master.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/master.xml	2009-06-24 11:32:27 UTC (rev 555)
+++ branches/JBossProfiler2/doc/userguide/en/master.xml	2009-06-24 15:17:45 UTC (rev 556)
@@ -6,6 +6,7 @@
         <!ENTITY installation SYSTEM "modules/installation.xml">
         <!ENTITY configuration SYSTEM "modules/configuration.xml">
         <!ENTITY client SYSTEM "modules/client.xml">
+        <!ENTITY embedded SYSTEM "modules/embedded.xml">
         <!ENTITY ant SYSTEM "modules/ant.xml">
         <!ENTITY jbossas SYSTEM "modules/jbossas.xml">
         <!ENTITY reports SYSTEM "modules/reports.xml">
@@ -38,6 +39,8 @@
 
    &client;
 
+   &embedded;
+
    &ant;
 
    &jbossas;

Added: branches/JBossProfiler2/doc/userguide/en/modules/embedded.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/embedded.xml	                        (rev 0)
+++ branches/JBossProfiler2/doc/userguide/en/modules/embedded.xml	2009-06-24 15:17:45 UTC (rev 556)
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="embedded">
+   <title>Embedded</title>
+
+   <para>The JBoss Profiler Embedded distribution allows to use the profiler from within your
+     own applications. The embedded API features access to the agent and the client APIs 
+     giving you the option to control all of the operation.</para>
+
+   <para>The embedded distribution uses all the existing services of the profiler, so configuration
+     is done in the same way.</para>
+
+   <section>
+     <title>Dependencies</title>
+     <para>The JBoss Profiler Embedded distribution requires the following JAR files:</para>
+
+     <itemizedlist spacing="compact">
+       <listitem>
+         <code>jboss-profiler-embedded.jar</code>
+       </listitem>
+       <listitem>
+         <code>log4.jar</code>
+       </listitem>
+       <listitem>
+         <code>javassist.jar</code>
+       </listitem>
+     </itemizedlist>
+   </section>
+
+   <section>
+     <title>Profiler API</title>
+     <para>The API to control the profiler is located in:</para>
+     <programlisting>
+org.jboss.profiler.embedded.Profiler
+     </programlisting>
+   </section>
+
+   <section>
+     <title>Example</title>
+     <para>An example of the embedded usage:</para>
+     <programlisting>
+java -javaagent:jboss-profiler-embedded.jar \ 
+   -Djboss-profiler.properties=jboss-profiler.properties \
+   -classpath log4j.jar:javassist.jar:myapp.jar com.mycompany.MyMain
+     </programlisting>
+   </section>
+
+
+</chapter>