[jboss-cvs] JBoss Profiler SVN: r551 - branches/JBossProfiler2/doc/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Mon Jun 22 21:29:09 EDT 2009
Author: jesper.pedersen
Date: 2009-06-22 21:29:08 -0400 (Mon, 22 Jun 2009)
New Revision: 551
Modified:
branches/JBossProfiler2/doc/userguide/en/modules/ant.xml
branches/JBossProfiler2/doc/userguide/en/modules/client.xml
branches/JBossProfiler2/doc/userguide/en/modules/installation.xml
branches/JBossProfiler2/doc/userguide/en/modules/introduction.xml
branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml
Log:
minor improvements
Modified: branches/JBossProfiler2/doc/userguide/en/modules/ant.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/ant.xml 2009-06-21 17:27:22 UTC (rev 550)
+++ branches/JBossProfiler2/doc/userguide/en/modules/ant.xml 2009-06-23 01:29:08 UTC (rev 551)
@@ -2,72 +2,208 @@
<chapter id="ant">
<title>Apache Ant integration</title>
- <programlisting>
-Profiler Ant tasks:
--------------------
-The jboss-profiler-ant.jar file contains Ant tasks for the JBoss Profiler.
+ <section id="profileranttasks">
+ <title>Profiler tasks</title>
-Assuming that this file has been placed in in ${ant.home}/lib the following file
-will automatically load the definitions of the tasks:
+ <para>The jboss-profiler-ant.jar file contains Ant tasks for the JBoss Profiler.</para>
- <project default="defaulttarget" xmlns:jboss-profiler="antlib:org.jboss.profiler.ant">
+ <para>Assuming that this file has been placed in in ${ant.home}/lib the following file
+ will automatically load the definitions of the tasks:</para>
-Otherwise you can configure the Ant integration using the following task definitions:
+ <programlisting>
+<project default="defaulttarget" xmlns:jboss-profiler="antlib:org.jboss.profiler.ant">
+ </programlisting>
- <taskdef name="enable" classname="org.jboss.profiler.ant.EnableProfilerTask"/>
- <taskdef name="disable" classname="org.jboss.profiler.ant.DisableProfilerTask"/>
- <taskdef name="startprofiler" classname="org.jboss.profiler.ant.StartProfilerTask"/>
- <taskdef name="stopprofiler" classname="org.jboss.profiler.ant.StopProfilerTask"/>
- <taskdef name="clearsnapshots" classname="org.jboss.profiler.ant.ClearSnapshotsTask"/>
- <taskdef name="gc" classname="org.jboss.profiler.ant.GCTask"/>
- <taskdef name="save" classname="org.jboss.profiler.ant.SaveTask"/>
- <taskdef name="add" classname="org.jboss.profiler.ant.AddClassesTask"/>
- <taskdef name="remove" classname="org.jboss.profiler.ant.RemoveClassesTask"/>
+ <para>Otherwise you can configure the Ant integration using the following task definitions:</para>
-All tasks have the following attributes in common:
+ <programlisting>
+<taskdef name="enable" classname="org.jboss.profiler.ant.EnableProfilerTask"/>
+<taskdef name="disable" classname="org.jboss.profiler.ant.DisableProfilerTask"/>
+<taskdef name="startprofiler" classname="org.jboss.profiler.ant.StartProfilerTask"/>
+<taskdef name="stopprofiler" classname="org.jboss.profiler.ant.StopProfilerTask"/>
+<taskdef name="clearsnapshots" classname="org.jboss.profiler.ant.ClearSnapshotsTask"/>
+<taskdef name="gc" classname="org.jboss.profiler.ant.GCTask"/>
+<taskdef name="save" classname="org.jboss.profiler.ant.SaveTask"/>
+<taskdef name="add" classname="org.jboss.profiler.ant.AddClassesTask"/>
+<taskdef name="remove" classname="org.jboss.profiler.ant.RemoveClassesTask"/>
+ </programlisting>
- protocol - The protocol used for connection (socket, rmi, http) (default: socket)
- host - The host name (default: localhost)
- port - The port number (default: 5400)
+ <para>All tasks have the following attributes in common:</para>
-Save task:
+ <table frame="all">
+ <title>Common Apache Ant elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>protocol</entry>
+ <entry>
+ The protocol used for connection (socket, rmi, http) (default: socket).
+ </entry>
+ </row>
+ <row>
+ <entry>host</entry>
+ <entry>
+ The host name (default: localhost).
+ </entry>
+ </row>
+ <row>
+ <entry>port</entry>
+ <entry>
+ The port number (default: 5400)
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
- snapshot - The snapshot number
- destination - The destination of the snapshot
+ <para>The save task has these additional elements</para>
+ <table frame="all">
+ <title>Save task</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>snapshot</entry>
+ <entry>
+ The snapshot number.
+ </entry>
+ </row>
+ <row>
+ <entry>destination</entry>
+ <entry>
+ The destination of the snapshot.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
-Add task:
+ <para>The add task has these additional elements</para>
+ <table frame="all">
+ <title>Add task</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>classes</entry>
+ <entry>
+ The classes that should be added.
+ <para>[package|class][|visibility][,...]</para>
+ <para>f.ex: org.jboss.profiler.test.*|public,org.jboss.profiler.test.sub.*|private</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
- classes - The classes that should be added
- [package|class][|visibility][,...]
- f.ex: org.jboss.profiler.test.*|public,org.jboss.profiler.test.sub.*|private
+ <para>The remove task has these additional elements</para>
+ <table frame="all">
+ <title>Remove task</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>classes</entry>
+ <entry>
+ The classes that should be removed.
+ <para>[package|class][,...]</para>
+ <para>f.ex: org.jboss.profiler.test.*</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
-Remove task:
+ <para>Example:</para>
+ <programlisting>
+<startprofiler protocol="socket"
+ host="localhost"
+ port="5400"/>
- classes - The classes that should be removed
- [package|class][,...]
- f.ex: org.jboss.profiler.test.*
+ </programlisting>
+ </section>
-Example:
- <startprofiler protocol="socket"
- host="localhost"
- port="5400"/>
+ <section id="regressionanttasks">
+ <title>Regression tasks</title>
-Regression Ant tasks:
----------------------
-The jboss-profiler-ant.jar file contains the following regression Ant tasks.
+ <para>The jboss-profiler-ant.jar file contains the following regression Ant tasks.</para>
+ <programlisting>
+<taskdef name="regression" classname="org.jboss.profiler.ant.RegressionTask"/>
+ </programlisting>
- <taskdef name="regression" classname="org.jboss.profiler.ant.RegressionTask"/>
+ <section id="regressionanttask">
+ <title>Regression task</title>
-Regression task:
+ <table frame="all">
+ <title>Regression task</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>oldsnapshot</entry>
+ <entry>
+ The location of the old snapshot.
+ </entry>
+ </row>
+ <row>
+ <entry>newsnapshot</entry>
+ <entry>
+ The location of the new snapshot.
+ </entry>
+ </row>
+ <row>
+ <entry>difference</entry>
+ <entry>
+ The maximum difference in percent between the two snapshots.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
- oldsnapshot - The location of the old snapshot
- newsnapshot - The location of the new snapshot
- difference - The maximum difference in percent between the two snapshots
+ <para>Example:</para>
+ <programlisting>
+<regression oldsnapshot="old.jps"
+ newsnapshot="new.jps"
+ difference="3"/>
+ </programlisting>
+ </section>
+ </section>
- <regression oldsnapshot="old.jps"
- newsnapshot="new.jps"
- difference="3"/>
-
- </programlisting>
-
</chapter>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/client.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/client.xml 2009-06-21 17:27:22 UTC (rev 550)
+++ branches/JBossProfiler2/doc/userguide/en/modules/client.xml 2009-06-23 01:29:08 UTC (rev 551)
@@ -280,10 +280,10 @@
<section id="precompiler">
<title>Using the precompiler</title>
- <warning>The JBoss Profiler precompiler will overwrite the JAR files in your application, so
+ <warning>The JBoss Profiler Precompiler will overwrite the JAR files in your application, so
make sure that you keep a copy of the original files.</warning>
- <para>The JBoss Profiler precompiler will precompile the JAR archives in the specifed directory
+ <para>The JBoss Profiler Precompiler will precompile the JAR archives in the specifed directory
with instrumentation information used by the agent. This allows you to start up your
application quicker.</para>
<para>The precompiler is run using the following command:</para>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/installation.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/installation.xml 2009-06-21 17:27:22 UTC (rev 550)
+++ branches/JBossProfiler2/doc/userguide/en/modules/installation.xml 2009-06-23 01:29:08 UTC (rev 551)
@@ -25,7 +25,7 @@
<para>JBoss Profiler is now located in a folder under the directory you extracted the files into.</para>
<section id="as5">
- <title>JBoss Application Server 5.x</title>
+ <title>JBoss Application Server 5.x and 6.x</title>
<itemizedlist spacing="compact">
<listitem>
@@ -134,6 +134,10 @@
<para>Builds the documentation for the project.</para>
</listitem>
<listitem>
+ <para>precompiler</para>
+ <para>Builds the precompiler.</para>
+ </listitem>
+ <listitem>
<para>web</para>
<para>Builds the web front-end for the project.</para>
</listitem>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/introduction.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/introduction.xml 2009-06-21 17:27:22 UTC (rev 550)
+++ branches/JBossProfiler2/doc/userguide/en/modules/introduction.xml 2009-06-23 01:29:08 UTC (rev 551)
@@ -6,146 +6,141 @@
<itemizedlist spacing="compact">
<listitem>
- <para>100% Pure Java</para>
+ 100% Pure Java
</listitem>
<listitem>
- <para>Integration with JBoss Enterprise Middleware Suite (JEMS)</para>
+ Integration with JBoss Enterprise Middleware Suite (JEMS)
</listitem>
<listitem>
- <para>Access through multiple protocols using JBoss Remoting
- <itemizedlist spacing="compact">
- <listitem>
- <para>Socket</para>
- </listitem>
- <listitem>
- <para>Remote Method Invocation (RMI)</para>
- </listitem>
- <listitem>
- <para>Hyper Text Transport Protocol (HTTP)</para>
- </listitem>
- </itemizedlist>
- </para>
+ Access through multiple protocols using JBoss Remoting
+ <itemizedlist spacing="compact">
+ <listitem>
+ Socket
+ </listitem>
+ <listitem>
+ Remote Method Invocation (RMI)
+ </listitem>
+ <listitem>
+ Hyper Text Transport Protocol (HTTP)
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>Reports
- <itemizedlist spacing="compact">
- <listitem>
- <para>Overview</para>
+ Reports
+ <itemizedlist spacing="compact">
+ <listitem>
+ Overview
+ </listitem>
+ <listitem>
+ Packages
</listitem>
- <listitem>
- <para>Packages</para>
- </listitem>
- <listitem>
- <para>Classes</para>
- </listitem>
- <listitem>
- <para>Methods</para>
- </listitem>
- <listitem>
- <para>Hotspots</para>
- </listitem>
- <listitem>
- <para>Caller</para>
- </listitem>
- <listitem>
- <para>Wait time</para>
- </listitem>
- <listitem>
- <para>PerThread</para>
- </listitem>
- <listitem>
- <para>PerClass</para>
- </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ Classes
+ </listitem>
+ <listitem>
+ Methods
+ </listitem>
+ <listitem>
+ Hotspots
+ </listitem>
+ <listitem>
+ Caller
+ </listitem>
+ <listitem>
+ Wait time
+ </listitem>
+ <listitem>
+ PerThread
+ </listitem>
+ <listitem>
+ PerClass
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>Able to specify method visibility
- <itemizedlist spacing="compact">
- <listitem>
- <para>Global</para>
- </listitem>
- <listitem>
- <para>Package</para>
- </listitem>
- <listitem>
- <para>Method</para>
- </listitem>
- </itemizedlist>
- </para>
+ Able to specify method visibility
+ <itemizedlist spacing="compact">
+ <listitem>
+ Global
+ </listitem>
+ <listitem>
+ Package
+ </listitem>
+ <listitem>
+ Method
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>Component identification
- <itemizedlist spacing="compact">
- <listitem>
- <para>Plain Old Java Object (POJO)</para>
- </listitem>
- <listitem>
- <para>java.lang.Throwable</para>
- </listitem>
- <listitem>
- <para>Enterprise JavaBean: Entity</para>
- </listitem>
- <listitem>
- <para>Enterprise JavaBean: Session</para>
- </listitem>
- <listitem>
- <para>Enterprise JavaBean: Message</para>
- </listitem>
- <listitem>
- <para>Servlet</para>
- </listitem>
- <listitem>
- <para>Servlet filter</para>
- </listitem>
- <listitem>
- <para>JavaServer Pages</para>
- </listitem>
- <listitem>
- <para>JMX MBean</para>
- </listitem>
- <listitem>
- <para>JavaServer Faces Converter</para>
- </listitem>
- <listitem>
- <para>JavaServer Faces Managed Bean</para>
- </listitem>
- <listitem>
- <para>RMI: Remote</para>
- </listitem>
- <listitem>
- <para>RMI: Server</para>
- </listitem>
- <listitem>
- <para>CORBA: Object</para>
- </listitem>
- <listitem>
- <para>CORBA: Servant</para>
- </listitem>
- <listitem>
- <para>3rd party plugins</para>
- </listitem>
- </itemizedlist>
- </para>
+ Component identification
+ <itemizedlist spacing="compact">
+ <listitem>
+ Plain Old Java Object (POJO)
+ </listitem>
+ <listitem>
+ java.lang.Throwable
+ </listitem>
+ <listitem>
+ Enterprise JavaBean: Entity
+ </listitem>
+ <listitem>
+ Enterprise JavaBean: Session
+ </listitem>
+ <listitem>
+ Enterprise JavaBean: Message
+ </listitem>
+ <listitem>
+ Servlet
+ </listitem>
+ <listitem>
+ Servlet filter
+ </listitem>
+ <listitem>
+ JavaServer Pages
+ </listitem>
+ <listitem>
+ JMX MBean
+ </listitem>
+ <listitem>
+ JavaServer Faces Converter
+ </listitem>
+ <listitem>
+ JavaServer Faces Managed Bean
+ </listitem>
+ <listitem>
+ RMI: Remote
+ </listitem>
+ <listitem>
+ RMI: Server
+ </listitem>
+ <listitem>
+ CORBA: Object
+ </listitem>
+ <listitem>
+ CORBA: Servant
+ </listitem>
+ <listitem>
+ 3rd party plugins
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>Compare snapshots</para>
+ Compare snapshots
</listitem>
<listitem>
- <para>Client
- <itemizedlist spacing="compact">
- <listitem>
- <para>Apache Ant integration</para>
- </listitem>
- <listitem>
- <para>Command line</para>
- </listitem>
- </itemizedlist>
- </para>
+ Client
+ <itemizedlist spacing="compact">
+ <listitem>
+ Apache Ant integration
+ </listitem>
+ <listitem>
+ Command line
+ </listitem>
+ </itemizedlist>
</listitem>
</itemizedlist>
- <para>JBoss Profiler 2 was designed to run on the JBoss Application Server 4.2 and JBoss Application Server 5.0
+ <para>JBoss Profiler 2 was designed to run on the JBoss Application Server 4.2, JBoss Application Server 5.x and JBoss Application Server 6.x
releases or any other Java applications using Java Runtime Environment 5 or higher.</para>
</chapter>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml 2009-06-21 17:27:22 UTC (rev 550)
+++ branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml 2009-06-23 01:29:08 UTC (rev 551)
@@ -11,26 +11,64 @@
jboss-profiler.sar/META-INF/jboss-service.xml
</programlisting>
- <programlisting>
-Socket Should socket communication be enabled ?
- [true|false] default: true
-
-SocketPort The socket port
- default: 5400
-
-Rmi Should RMI communication be enabled ?
- [true|false] default: false
-
-RmiPort The RMI port
- default: 5401
-
-Http Should HTTP communication be enabled ?
- [true|false] default: false
-
-HttpPort The HTTP port
- default: 5402
- </programlisting>
-
+ <table frame="all">
+ <title>Communicator configuration</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Key</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Socket</entry>
+ <entry>
+ Should socket communication be enabled ?
+ <para>[true|false] default: true</para>
+ </entry>
+ </row>
+ <row>
+ <entry>SocketPort</entry>
+ <entry>
+ The socket port
+ <para>default: 5400</para>
+ </entry>
+ </row>
+ <row>
+ <entry>Rmi</entry>
+ <entry>
+ Should RMI communication be enabled ?
+ <para>[true|false] default: false</para>
+ </entry>
+ </row>
+ <row>
+ <entry>RmiPort</entry>
+ <entry>
+ The RMI port
+ <para>default: 5401</para>
+ </entry>
+ </row>
+ <row>
+ <entry>Http</entry>
+ <entry>
+ Should HTTP communication be enabled ?
+ <para>[true|false] default: false</para>
+ </entry>
+ </row>
+ <row>
+ <entry>HttpPort</entry>
+ <entry>
+ The HTTP port
+ <para>default: 5402</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
</section>
<section>
More information about the jboss-cvs-commits
mailing list