svn commit - mysqldoc@oter02: r26112 - trunk/mysqldoc-guide

[jon.stephens]

Author: js221926
Date: 2011-05-03 16:22:58 +0200 (Tue, 03 May 2011)
New Revision: 26112

Log:

Added item about ndbinfo link generation to guide



Modified:
   trunk/mysqldoc-guide/special-markup.xml


Modified: trunk/mysqldoc-guide/special-markup.xml
===================================================================
--- trunk/mysqldoc-guide/special-markup.xml	2011-05-03 13:06:31 UTC (rev 26111)
+++ trunk/mysqldoc-guide/special-markup.xml	2011-05-03 14:22:58 UTC (rev 26112)
Changed blocks: 2, Lines Added: 40, Lines Deleted: 3; 2411 bytes

@@ -881,10 +881,13 @@
           <literal>cfunc</literal> for a C API function,
           <literal>jointype</literal> for an optimizer join type (as
           seen in <literal>EXPLAIN</literal> output),
-          <literal>priv</literal> for an access privilege, or
+          <literal>priv</literal> for an access privilege,
           <literal>ndbapi</literal> (or possibly
-          <literal>ndbapi:<replaceable>$class_name</replaceable></literal>&mdash;see
-          below) for an NDB API class, class member, type, or struct.
+          <literal>ndbapi:<replaceable>$class_name</replaceable></literal>;
+          see below) for an NDB API class, class member, type, or
+          struct, <literal>mgmapi</literal> for an MGM API function, or
+          <literal>ndbinfo</literal> for the <literal>ndbinfo</literal>
+          database or one of its tables.
         </para>
 
         <para>

@@ -1357,6 +1360,40 @@
 </programlisting>
       </listitem>
 
+      <listitem>
+        <para>
+          <literal>ndbinfo</literal> database or table: Prefix with
+          <literal>mysql-cluster-</literal>. If the element text
+          contains a period: Strip it and any text leading up to it. If
+          the remainder (call it <replaceable>r</replaceable>) is not
+          the string "ndbinfo", add <literal>ndbinfo-</literal> to the
+          prefix. Convert any underscores contained in the remainder
+          (<replaceable>r</replaceable>) to dashes, and use the result.
+        </para>
+
+        <para>
+          Example 1. The following generates a link to the ID
+          <literal>mysql-cluster-ndbinfo</literal>:
+        </para>
+
+<programlisting>
+&lt;literal role="ndbinfo"&gt;ndbndbinfo&lt;/literal&gt;
+</programlisting>
+
+        <para>
+          Example 2. Each of the following generates a link to the ID
+          <literal>mysql-cluster-ndbinfo-config-params</literal>:
+        </para>
+
+<programlisting>
+&lt;literal role="ndbinfo"&gt;ndbinfo.config_params&lt;/literal&gt;
+</programlisting>
+
+<programlisting>
+&lt;literal role="ndbinfo"&gt;config_params&lt;/literal&gt;
+</programlisting>
+      </listitem>
+
     </itemizedlist>
 
     <para>