List:Commits« Previous MessageNext Message »
From:jon.stephens Date:November 27 2010 12:38pm
Subject:svn commit - mysqldoc@docsrva: r24059 - in trunk: dynamic-docs/changelog ndbapi
View as plain text  
Author: jstephens
Date: 2010-11-27 13:37:59 +0100 (Sat, 27 Nov 2010)
New Revision: 24059

Log:

Added MGM API auto-link markup to Cluster API docs, changelogs

Added missing ndb_mgm_get_status2() MGM API function



Modified:
   trunk/dynamic-docs/changelog/mysqld-1.xml
   trunk/dynamic-docs/changelog/mysqld-2.xml
   trunk/dynamic-docs/changelog/mysqld.xml
   trunk/ndbapi/mgm-api.xml
   trunk/ndbapi/overview.xml


Modified: trunk/dynamic-docs/changelog/mysqld-1.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld-1.xml	2010-11-27 10:45:18 UTC (rev 24058)
+++ trunk/dynamic-docs/changelog/mysqld-1.xml	2010-11-27 12:37:59 UTC (rev 24059)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 8; 1806 bytes

@@ -13190,7 +13190,7 @@
       <highlight type="clusterapi"/>
       <manual type="ndb_mgmd"/>
       <manual type="upgrades"/>
-      <manual type="ndb_mgm_get_configuration()"/>
+      <manual type="ndb_mgm_get_configuration_nodeid()"/>
     </tags>
 
     <bugs>

@@ -13224,7 +13224,8 @@
 
         <listitem>
           <para>
-            The MGM API <literal>ndb_mgm_get_configuration()</literal>
+            The MGM API
+            <literal role="mgmapi">ndb_mgm_get_configuration_nodeid()</literal>
             function failed to obtain configuration data.
           </para>
         </listitem>

@@ -21148,8 +21149,9 @@
     <message>
 
       <para>
-        The MGM API function <literal>ndb_mgm_listen_event()</literal>
-        ignored bind addresses.
+        The MGM API function
+        <literal role="mgmapi">ndb_mgm_listen_event()</literal> ignored
+        bind addresses.
       </para>
 
       <para>

@@ -21292,10 +21294,10 @@
           <listitem>
             <para>
               A new function
-              <literal>ndb_mgm_set_ignore_sigpipe()</literal> has been
-              added to the MGM API. This function makes it possible to
-              bypass the <literal>SIGPIPE</literal> handler provded by
-              the MGM API.
+              <literal role="mgmapi">ndb_mgm_set_ignore_sigpipe()</literal>
+              has been added to the MGM API. This function makes it
+              possible to bypass the <literal>SIGPIPE</literal> handler
+              provded by the MGM API.
             </para>
           </listitem>
 


Modified: trunk/dynamic-docs/changelog/mysqld-2.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld-2.xml	2010-11-27 10:45:18 UTC (rev 24058)
+++ trunk/dynamic-docs/changelog/mysqld-2.xml	2010-11-27 12:37:59 UTC (rev 24059)
Changed blocks: 5, Lines Added: 24, Lines Deleted: 20; 3609 bytes

@@ -65,7 +65,7 @@
       <para>
         It was not possible to obtain the status of nodes accurately
         after stopping a data node using
-        <literal>ndb_mgm_stop()</literal>.
+        <literal role="mgmapi">ndb_mgm_stop()</literal>.
       </para>
 
     </message>

@@ -2647,11 +2647,13 @@
     <message>
 
       <para>
-        The MGM API functions <literal>ndb_mgm_stop()</literal> and
-        <literal>ndb_mgm_restart()</literal> set the error code and
-        message without first checking whether the management server
-        handle was <literal>NULL</literal>, which could lead to fatal
-        errors in MGM API applications that depended on these functions.
+        The MGM API functions
+        <literal role="mgmapi">ndb_mgm_stop()</literal> and
+        <literal role="mgmapi">ndb_mgm_restart()</literal> set the error
+        code and message without first checking whether the management
+        server handle was <literal>NULL</literal>, which could lead to
+        fatal errors in MGM API applications that depended on these
+        functions.
       </para>
 
     </message>

@@ -2678,13 +2680,15 @@
     <message>
 
       <para>
