List:Commits« Previous MessageNext Message »
From:jon.stephens Date:October 5 2010 10:40am
Subject:svn commit - mysqldoc@docsrva: r22978 - trunk/ndbapi
View as plain text  
Author: jstephens
Date: 2010-10-05 12:40:42 +0200 (Tue, 05 Oct 2010)
New Revision: 22978

Log:

De-gunking/general revisions



Modified:
   trunk/ndbapi/ndb-event.xml
   trunk/ndbapi/ndb-getting-started.xml
   trunk/ndbapi/ndb-getvaluespec.xml
   trunk/ndbapi/ndb-hierarchy.xml
   trunk/ndbapi/ndb-index.xml
   trunk/ndbapi/ndb-indexbound.xml
   trunk/ndbapi/ndb-template.xml


Modified: trunk/ndbapi/ndb-event.xml
===================================================================
--- trunk/ndbapi/ndb-event.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-event.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 22, Lines Added: 301, Lines Deleted: 290; 24597 bytes

@@ -215,20 +215,20 @@
     <para>
       This diagram shows all the available methods and enumerated types
       of the <literal>Event</literal> class:
-
-      <mediaobject>
-        <imageobject>
-          <imagedata contentwidth="640" contentdepth="772" fileref="images/published/NdbDictionary-Object-Event-class.png" format="PNG"/>
-        </imageobject>
-        <textobject>
-          <phrase lang="en">Public methods and enumerated types of the
-          <literal>Event</literal> class.</phrase>
-        </textobject>
-      </mediaobject>
     </para>
 
   </formalpara>
 
+  <mediaobject>
+    <imageobject>
+      <imagedata contentwidth="640" contentdepth="772" fileref="images/published/NdbDictionary-Object-Event-class.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase lang="en">Public methods and enumerated types of the
+      <literal>Event</literal> class.</phrase>
+    </textobject>
+  </mediaobject>
+
   <section id="ndb-event-types">
 
     <title><literal>Event</literal> Types</title>

@@ -279,77 +279,80 @@
         <title>Enumeration values</title>
 
         <para>
-          <informaltable>
-            <tgroup cols="2">
-              <colspec colwidth="35*"/>
-              <colspec colwidth="65*"/>
-              <thead>
-                <row>
-                  <entry>Value</entry>
-                  <entry>Description</entry>
-                </row>
-              </thead>
-              <tbody>
-                <row>
-                  <entry><literal>TE_INSERT</literal></entry>
-                  <entry>Insert event on a table</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_DELETE</literal></entry>
-                  <entry>Delete event on a table</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_UPDATE</literal></entry>
-                  <entry>Update event on a table</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_DROP</literal></entry>
-                  <entry>Occurs when a table is dropped</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_ALTER</literal></entry>
-                  <entry>Occurs when a table definition is changed</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_CREATE</literal></entry>
-                  <entry>Occurs when a table is created</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_GCP_COMPLETE</literal></entry>
-                  <entry>Occurs on the completion of a global checkpoint</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_CLUSTER_FAILURE</literal></entry>
-                  <entry>Occurs on Cluster failures</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_STOP</literal></entry>
-                  <entry>Occurs when an event operation is stopped</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_NODE_FAILURE</literal></entry>
-                  <entry>Occurs when a Cluster node fails</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_SUBSCRIBE</literal></entry>
-                  <entry>Occurs when a cluster node subscribes to an event</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_UNSUBSCRIBE</literal></entry>
-                  <entry>Occurs when a cluster node unsubscribes from an event</entry>
-                </row>
-                <row>
-                  <entry><literal>TE_ALL</literal></entry>
-                  <entry>Occurs when any event occurs on a table (not relevant when a specific
-                    event is received)</entry>
-                </row>
-              </tbody>
-            </tgroup>
-          </informaltable>
+          Possible values are shown, along with descriptions, in the
+          following table:
         </para>
 
       </formalpara>
 
+      <informaltable>
+        <tgroup cols="2">
+          <colspec colwidth="35*"/>
+          <colspec colwidth="65*"/>
+          <thead>
+            <row>
+              <entry>Value</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>TE_INSERT</literal></entry>
+              <entry>Insert event on a table</entry>
+            </row>
+            <row>
+              <entry><literal>TE_DELETE</literal></entry>
+              <entry>Delete event on a table</entry>
+            </row>
+            <row>
+              <entry><literal>TE_UPDATE</literal></entry>
+              <entry>Update event on a table</entry>
+            </row>
+            <row>
+              <entry><literal>TE_DROP</literal></entry>
+              <entry>Occurs when a table is dropped</entry>
+            </row>
+            <row>
+              <entry><literal>TE_ALTER</literal></entry>
+              <entry>Occurs when a table definition is changed</entry>
+            </row>
+            <row>
+              <entry><literal>TE_CREATE</literal></entry>
+              <entry>Occurs when a table is created</entry>
+            </row>
+            <row>
+              <entry><literal>TE_GCP_COMPLETE</literal></entry>
+              <entry>Occurs on the completion of a global checkpoint</entry>
+            </row>
+            <row>
+              <entry><literal>TE_CLUSTER_FAILURE</literal></entry>
+              <entry>Occurs on Cluster failures</entry>
+            </row>
+            <row>
+              <entry><literal>TE_STOP</literal></entry>
+              <entry>Occurs when an event operation is stopped</entry>
+            </row>
+            <row>
+              <entry><literal>TE_NODE_FAILURE</literal></entry>
+              <entry>Occurs when a Cluster node fails</entry>
+            </row>
+            <row>
+              <entry><literal>TE_SUBSCRIBE</literal></entry>
+              <entry>Occurs when a cluster node subscribes to an event</entry>
+            </row>
+            <row>
+              <entry><literal>TE_UNSUBSCRIBE</literal></entry>
+              <entry>Occurs when a cluster node unsubscribes from an event</entry>
+            </row>
+            <row>
+              <entry><literal>TE_ALL</literal></entry>
+              <entry>Occurs when any event occurs on a table (not relevant when a specific
+                event is received)</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
     </section>
 
     <section id="ndb-event-eventdurability">

@@ -389,69 +392,72 @@
         <title>Enumeration values</title>
 
         <para>
-          <informaltable>
-            <tgroup cols="2">
-              <colspec colwidth="35*"/>
-              <colspec colwidth="65*"/>
-              <thead>
-                <row>
-                  <entry>Value</entry>
-                  <entry>Description</entry>
-                </row>
-              </thead>
-              <tbody>
-                <row>
-                  <entry><literal>ED_UNDEFINED</literal></entry>
-                  <entry>The event is undefined or of an unsupported type.</entry>
-                </row>
-                <row>
-                  <entry><literal>ED_SESSION</literal></entry>
-                  <entry>This event persists only for the duration of the current session, and is
-                    available only to the current application. It is
-                    deleted after the application disconnects or
-                    following a cluster restart.
+          Possible values are shown, along with descriptions, in the
+          following table:
+        </para>
 
-                    <important>
-                      <para>
-                        The value <literal>ED_SESSION</literal> is
-                        reserved for future use and is not yet supported
-                        in any MySQL Cluster release.
-                      </para>
-                    </important></entry>
-                </row>
-                <row>
-                  <entry><literal>ED_TEMPORARY</literal></entry>
-                  <entry>Any application may use the event, but it is deleted following a cluster
-                    restart.
+      </formalpara>
 
-                    <important>
-                      <para>
-                        The value <literal>ED_TEMPORARY</literal> is
-                        reserved for future use and is not yet supported
-                        in any MySQL Cluster release.
-                      </para>
-                    </important></entry>
-                </row>
-                <row>
-                  <entry><literal>ED_PERMANENT</literal></entry>
-                  <entry>Any application may use the event, and it persists until deleted by an
-                    application&mdash;even following a cluster. restart
+      <informaltable>
+        <tgroup cols="2">
+          <colspec colwidth="35*"/>
+          <colspec colwidth="65*"/>
+          <thead>
+            <row>
+              <entry>Value</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ED_UNDEFINED</literal></entry>
+              <entry>The event is undefined or of an unsupported type.</entry>
+            </row>
+            <row>
+              <entry><literal>ED_SESSION</literal></entry>
+              <entry>This event persists only for the duration of the current session, and is
+                available only to the current application. It is deleted
+                after the application disconnects or following a cluster
+                restart.
 
