svn commit - mysqldoc@docsrva: r1470 - trunk/internals

[stefan]

Author: shinz
Date: 2006-03-01 14:03:18 +0100 (Wed, 01 Mar 2006)
New Revision: 1470

Log:
Add 'running a test with the debugger' section (Holyfoot)

Modified:
   trunk/internals/internals.xml

Modified: trunk/internals/internals.xml
===================================================================
--- trunk/internals/internals.xml	2006-03-01 12:54:32 UTC (rev 1469)
+++ trunk/internals/internals.xml	2006-03-01 13:03:18 UTC (rev 1470)
@@ -75,59 +75,7 @@
       vital to MySQL's working, and comment on specific lines in the
       source code. We'll close off with a few pictures of file formats.
     </para>
-<!-- [SH] Put this section where it fits best (I've asked Holyfoot who wrote the
-  draft)
-<section>
-  <title>Test</title>
-  <para>
-    To run a test named <literal>some.test</literal> with the debugger in
-    embedded mode you could do this:
-  </para>
-  <orderedlist>
-    <listitem>
-      <para>
-        Run <literal>libmysqld/examples/test_run - -gdb some.test</literal>.
-        This creates a <filename>libmysqld/examples/test-gdbinit</filename>
-        file which contains the required parameters for
-        <command>mysqltest</command>.
-      </para>
-    </listitem>
-    <listitem>
-      <para>
-        Copy the <filename>test-gdbinit</filename> file to the
-        <filename>some-gdbinit</filename> directory. The
-        <filename>test-gdbinit</filename> file will be removed after
-        <literal>test-run - -gdb</literal> has finished.
-      </para>
-    </listitem>
-    <listitem>
-      <para>
-        Load <filename>libmysqld/examples/mysqltest_embedded</filename> into
-        your favorite debugger, for example: <literal>gdb
-        mysqltest_embedded</literal>.
-      </para>
-    </listitem>
-    <listitem>
-      <para>
-        In the debugger, for example in <literal>gdb</literal>, do:
-        <literal>- -sou some-gdbinit</literal>
-      </para>
-    </listitem>
-  </orderedlist>
-  <para>
-    Now <literal>some.test</literal> is running, and you can see if it's
-    passing or not.
-  </para>
-  <para>
-    If you just want to debug some queries with the embedded server (not the
-    test), it's easier to just run
-    <filename>libmysqld/examples/mysql</filename>.
-    It's the embedded server-based clone of the usual
-    <command>mysql</command> tool, and works fine under
-    <command>gdb</command> or whatever your favorite debugger is. 
-  </para>
-</section>
--->    
+
     <para>
       <emphasis role="bold">BitKeeper</emphasis>
     </para>
@@ -436,6 +384,68 @@
     </para>
 
     <para>
+      <emphasis>Running a test with the debugger</emphasis>
+    </para>
+
+    <para>
+      To run a test named <literal>some.test</literal> with the debugger
+      in embedded mode you could do this:
+    </para>
+
+    <orderedlist>
+
+      <listitem>
+        <para>
+          Run <literal>libmysqld/examples/test_run --gdb
+          some.test</literal>. This creates a
+          <filename>libmysqld/examples/test-gdbinit</filename> file
+          which contains the required parameters for
+          <command>mysqltest</command>.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          Make a copy of the <filename>test-gdbinit</filename> file
+          (call it, for example, <filename>some-gdbinit</filename>). The
+          <filename>test-gdbinit</filename> file will be removed after
+          <literal>test-run --gdb</literal> has finished.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          Load
+          <filename>libmysqld/examples/mysqltest_embedded</filename>
+          into your favorite debugger, for example: <literal>gdb
+          mysqltest_embedded</literal>.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          In the debugger, for example in <literal>gdb</literal>, do:
+          <literal>--sou some-gdbinit</literal>
+        </para>
+      </listitem>
+
+    </orderedlist>
+
+    <para>
+      Now <literal>some.test</literal> is running, and you can see if
+      it's passing or not.
+    </para>
+
+    <para>
+      If you just want to debug some queries with the embedded server
+      (not the test), it's easier to just run
+      <filename>libmysqld/examples/mysql</filename>. It's the embedded
+      server-based clone of the usual <command>mysql</command> tool, and
+      works fine under <command>gdb</command> or whatever your favorite
+      debugger is.
+    </para>
+
+    <para>
       <emphasis role="bold">The Major Directories: #2 client</emphasis>
     </para>