-        The MGM API function <literal>ndb_mgm_get_version()</literal>
-        did not set the error message before returning with an error.
-        With this fix, it is now possible to call
-        <literal>ndb_mgm_get_latest_error()</literal> after a failed
-        call to this function such that
-        <literal>ndb_mgm_get_latest_error()</literal> returns an error
-        number and error message, as expected of MGM API calls.
+        The MGM API function
+        <literal role="mgmapi">ndb_mgm_get_version()</literal> did not
+        set the error message before returning with an error. With this
+        fix, it is now possible to call
+        <literal role="mgmapi">ndb_mgm_get_latest_error()</literal>
+        after a failed call to this function such that
+        <literal role="mgmapi">ndb_mgm_get_latest_error()</literal>
+        returns an error number and error message, as expected of MGM
+        API calls.
       </para>
 
     </message>

@@ -2951,11 +2955,10 @@
 
       <para>
         The MGM API function
-        <link linkend="mgm-ndb-mgm-get-version"><literal>ndb_mgm_get_version()</literal></link>,
-        which was previously internal, has now been moved to the public
-        API. This function can be used to get <literal>NDB</literal>
-        storage engine and other version information from the management
-        server.
+        <literal role="mgmapi">ndb_mgm_get_version()</literal>, which
+        was previously internal, has now been moved to the public API.
+        This function can be used to get <literal>NDB</literal> storage
+        engine and other version information from the management server.
       </para>
 
     </message>

@@ -4595,8 +4598,9 @@
         waiting for an event on one or more sockets returned error -1
         with <literal>errno</literal> set to
         <errorcode>EINTR</errorcode>. This caused problems with MGM API
-        functions such as <literal>ndb_mgm_logevent_get_next()</literal>
-        and <literal>ndb_mgm_get_status2()</literal>.
+        functions such as
+        <literal role="mgmapi">ndb_logevent_get_next()</literal> and
+        <literal role="mgmapi">ndb_mgm_get_status2()</literal>.
       </para>
 
       <para>


Modified: trunk/dynamic-docs/changelog/mysqld.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld.xml	2010-11-27 10:45:18 UTC (rev 24058)
+++ trunk/dynamic-docs/changelog/mysqld.xml	2010-11-27 12:37:59 UTC (rev 24059)
Changed blocks: 5, Lines Added: 14, Lines Deleted: 23; 2750 bytes

@@ -14130,15 +14130,11 @@
     <message>
 
       <para>
-        A new <literal>ndb_mgm_get_clusterlog_loglevel()</literal>
+        A new
+        <literal role="mgmapi">ndb_mgm_get_clusterlog_loglevel()</literal>
         function was added to the MGM API.
       </para>
 
-      <para>
-        For more information, see
-        <xref linkend="mgm-ndb-mgm-get-clusterlog-loglevel"/>.
-      </para>
-
     </message>
 
   </logentry>

@@ -16661,19 +16657,13 @@
 
       <para>
         The MGM API now supports explicit setting of network timeouts
-        using the <literal>ndb_mgm_set_timeout()</literal> function. A
-        utility function
-        <literal>ndb_mgm_number_of_mgmd_in_connect_string()</literal> is
-        also implemented to facilitate calculation of timeouts based on
-        the number of management servers in the cluster.
+        using the <literal role="mgmapi">ndb_mgm_set_timeout()</literal>
+        function. A utility function
+        <literal role="mgmapi">ndb_mgm_number_of_mgmd_in_connect_string()</literal>
+        is also implemented to facilitate calculation of timeouts based
+        on the number of management servers in the cluster.
       </para>
 
-      <para>
-        For more information, see
-        <xref linkend="mgm-ndb-mgm-set-timeout"/>, and
-        <xref linkend="mgm-ndb-mgm-number-of-mgmd-in-connect-string"/>.
-      </para>
-
     </message>
 
   </logentry>

@@ -18756,7 +18746,8 @@
 
       <para>
         Invoking the MGM API function
-        <literal>ndb_mgm_listen_event()</literal> caused a memory leak.
+        <literal role="mgmapi">ndb_mgm_listen_event()</literal> caused a
+        memory leak.
       </para>
 
     </message>