-                    <important>
-                      <para>
-                        The value <literal>ED_PERMANENT</literal> is
-                        reserved for future use and is not yet supported
-                        in any MySQL Cluster release.
-                      </para>
-                    </important></entry>
-                </row>
-              </tbody>
-            </tgroup>
-          </informaltable>
-        </para>
+                <important>
+                  <para>
+                    The value <literal>ED_SESSION</literal> is reserved
+                    for future use and is not yet supported in any MySQL
+                    Cluster release.
+                  </para>
+                </important></entry>
+            </row>
+            <row>
+              <entry><literal>ED_TEMPORARY</literal></entry>
+              <entry>Any application may use the event, but it is deleted following a cluster
+                restart.
 
-      </formalpara>
+                <important>
+                  <para>
+                    The value <literal>ED_TEMPORARY</literal> is
+                    reserved for future use and is not yet supported in
+                    any MySQL Cluster release.
+                  </para>
+                </important></entry>
+            </row>
+            <row>
+              <entry><literal>ED_PERMANENT</literal></entry>
+              <entry>Any application may use the event, and it persists until deleted by an
+                application&mdash;even following a cluster. restart
 
+                <important>
+                  <para>
+                    The value <literal>ED_PERMANENT</literal> is
+                    reserved for future use and is not yet supported in
+                    any MySQL Cluster release.
+                  </para>
+                </important></entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
     </section>
 
     <section id="ndb-event-eventreport">

@@ -491,45 +497,47 @@
         <title>Enumeration values</title>
 
         <para>
-          <informaltable>
-            <tgroup cols="2">
-              <colspec colwidth="35*"/>
-              <colspec colwidth="65*"/>
-              <thead>
-                <row>
-                  <entry>Value</entry>
-                  <entry>Description</entry>
-                </row>
-              </thead>
-              <tbody>
-                <row>
-                  <entry><literal>ER_UPDATED</literal></entry>
-                  <entry>Reporting of update events</entry>
-                </row>
-                <row>
-                  <entry><literal>ER_ALL</literal></entry>
-                  <entry>Reporting of all events, except for those not resulting in any updates
-                    to the inline parts of <literal>BLOB</literal>
-                    columns</entry>
-                </row>
-                <row>
-                  <entry><literal>ER_SUBSCRIBE</literal></entry>
-                  <entry>Reporting of subscription events</entry>
-                </row>
-                <row>
-                  <entry><literal>ER_DDL</literal></entry>
-                  <entry>Reporting of DDL events (<emphasis>added in MySQL Cluster NDB 6.3.34,
-                    7.0.15, and 7.1.4; see
-                    <xref linkend="ndb-event-setreport"/>, for more
-                    information</emphasis>)</entry>
-                </row>
-              </tbody>
-            </tgroup>
-          </informaltable>
+          Possible values are shown, along with descriptions, in the
+          following table:
         </para>
 
       </formalpara>
 
+      <informaltable>
+        <tgroup cols="2">
+          <colspec colwidth="35*"/>
+          <colspec colwidth="65*"/>
+          <thead>
+            <row>
+              <entry>Value</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ER_UPDATED</literal></entry>
+              <entry>Reporting of update events</entry>
+            </row>
+            <row>
+              <entry><literal>ER_ALL</literal></entry>
+              <entry>Reporting of all events, except for those not resulting in any updates
+                to the inline parts of <literal>BLOB</literal> columns</entry>
+            </row>
+            <row>
+              <entry><literal>ER_SUBSCRIBE</literal></entry>
+              <entry>Reporting of subscription events</entry>
+            </row>
+            <row>
+              <entry><literal>ER_DDL</literal></entry>
+              <entry>Reporting of DDL events (<emphasis>added in MySQL Cluster NDB 6.3.34,
+                7.0.15, and 7.1.4; see
+                <xref linkend="ndb-event-setreport"/>, for more
+                information</emphasis>)</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
     </section>
 
   </section>

@@ -559,8 +567,12 @@
         <title>Signatures</title>
 
         <para>
-          Name only:
+          It is possible to invoke this method in either of two ways,
+          the first of these being by name only, as shown here:
+        </para>
 
+      </formalpara>
+
 <programlisting>
 Event
     (

@@ -568,7 +580,10 @@
     )
 </programlisting>
 
-          Name and associated table:
+      <para>
+        Alternatively, you can use the event name and an associated
+        table, like this:
+      </para>
 
 <programlisting>
 Event

@@ -577,10 +592,7 @@
       const NdbDictionary::Table&amp; <replaceable>table</replaceable>
     )
 </programlisting>
-        </para>
 
-      </formalpara>
-
       <formalpara>
 
         <title>Parameters</title>

@@ -906,8 +918,8 @@
         <title>Parameters</title>
 
         <para>
-          This method takes a single parameter - the table event's type,
-          that is, a <literal>TableEvent</literal> value. See
+          This method takes a single parameter, the table event's
+          type&mdash;that is, a <literal>TableEvent</literal> value. See
           <xref linkend="ndb-event-tableevent"/>, for the list of
           possible values.
         </para>

@@ -928,17 +940,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1298,7 +1310,7 @@
         <title>Return value</title>
 
         <para>
-          The object status of the event&mdash;for possible values, see
+          The object status of the event. For possible values, see
           <xref linkend="ndb-object-status"/>.
         </para>
 

@@ -1451,17 +1463,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1534,17 +1546,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1619,17 +1631,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1695,17 +1707,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1769,17 +1781,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1895,17 +1907,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1983,30 +1995,30 @@
 
         <para>
           This method takes a single argument, which may be either one
-          of:
+          of the following:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                The column ID (<literal>attrId</literal>), which should
-                be an integer greater than or equal to
-                <literal>0</literal>, and less than the value returned
-                by <literal>getNoOfEventColumns()</literal>.
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                The column's <replaceable>name</replaceable> (as a
-                constant character pointer).
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            The column ID (<literal>attrId</literal>), which should be
+            an integer greater than or equal to <literal>0</literal>,
+            and less than the value returned by
+            <literal>getNoOfEventColumns()</literal>.
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            The column's <replaceable>name</replaceable> (as a constant
+            character pointer).
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
       <formalpara>
 

@@ -2019,17 +2031,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -2088,29 +2100,29 @@
         <title>Parameters</title>
 
         <para>
-          This method requires two arguments:
+          This method requires two arguments, listed here:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                The number of columns <replaceable>n</replaceable> (an
-                integer).
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                The names of the columns
-                <replaceable>columnNames</replaceable>&mdash;this must
-                be passed as a pointer to a character pointer.
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            The number of columns <replaceable>n</replaceable> (an
+            integer).
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            The names of the columns
+            <replaceable>columnNames</replaceable>&mdash;this must be
+            passed as a pointer to a character pointer.
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
       <formalpara>
 

@@ -2123,17 +2135,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -2159,37 +2171,36 @@
           flag</firstterm>, which is <literal>false</literal> by
           default. Setting it to <literal>true</literal> implies that
           events are merged as follows:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                For a given <literal>NdbEventOperation</literal>
-                associated with this event, events on the same primary
-                key within the same global checkpoint index (GCI) are
-                merged into a single event.
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                A blob table event is created for each blob attribute,
-                and blob events are handled as part of main table
-                events.
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            For a given <literal>NdbEventOperation</literal> associated
+            with this event, events on the same primary key within the
+            same global checkpoint index (GCI) are merged into a single
+            event.
+          </para>
+        </listitem>
 
-            <listitem>
-              <para>
-                Blob post/pre data from blob part events can be read via
-                <literal>NdbBlob</literal> methods as a single value.
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            A blob table event is created for each blob attribute, and
+            blob events are handled as part of main table events.
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            Blob post/pre data from blob part events can be read via
+            <literal>NdbBlob</literal> methods as a single value.
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
       <note>
         <para>

@@ -2236,17 +2247,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>


Modified: trunk/ndbapi/ndb-getting-started.xml
===================================================================
--- trunk/ndbapi/ndb-getting-started.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-getting-started.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 15, Lines Added: 226, Lines Deleted: 232; 21835 bytes

