svn commit - mysqldoc@docsrva: r11600 - in trunk: . mysqltest

[paul.dubois]

Author: paul
Date: 2008-08-22 21:59:41 +0200 (Fri, 22 Aug 2008)
New Revision: 11600

Log:
 r33487@frost:  paul | 2008-08-22 14:44:35 -0500
 Add indexing tags


Modified:
   trunk/mysqltest/writing-tests.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:33486
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:32819
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:33487
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:32819


Modified: trunk/mysqltest/writing-tests.xml
===================================================================
--- trunk/mysqltest/writing-tests.xml	2008-08-22 19:59:36 UTC (rev 11599)
+++ trunk/mysqltest/writing-tests.xml	2008-08-22 19:59:41 UTC (rev 11600)
Changed blocks: 10, Lines Added: 49, Lines Deleted: 0; 3425 bytes

@@ -202,6 +202,15 @@
 
     <title>Test Case Coding Guidelines</title>
 
+    <indexterm>
+      <primary>test case coding guidelines</primary>
+    </indexterm>
+
+    <indexterm>
+      <primary>coding guidelines</primary>
+      <secondary>test case</secondary>
+    </indexterm>
+
     <section id="writing-tests-filename-guidelines">
 
       <title>File Naming and Organization Guidelines</title>

@@ -339,6 +348,11 @@
             Write SQL statements using the same style as our manual:
           </para>
 
+          <indexterm>
+            <primary>lettercase conventions</primary>
+            <secondary>SQL statements</secondary>
+          </indexterm>
+
           <itemizedlist>
 
             <listitem>

@@ -361,6 +375,11 @@
             processing for SQL statements, of course.
           </para>
 
+          <indexterm>
+            <primary>lettercase conventions</primary>
+            <secondary>mysqltest commands</secondary>
+          </indexterm>
+
           <para>
             Use lowercase for <command>mysqltest</command> commands
             (<literal>echo</literal>, <literal>sleep</literal>,

@@ -481,6 +500,10 @@
 
       <title>Naming Conventions for Database Objects</title>
 
+      <indexterm>
+        <primary>object naming conventions</primary>
+      </indexterm>
+
       <para>
         It is possible to run test cases against a production server.
         (Generally, we will not do that, but our customers might,

@@ -614,6 +637,10 @@
 
     <title>Cleaning Up from a Previous Test Run</title>
 
+    <indexterm>
+      <primary>cleaning up</primary>
+    </indexterm>
+
     <para>
       For efficiency, the <command>mysqltest</command> test engine does
       not start with a clean new database for running each test case, so

@@ -683,6 +710,11 @@
 
     <title>Generating a Test Case Result File</title>
 
+    <indexterm>
+      <primary>result file</primary>
+      <secondary>generating</secondary>
+    </indexterm>
+
     <para>
       The test code we just wrote contains no checks of the result. The
       test will report a failure for one of two reasons:

@@ -773,6 +805,10 @@
 
     <title>Checking for Expected Errors</title>
 
+    <indexterm>
+      <primary>error checking</primary>
+    </indexterm>
+
     <remark role="todo">
       It's inconsistent and confusing that <command>mysqltest</command>
       displays numeric error codes in one error-reporting context and

@@ -1230,6 +1266,10 @@
 
     <title>Using Include Files to Simplify Test Cases</title>
 
+    <indexterm>
+      <primary>include files</primary>
+    </indexterm>
+
     <para>
       The <filename>include</filename> directory contains many files
       intended for inclusion into test case files. For example, to

@@ -1306,6 +1346,11 @@
 
     <title>Controlling the Binary Log Format</title>
 
+    <indexterm>
+      <primary>binary logging</primary>
+      <secondary>controlling</secondary>
+    </indexterm>
+
     <para>
       To be added.
     </para>

@@ -1316,6 +1361,10 @@
 
     <title>Writing Replication Tests</title>
 
+    <indexterm>
+      <primary>replication testing</primary>
+    </indexterm>
+
     <para>
       If you are writing a replication test case, the first line of the
       test file should be <literal>source