@@ -53312,9 +53303,8 @@
 
       <para>
         You can now use the
-        <literal>ndb_mgm_check_connection()</literal> function to
-        determine whether a management server is running. See
-        <xref linkend="mgm-ndb-mgm-check-connection"/>.
+        <literal role="mgmapi">ndb_mgm_check_connection()</literal>
+        function to determine whether a management server is running.
       </para>
 
     </message>

@@ -84384,8 +84374,9 @@
 
       <para>
         The timeout set using the MGM API
-        <literal>ndb_mgm_set_timeout()</literal> function was
-        incorrectly interpreted as seconds rather than as milliseconds.
+        <literal role="mgmapi">ndb_mgm_set_timeout()</literal> function
+        was incorrectly interpreted as seconds rather than as
+        milliseconds.
       </para>
 
     </message>


Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml	2010-11-27 10:45:18 UTC (rev 24058)
+++ trunk/ndbapi/mgm-api.xml	2010-11-27 12:37:59 UTC (rev 24059)
Changed blocks: 39, Lines Added: 243, Lines Deleted: 124; 25299 bytes

@@ -26,11 +26,13 @@
       <primary>NdbMgmHandle</primary>
     </indexterm>
 
-    <para>
+    <para id="mgm-ndbmgmhandle">
       Each MGM API function needs a management server handle of type
       <literal>NdbMgmHandle</literal>. This handle is created by calling
-      the function <literal>ndb_mgm_create_handle()</literal> and freed
-      by calling <literal>ndb_mgm_destroy_handle()</literal>.
+      the function
+      <literal role="mgmapi">ndb_mgm_create_handle()</literal> and freed
+      by calling
+      <literal role="mgmapi">ndb_mgm_destroy_handle()</literal>.
     </para>
 
     <para>

@@ -81,8 +83,8 @@
     <para>
       Error conditions can be identified by using the appropriate
       error-reporting functions
-      <literal>ndb_mgm_get_latest_error()</literal> and
-      <literal>ndb_mgm_error()</literal>.
+      <literal role="mgmapi">ndb_mgm_get_latest_error()</literal> and
+      <literal role="mgmapi">ndb_mgm_error()</literal>.
     </para>
 
     <para>

@@ -117,18 +119,22 @@
         occasions report on various log events that occur in the
         cluster. These log events are written to the cluster log.
         Optionally an MGM API client may listen to these events using
-        the method <literal>ndb_mgm_listen_event()</literal>. Each log
-        event belongs to a category
-        <literal>ndb_mgm_event_category</literal>) and has a severity
-        <literal>ndb_mgm_event_severity</literal> associated with it.
-        Each log event also has a level (0-15) associated with it.
+        the method
+        <literal role="mgmapi">ndb_mgm_listen_event()</literal>. Each
+        log event belongs to a category
+        <literal role="mgmapi">ndb_mgm_event_category</literal>) and has
+        a severity
+        <literal role="mgmapi">ndb_mgm_event_severity</literal>
+        associated with it. Each log event also has a level (0-15)
+        associated with it.
       </para>
 
       <para>
         Which log events that come out is controlled with
-        <literal>ndb_mgm_listen_event()</literal>,
-        <literal>ndb_mgm_set_clusterlog_loglevel()</literal>, and
-        <literal>ndb_mgm_set_clusterlog_severity_filter()</literal>.
+        <literal role="mgmapi">ndb_mgm_listen_event()</literal>,
+        <literal role="mgmapi">ndb_mgm_set_clusterlog_loglevel()</literal>,
+        and
+        <literal role="mgmapi">ndb_mgm_set_clusterlog_severity_filter()</literal>.
       </para>
 
       <para>

@@ -156,24 +162,25 @@
         <listitem>
           <para>
             Create an <literal>NdbLogEventHandle</literal> using
-            <literal>ndb_mgm_create_logevent_handle()</literal>.
+            <literal role="mgmapi">ndb_mgm_create_logevent_handle()</literal>.
           </para>
         </listitem>
 
         <listitem>
           <para>
             Wait for and store log events using
-            <literal>ndb_logevent_get_next()</literal>.
+            <literal role="mgmapi">ndb_logevent_get_next()</literal>.
           </para>
         </listitem>
 
         <listitem>
           <para>
             The log event data is available in the structure