@@ -3,19 +3,6 @@
 <!ENTITY % all.entities SYSTEM "all-entities.ent">
   %all.entities;
 ]>
-<!--
-  <section id="tips-tricks-problems">
-
-    <title>TIPS, TRICKS, AND COMMON PROBLEMS</title>
-
-    <abstract>
-
-      <para></para>
-
-    </abstract>
-
-  </section>
--->
 <section id="ndb-getting-started">
 
   <title>Getting Started with the NDB API</title>

@@ -59,7 +46,8 @@
           MySQL 4.1 does not install the required
           <literal>NDB</literal>-specific header files. You should use
           MySQL 5.0 or later when writing NDB API applications, and this
-          Guide is targeted for use with MySQL 5.1.
+          Guide is targeted for use with MySQL Cluster in MySQL 5.1,
+          MySQL Cluster NDB 6.X, MySQL Cluster NDB 7.X, and later.
         </para>
 
         <para>

@@ -87,25 +75,25 @@
           Header files specific to the NDB API are installed in the
           following subdirectories of the MySQL
           <filename>include</filename> directory:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                <filename>include/mysql/storage/ndb/ndbapi</filename>
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                <filename>include/mysql/storage/ndb/mgmapi</filename>
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            <filename>include/mysql/storage/ndb/ndbapi</filename>
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            <filename>include/mysql/storage/ndb/mgmapi</filename>
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
       <formalpara>
 

@@ -115,28 +103,35 @@
           The MySQL-specific compiler flags needed can be determined
           using the <command>mysql_config</command> utility that is part
           of the MySQL installation:
+        </para>
 
+      </formalpara>
+
 <programlisting>
 $ mysql_config --cflags
 -I/usr/local/mysql/include/mysql -Wreturn-type -Wtrigraphs -W -Wformat
 -Wsign-compare -Wunused  -mcpu=pentium4 -march=pentium4
 </programlisting>
 
-          This sets the include path for the MySQL header files but not
-          for those specific to the NDB API. The
-          <option>--include</option> option to
-          <command>mysql_config</command> returns the generic include
-          path switch:
+      <para>
+        This sets the include path for the MySQL header files but not
+        for those specific to the NDB API. The
+        <option>--include</option> option to
+        <command>mysql_config</command> returns the generic include path
+        switch:
+      </para>
 
 <programlisting>
 shell&gt; mysql_config --include
 -I/usr/local/mysql/include/mysql
 </programlisting>
 
-          It is necessary to add the subdirectory paths explicitly, so
-          that adding all the needed compile flags to the
-          <literal>CXXFLAGS</literal> shell variable should look
-          something like this:
+      <para>
+        It is necessary to add the subdirectory paths explicitly, so
+        that adding all the needed compile flags to the
+        <literal>CXXFLAGS</literal> shell variable should look something
+        like this:
+      </para>
 
 <programlisting>
 CFLAGS="$CFLAGS "`mysql_config --cflags`

@@ -144,10 +139,7 @@
 CFLAGS="$CFLAGS "`mysql_config --include`/storage/ndb/ndbapi
 CFLAGS="$CFLAGS "`mysql_config --include`/storage/ndb/mgmapi
 </programlisting>
-        </para>
 
-      </formalpara>
-
       <tip>
         <para>
           If you do not intend to use the Cluster management functions,

@@ -179,13 +171,13 @@
         <option>--libs</option></command>. For multithreaded
         applications you should use the <option>--libs_r</option>
         instead:
+      </para>
 
 <programlisting>
 $ mysql_config --libs_r
 -L/usr/local/mysql-5.1/lib/mysql -lmysqlclient_r -lz -lpthread -lcrypt
 -lnsl -lm -lpthread -L/usr/lib -lssl -lcrypto
 </programlisting>
-      </para>
 
       <para>
         Formerly, to link an NDB API application, it was necessary to

@@ -193,24 +185,26 @@
         <option>-lmystrings</option> to these options, in the order
         shown, and adding all the required linker flags to the
         <literal>LDFLAGS</literal> variable looked something like this:
+      </para>
 
 <programlisting>
 LDFLAGS="$LDFLAGS "`mysql_config --libs_r`
 LDFLAGS="$LDFLAGS -lndbclient -lmysys -lmystrings"
 </programlisting>
-      </para>
 
       <para>
         Beginning with MySQL 5.1.24-ndb-6.2.16 and MySQL
         5.1.24-ndb-6.3.14, it is necessary only to add
         <option>-lndbclient</option> to <literal>LD_FLAGS</literal>, as
         shown here:
+      </para>
 
 <programlisting>
 LDFLAGS="$LDFLAGS "`mysql_config --libs_r`
 LDFLAGS="$LDFLAGS -lndbclient"
 </programlisting>
 
