[Laszlo-checkins] r6741 - openlaszlo/trunk/docs/src/developers

[lou@openlaszlo.org]

Author: lou
Date: 2007-10-06 07:39:16 -0700 (Sat, 06 Oct 2007)
New Revision: 6741

Modified:
   openlaszlo/trunk/docs/src/developers/debugging.dbk
Log:
Change 20071003-lou-pXqghd by lou at lou-laptop on 2007-10-03 10:03:33 AST
    in /home/lou/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Added Debug.bugReport() description

New Features:

Bugs Fixed: LPP-4798

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: John Sundman

Details: Add section 1.6 Generating a bug report to the Debugging chapter.
    

Tests:



Modified: openlaszlo/trunk/docs/src/developers/debugging.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/debugging.dbk	2007-10-06 14:38:01 UTC (rev 6740)
+++ openlaszlo/trunk/docs/src/developers/debugging.dbk	2007-10-06 14:39:16 UTC (rev 6741)
@@ -273,7 +273,20 @@
 </canvas>
 </programlisting><?lzx-edit programs/debugging-$5.lzx></example?>
 <calloutlist><callout arearefs="N10239"><para>The (only) argument to <indexterm><primary><literal>Debug.write()</literal> method</primary></indexterm><methodname>Debug.write()</methodname> is a string, so the value of <literal>canvas.subviews</literal> is not inspectable.</para></callout><callout arearefs="N10243"><para>The second argument to <indexterm><primary><literal>Debug.write()</literal> method</primary></indexterm><methodname>Debug.write()</methodname> is an non-string Object, so it is inspectable.</para></callout></calloutlist>
-<para/></section><section><title>Conditional Compilation of Debugging Code</title>
+<para/></section>
+<section>
+<title>Generating a bug report</title>
+<para>If you encounter a bug that prints a message in the debugger and you believe it is an OpenLaszlo bug, take the following steps to generate a bug report:</para>
+<orderedlist spacing="compact">
+<listitem><para>Enable Backtrace in the developer console</para></listitem>
+<listitem><para>Provoke the error</para></listitem>
+<listitem><para>Click on the debugger message to `inspect` it</para></listitem>
+<listitem><para>Invoke `Debug.bugReport()` in the debugger</para></listitem>
+<listitem><para>Copy and Paste the output into your bug report</para></listitem>
+</orderedlist>
+<para>The Bug Report gives details of the exact build of OpenLaszlo that you are reporting on, the detailed error message, backtrace, and the details of all objects involved.</para>
+</section>
+<section><title>Conditional Compilation of Debugging Code</title>
 <para>
 Sometimes you may have computations that you need to make only when you're debugging an application. For example, you may include some time stamps in order to measure performance of certain sections of code.
 </para>