-            <literal>ndb_logevent</literal>. The data which is specific
-            to a particular event is stored in a union between
-            structures; use <literal>ndb_logevent::type</literal> to
-            decide which structure is valid.
+            <literal role="mgmapi">ndb_logevent</literal>. The data
+            which is specific to a particular event is stored in a union
+            between structures; use
+            <literal>ndb_logevent::type</literal> to decide which
+            structure is valid.
           </para>
         </listitem>
 

@@ -944,11 +951,9 @@
 
           <para>
             An error code corresponding to an
-            <literal>ndb_mgm_error</literal> value; see
-            <xref linkend="mgm-ndb-mgm-error"/>. You can obtain the
-            related error message using
-            <literal>ndb_mgm_get_latest_error_msg()</literal>; see
-            <xref linkend="mgm-ndb-mgm-get-latest-error-msg"/>.
+            <literal role="mgmapi">ndb_mgm_error</literal> value. You
+            can obtain the related error message using
+            <literal role="mgmapi">ndb_mgm_get_latest_error_msg()</literal>.
           </para>
 
         </formalpara>

@@ -1020,9 +1025,7 @@
           <para>
             The error message text. More specific information can be
             obtained using
-            <literal>ndb_mgm_get_latest_error_desc()</literal>; see
-            <xref linkend="mgm-ndb-mgm-get-latest-error-desc"/>, for
-            details.
+            <literal role="mgmapi">ndb_mgm_get_latest_error_desc()</literal>-
           </para>
 
         </formalpara>

@@ -1403,10 +1406,11 @@
             creating the management server handle and before using the
             handle to connect to the management server. (In other words,
             call this function after using
-            <literal>ndb_mgm_create_handle()</literal> but before
-            calling <literal>ndb_mgm_connect()</literal>, which causes
-            the MGM API&apos;s <literal>SIGPIPE</literal> handler to be
-            installed unless overridden.)
+            <literal role="mgmapi">ndb_mgm_create_handle()</literal> but
+            before calling
+            <literal role="mgmapi">ndb_mgm_connect()</literal>, which
+            causes the MGM API&apos;s <literal>SIGPIPE</literal> handler
+            to be installed unless overridden.)
           </para>
 
         </formalpara>

@@ -1605,10 +1609,11 @@
         <note>
           <para>
             This function returns the default connectstring if no call
-            to <literal>ndb_mgm_set_connectstring()</literal> has been
-            performed. In addition, the returned connectstring may be
-            formatted slightly differently than the original in that it
-            may contain specifiers not present in the original.
+            to
+            <literal role="mgmapi">ndb_mgm_set_connectstring()</literal>
+            has been performed. In addition, the returned connectstring
+            may be formatted slightly differently than the original in
+            that it may contain specifiers not present in the original.
           </para>
 
           <para>

@@ -1986,7 +1991,7 @@
 
           <para>
             <literal>ndb_mgm_get_version()</literal> returns an integer:
-            0 on success, and any nonzero value indicating an error.
+            0 on success; any nonzero value indicates an error.
           </para>
 
         </formalpara>

@@ -2030,10 +2035,8 @@
             This function does not determine whether or not there is a
             <quote>live</quote> management server at the other end of
             the connection. Beginning with MySQL 5.1.17, you can use
-            <literal>ndb_mgm_check_connection()</literal> to accomplish
-            that task. See
-            <xref linkend="mgm-ndb-mgm-check-connection"/>, for more
-            information.
+            <literal role="mgmapi">ndb_mgm_check_connection()</literal>
+            to accomplish that task.
           </para>
         </note>
 

@@ -2202,7 +2205,7 @@
             This is a convenience function which provides an easy way to
             determine the number of management servers referenced in a
             connectstring as set using
-            <literal>ndb_mgm_set_connectstring()</literal>.
+            <literal role="mgmapi">ndb_mgm_set_connectstring()</literal>.
           </para>
 
         </formalpara>

@@ -2422,8 +2425,7 @@
 
           <para>
             <literal>ndb_mgm_set_connectstring()</literal> takes two
-            parameters: <xref linkend="mgm-ndb-mgm-get-connectstring"/>
-            also uses this format for connectstrings.
+            parameters:
           </para>
 
         </formalpara>

