Author: jstephens
Date: 2007-04-25 14:06:48 +0200 (Wed, 25 Apr 2007)
New Revision: 6183
Log:
Reformat.
Modified:
trunk/refman-5.1/mysql-cluster-merged.xml
Modified: trunk/refman-5.1/mysql-cluster-merged.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-merged.xml 2007-04-25 12:05:59 UTC (rev 6182)
+++ trunk/refman-5.1/mysql-cluster-merged.xml 2007-04-25 12:06:48 UTC (rev 6183)
Changed blocks: 2, Lines Added: 109, Lines Deleted: 93; 8912 bytes
@@ -15722,109 +15722,120 @@
</refentry>
- </section><section
id="fake-id-for-ndb-redo-log-reader-manpage-section-wrapper">
-
+ </section>
+
+ <section id="fake-id-for-ndb-redo-log-reader-manpage-section-wrapper">
+
<title>fake title for ndb_redo_log_reader manpage</title>
+
<refentry id="mysql-cluster-utilities-ndbd-redo-log-reader">
- <indexterm>
- <primary></primary>
- </indexterm>
+
+ <indexterm>
+ <primary></primary>
+ </indexterm>
+
<refmeta>
<refentrytitle><command>ndbd_redo_log_reader</command></refentrytitle>
-
+
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">MySQL Database System</refmiscinfo>
<refmiscinfo class="source">MySQL</refmiscinfo>
<refmiscinfo
class="version">¤t-series-mccge;</refmiscinfo>
<refmiscinfo class="refman">Check and Print Content of Cluster Redo
Log</refmiscinfo>
</refmeta>
+
<refnamediv>
<refname>ndbd_redo_log_reader</refname>
-
+
<refpurpose>check and print content of cluster redo
log</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>ndbd_redo_log_reader
<replaceable>file_name</replaceable>
[<replaceable>options</replaceable>]</command>
</cmdsynopsis>
</refsynopsisdiv>
+
<refsection id="ndb-redo-log-reader">
+
<title>Description</title>
- <para>
- Reads a redo log file, checking it for errors, printing its
- contents in a human-readable format, or both.
- <command>ndbd_redo_log_reader</command> is intended for use
- primarily by MySQL developers and support personnel in debugging
- and diagnosing problems.
- </para>
-
- <para>
- This utility was made available as part of the default build
- beginning with MySQL 5.1.15-ndb-6.1.3. It remains under
- development, and its syntax and behavior are subject to change
- in future releases. For this reason, it should be considered
- experimental at this time.
- </para>
-
- <para>
- The C++ source files for <command>ndbd_redo_log_reader</command>
- can be found in the directory
-
<filename>/storage/ndb/src/kernel/blocks/dblqh/redoLogReader</filename>.
- </para>
-
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
-
+
+ <para>
+ Reads a redo log file, checking it for errors, printing its
+ contents in a human-readable format, or both.
+ <command>ndbd_redo_log_reader</command> is intended for use
+ primarily by MySQL developers and support personnel in
+ debugging and diagnosing problems.
+ </para>
+
+ <para>
+ This utility was made available as part of the default build
+ beginning with MySQL 5.1.15-ndb-6.1.3. It remains under
+ development, and its syntax and behavior are subject to
+ change in future releases. For this reason, it should be
+ considered experimental at this time.
+ </para>
+
+ <para>
+ The C++ source files for
+ <command>ndbd_redo_log_reader</command> can be found in the
+ directory
+
<filename>/storage/ndb/src/kernel/blocks/dblqh/redoLogReader</filename>.
+ </para>
+
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndbd_redo_log_reader <replaceable>file_name</replaceable>
[<replaceable>options</replaceable>]
</programlisting>
-
- <remark role="todo">
- [js] Add link to discussion of cluster filesystem when that has
- been added to the Internals Manual.
- </remark>
-
- <para>
- <replaceable>file_name</replaceable> is the name of a cluster
- REDO log file. REDO log files are located in the numbered
- directories under the data node's data directory
- (<literal>DataDir</literal>); the path under this directory to
- the REDO log files matches the pattern
-
<filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/LCP/<replaceable>#</replaceable>/T<replaceable>#</replaceable>F<replaceable>#</replaceable>.Data</filename>.
- In each case, the <replaceable>#</replaceable> represents a
- number (not necessarily the same number).
- </para>
-
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
-
+
+ <remark role="todo">
+ [js] Add link to discussion of cluster filesystem when that
+ has been added to the Internals Manual.
+ </remark>
+
<para>
+ <replaceable>file_name</replaceable> is the name of a
+ cluster REDO log file. REDO log files are located in the
+ numbered directories under the data node's data directory
+ (<literal>DataDir</literal>); the path under this directory
+ to the REDO log files matches the pattern
+
<filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/LCP/<replaceable>#</replaceable>/T<replaceable>#</replaceable>F<replaceable>#</replaceable>.Data</filename>.
+ In each case, the <replaceable>#</replaceable> represents a
+ number (not necessarily the same number).
+ </para>
+
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
+
+ <para>
The name of the file to be read may be followed by one or
more of the options listed here:
-
- <itemizedlist>
-
- <listitem>
- <para>
- <option>-noprint</option>: Do not print the contents of
- the log file.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>-nocheck</option>: Do not check the log filre for
- errors.
- </para>
- </listitem>
-
- <!--
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <option>-noprint</option>: Do not print the contents
+ of the log file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>-nocheck</option>: Do not check the log filre
+ for errors.
+ </para>
+ </listitem>
+
+<!--
Following options commented out until they actually do something.
-->
-
- <!--
+
+<!--
<listitem>
<para>
@@ -15877,26 +15888,31 @@
</para>
</listitem>
-->
-
- </itemizedlist>
- </para>
-
- <para>
- Like <command>ndb_print_backup_file</command> and
- <command>ndb_print_schema_file</command> (and unlike most of the
- <literal>NDB</literal> utilities that are intended to be run on
- a management server host or to connect to a management server)
- <command>ndbd_redo_log_reader</command> must be run on a cluster
- data node, since it accesses the data node filesystem directly.
- Because it does not make use of the management server, this
- utility can be used when the management server is not running,
- and even when the cluster has been completely shut down.
- </para>
-
- <remark role="todo">
- [js] Add sample output with explanation.
- </remark></refsection>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ Like <command>ndb_print_backup_file</command> and
+ <command>ndb_print_schema_file</command> (and unlike most of
+ the <literal>NDB</literal> utilities that are intended to be
+ run on a management server host or to connect to a
+ management server) <command>ndbd_redo_log_reader</command>
+ must be run on a cluster data node, since it accesses the
+ data node filesystem directly. Because it does not make use
+ of the management server, this utility can be used when the
+ management server is not running, and even when the cluster
+ has been completely shut down.
+ </para>
+
+ <remark role="todo">
+ [js] Add sample output with explanation.
+ </remark>
+
+ </refsection>
+
</refentry>
+
</section>
<section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r6183 - trunk/refman-5.1 | jon | 25 Apr |