+      <para>
         (For more information about this change, see Bug#29791.)
       </para>
 

@@ -235,29 +229,31 @@
         <literal>WITH_MYSQL</literal>. A typical complete example
         consists of the actual source file and the following helper
         files:
+      </para>
 
-        <itemizedlist>
+      <itemizedlist>
 
-          <listitem>
-            <para>
-              <filename>acinclude</filename>
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            <filename>acinclude</filename>
+          </para>
+        </listitem>
 
-          <listitem>
-            <para>
-              <filename>configure.in</filename>
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            <filename>configure.in</filename>
+          </para>
+        </listitem>
 
-          <listitem>
-            <para>
-              <filename>Makefile.m4</filename>
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            <filename>Makefile.m4</filename>
+          </para>
+        </listitem>
 
-        </itemizedlist>
+      </itemizedlist>
 
+      <para>
         <command>automake</command> also requires that you provide
         <filename>README</filename>, <filename>NEWS</filename>,
         <filename>AUTHORS</filename>, and <filename>ChangeLog</filename>

@@ -266,6 +262,7 @@
 
       <para>
         To create all necessary build files, run the following:
+      </para>
 
 <programlisting>
 aclocal

@@ -274,6 +271,7 @@
 configure --with-mysql=<replaceable>/mysql/prefix/path</replaceable>
 </programlisting>
 
+      <para>
         Normally, this needs to be done only once, after which
         <command>make</command> will accommodate any file changes.
       </para>

@@ -405,33 +403,33 @@
       <para>
         NDB API applications require one or more of the following
         include files:
+      </para>
 
-        <itemizedlist>
+      <itemizedlist>
 
-          <listitem>
-            <para>
-              Applications accessing Cluster data using the NDB API must
-              include the file <filename>NdbApi.hpp</filename>.
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            Applications accessing Cluster data using the NDB API must
+            include the file <filename>NdbApi.hpp</filename>.
+          </para>
+        </listitem>
 
-          <listitem>
-            <para>
-              Applications making use of both the <literal>NDB</literal>
-              API and the regular MySQL client API also need to include
-              <filename>mysql.h</filename>.
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            Applications making use of both the <literal>NDB</literal>
+            API and the regular MySQL client API also need to include
+            <filename>mysql.h</filename>.
+          </para>
+        </listitem>
 
-          <listitem>
-            <para>
-              Applications that use cluster management functions need
-              the include file <filename>mgmapi.h</filename>.
-            </para>
-          </listitem>
+        <listitem>
+          <para>
+            Applications that use cluster management functions need the
+            include file <filename>mgmapi.h</filename>.
+          </para>
+        </listitem>
 
-        </itemizedlist>
-      </para>
+      </itemizedlist>
 
     </section>
 

@@ -470,12 +468,12 @@
       </para>
 
       <para>
-        By default an API node will connect to the
-        <quote>nearest</quote> data node&mdash;usually a data node
-        running on the same machine, due to the fact that shared memory
-        transport can be used instead of the slower TCP/IP. This may
-        lead to poor load distribution in some cases, so it is possible
-        to enforce a round-robin node connection scheme by calling the
+        By default an API node connects to the <quote>nearest</quote>
+        data node&mdash;usually a data node running on the same machine,
+        due to the fact that shared memory transport can be used instead
+        of the slower TCP/IP. This may lead to poor load distribution in
+        some cases, so it is possible to enforce a round-robin node
+        connection scheme by calling the
         <literal>set_optimized_node_selection()</literal> method with
         <literal>0</literal> as its argument prior to calling
         <literal>connect()</literal>. (See

@@ -615,53 +613,54 @@
 
       <para>
         There are two different type of NDB indexes:
+      </para>
 
-        <itemizedlist>
+    </formalpara>
 
-          <listitem>
-            <para>
-              <firstterm>Hash indexes</firstterm> are unique, but not
-              ordered.
-            </para>
-          </listitem>
+    <itemizedlist>
 
-          <listitem>
-            <para>
-              <firstterm>B-tree indexes</firstterm> are ordered, but
-              permit duplicate values.
-            </para>
-          </listitem>
+      <listitem>
+        <para>
+          <firstterm>Hash indexes</firstterm> are unique, but not
+          ordered.
+        </para>
+      </listitem>
 
-        </itemizedlist>
+      <listitem>
+        <para>
+          <firstterm>B-tree indexes</firstterm> are ordered, but permit
+          duplicate values.
+        </para>
+      </listitem>
 
-        Names of unique indexes and primary keys are handled as follows:
+    </itemizedlist>
 
-        <itemizedlist>
+    <para>
+      Names of unique indexes and primary keys are handled as follows:
+    </para>
 
-          <listitem>
-            <para>
-              For a MySQL <literal>UNIQUE</literal> index, both a B-tree
-              and a hash index are created. The B-tree index uses the
-              MySQL name for the index; the name for the hash index is
-              generated by appending '<literal>$unique</literal>' to the
-              index name.
-            </para>
-          </listitem>
+    <itemizedlist>
 
-          <listitem>
-            <para>
-              For a MySQL primary key only a B-tree index is created.
-              This index is given the name <literal>PRIMARY</literal>.
-              There is no extra hash; however, the uniqueness of the
-              primary key is guaranteed by making the MySQL key the
-              internal primary key of the <literal>NDB</literal> table.
-            </para>
-          </listitem>
+      <listitem>
+        <para>
+          For a MySQL <literal>UNIQUE</literal> index, both a B-tree and
+          a hash index are created. The B-tree index uses the MySQL name
+          for the index; the name for the hash index is generated by
+          appending '<literal>$unique</literal>' to the index name.
+        </para>
+      </listitem>
 
-        </itemizedlist>
-      </para>
+      <listitem>
+        <para>
+          For a MySQL primary key only a B-tree index is created. This
+          index is given the name <literal>PRIMARY</literal>. There is
+          no extra hash; however, the uniqueness of the primary key is
+          guaranteed by making the MySQL key the internal primary key of
+          the <literal>NDB</literal> table.
+        </para>
+      </listitem>
 
-    </formalpara>
+    </itemizedlist>
 
     <formalpara>
 

@@ -681,152 +680,147 @@
       <para>
         MySQL data types are stored in <literal>NDB</literal> columns as
         follows:
+      </para>
 
+    </formalpara>
+
+    <itemizedlist>
+
+      <listitem>
+        <para>
+          The MySQL <literal>TINYINT</literal>,
+          <literal>SMALLINT</literal>, <literal>INT</literal>, and
+          <literal>BIGINT</literal> data types map to
+          <literal>NDB</literal> types having the same names and storage
+          requirements as their MySQL counterparts.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          The MySQL <literal>FLOAT</literal> and
+          <literal>DOUBLE</literal> data types are mapped to
+          <literal>NDB</literal> types having the same names and storage
+          requirements.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          The storage space required for a MySQL <literal>CHAR</literal>
+          column is determined by the maximum number of characters and
+          the column's character set. For most (but not all) character
+          sets, each character takes one byte of storage. When using
+          UTF-8, each character requires three bytes. You can find the
+          number of bytes needed per character in a given character set
+          by checking the <literal>Maxlen</literal> column in the output
+          of <literal>SHOW CHARACTER SET</literal>.
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          In MySQL 5.1 and later, the storage requirements for a
+          <literal>VARCHAR</literal> or <literal>VARBINARY</literal>
+          column depend on whether the column is stored in memory or on
+          disk:
+        </para>
+
         <itemizedlist>
 
           <listitem>
             <para>
-              The MySQL <literal>TINYINT</literal>,
-              <literal>SMALLINT</literal>, <literal>INT</literal>, and
-              <literal>BIGINT</literal> data types map to
-              <literal>NDB</literal> types having the same names and
-              storage requirements as their MySQL counterparts.
+              For in-memory columns, the <literal>NDBCLUSTER</literal>
+              storage engine supports variable-width columns with 4-byte
+              alignment. This means that (for example) a the string
+              <literal>'abcde'</literal> stored in a
+              <literal>VARCHAR(50)</literal> column using the
+              <literal>latin1</literal> character set requires 12
+              bytes&mdash;in this case, 2 bytes times 5 characters is
+              10, rounded up to the next even multiple of 4 yields 12.
+              (This represents a change in behavior from Cluster in
+              MySQL 5.0 and 4.1, where a column having the same
+              definition required 52 bytes storage per row regardless of
+              the length of the string being stored in the row.)
             </para>
           </listitem>
 
           <listitem>
             <para>
-              The MySQL <literal>FLOAT</literal> and
-              <literal>DOUBLE</literal> data types are mapped to
-              <literal>NDB</literal> types having the same names and
-              storage requirements.
+              In Disk Data columns, <literal>VARCHAR</literal> and
+              <literal>VARBINARY</literal> are stored as fixed-width
+              columns. This means that each of these types requires the
+              same amount of storage as a <literal>CHAR</literal> of the
+              same size.
             </para>
           </listitem>
 
-          <listitem>
-            <para>
-              The storage space required for a MySQL
-              <literal>CHAR</literal> column is determined by the
-              maximum number of characters and the column's character
-              set. For most (but not all) character sets, each character
-              takes one byte of storage. When using UTF-8, each
-              character requires three bytes. You can find the number of
-              bytes needed per character in a given character set by
-              checking the <literal>Maxlen</literal> column in the
-              output of <literal>SHOW CHARACTER SET</literal>.
-            </para>
-          </listitem>
+        </itemizedlist>
+      </listitem>
 
-          <listitem>
-            <para>
-              In MySQL 5.1, the storage requirements for a
-              <literal>VARCHAR</literal> or <literal>VARBINARY</literal>
-              column depend on whether the column is stored in memory or
-              on disk:
+      <listitem>
+        <para>
+          Each row in a Cluster <literal>BLOB</literal> or
+          <literal>TEXT</literal> column is made up of two separate
+          parts. One of these is of fixed size (256 bytes), and is
+          actually stored in the original table. The other consists of
+          any data in excess of 256 bytes, which stored in a hidden
+          table. The rows in this second table are always 2000 bytes
+          long. This means that record of
+          <replaceable>size</replaceable> bytes in a
+          <literal>TEXT</literal> or <literal>BLOB</literal> column
+          requires
+        </para>
 
-              <itemizedlist>
+        <itemizedlist>
 
-                <listitem>
-                  <para>
-                    For in-memory columns, the
-                    <literal>NDBCLUSTER</literal> storage engine
-                    supports variable-width columns with 4-byte
-                    alignment. This means that (for example) a the
-                    string <literal>'abcde'</literal> stored in a
-                    <literal>VARCHAR(50)</literal> column using the
-                    <literal>latin1</literal> character set requires 12
-                    bytes&mdash;in this case, 2 bytes times 5 characters
-                    is 10, rounded up to the next even multiple of 4
-                    yields 12. (This represents a change in behavior
-                    from Cluster in MySQL 5.0 and 4.1, where a column
-                    having the same definition required 52 bytes storage
-                    per row regardless of the length of the string being
-                    stored in the row.)
-                  </para>
-                </listitem>
-
-                <listitem>
-                  <para>
-                    In Disk Data columns, <literal>VARCHAR</literal> and
-                    <literal>VARBINARY</literal> are stored as
-                    fixed-width columns. This means that each of these
-                    types requires the same amount of storage as a
-                    <literal>CHAR</literal> of the same size.
-                  </para>
-                </listitem>
-
-              </itemizedlist>
+          <listitem>
+            <para>
+              256 bytes, if <literal><replaceable>size</replaceable>
+              &lt;= 256</literal>
             </para>
           </listitem>
 
           <listitem>
             <para>
-              Each row in a Cluster <literal>BLOB</literal> or
-              <literal>TEXT</literal> column is made up of two separate
-              parts. One of these is of fixed size (256 bytes), and is
-              actually stored in the original table. The other consists
-              of any data in excess of 256 bytes, which stored in a
-              hidden table. The rows in this second table are always
-              2000 bytes long. This means that record of
-              <replaceable>size</replaceable> bytes in a
-              <literal>TEXT</literal> or <literal>BLOB</literal> column
-              requires
-
-              <itemizedlist>
-
-                <listitem>
-                  <para>
-                    256 bytes, if
-                    <literal><replaceable>size</replaceable> &lt;=
-                    256</literal>
-                  </para>
-                </listitem>
-
-                <listitem>
-                  <para>
-                    <literal>256 + 2000 *
-                    ((<replaceable>size</replaceable> – 256) \ 2000) +
-                    1)</literal> bytes otherwise
-                  </para>
-                </listitem>
-
-              </itemizedlist>
+              <literal>256 + 2000 * ((<replaceable>size</replaceable>
+              – 256) \ 2000) + 1)</literal> bytes otherwise
             </para>
           </listitem>
 
         </itemizedlist>