@@ -2448,10 +2450,15 @@
 </programlisting>
 
             <para>
-              (It is possible to establish connections with multiple
-              management servers using a single connectstring.)
+              <literal role="mgmapi">ndb_mgm_get_connectstring()</literal>
+              also uses this format for connectstrings.
             </para>
 
+            <para>
+              It is possible to establish connections with multiple
+              management servers using a single connectstring.
+            </para>
+
 <programlisting>
 <replaceable>nodeid-specification</replaceable> := nodeid=<replaceable>id</replaceable>
 <replaceable>host-specification</replaceable> := <replaceable>host</replaceable>[:<replaceable>port</replaceable>]

@@ -2959,10 +2966,9 @@
           <title>Return value</title>
 
           <para>
-            A pointer to an <literal>ndb_mgm_cluster_state</literal>
-            data structure. See
-            <xref linkend="mgm-ndb-mgm-cluster-state"/>, for more
-            information.
+            A pointer to an
+            <literal role="mgmapi">ndb_mgm_cluster_state</literal> data
+            structure.
           </para>
 
         </formalpara>

@@ -2983,6 +2989,109 @@
 
       </section>
 
+      <section id="mgm-ndb-mgm-get-status2">
+
+        <title><literal>ndb_mgm_get_status2()</literal></title>
+
+        <indexterm>
+          <primary>ndb_mgm_get_status2() function (MGM API)</primary>
+        </indexterm>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This function is similar to
+            <literal role="mgmapi">ndb_mgm_get_status()</literal>, in
+            that it is used to obtain the status of the nodes in a MySQL
+            Cluster. However, <literal>ndb_mgm_get_status2()</literal>
+            allows one to specify the type or types of nodes
+            (<literal role="mgmapi">ndb_mgm_node_type</literal>) to be
+            checked.
+          </para>
+
+        </formalpara>
+
+        <note>
+          <para>
+            The caller must free the pointer returned by this function.
+          </para>
+        </note>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+struct ndb_mgm_cluster_state* ndb_mgm_get_status2
+    (
+      NdbMgmHandle <replaceable>handle</replaceable>,
+      const enum ndb_mgm_node_type <replaceable>types[]</replaceable>
+    )
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            This function takes two parameters:
+          </para>
+
+        </formalpara>
+
+        <itemizedlist>
+
+          <listitem>
+            <para>
+              A management server <replaceable>handle</replaceable>
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              A pointer to array of the node types to be checked. These
+              are <literal role="mgmapi">ndb_mgm_node_type</literal>
+              values. The array should be terminated by an element of
+              type <literal>NDB_MGM_NODE_TYPE_UNKNOWN</literal>.
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <formalpara>
+
+          <title>Return value</title>
+
+          <para>
+            A pointer to an
+            <literal role="mgmapi">ndb_mgm_cluster_state</literal> data
+            structure.
+          </para>
+
+        </formalpara>
+
+<!--
+          <formalpara>
+          
+          <title>Example</title>
+          
+          <para>
+          <programlisting>
+          [<emphasis>To be supplied...</emphasis>]
+          </programlisting>
+          </para>
+          
+          </formalpara>
+        -->
+
+      </section>
+
       <section id="mgm-ndb-mgm-dump-state">
 
         <title><literal>ndb_mgm_dump_state()</literal></title>

@@ -3096,10 +3205,9 @@
 
           <listitem>
             <para>
-              An <literal>ndb_mgm_reply</literal> which cntains a return
-              code along with a response or error message (see
-              <xref linkend="mgm-ndb-mgm-reply"/>, for more
-              information).
+              An <literal role="mgmapi">ndb_mgm_reply</literal>, which
+              contains a return code along with a response or error
+              message.
             </para>
           </listitem>
 

@@ -3179,7 +3287,7 @@
             <title>Starting Nodes</title>
 
             <para>
-              Use <literal>ndb_mgm_start()</literal>.
+              Use <literal role="mgmapi">ndb_mgm_start()</literal>.
             </para>
 
           </formalpara>

@@ -3191,9 +3299,12 @@
             <title>Stopping Nodes</title>
 
             <para>
-              Use <literal>ndb_mgm_stop()</literal>,
-              <literal>ndb_mgm_stop2()</literal>, or
-              <literal>ndb_mgm_stop3()</literal>.
+              Use <literal role="mgmapi">ndb_mgm_stop()</literal>,
+              <literal role="mgmapi">ndb_mgm_stop2()</literal>,
+              <literal role="mgmapi">ndb_mgm_stop3()</literal>, or
+              (beginning with MySQL Cluster NDB 7.0.19 and MySQL Cluster
+              NDB 7.1.8)
+              <literal role="mgmapi">ndb_mgm_stop4()</literal>.
             </para>
 
           </formalpara>

@@ -3205,9 +3316,12 @@
             <title>Restarting Nodes</title>
 
             <para>
-              Use <literal>ndb_mgm_restart()</literal>,
-              <literal>ndb_mgm_restart2()</literal>, or
-              <literal>ndb_mgm_restart3()</literal>.
+              Use <literal role="mgmapi">ndb_mgm_restart()</literal>,
+              <literal role="mgmapi">ndb_mgm_restart2()</literal>,
+              <literal role="mgmapi">ndb_mgm_restart3()</literal>, or
+              (beginning with MySQL Cluster NDB 7.0.19 and MySQL Cluster
+              NDB 7.1.8)
+              <literal role="mgmapi">ndb_mgm_restart4()</literal>.
             </para>
 
           </formalpara>

@@ -3359,10 +3473,9 @@
           <para>
             <literal>ndb_mgm_stop()</literal> takes 3 parameters:
             Calling this function is equivalent to calling
-            <literal>ndb_mgm_stop2(<replaceable>handle</replaceable>,
+            <literal role="mgmapi">ndb_mgm_stop2(<replaceable>handle</replaceable>,
             <replaceable>number</replaceable>,
-            <replaceable>list</replaceable>, 0)</literal>. See
-            <xref linkend="mgm-ndb-mgm-stop2"/>.
+            <replaceable>list</replaceable>, 0)</literal>.
           </para>
 
         </formalpara>

@@ -3432,9 +3545,10 @@
           <title>Description</title>
 
           <para>
-            Like <literal>ndb_mgm_stop()</literal>, this function stops
-            one or more data nodes. However, it offers the ability to
-            specify whether or not the nodes shut down gracefully.
+            Like <literal role="mgmapi">ndb_mgm_stop()</literal>, this
+            function stops one or more data nodes. However, it offers
+            the ability to specify whether or not the nodes shut down
+            gracefully.
           </para>
 
         </formalpara>

@@ -3542,13 +3656,14 @@
           <title>Description</title>
 
           <para>
-            Like <literal>ndb_mgm_stop()</literal> and
-            <literal>ndb_mgm_stop2()</literal>, this function stops one
-            or more data nodes. Like <literal>ndb_mgm_stop2()</literal>,
-            it offers the ability to specify whether the nodes should
-            shut down gracefully. In addition, it provides for a way to
-            check to see whether disconnection is required prior to
-            stopping a node.
+            Like <literal role="mgmapi">ndb_mgm_stop()</literal> and
+            <literal role="mgmapi">ndb_mgm_stop2()</literal>, this
+            function stops one or more data nodes. Like
+            <literal role="mgmapi">ndb_mgm_stop2()</literal>, it offers
+            the ability to specify whether the nodes should shut down
+            gracefully. In addition, it provides for a way to check to
+            see whether disconnection is required prior to stopping a
+            node.
           </para>
 
         </formalpara>

@@ -3671,13 +3786,14 @@
             Like the other
             <literal>ndb_mgm_stop<replaceable>*</replaceable>()</literal>
             functions, this function stops one or more data nodes. Like
-            <literal>ndb_mgm_stop2()</literal>, it offers the ability to
-            specify whether the nodes should shut down gracefully; like
-            <literal>ndb_mgm_stop3()</literal> it provides for a way to
-            check to see whether disconnection is required prior to
-            stopping a node. In addition, it is possible to force the
-            node to shut down even if this would cause the cluster to
-            become nonviable.
+            <literal role="mgmapi">ndb_mgm_stop2()</literal>, it offers
+            the ability to specify whether the nodes should shut down
+            gracefully; like
+            <literal role="mgmapi">ndb_mgm_stop3()</literal> it provides
+            for a way to check to see whether disconnection is required
+            prior to stopping a node. In addition, it is possible to
+            force the node to shut down even if this would cause the
+            cluster to become nonviable.
           </para>
 
         </formalpara>

@@ -3925,11 +4041,11 @@
           <title>Description</title>
 
           <para>
-            Like <literal>ndb_mgm_restart()</literal>, this function can
-            be used to restart one or more Cluster data nodes. However,
-            <literal>ndb_mgm_restart2()</literal> provides additional
-            restart options, including initial restart, waiting start,
-            and immediate (forced) restart.
+            Like <literal role="mgmapi">ndb_mgm_restart()</literal>,
+            this function can be used to restart one or more Cluster
+            data nodes. However, <literal>ndb_mgm_restart2()</literal>
+            provides additional restart options, including initial
+            restart, waiting start, and immediate (forced) restart.
           </para>
 
         </formalpara>

@@ -4053,12 +4169,13 @@
           <title>Description</title>
 
           <para>
-            Like <literal>ndb_mgm_restart2()</literal>, this function
-            can be used to cause an initial restart, waiting restart,
-            and immediate (forced) restart on one or more Cluster data
-            nodes. However, <literal>ndb_mgm_restart3()</literal>
-            provides the additional options of checking whether
-            disconnection is required prior to the restart.
+            Like <literal role="mgmapi">ndb_mgm_restart2()</literal>,
+            this function can be used to cause an initial restart,
+            waiting restart, and immediate (forced) restart on one or
+            more Cluster data nodes. However,
+            <literal>ndb_mgm_restart3()</literal> provides the
+            additional options of checking whether disconnection is
+            required prior to the restart.
           </para>
 
         </formalpara>

@@ -4197,14 +4314,15 @@
             Like the other
             <literal>ndb_mgm_restart<replaceable>*</replaceable>()</literal>
             functions, this function restarts one or more data nodes.
-            Like <literal>ndb_mgm_restart2()</literal>, it can be used
-            to cause an initial restart, waiting restart, and immediate
-            (forced) restart on one or more MySQL Cluster data nodes;
-            like <literal>ndb_mgm_stop3()</literal> it provides for a
-            way to check to see whether disconnection is required prior
-            to stopping a node. In addition, it is possible to force the
-            node to restart even if this would cause a restart of the
-            cluster.
+            Like <literal role="mgmapi">ndb_mgm_restart2()</literal>, it
+            can be used to cause an initial restart, waiting restart,
+            and immediate (forced) restart on one or more MySQL Cluster
+            data nodes; like
+            <literal role="mgmapi">ndb_mgm_stop3()</literal> it provides
+            for a way to check to see whether disconnection is required
+            prior to stopping a node. In addition, it is possible to
+            force the node to restart even if this would cause a restart
+            of the cluster.
           </para>
 
         </formalpara>

@@ -4619,9 +4737,9 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal> structure
-              for a reply message. See
-              <xref linkend="mgm-ndb-mgm-reply"/>.
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal> structure
+              for a reply message.
             </para>
           </listitem>
 

@@ -4673,7 +4791,7 @@
           <para>
             This function, added in MySQL 5.1.16, is used to obtain log
             category and level information. It replaces the older
-            <literal>ndb_mgm_get_loglevel_clusterlog()</literal>
+            <literal role="mgmapi">ndb_mgm_get_loglevel_clusterlog()</literal>
             function, which performed the same purpose, but was not
             thread-safe. (See later in this section for a brief
             description of the deprecated version of the function.)

@@ -4714,7 +4832,7 @@
           <listitem>
             <para>
               A management <replaceable>handle</replaceable>
-              (<literal>NdbMgmHandle</literal>).
+              (<literal role="mgmapi">NdbMgmHandle</literal>).
             </para>
           </listitem>
 

@@ -4748,7 +4866,7 @@
         </formalpara>
 
         <note>
-          <para>
+          <para id="mgm-ndb-mgm-get-loglevel-clusterlog">
             Prior to MySQL 5.1.14, this function was known as
             <literal>ndb_mgm_get_loglevel_clusterlog()</literal>, and
             had the following signature:

@@ -4863,9 +4981,9 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal> structure
-              for the <replaceable>reply</replaceable> message. (See
-              <xref linkend="mgm-ndb-mgm-reply"/>.)
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal> structure
+              for the <replaceable>reply</replaceable> message.
             </para>
           </listitem>
 

@@ -5017,9 +5135,9 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal> structure
-              to accommodate a <replaceable>reply</replaceable>. See
-              <xref linkend="mgm-ndb-mgm-reply"/>.
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal> structure
+              to accommodate a <replaceable>reply</replaceable>.
             </para>
           </listitem>
 

@@ -5113,8 +5231,8 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal>
-              structure.
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal> structure.
             </para>
           </listitem>
 

@@ -5227,9 +5345,9 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal>
-              structure, used for a <replaceable>reply</replaceable>
-              message.
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal> structure,
+              used for a <replaceable>reply</replaceable> message.
             </para>
           </listitem>
 

@@ -5316,7 +5434,8 @@
 
           <listitem>
             <para>
-              A pointer to an <literal>ndb_mgm_reply</literal>.
+              A pointer to an
+              <literal role="mgmapi">ndb_mgm_reply</literal>.
             </para>
           </listitem>
 

@@ -6004,9 +6123,9 @@
         <para>
           These are the log event severities used to filter the cluster
           log by
-          <literal>ndb_mgm_set_clusterlog_severity_filter()</literal>,
+          <literal role="mgmapi">ndb_mgm_set_clusterlog_severity_filter()</literal>,
           and to filter listening to events by
-          <literal>ndb_mgm_listen_event()</literal>.
+          <literal role="mgmapi">ndb_mgm_listen_event()</literal>.
         </para>
 
       </formalpara>

@@ -6170,8 +6289,8 @@
           These are the log event categories referenced in
           <xref linkend="mgm-ndb-logevent-type"/>. They are also used by
           the MGM API functions
-          <literal>ndb_mgm_set_clusterlog_loglevel()</literal> and
-          <literal>ndb_mgm_listen_event()</literal>.
+          <literal role="mgmapi">ndb_mgm_set_clusterlog_loglevel()</literal>
+          and <literal role="mgmapi">ndb_mgm_listen_event()</literal>.
         </para>
 
       </formalpara>

@@ -7129,7 +7248,7 @@
         <para>
           Provides information on the status of all Cluster nodes. This
           structure is returned by
-          <literal>ndb_mgm_get_status()</literal>.
+          <literal role="mgmapi">ndb_mgm_get_status()</literal>.
         </para>
 
       </formalpara>

@@ -7164,8 +7283,8 @@
 
           <para>
             Each element of this array is an
-            <literal>ndb_mgm_node_state</literal> structure. For more
-            information, see <xref linkend="mgm-ndb-mgm-node-state"/>.
+            <literal role="mgmapi">ndb_mgm_node_state</literal>
+            structure.
           </para>
         </listitem>
 


Modified: trunk/ndbapi/overview.xml
===================================================================
--- trunk/ndbapi/overview.xml	2010-11-27 10:45:18 UTC (rev 24058)
+++ trunk/ndbapi/overview.xml	2010-11-27 12:37:59 UTC (rev 24059)
Changed blocks: 1, Lines Added: 6, Lines Deleted: 4; 988 bytes

@@ -114,10 +114,12 @@
 
       <para>
         The MGM API's principal structures model the states of
-        individual modes (<literal>ndb_mgm_node_state</literal>), the
-        state of the Cluster as a whole
-        (<literal>ndb_mgm_cluster_state</literal>), and management
-        server response messages (<literal>ndb_mgm_reply</literal>). See
+        individual modes
+        (<literal role="mgmapi">ndb_mgm_node_state</literal>), the state
+        of the Cluster as a whole
+        (<literal role="mgmapi">ndb_mgm_cluster_state</literal>), and
+        management server response messages
+        (<literal role="mgmapi">ndb_mgm_reply</literal>). See
         <xref linkend="mgm-structures"/>, for detailed descriptions of
         these.
       </para>


Thread
svn commit - mysqldoc@docsrva: r24059 - in trunk: dynamic-docs/changelog ndbapijon.stephens27 Nov