List:Commits« Previous MessageNext Message »
From:jon.stephens Date:November 9 2010 12:03pm
Subject:svn commit - mysqldoc@docsrva: r23617 - trunk/ndbapi
View as plain text  
Author: jstephens
Date: 2010-11-09 13:03:06 +0100 (Tue, 09 Nov 2010)
New Revision: 23617

Log:


Add auto-link markup (WL#5467)




Modified:
   trunk/ndbapi/ndb-internals.xml


Modified: trunk/ndbapi/ndb-internals.xml
===================================================================
--- trunk/ndbapi/ndb-internals.xml	2010-11-09 12:02:23 UTC (rev 23616)
+++ trunk/ndbapi/ndb-internals.xml	2010-11-09 12:03:06 UTC (rev 23617)
Changed blocks: 17, Lines Added: 60, Lines Deleted: 53; 11573 bytes

@@ -37,10 +37,11 @@
 
       <section id="ndb-internals-ndbd-datadir-files">
 
-        <title>Cluster Data Node <literal>DataDir</literal> Files</title>
+        <title>MySQL Cluster Data Node <literal>DataDir</literal> Files</title>
 
         <para>
-          A cluster data node's <literal>DataDir</literal> contains at a
+          A MySQL Cluster data node&apos;s
+          <literal role="ndbparam:ndbd">DataDir</literal> contains at a
           minimum 3 files. These are named as shown here, where
           <replaceable>node_id</replaceable> is the node ID:
         </para>

@@ -115,8 +116,8 @@
 
         <para>
           The location of these files is determined by the value of the
-          <literal>DataDir</literal> configuration parameter. See
-          <link linkend="ndbparam-ndbd-datadir"><literal>DataDir</literal></link>.
+          <literal role="ndbparam:ndbd">DataDir</literal> configuration
+          parameter.
         </para>
 
       </section>

@@ -193,13 +194,13 @@
                   has one primary fragment and one backup fragment. This
                   means that, for a MySQL Cluster having 2 data nodes,
                   and with
-                  <link linkend="ndbparam-ndbd-noofreplicas"><literal>NoOfReplicas
-                  = 2</literal></link>, <replaceable>M</replaceable> is
-                  either 0 to 1. For a 4-node cluster with
-                  <link linkend="ndbparam-ndbd-noofreplicas"><literal>NoOfReplicas
-                  = 2</literal></link>, <replaceable>M</replaceable> is
-                  either 0 or 2 on node group 1, and either 1 or 3 on
-                  node group 2.
+                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>
+                  equal to 2, <replaceable>M</replaceable> is either 0
+                  to 1. For a 4-node cluster with
+                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>
+                  equal to 2, <replaceable>M</replaceable> is either 0
+                  or 2 on node group 1, and either 1 or 3 on node group
+                  2.
                 </para>
 
                 <para>

@@ -210,19 +211,19 @@
                   of 0 to the number of LQH worker threads in the entire
                   cluster, less 1. The number of fragments on each data
                   node is equal to the number of LQH on that node times
-                  <link linkend="ndbparam-ndbd-noofreplicas"><literal>NoOfReplicas</literal></link>.
+                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>.
                 </para>
 
                 <note>
                   <para>
                     Increasing
-                    <link linkend="ndbparam-ndbmtd-maxnoofexecutionthreads"><literal>MaxNoOfExecutionThreads</literal></link>
+                    <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>
                     does not change the number of fragments used by
                     existing tables; only newly-created tables
                     automatically use the new fragment count. To force
                     the new fragment count to be used by an existing
                     table after increasing
-                    <link linkend="ndbparam-ndbmtd-maxnoofexecutionthreads"><literal>MaxNoOfExecutionThreads</literal></link>,
+                    <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>,
                     you must perform an
                     <literal role="stmt" condition="alter-table">ALTER
                     TABLE ... REORGANIZE PARTITION</literal> statement

@@ -286,7 +287,7 @@
                       <filename>S<replaceable>N</replaceable>.FragLog</filename>,
                       where <replaceable>N</replaceable> is equal to the
                       value of the
-                      <literal>NoOfFragmentLogFiles</literal>
+                      <literal role="ndbparam:ndbd">NoOfFragmentLogFiles</literal>
                       configuration parameter.
                     </para>
 

@@ -328,17 +329,15 @@
 
         <para>
           MySQL Cluster creates backup files in the directory specified
-          by the <literal>BackupDataDir</literal> configuration
-          parameter, as discussed in
-          <xref linkend="mysql-cluster-backup-using-management-client"/>,
-          and
-          <link linkend="mysql-cluster-identifying-data-nodes">Identifying
-          Data Nodes</link>.
+          by the <literal role="ndbparam:ndbd">BackupDataDir</literal>
+          configuration parameter, as discussed in
+          <xref linkend="mysql-cluster-backup-using-management-client"/>.
         </para>
 
         <para>
-          The files created when a backup is performed are listed and
-          described in <xref linkend="mysql-cluster-backup-concepts"/>.
+          See <xref linkend="mysql-cluster-backup-concepts"/>, for
+          information about the files created when a backup is
+          performed.
         </para>
 
       </section>

@@ -381,9 +380,10 @@
 
         <para>
           Both undo logfiles and datafiles are created in the data
-          directory (<literal>DataDir</literal>) of each cluster data
-          node. The relationship of these files with their logfile group
-          and tablespace are shown in the following diagram:
+          directory (<literal role="ndbparam:ndbd">DataDir</literal>) of
+          each cluster data node. The relationship of these files with
+          their logfile group and tablespace are shown in the following
+          diagram:
         </para>
 
         <mediaobject>

@@ -1121,10 +1121,11 @@
           <title>Description</title>
 
           <para>
-            Prints values of <literal>BackupDataBufferSize</literal>,
-            <literal>BackupLogBufferSize</literal>,
-            <literal>BackupWriteSize</literal>, and
-            <literal>BackupMaxWriteSize</literal>
+            Prints the values of
+            <literal role="ndbparam:ndbd">BackupDataBufferSize</literal>,
+            <literal role="ndbparam:ndbd">BackupLogBufferSize</literal>,
+            <literal role="ndbparam:ndbd">BackupWriteSize</literal>, and
+            <literal role="ndbparam:ndbd">BackupMaxWriteSize</literal>
           </para>
 
         </formalpara>

@@ -2136,9 +2137,9 @@
           <para>
             Causes heartbeat transmission information.to be written to
             the data node logs. Useful in conjunction with setting the
-            <literal>HeartbeatOrder</literal> parameter (introduced in
-            MySQL Cluster NDB 6.3.35, MySQL Cluster NDB 7.0.16, and
-            MySQL Cluster NDB 7.1.5).
+            <literal role="ndbparam:ndbd">HeartbeatOrder</literal>
+            parameter (introduced in MySQL Cluster NDB 6.3.35, MySQL
+            Cluster NDB 7.0.16, and MySQL Cluster NDB 7.1.5).
           </para>
 
         </formalpara>

@@ -2217,8 +2218,9 @@
           <para>
             Prints data node mMemory usage (<literal>ACC</literal> &amp;
             <literal>TUP</literal>), as both a number of data pages, and
-            the percentage of <literal>DataMemory</literal> and
-            <literal>IndexMemory</literal> used.
+            the percentage of
+            <literal role="ndbparam:ndbd">DataMemory</literal> and
+            <literal role="ndbparam:ndbd">IndexMemory</literal> used.
           </para>
 
         </formalpara>

@@ -5182,8 +5184,8 @@
 
           <para>
             Dumps the value of
-            <literal>MaxNoOfConcurrentOperations</literal>, and the
-            current resource usage, in a continuous loop. The
+            <literal role="ndbparam:ndbd">MaxNoOfConcurrentOperations</literal>,
+            and the current resource usage, in a continuous loop. The
             <replaceable>delay</replaceable> time between reports can
             optionally be specified (in seconds), with the default being
             1 and the maximum value being 25 (values greater than 25 are

@@ -5212,10 +5214,11 @@
 
           <para>
             There appears to be no way to disable the repeated checking
-            of <literal>MaxNoOfConcurrentOperations</literal> once
-            started by this command, except by restarting the data node.
-            It may be preferable for this reason to use <literal>DUMP
-            2513</literal> instead (see
+            of
+            <literal role="ndbparam:ndbd">MaxNoOfConcurrentOperations</literal>
+            once started by this command, except by restarting the data
+            node. It may be preferable for this reason to use
+            <literal>DUMP 2513</literal> instead (see
             <xref linkend="ndb-internals-dump-command-2513"/>).
           </para>
 

@@ -5255,8 +5258,8 @@
 
           <para>
             Dumps the value of
-            <literal>MaxNoOfConcurrentOperations</literal>, and the
-            current resource usage.
+            <literal role="ndbparam:ndbd">MaxNoOfConcurrentOperations</literal>,
+            and the current resource usage.
           </para>
 
         </formalpara>

@@ -7722,12 +7725,13 @@
             stays very low relative to <literal>subscriberPool ...
             size</literal>, it is often a good idea to increase the
             value of the
-            <link linkend="ndbparam-ndbd-maxnooftables"><literal>MaxNoOfTables</literal></link>
+            <literal role="ndbparam:ndbd">MaxNoOfTables</literal>
             configuration parameter (<literal>subscriberPool</literal> =
-            2 * <literal>MaxNoOfTables</literal>). However, there could
-            also be a problem with API nodes not releasing resources
-            correctly when they are shut down. <literal>DUMP
-            8004</literal> provides a way to monitor these values.
+            2 * <literal role="ndbparam:ndbd">MaxNoOfTables</literal>).
+            However, there could also be a problem with API nodes not
+            releasing resources correctly when they are shut down.
+            <literal>DUMP 8004</literal> provides a way to monitor these
+            values.
           </para>
 
         </formalpara>

@@ -11691,7 +11695,8 @@
 
       <para>
         Some preparations for more intelligent pooling of memory
-        resources have been made. <literal>DataMemory</literal> and disk
+        resources have been made.
+        <literal role="ndbparam:ndbd">DataMemory</literal> and disk
         records already belong to this global memory pool.
       </para>
 

@@ -11917,8 +11922,9 @@
 
       <para>
         If the cluster is configured to lock pages (that is, if the
-        <literal>LockPagesInMainMemory</literal> configuration parameter
-        has been set), <literal>CMVMI</literal> handles this locking.
+        <literal role="ndbparam:ndbd">LockPagesInMainMemory</literal>
+        configuration parameter has been set), <literal>CMVMI</literal>
+        handles this locking.
       </para>
 
       <para>

@@ -12059,9 +12065,10 @@
         <literal>NDBCNTR</literal> from <literal>QMGR</literal>
         reporting the changes in status of any the nodes.
         <literal>NDBCNTR</literal> also sets timers corresponding to the
-        <literal>StartPartialTimeout</literal>,
+        <literal role="ndbparam:ndbd">StartPartialTimeout</literal>,
         <literal>StartPartitionTimeout</literal>, and
-        <literal>StartFailureTimeout</literal> configuration parameters.
+        <literal role="ndbparam:ndbd">StartFailureTimeout</literal>
+        configuration parameters.
       </para>
 
       <para>


Thread
svn commit - mysqldoc@docsrva: r23617 - trunk/ndbapijon.stephens9 Nov