-      </para>
+      </listitem>
 
-    </formalpara>
+    </itemizedlist>
 
   </section>
 
 <!--
-      <section id="ndb-start-reading-data">
-        <title></title>
+  <section id="ndb-start-reading-data">
+    <title></title>
 
-        <section id="ndb-start-beginning-transaction">
-          <title></title>
-        </section>
+    <section id="ndb-start-beginning-transaction">
+      <title></title>
+    </section>
 
-        <section id="ndb-start-preparing-read">
-          <title></title>
-        </section>
+    <section id="ndb-start-preparing-read">
+      <title></title>
+    </section>
 
-        <section id="ndb-start-performing-read">
-          <title></title>
-        </section>
+    <section id="ndb-start-performing-read">
+      <title></title>
+    </section>
 
-        <section id="ndb-start-fetching-results">
-          <title></title>
-        </section>
+    <section id="ndb-start-fetching-results">
+      <title></title>
+    </section>
 
 
-      </section>
+  </section>
 -->
 
 <!--
-  <section id="tips-tricks-common-problems">
+  <section id="ndb-tips-tricks-common-problems">
 
     <title>Common Problems</title>
 

@@ -842,7 +836,7 @@
 
   </section>
 
-  <section id="tips-tricks">
+  <section id="ndb-tips-tricks">
 
     <title>Tips &amp; Tricks</title>
 


Modified: trunk/ndbapi/ndb-getvaluespec.xml
===================================================================
--- trunk/ndbapi/ndb-getvaluespec.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-getvaluespec.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 1, Lines Added: 77, Lines Deleted: 77; 6647 bytes

@@ -36,93 +36,93 @@
 
     <para>
       The makeup of this structure is shown here:
+    </para>
 
-      <mediaobject>
-        <imageobject>
-          <imagedata contentwidth="225" contentdepth="165" fileref="images/published/NdbOperation-GetValueSpec.png" format="PNG"/>
-        </imageobject>
-        <textobject>
-          <phrase lang="en">NdbOperation::GetValueSpec
-          structure</phrase>
-        </textobject>
-      </mediaobject>
+  </formalpara>
 
-      The individual members are described in more detail in the
-      following table:
+  <mediaobject>
+    <imageobject>
+      <imagedata contentwidth="225" contentdepth="165" fileref="images/published/NdbOperation-GetValueSpec.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase lang="en">NdbOperation::GetValueSpec structure</phrase>
+    </textobject>
+  </mediaobject>
 
-      <informaltable>
-        <tgroup cols="3">
-          <colspec colwidth="25*"/>
-          <colspec colwidth="25*"/>
-          <colspec colwidth="50*"/>
-          <thead>
-            <row>
-              <entry>Name</entry>
-              <entry>Type</entry>
-              <entry>Description</entry>
-            </row>
-          </thead>
-          <tbody>
-            <row>
-              <entry><literal>column</literal></entry>
-              <entry><literal>const
-                <link linkend="ndb-column"><literal>NdbDictionary::Column</literal></link>*</literal></entry>
-              <entry>To specify an extra value to read, the caller must provide this, as well
-                as (optionally <literal>NULL</literal>)
-                <replaceable>appStorage</replaceable> pointer.</entry>
-            </row>
-            <row>
-              <entry><literal>appStorage</literal></entry>
-              <entry><literal>void*</literal></entry>
-              <entry>If this pointer is null, then the received value is stored in memory
-                managed by the
-                <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
-                object. Otherwise, the received value is stored at the
-                location pointed to (and is still accessable using the
-                <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
-                object).
+  <para>
+    The individual members are described in more detail in the following
+    table:
+  </para>
 
-                <important>
-                  <para>
-                    It is the caller&apos;s responsibility to ensure
-                    that
+  <informaltable>
+    <tgroup cols="3">
+      <colspec colwidth="25*"/>
+      <colspec colwidth="25*"/>
+      <colspec colwidth="50*"/>
+      <thead>
+        <row>
+          <entry>Name</entry>
+          <entry>Type</entry>
+          <entry>Description</entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry><literal>column</literal></entry>
+          <entry><literal>const
+            <link linkend="ndb-column"><literal>NdbDictionary::Column</literal></link>*</literal></entry>
+          <entry>To specify an extra value to read, the caller must provide this, as well
+            as (optionally <literal>NULL</literal>)
+            <replaceable>appStorage</replaceable> pointer.</entry>
+        </row>
+        <row>
+          <entry><literal>appStorage</literal></entry>
+          <entry><literal>void*</literal></entry>
+          <entry>If this pointer is null, then the received value is stored in memory
+            managed by the
+            <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
+            object. Otherwise, the received value is stored at the
+            location pointed to (and is still accessable using the
+            <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
+            object).
 
-                    <itemizedlist>
+            <important>
+              <para>
+                It is the caller&apos;s responsibility to ensure that
+                the following conditions are met:
+              </para>
 
-                      <listitem>
-                        <para>
-                          <replaceable>appStorage</replaceable> points
-                          to sufficient space to store any returned
-                          data.
-                        </para>
-                      </listitem>
+              <orderedlist>
 
-                      <listitem>
-                        <para>
-                          Memory pointed to by
-                          <replaceable>appStorage</replaceable> is not
-                          reused or freed until after the
-                          <literal>execute()</literal> call returns.
-                        </para>
-                      </listitem>
+                <listitem>
+                  <para>
+                    <replaceable>appStorage</replaceable> points to
+                    sufficient space to store any returned data.
+                  </para>
+                </listitem>
 
-                    </itemizedlist>
+                <listitem>
+                  <para>
+                    Memory pointed to by
+                    <replaceable>appStorage</replaceable> is not reused
+                    or freed until after the
+                    <literal>execute()</literal> call returns.
                   </para>
-                </important></entry>
-            </row>
-            <row>
-              <entry><literal>recAttr</literal></entry>
-              <entry><link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>*</entry>
-              <entry>After the operation is defined, <replaceable>recAttr</replaceable>
-                contains a pointer to the <literal>NdbRecAttr</literal>
-                object for receiving the data.</entry>
-            </row>
-          </tbody>
-        </tgroup>
-      </informaltable>
-    </para>
+                </listitem>
 
-  </formalpara>
+              </orderedlist>
+            </important></entry>
+        </row>
+        <row>
+          <entry><literal>recAttr</literal></entry>
+          <entry><link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>*</entry>
+          <entry>After the operation is defined, <replaceable>recAttr</replaceable>
+            contains a pointer to the <literal>NdbRecAttr</literal>
+            object for receiving the data.</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
 
   <important>
     <para>


Modified: trunk/ndbapi/ndb-hierarchy.xml
===================================================================
--- trunk/ndbapi/ndb-hierarchy.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-hierarchy.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 1, Lines Added: 178, Lines Deleted: 180; 12566 bytes

@@ -12,258 +12,256 @@
     interfaces, and structures exposed by the NDB API.
   </para>
 
-  <para>
-    <itemizedlist>
+  <itemizedlist>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndb"><literal>Ndb</literal></link>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndb"><literal>Ndb</literal></link>
+      </para>
 
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            <link linkend="ndb-key-part-ptr"><literal>Key_part_ptr</literal></link>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <link linkend="ndb-partitionspec"><literal>PartitionSpec</literal></link>
+          </para>
+        </listitem>
+
+      </itemizedlist>
+    </listitem>
+
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbblob"><literal>NdbBlob</literal></link>
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <link linkend="ndb-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link>
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbdictionary"><literal>NdbDictionary</literal></link>
+      </para>
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            <link linkend="ndb-autogrowspecification"><literal>AutoGrowSpecification</literal></link>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <link linkend="ndb-dictionary"><literal>Dictionary</literal></link>
+          </para>
+
           <itemizedlist>
 
             <listitem>
               <para>
-                <link linkend="ndb-key-part-ptr"><literal>Key_part_ptr</literal></link>
+                <link linkend="ndb-list"><literal>List</literal></link>
               </para>
-            </listitem>
 
-            <listitem>
-              <para>
-                <link linkend="ndb-partitionspec"><literal>PartitionSpec</literal></link>
-              </para>
+              <itemizedlist>
+
+                <listitem>
+                  <para>
+                    <link linkend="ndb-element"><literal>Element</literal></link>
+                  </para>
+                </listitem>
+
+              </itemizedlist>
             </listitem>
 
           </itemizedlist>
-        </para>
-      </listitem>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbblob"><literal>NdbBlob</literal></link>
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            <link linkend="ndb-column"><literal>Column</literal></link>
+          </para>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link>
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            <link linkend="ndb-object"><literal>Object</literal></link>
+          </para>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbdictionary"><literal>NdbDictionary</literal></link>
-
           <itemizedlist>
 
             <listitem>
               <para>
-                <link linkend="ndb-autogrowspecification"><literal>AutoGrowSpecification</literal></link>
+                <link linkend="ndb-datafile"><literal>Datafile</literal></link>
               </para>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-dictionary"><literal>Dictionary</literal></link>
-
-                <itemizedlist>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-list"><literal>List</literal></link>
-
-                      <itemizedlist>
-
-                        <listitem>
-                          <para>
-                            <link linkend="ndb-element"><literal>Element</literal></link>
-                          </para>
-                        </listitem>
-
-                      </itemizedlist>
-                    </para>
-                  </listitem>
-
-                </itemizedlist>
+                <link linkend="ndb-event"><literal>Event</literal></link>
               </para>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-column"><literal>Column</literal></link>
+                <link linkend="ndb-index"><literal>Index</literal></link>
               </para>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-object"><literal>Object</literal></link>
-
-                <itemizedlist>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-datafile"><literal>Datafile</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-event"><literal>Event</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-index"><literal>Index</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-logfilegroup"><literal>LogfileGroup</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-table"><literal>Table</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-tablespace"><literal>Tablespace</literal></link>
-                    </para>
-                  </listitem>
-
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-undofile"><literal>Undofile</literal></link>
-                    </para>
-                  </listitem>
-
-                </itemizedlist>
+                <link linkend="ndb-logfilegroup"><literal>LogfileGroup</literal></link>
               </para>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-recordspecification"><literal>RecordSpecification</literal></link>
+                <link linkend="ndb-table"><literal>Table</literal></link>
               </para>
             </listitem>
 
-          </itemizedlist>
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <link linkend="ndb-ndberror"><literal>NdbError</literal></link>
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbeventoperation"><literal>NdbEventOperation</literal></link>
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbinterpretedcode"><literal>NdbInterpretedCode</literal></link>
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
-
-          <itemizedlist>
-
             <listitem>
               <para>
-                <link linkend="ndb-ndbindexoperation"><literal>NdbIndexOperation</literal></link>
+                <link linkend="ndb-tablespace"><literal>Tablespace</literal></link>
               </para>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-ndbscanoperation"><literal>NdbScanOperation</literal></link>
+                <link linkend="ndb-undofile"><literal>Undofile</literal></link>
+              </para>
+            </listitem>
 
-                <itemizedlist>
+          </itemizedlist>
+        </listitem>
 
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link>
+        <listitem>
+          <para>
+            <link linkend="ndb-recordspecification"><literal>RecordSpecification</literal></link>
+          </para>
+        </listitem>
 
-                      <itemizedlist>
+      </itemizedlist>
+    </listitem>
 
-                        <listitem>
-                          <para>
-                            <link linkend="ndb-indexbound"><literal>IndexBound</literal></link>
-                          </para>
-                        </listitem>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndberror"><literal>NdbError</literal></link>
+      </para>
+    </listitem>
 
-                      </itemizedlist>
-                    </para>
-                  </listitem>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbeventoperation"><literal>NdbEventOperation</literal></link>
+      </para>
+    </listitem>
 
-                  <listitem>
-                    <para>
-                      <link linkend="ndb-scanoptions"><literal>ScanOptions</literal></link>
-                    </para>
-                  </listitem>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbinterpretedcode"><literal>NdbInterpretedCode</literal></link>
+      </para>
+    </listitem>
 
-                </itemizedlist>
-              </para>
-            </listitem>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
+      </para>
 
-            <listitem>
-              <para>
-                <link linkend="ndb-getvaluespec"><literal>GetValueSpec</literal></link>
-              </para>
-            </listitem>
+      <itemizedlist>
 
+        <listitem>
+          <para>
+            <link linkend="ndb-ndbindexoperation"><literal>NdbIndexOperation</literal></link>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <link linkend="ndb-ndbscanoperation"><literal>NdbScanOperation</literal></link>
+          </para>
+
+          <itemizedlist>
+
             <listitem>
               <para>
-                <link linkend="ndb-setvaluespec"><literal>SetValueSpec</literal></link>
+                <link linkend="ndb-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link>
               </para>
+
+              <itemizedlist>
+
+                <listitem>
+                  <para>
+                    <link linkend="ndb-indexbound"><literal>IndexBound</literal></link>
+                  </para>
+                </listitem>
+
+              </itemizedlist>
             </listitem>
 
             <listitem>
               <para>
-                <link linkend="ndb-operationoptions"><literal>OperationOptions</literal></link>
+                <link linkend="ndb-scanoptions"><literal>ScanOptions</literal></link>
               </para>
             </listitem>
 
           </itemizedlist>
-        </para>
-      </listitem>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            <link linkend="ndb-getvaluespec"><literal>GetValueSpec</literal></link>
+          </para>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            <link linkend="ndb-setvaluespec"><literal>SetValueSpec</literal></link>
+          </para>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbscanfilter"><literal>NdbScanFilter</literal></link>
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            <link linkend="ndb-operationoptions"><literal>OperationOptions</literal></link>
+          </para>
+        </listitem>
 
-      <listitem>
-        <para>
-          <link linkend="ndb-ndbtransaction"><literal>NdbTransaction</literal></link>
-        </para>
-      </listitem>
+      </itemizedlist>
+    </listitem>
 
-    </itemizedlist>
-  </para>
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
+      </para>
+    </listitem>
 
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbscanfilter"><literal>NdbScanFilter</literal></link>
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <link linkend="ndb-ndbtransaction"><literal>NdbTransaction</literal></link>
+      </para>
+    </listitem>
+
+  </itemizedlist>
+
 </section>


Modified: trunk/ndbapi/ndb-index.xml
===================================================================
--- trunk/ndbapi/ndb-index.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-index.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 20, Lines Added: 243, Lines Deleted: 239; 19521 bytes

@@ -62,100 +62,102 @@
     <para>
       The following table lists the public methods of
       <literal>Index</literal> and the purpose or use of each method:
-
-      <informaltable>
-        <tgroup cols="2">
-          <colspec colwidth="35*"/>
-          <colspec colwidth="65*"/>
-          <thead>
-            <row>
-              <entry>Method</entry>
-              <entry>Purpose / Use</entry>
-            </row>
-          </thead>
-          <tbody>
-            <row>
-              <entry><literal><link linkend="ndb-index-constructor">Index()</link></literal></entry>
-              <entry>Class constructor</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-constructor">~Index()</link></literal></entry>
-              <entry>Destructor</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getname">getName()</link></literal></entry>
-              <entry>Gets the name of the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-gettable">getTable()</link></literal></entry>
-              <entry>Gets the name of the table being indexed</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getnoofcolumns">getNoOfColumns()</link></literal></entry>
-              <entry>Gets the number of columns belonging to the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getcolumn">getColumn()</link></literal></entry>
-              <entry>Gets a column making up (part of) the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-gettype">getType()</link></literal></entry>
-              <entry>Gets the index type</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getlogging">getLogging()</link></literal></entry>
-              <entry>Checks whether the index is logged to disk</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getobjectstatus">getObjectStatus()</link></literal></entry>
-              <entry>Gets the index object status</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getobjectversion">getObjectVersion()</link></literal></entry>
-              <entry>Gets the index object status</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-getobjectid">getObjectId()</link></literal></entry>
-              <entry>Gets the index object ID</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-setname">setName()</link></literal></entry>
-              <entry>Sets the name of the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-settable">setTable()</link></literal></entry>
-              <entry>Sets the name of the table to be indexed</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-addcolumn">addColumn()</link></literal></entry>
-              <entry>Adds a <literal>Column</literal> object to the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-addcolumnname">addColumnName()</link></literal></entry>
-              <entry>Adds a column by name to the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-addcolumnnames">addColumnNames()</link></literal></entry>
-              <entry>Adds multiple columns by name to the index</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-settype">setType()</link></literal></entry>
-              <entry>Set the index type</entry>
-            </row>
-            <row>
-              <entry><literal><link linkend="ndb-index-setlogging">setLogging()</link></literal></entry>
-              <entry>Enable/disable logging of the index to disk</entry>
-            </row>
-          </tbody>
-        </tgroup>
-      </informaltable>
-
-      For detailed descriptions, signatures, and examples of use for
-      each of these methods, see <xref linkend="ndb-index-methods"/>.
     </para>
 
   </formalpara>
 
+  <informaltable>
+    <tgroup cols="2">
+      <colspec colwidth="35*"/>
+      <colspec colwidth="65*"/>
+      <thead>
+        <row>
+          <entry>Method</entry>
+          <entry>Purpose / Use</entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry><literal><link linkend="ndb-index-constructor">Index()</link></literal></entry>
+          <entry>Class constructor</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-constructor">~Index()</link></literal></entry>
+          <entry>Destructor</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getname">getName()</link></literal></entry>
+          <entry>Gets the name of the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-gettable">getTable()</link></literal></entry>
+          <entry>Gets the name of the table being indexed</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getnoofcolumns">getNoOfColumns()</link></literal></entry>
+          <entry>Gets the number of columns belonging to the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getcolumn">getColumn()</link></literal></entry>
+          <entry>Gets a column making up (part of) the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-gettype">getType()</link></literal></entry>
+          <entry>Gets the index type</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getlogging">getLogging()</link></literal></entry>
+          <entry>Checks whether the index is logged to disk</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getobjectstatus">getObjectStatus()</link></literal></entry>
+          <entry>Gets the index object status</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getobjectversion">getObjectVersion()</link></literal></entry>
+          <entry>Gets the index object status</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-getobjectid">getObjectId()</link></literal></entry>
+          <entry>Gets the index object ID</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-setname">setName()</link></literal></entry>
+          <entry>Sets the name of the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-settable">setTable()</link></literal></entry>
+          <entry>Sets the name of the table to be indexed</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-addcolumn">addColumn()</link></literal></entry>
+          <entry>Adds a <literal>Column</literal> object to the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-addcolumnname">addColumnName()</link></literal></entry>
+          <entry>Adds a column by name to the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-addcolumnnames">addColumnNames()</link></literal></entry>
+          <entry>Adds multiple columns by name to the index</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-settype">setType()</link></literal></entry>
+          <entry>Set the index type</entry>
+        </row>
+        <row>
+          <entry><literal><link linkend="ndb-index-setlogging">setLogging()</link></literal></entry>
+          <entry>Enable/disable logging of the index to disk</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>
+    For detailed descriptions, signatures, and examples of use for each
+    of these methods, see <xref linkend="ndb-index-methods"/>.
+  </para>
+
   <formalpara>
 
     <title>Types</title>

@@ -175,20 +177,20 @@
     <para>
       This diagram shows all the available methods and enumerated types
       of the <literal>Index</literal> class:
-
-      <mediaobject>
-        <imageobject>
-          <imagedata contentwidth="586" contentdepth="534" fileref="images/published/NdbDictionary-Object-Index-class.png" format="PNG"/>
-        </imageobject>
-        <textobject>
-          <phrase lang="en">Public methods and types of the
-          <literal>Index</literal> class.</phrase>
-        </textobject>
-      </mediaobject>
     </para>
 
   </formalpara>
 
+  <mediaobject>
+    <imageobject>
+      <imagedata contentwidth="586" contentdepth="534" fileref="images/published/NdbDictionary-Object-Index-class.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase lang="en">Public methods and types of the
+      <literal>Index</literal> class.</phrase>
+    </textobject>
+  </mediaobject>
+
   <section id="ndb-index-type">
 
     <title>The <literal>Index::Type</literal> Type</title>

@@ -228,36 +230,39 @@
       <title>Enumeration values</title>
 
       <para>
-        <informaltable>
-          <tgroup cols="2">
-            <colspec colwidth="35*"/>
-            <colspec colwidth="65*"/>
-            <thead>
-              <row>
-                <entry>Value</entry>
-                <entry>Description</entry>
-              </row>
-            </thead>
-            <tbody>
-              <row>
-                <entry><literal>Undefined</literal></entry>
-                <entry>Undefined object type (initial/default value)</entry>
-              </row>
-              <row>
-                <entry><literal>UniqueHashIndex</literal></entry>
-                <entry>Unique unordered hash index (only index type currently supported)</entry>
-              </row>
-              <row>
-                <entry><literal>OrderedIndex</literal></entry>
-                <entry>Nonunique, ordered index</entry>
-              </row>
-            </tbody>
-          </tgroup>
-        </informaltable>
+        Possible values are shown, along with descriptions, in the
+        following table:
       </para>
 
     </formalpara>
 
+    <informaltable>
+      <tgroup cols="2">
+        <colspec colwidth="35*"/>
+        <colspec colwidth="65*"/>
+        <thead>
+          <row>
+            <entry>Value</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry><literal>Undefined</literal></entry>
+            <entry>Undefined object type (initial/default value)</entry>
+          </row>
+          <row>
+            <entry><literal>UniqueHashIndex</literal></entry>
+            <entry>Unique unordered hash index (only index type currently supported)</entry>
+          </row>
+          <row>
+            <entry><literal>OrderedIndex</literal></entry>
+            <entry>Nonunique, ordered index</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+
   </section>
 
   <section id="ndb-index-methods">

@@ -429,17 +434,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -503,17 +508,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -578,17 +583,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -658,17 +663,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -732,17 +737,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -814,39 +819,38 @@
 
         <para>
           A Boolean value:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                <literal>true</literal>: The index is being logged to
-                disk.
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                <literal>false</literal>: The index is not being logged.
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            <literal>true</literal>: The index is being logged to disk.
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            <literal>false</literal>: The index is not being logged.
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -910,17 +914,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -983,17 +987,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1056,17 +1060,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1138,17 +1142,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1213,17 +1217,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1295,17 +1299,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1372,17 +1376,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1440,29 +1444,29 @@
         <title>Parameters</title>
 
         <para>
-          This method takes two parameters:
+          This method takes two parameters, listed here:
+        </para>
 
-          <itemizedlist>
+      </formalpara>
 
-            <listitem>
-              <para>
-                The number of columns/names
-                <replaceable>noOfNames</replaceable> to be added to the
-                index.
-              </para>
-            </listitem>
+      <itemizedlist>
 
-            <listitem>
-              <para>
-                The <replaceable>names</replaceable> to be added (as a
-                pointer to a pointer).
-              </para>
-            </listitem>
+        <listitem>
+          <para>
+            The number of columns and names
+            <replaceable>noOfNames</replaceable> to be added to the
+            index.
+          </para>
+        </listitem>
 
-          </itemizedlist>
-        </para>
+        <listitem>
+          <para>
+            The <replaceable>names</replaceable> to be added (as a
+            pointer to a pointer).
+          </para>
+        </listitem>
 
-      </formalpara>
+      </itemizedlist>
 
       <formalpara>
 

@@ -1475,17 +1479,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1549,17 +1553,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>

@@ -1619,17 +1623,17 @@
       </formalpara>
 
 <!--
-            <formalpara>
+      <formalpara>
 
-              <title>Example</title>
+        <title>Example</title>
 
-              <para>
+        <para>
 <programlisting>
 [<emphasis>To be supplied...</emphasis>]
 </programlisting>
-              </para>
+        </para>
 
-            </formalpara>
+      </formalpara>
 -->
 
     </section>


Modified: trunk/ndbapi/ndb-indexbound.xml
===================================================================
--- trunk/ndbapi/ndb-indexbound.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-indexbound.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 1, Lines Added: 62, Lines Deleted: 63; 5597 bytes

@@ -35,73 +35,72 @@
 
     <para>
       These are shown in the following table:
-
-      <informaltable>
-        <tgroup cols="3">
-          <colspec colwidth="25*"/>
-          <colspec colwidth="25*"/>
-          <colspec colwidth="50*"/>
-          <thead>
-            <row>
-              <entry>Name</entry>
-              <entry>Type</entry>
-              <entry>Description</entry>
-            </row>
-          </thead>
-          <tbody>
-            <row>
-              <entry><literal>low_key</literal></entry>
-              <entry><literal>const char*</literal></entry>
-              <entry>Row containing lower bound for scan (or <literal>NULL</literal> for scan
-                from the start).</entry>
-            </row>
-            <row>
-              <entry><literal>low_key_count</literal></entry>
-              <entry><literal>Uint32</literal></entry>
-              <entry>Number of columns in lower bound (for bounding by partial prefix).</entry>
-            </row>
-            <row>
-              <entry><literal>low_inclusive</literal></entry>
-              <entry><literal>bool</literal></entry>
-              <entry>True for <literal>&lt;=</literal> relation, false for
-                <literal>&lt;</literal>.</entry>
-            </row>
-            <row>
-              <entry><literal>high_key</literal></entry>
-              <entry><literal>const char*</literal></entry>
-              <entry>Row containing upper bound for scan (or <literal>NULL</literal> for scan
-                to the end).</entry>
-            </row>
-            <row>
-              <entry><literal>high_key_count</literal></entry>
-              <entry><literal>Uint32</literal></entry>
-              <entry>Number of columns in upper bound (for bounding by partial prefix).</entry>
-            </row>
-            <row>
-              <entry><literal>high_inclusive</literal></entry>
-              <entry><literal>bool</literal></entry>
-              <entry>True for <literal>&gt;=</literal> relation, false for
-                <literal>&gt;</literal>.</entry>
-            </row>
-            <row>
-              <entry><literal>range_no</literal></entry>
-              <entry><literal>Uint32</literal></entry>
-              <entry>Value to identify this bound; may be read using the
-                <literal>get_range_no()</literal> method (see
-                <xref linkend="ndb-ndbindexscanoperation-get-range-no"/>).
-                This value must be less than 8192 (set to zero if it is
-                not being used). For ordered scans,
-                <literal>range_no</literal> must be strictly increasing
-                for each range, or else the result set will not be
-                sorted correctly.</entry>
-            </row>
-          </tbody>
-        </tgroup>
-      </informaltable>
     </para>
 
   </formalpara>
 
+  <informaltable>
+    <tgroup cols="3">
+      <colspec colwidth="25*"/>
+      <colspec colwidth="25*"/>
+      <colspec colwidth="50*"/>
+      <thead>
+        <row>
+          <entry>Name</entry>
+          <entry>Type</entry>
+          <entry>Description</entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry><literal>low_key</literal></entry>
+          <entry><literal>const char*</literal></entry>
+          <entry>Row containing lower bound for scan (or <literal>NULL</literal> for scan
+            from the start).</entry>
+        </row>
+        <row>
+          <entry><literal>low_key_count</literal></entry>
+          <entry><literal>Uint32</literal></entry>
+          <entry>Number of columns in lower bound (for bounding by partial prefix).</entry>
+        </row>
+        <row>
+          <entry><literal>low_inclusive</literal></entry>
+          <entry><literal>bool</literal></entry>
+          <entry>True for <literal>&lt;=</literal> relation, false for
+            <literal>&lt;</literal>.</entry>
+        </row>
+        <row>
+          <entry><literal>high_key</literal></entry>
+          <entry><literal>const char*</literal></entry>
+          <entry>Row containing upper bound for scan (or <literal>NULL</literal> for scan
+            to the end).</entry>
+        </row>
+        <row>
+          <entry><literal>high_key_count</literal></entry>
+          <entry><literal>Uint32</literal></entry>
+          <entry>Number of columns in upper bound (for bounding by partial prefix).</entry>
+        </row>
+        <row>
+          <entry><literal>high_inclusive</literal></entry>
+          <entry><literal>bool</literal></entry>
+          <entry>True for <literal>&gt;=</literal> relation, false for
+            <literal>&gt;</literal>.</entry>
+        </row>
+        <row>
+          <entry><literal>range_no</literal></entry>
+          <entry><literal>Uint32</literal></entry>
+          <entry>Value to identify this bound; may be read using the
+            <literal>get_range_no()</literal> method (see
+            <xref linkend="ndb-ndbindexscanoperation-get-range-no"/>).
+            This value must be less than 8192 (set to zero if it is not
+            being used). For ordered scans, <literal>range_no</literal>
+            must be strictly increasing for each range, or else the
+            result set will not be sorted correctly.</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
   <para>
     For more information, see <xref linkend="ndb-ndbrecord"/>.
   </para>


Modified: trunk/ndbapi/ndb-template.xml
===================================================================
--- trunk/ndbapi/ndb-template.xml	2010-10-05 08:31:26 UTC (rev 22977)
+++ trunk/ndbapi/ndb-template.xml	2010-10-05 10:40:42 UTC (rev 22978)
Changed blocks: 3, Lines Added: 33, Lines Deleted: 28; 2483 bytes

@@ -118,20 +118,20 @@
     <para>
       This diagram shows all the available methods and enumerated types
       of the <literal>...</literal> class:
-
-      <mediaobject>
-        <imageobject>
-          <imagedata fileref="images/published/___-class.png" format="PNG"/>
-        </imageobject>
-        <textobject>
-          <phrase lang="en">Public methods and enumerated types of the
-          <literal>...</literal> class.</phrase>
-        </textobject>
-      </mediaobject>
     </para>
 
   </formalpara>
 
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="images/published/___-class.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase lang="en">Public methods and enumerated types of the
+      <literal>...</literal> class.</phrase>
+    </textobject>
+  </mediaobject>
+
   <section id="ndb-___-types">
 
     <title><literal>...</literal> Types</title>

@@ -162,28 +162,31 @@
         <title>Enumeration values</title>
 
         <para>
-          <informaltable>
-            <tgroup cols="2">
-              <colspec colwidth="35*"/>
-              <colspec colwidth="65*"/>
-              <thead>
-                <row>
-                  <entry>Value</entry>
-                  <entry>Description</entry>
-                </row>
-              </thead>
-              <tbody>
-                <row>
-                  <entry><literal></literal></entry>
-                  <entry></entry>
-                </row>
-              </tbody>
-            </tgroup>
-          </informaltable>
+          Possible values are shown, along with descriptions, in the
+          following table:
         </para>
 
       </formalpara>
 
+      <informaltable>
+        <tgroup cols="2">
+          <colspec colwidth="35*"/>
+          <colspec colwidth="65*"/>
+          <thead>
+            <row>
+              <entry>Value</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal></literal></entry>
+              <entry></entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
     </section>
 
   </section>

@@ -192,6 +195,8 @@
 
     <title><literal>...</literal> Class Members</title>
 
+    <para></para>
+
   </section>
 
 </section>


Thread
svn commit - mysqldoc@docsrva: r22978 - trunk/ndbapijon.stephens5 Oct