[jboss-cvs] JBoss Profiler SVN: r454 - branches/JBossProfiler2/doc.

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

Author: jesper.pedersen
Date: 2008-05-19 16:16:14 -0400 (Mon, 19 May 2008)
New Revision: 454

Modified:
   branches/JBossProfiler2/doc/README.txt
Log:
More documentation

Modified: branches/JBossProfiler2/doc/README.txt
===================================================================
--- branches/JBossProfiler2/doc/README.txt	2008-05-19 20:15:51 UTC (rev 453)
+++ branches/JBossProfiler2/doc/README.txt	2008-05-19 20:16:14 UTC (rev 454)
@@ -17,6 +17,7 @@
 
  * Reports
    x Overview
+   x Packages
    x Classes
    x Methods
    x Hotspots
@@ -78,6 +79,8 @@
 Host defaults to 'localhost'.
 Port defaults to '5400'.
 
+The default extension for the generated snapshot is JBoss Profiler Snapshot (.JPS).
+
 Examples:
 
 Client startProfiler
@@ -132,7 +135,7 @@
 repository              Repository for class files. Must be enabled in order to add/remove classes at run-time
                         [yes|no] default: no
 
-remote                  Enable / disable remote API
+remote                  Enable / disable remote API - this information is used when profiling Java SE applications
                         [yes|no] default: yes
 
 store                   Where should the profile information be stored in the agent
@@ -203,7 +206,7 @@
 
 Communicator MBean:
 -------------------
-Configuration can be found in jboss-service.xml
+Configuration can be found in jboss-profiler.sar/META-INF/jboss-service.xml
 
 Socket                  Should socket communication be enabled ?
                         [true|false] default: true
@@ -281,8 +284,8 @@
 
 Warning: The jobs override the current settings used in agent.
 
-Ant tasks:
-----------
+Profiler Ant tasks:
+-------------------
 The jboss-profiler-ant.jar file contains Ant tasks for the JBoss Profiler.
 
 The following tasks exists:
@@ -325,6 +328,22 @@
                 host="localhost"
                 port="5400"/>
 
+Regression Ant tasks:
+-------------------
+The jboss-profiler-ant.jar file contains the following regression Ant tasks.
+
+ <taskdef name="regression" classname="org.jboss.profiler.ant.RegressionTask"/>
+
+Regression task:
+
+  oldsnapshot - The location of the old snapshot
+  newsnapshot - The location of the new snapshot
+  difference  - The maximum difference in percent between the two snapshots
+
+ <regression oldsnapshot="old.jps"
+             newsnapshot="new.jps"
+             difference="3"/>
+
 Third party libraries:
 ----------------------
 The following libraries are needed
@@ -362,6 +381,21 @@
 
 Output: Directory with analysis reports
 
+Reports:
+--------
+The generated reports uses to following abbrevations for the headlines
+
+ Count  - The number of invocations
+ Ms     - The number of miliseconds
+ Ms (T) - The total number of miliseconds
+ Ms (N) - The number of miliseconds for this method
+ Avg    - The average execution time in miliseconds
+ %      - The percent
+ % (T)  - The total percent
+ % (C)  - The percent of the class
+ % (N)  - The percent for this method
+ Method - The method name
+ 
 Twiddle:
 --------
 Information: