svn commit - mysqldoc@docsrva: r11646 - in trunk/dynamic-docs/command-optvars: . ndb ndb/config-params ndb/errors ndb/programs

[jon]

Author: jstephens
Date: 2008-09-03 09:56:44 +0200 (Wed, 03 Sep 2008)
New Revision: 11646

Log:

The Dynamic-Documentation-isation of NDB stuff commences...

Groundwork, working files/dirs for

  WL#3864 (Create OptVars files for NDB executables)

  WL#4136 (Dynamic Docs for NDB Config Parameters)

  WL#4539 (Improve NDB Error Message Documentation Process)



Added:
   trunk/dynamic-docs/command-optvars/ndb/config-params/MyParam.xml
   trunk/dynamic-docs/command-optvars/ndb/config-params/ndb-config-params.dtd
   trunk/dynamic-docs/command-optvars/ndb/errors/error-regexes.txt
   trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_config.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_delete_all.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_desc.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_index.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_table.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_error_reporter.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgm.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgmd.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_backup_file.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_schema_file.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_sys_file.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_restore.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_all.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_count.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_show_tables.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_size_pl.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_test_platform.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndb_waiter.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/ndbd_redo_log_reader.xml
   trunk/dynamic-docs/command-optvars/ndb/programs/options.dtd
   trunk/dynamic-docs/command-optvars/ndb/programs/programs.txt
   trunk/dynamic-docs/command-optvars/ndb/programs/template.xml

Property changes on: trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php
___________________________________________________________________
Name: svn:executable
   + *


Added: trunk/dynamic-docs/command-optvars/ndb/config-params/MyParam.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/config-params/MyParam.xml	                     
  (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/config-params/MyParam.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 18, Lines Deleted: 0; 947 bytes

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE parameters SYSTEM "ndb-config-params.dtd">
+<parameters>
+  <parameter id="ndb-config_myparam" nodetype="data" restart="node">
+    <name>MyParam</name>
+    <shortdescription lang="en">
+      A MySQL Cluster configuration parameter...
+    </shortdescription>
+    <manuals>
+      <manual version="5.0"/>
+      <manual version="5.1"/>
+    </manuals>
+    <value-set type="bool" platform="all" inversion="5.0.5" outversion="5.1.19">
+      <value type="default">N</value>
+    </value-set>
+  </parameter>
+  
+</parameters>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/config-params/ndb-config-params.dtd
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/config-params/ndb-config-params.dtd	           
            (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/config-params/ndb-config-params.dtd	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 66, Lines Deleted: 0; 2344 bytes

@@ -0,0 +1,66 @@
+
+<!--  Optional seealso and xrefto elements  -->
+
+<!ELEMENT seealso EMPTY>
+<!ATTLIST seealso xref IDREF #REQUIRED>
+
+<!ELEMENT xrefto EMPTY>
+<!ATTLIST xrefto id IDREF #REQUIRED>
+
+<!--  Set the manual(s) in which the parameter should appear  -->
+
+<!ELEMENT manuals (manual)*>
+<!ELEMENT manual EMPTY>
+<!ATTLIST manual version (4.1 | 5.0 | 5.1 | 5.2 | 6.0) #REQUIRED>
+
+<!--  Short description  -->
+
+<!ELEMENT shortdescription (#PCDATA)>
+<!ATTLIST shortdescription lang CDATA #REQUIRED>
+
+<!--  
+      Defines a parameter with value set, node type,
+      restart type, and version information 
+-->
+
+<!ELEMENT parameter (xrefto? , seealso? , name , shortdescription , manuals ,
value-set+)>
+<!ATTLIST parameter id ID #REQUIRED>
+<!ATTLIST parameter inversion CDATA #IMPLIED>
+<!ATTLIST parameter outversion CDATA #IMPLIED>
+<!ATTLIST parameter nodetype (data | mgm | api) #REQUIRED>
+<!ATTLIST parameter restart (initial | node | initial-node | none) #REQUIRED>
+
+<!ELEMENT value-set (value | choice)*>
+<!ATTLIST value-set inversion CDATA #IMPLIED>
+<!ATTLIST value-set outversion CDATA #IMPLIED>
+<!ATTLIST value-set type (bool | num | string | filename | enum | datetime | bitmap)
#REQUIRED>
+<!ATTLIST value-set platform (all | linux | windows | macosx | hpux | solaris |
netware) #REQUIRED>
+
+<!ELEMENT parameters (parameter)*>
+
+<!-- 
+      For a parameter with a set list of possible choices, 
+      use a choice element for each entry 
+-->
+
+<!ELEMENT choice (#PCDATA)>
+<!ATTLIST choice value CDATA #REQUIRED>
+
+<!-- 
+      To set a default value, or upper/lower limits, you must also specify the
+      platform to which it applies 
+-->
+
+<!ELEMENT value (#PCDATA)>
+<!ATTLIST value type (default | minimum | maximum) #REQUIRED>
+
+<!ELEMENT deprecated EMPTY>
+<!ATTLIST deprecated xref IDREF #IMPLIED>
+<!ATTLIST deprecated version CDATA #IMPLIED>
+
+<!ELEMENT removed EMPTY>
+<!ATTLIST removed version CDATA #IMPLIED>
+
+<!ELEMENT version (#PCDATA)>
+
+<!ELEMENT name (#PCDATA)>


Added: trunk/dynamic-docs/command-optvars/ndb/errors/error-regexes.txt
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/errors/error-regexes.txt	                      
 (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/errors/error-regexes.txt	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 93, Lines Deleted: 0; 3040 bytes

@@ -0,0 +1,93 @@
+
+-For the error codes tables-
+
+Use the following regex:
+
+s/\{\s*(.*)\, (.*)\, (.*)\,
"(.*)"\s*\}\,?/<row><entry><errorcode>$1</errorcode></entry><entry><errorname>$2</errorname></entry><entry><errortype>$3</errortype></entry><entry><errortext>$4</errortext></entry></row>/
+
+on the ErrorCodes array in ndberror.c
+
+MATCHES:
+
+$1 : NDB error code
+$2 : MySQL error code
+$3 : NDB error classification
+$4 : Error message
+
+-For the error categories table-
+
+1.  Use this regex:
+
+      s/\{\s*(.*)\, (.*)\,
"(.*)"\s*\}\,?/<row><entry><errorcode>$2</errorcode></entry><entry><errortype>$1</errortype></entry><entry><errortext>$3</errortext></entry></row>/
+
+    on the StatusClassificationMapping array in ndberror.c
+
+2.  In the result, substitute the status descriptions for the status codes as shown:
+
+    ST_S -> Success
+    ST_T -> Temporary error
+    ST_P -> Permanent error
+    ST_U -> Unknown result
+
+-Both tables (error code and categories)-
+
+Run s/>\s+/>/ and s/\s+</</ on the result to get rid of extraneous
+spaces, and then s/Cant/Can't/ to fix most common misspelling.
+
+-For the ndbd exit codes table-
+
+1. Use this regexp:
+
+\s*\{(.*)\, (.*)\,
"(.*)"\s*}\,?/<row><entry><errorcode>$1</errorcode></entry><entry><errortype>$2</errortype></entry><entry><errortext>$3</errortext></entry></row>/
+
+on the errArray array in storage/ndb/src/kernel/error/ndbd_exit_codes.c
+
+MATCHES:
+
+$1 : Error code
+$2 : NDB error classification
+$3 : Error message
+
+Split up the result and paste into the appropriate tables in
+ndbd-error-codes using the C comments as a guide.
+
+-For the ndbd exit code classifications table-
+
+2. Use this regexp:
+
+\s*\{(.*)\, (.*)\,
"(.*)"\s*}\,?/<row><entry><errorcode>$2</errorcode></entry><entry><errortype>$1</errortype></entry><entry><errortext>$3</errortext></entry></row>/
+
+on the StatusExitClassificationMapping array (also in ndbd_exit_codes.c)
+
+MATCHES:
+
+$1 : Classification code
+$2 : Classification type
+$3 : Classification name
+
+Then replace according to the following (obtained from the
+StatusExitMessageMapping array):
+
+XST_S -> Success
+XST_U -> Unknown
+XST_P -> Permanent error, external action needed
+XST_R -> Temporary error, restart node
+XST_I -> Ndbd file system error, restart node initial
+
+-Transporter errors-
+
+These are listed in struct myTransporterError, internal to the method
+getTextTransporterError(), as found in the file
+storage/ndb/src/common/debugger/EventLogger.cpp.
+
+Match the following the following 2-line pattern within the struct:
+
+\s*\/\/TE.* \= (\w+).*
+\s*\{(TE.*)\,\"(.*)\"\}\,?
+
+And replace it with:
+
+<row><entry><errorcode>$1</errorcode></entry>
+<entry><errorname>$2</errorname></entry>
+<entry><errortext>$3</errortext></entry></row>
+


Added: trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php	                     
  (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 12, Lines Deleted: 0; 820 bytes

@@ -0,0 +1,12 @@
+#!/usr/bin/php
+<?php
+  $programs = file('./programs.txt');
+  
+  foreach($programs as $program)
+  {
+    $program = preg_replace('/\./', '_', $program);
+    $program = preg_replace('/\W/', '', $program);
+    
+    copy('template.xml',  "$program.xml");
+  }
+?>
\ No newline at end of file


Property changes on: trunk/dynamic-docs/command-optvars/ndb/programs/create-files.php
___________________________________________________________________
Name: svn:executable
   + *


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_config.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_config.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_config.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 496 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_delete_all.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_delete_all.xml	                   
    (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_delete_all.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 508 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_desc.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_desc.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_desc.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 490 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_index.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_index.xml	                   
    (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_index.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 508 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_table.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_table.xml	                   
    (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_drop_table.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 508 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_error_reporter.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_error_reporter.xml	               
        (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_error_reporter.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 520 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgm.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgm.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgm.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 487 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgmd.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgmd.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_mgmd.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 490 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_backup_file.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_backup_file.xml	            
           (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_backup_file.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 529 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_schema_file.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_schema_file.xml	            
           (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_schema_file.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 529 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_sys_file.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_sys_file.xml	               
        (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_print_sys_file.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 520 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_restore.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_restore.xml	                      
 (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_restore.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 499 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_all.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_all.xml	                   
    (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_all.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 508 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_count.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_count.xml	                 
      (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_select_count.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 514 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_show_tables.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_show_tables.xml	                  
     (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_show_tables.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 511 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_size_pl.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_size_pl.xml	                      
 (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_size_pl.xml	2008-09-03 07:56:44
UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 499 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_test_platform.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_test_platform.xml	                
       (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_test_platform.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 517 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndb_waiter.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndb_waiter.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndb_waiter.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 496 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/ndbd_redo_log_reader.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/ndbd_redo_log_reader.xml	             
          (rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/ndbd_redo_log_reader.xml	2008-09-03
07:56:44 UTC (rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 526 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/options.dtd
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/options.dtd	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/options.dtd	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 81, Lines Deleted: 0; 3489 bytes

@@ -0,0 +1,81 @@
+<!ELEMENT introduced EMPTY>
+<!ATTLIST introduced version CDATA #REQUIRED >
+<!ELEMENT types (optype|vartype)+>
+
+<!--Set the manual in which the option should appear-->
+<!ELEMENT manual EMPTY>
+<!ATTLIST manual version (4.0 | 4.1 | 5.0 | 5.1 | 5.2 | 6.0) #REQUIRED>
+
+<!-- Defines an 'Option', its class, format and version information -->
+<!ELEMENT optype EMPTY>
+<!ATTLIST optype class (mycnf | cmdline) #REQUIRED>
+<!ATTLIST optype inversion CDATA #IMPLIED>
+<!ATTLIST optype outversion CDATA #IMPLIED>
+<!ATTLIST optype format CDATA #IMPLIED>
+<!ATTLIST optype setvar CDATA #IMPLIED>
+
+<!-- Defines a 'Variable'; 'type' is for status variables; 'class' is for
+variable type -->
+<!ELEMENT vartype EMPTY>
+<!ATTLIST vartype inversion CDATA #IMPLIED>
+<!ATTLIST vartype outversion CDATA #IMPLIED>
+<!ATTLIST vartype format CDATA #IMPLIED>
+<!ATTLIST vartype scope (global | session | both) #IMPLIED>
+<!ATTLIST vartype class (status | system | both) #REQUIRED>
+<!ATTLIST vartype isdynamic (yes | no) #REQUIRED >
+
+<!-- Values specify the versions and value types -->
+
+<!ELEMENT values (value|choice)*>
+<!ATTLIST values inversion CDATA #IMPLIED>
+<!ATTLIST values outversion CDATA #IMPLIED>
+<!ATTLIST values vartype (boolean|numeric|string|filename|enumeration|datetime|bitmap)
#REQUIRED>
+<!ATTLIST values platform (all|linux|windows|macosx|hpux|solaris|netware)
#REQUIRED>
+
+<!-- For options with a set list of possible choices, use a choice element for
+each entry -->
+
+<!ELEMENT choice (#PCDATA)>
+<!ATTLIST choice value CDATA #REQUIRED>
+
+<!-- To set a default value, or upper/lower limits, you must also specify the
+platform to which it applies -->
+
+<!ELEMENT value EMPTY>
+<!ATTLIST value default CDATA #IMPLIED>
+<!ATTLIST value minimum CDATA #IMPLIED>
+<!ATTLIST value maximum CDATA #IMPLIED>
+
+<!ELEMENT seealso EMPTY>
+<!ATTLIST seealso xref IDREF #REQUIRED>
+
+<!ELEMENT disabledby EMPTY>
+<!ATTLIST disabledby xref IDREF #REQUIRED>
+<!ELEMENT deprecated EMPTY>
+<!ATTLIST deprecated xref IDREF #IMPLIED>
+<!ATTLIST deprecated version CDATA #IMPLIED>
+<!ELEMENT removed EMPTY>
+<!ATTLIST removed version CDATA #IMPLIED>
+<!ELEMENT cmdline (#PCDATA | format)*>
+<!ELEMENT mysqloptions (#PCDATA | mysqloption)*>
+<!ELEMENT shortdescription (#PCDATA) >
+<!ATTLIST shortdescription lang CDATA #REQUIRED>
+<!ELEMENT xrefto EMPTY>
+<!ATTLIST xrefto id CDATA #REQUIRED>
+<!ELEMENT engine EMPTY>
+<!ELEMENT version (#PCDATA)>
+<!ELEMENT platforms EMPTY>
+<!ATTLIST platforms applies (linux|windows|macosx|hpux|solaris) #REQUIRED>
+<!ELEMENT incompatible (#PCDATA)>
+<!ELEMENT mysqloption
+( xrefto?, name+ , shortdescription+,
platforms*,seealso*,incompatible*,disabledby*,deprecated?,removed?,types+,values*,versions+
+)>
+<!ATTLIST mysqloption id ID #REQUIRED>
+<!ATTLIST mysqloption section (myisam | memory | innodb | bdb | blackhole | example
|archive | csv | ndb | federated | merge | isam | falcon | maria | security | ssl |
binlog | replication | server | cluster ) #IMPLIED>
+<!ATTLIST mysqloption subsection CDATA #IMPLIED>
+<!ELEMENT versions (#PCDATA | introduced | manual | removed)*>
+<!ELEMENT name (#PCDATA)>
+<!ELEMENT format (#PCDATA)>
+<!ATTLIST format version CDATA #IMPLIED>
+
+


Added: trunk/dynamic-docs/command-optvars/ndb/programs/programs.txt
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/programs.txt	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/programs.txt	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 19, Lines Deleted: 0; 659 bytes

@@ -0,0 +1,19 @@
+ndb_config
+ndb_delete_all
+ndb_desc
+ndbd_redo_log_reader
+ndb_drop_index
+ndb_drop_table
+ndb_error_reporter
+ndb_mgm
+ndb_mgmd
+ndb_print_backup_file
+ndb_print_schema_file
+ndb_print_sys_file
+ndb_restore
+ndb_select_all
+ndb_select_count
+ndb_show_tables
+ndb_size.pl
+ndb_test_platform
+ndb_waiter
\ No newline at end of file


Added: trunk/dynamic-docs/command-optvars/ndb/programs/template.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb/programs/template.xml	                       
(rev 0)
+++ trunk/dynamic-docs/command-optvars/ndb/programs/template.xml	2008-09-03 07:56:44 UTC
(rev 11646)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 490 bytes

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mysqloptions SYSTEM "options.dtd">
+<mysqloptions>
+  
+</mysqloptions>
\ No newline at end of file