svn commit: r280271 - /forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml

[cr...@apache.org]

Author: crossley
Date: Sun Sep 11 23:33:44 2005
New Revision: 280271

URL: http://svn.apache.org/viewcvs?rev=280271&view=rev
Log:
Add section to debugging about "Using the Cocoon sitemap profiler".

Modified:
    forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml?rev=280271&r1=280270&r2=280271&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dev.xml Sun Sep 11 23:33:44 2005
@@ -266,12 +266,43 @@
     </section>
 
     <section id="debug">
-      <title>Debugging techniques</title>
+      <title>Debugging and profiling techniques</title>
       <p>
         This <a href="site:v0.80//documentation/faq/logs">FAQ</a>
         describes the location of the Cocoon logfiles and their
         configuration.
       </p>
+
+      <section id="debug-cocoon-profiler">
+        <title>Using the Cocoon sitemap profiler</title>
+        <p>
+          Cocoon provides a simple profiler to analyse itself.
+          This enables us to list the various sitemap pipelines and
+          components that are being used, how much time was used
+          by each, whether each component uses the Cocoon cache,
+          and show the actual xml data.
+        </p>
+        <p>
+          Note that the profiler is not used by default. To switch
+         it on, edit <code>main/webapp/sitemap.xmap</code> and search
+         for "profiler". Follow the instructions there to replace the
+          standard "map:pipe" components with the profiling pipes.
+        </p>
+        <p>
+          Now start your application as normal using 'forrest run'
+          and request localhost:8888/index.html three or four times
+          to populate the profiler with data.
+        </p>
+        <p>
+          Now request the special uri localhost:8888/cprofile.html
+          to see the results. Start at the "index.html" request,
+          then follow the processing.
+        </p>
+        <p>
+          NOTE: Do not forget to turn off the profiler in 
+          <code>main/webapp/sitemap.xmap</code> when finished.
+        </p>
+      </section>
 
       <section id="debug-links">
         <title>Finding broken internal links</title>