following sections:</para>
<itemizedlist>
<listitem>
- <para><xref linkend="dbdoclet.debugging_tools"/></para>
+ <para><xref linkend="debugging_tools"/></para>
</listitem>
<listitem>
- <para><xref linkend="dbdoclet.debugging_procedures"/></para>
+ <para><xref linkend="debugging_procedures"/></para>
</listitem>
<listitem>
- <para><xref linkend="dbdoclet.debugging_for_devs"/></para>
+ <para><xref linkend="debugging_for_devs"/></para>
</listitem>
</itemizedlist>
- <section xml:id="dbdoclet.debugging_tools">
+ <section xml:id="debugging_tools">
<title><indexterm><primary>debugging</primary></indexterm>
Diagnostic and Debugging Tools</title>
<para>A variety of diagnostic and analysis tools are available to debug
</emphasis> - This tool is used with the debug_kernel option to
manually dump the Lustre debugging log or post-process debugging
logs that are dumped automatically. For more information about the
- lctl tool, see <xref linkend="dbdoclet.using_lctl_tool"/> and <xref
- linkend="dbdoclet.lctl"/>.</para>
+ lctl tool, see <xref linkend="using_lctl_tool"/> and <xref
+ linkend="lctl"/>.</para>
</listitem>
<listitem>
<para>Lustre subsystem asserts - A panic-style assertion (LBUG) in the kernel causes the
Lustre file system to dump the debug log to the file
<literal>/tmp/lustre-log.<replaceable>timestamp</replaceable></literal> where it can
be retrieved after a reboot. For more information, see <xref
- linkend="dbdoclet.troubleshooting"/>.</para>
+ linkend="troubleshooting"/>.</para>
</listitem>
<listitem>
<para>
<para>The tools described in this section are provided in the Linux
kernel or are available at an external website. For information about
using some of these tools for Lustre debugging, see
- <xref linkend="dbdoclet.debugging_procedures"/> and
- <xref linkend="dbdoclet.debugging_for_devs"/>.
+ <xref linkend="debugging_procedures"/> and
+ <xref linkend="debugging_for_devs"/>.
</para>
<section remap="h4">
<title><indexterm><primary>debugging</primary><secondary>admin tools</secondary></indexterm>Tools for Administrators and Developers</title>
</section>
</section>
</section>
- <section xml:id="dbdoclet.debugging_procedures">
+ <section xml:id="debugging_procedures">
<title><indexterm><primary>debugging</primary><secondary>procedure</secondary></indexterm>Lustre Debugging Procedures</title>
<para>The procedures below may be useful to administrators or developers
debugging a Lustre files system.</para>
<title><indexterm><primary>debugging</primary><secondary>message format</secondary></indexterm>Understanding the Lustre Debug Messaging Format</title>
<para>Lustre debug messages are categorized by originating subsystem,
message type, and location in the source code. For a list of subsystems
- and message types, see <xref linkend="dbdoclet.lctl"/>.
+ and message types, see <xref linkend="lctl"/>.
</para>
<note>
<para>For a current list of subsystems and debug message types, see
<literal>libcfs/include/libcfs/libcfs_debug.h</literal> in the Lustre software
tree</para>
</note>
- <para>The elements of a Lustre debug message are described in <xref linkend="dbdoclet.lustre_msg_format"/> Format of Lustre Debug Messages.</para>
- <section xml:id="dbdoclet.lustre_debug_msg">
+ <para>The elements of a Lustre debug message are described in <xref linkend="lustre_msg_format"/> Format of Lustre Debug Messages.</para>
+ <section xml:id="lustre_debug_msg">
<title>Lustre Debug Messages</title>
<para>Each Lustre debug message has the tag of the subsystem it originated in, the message
type, and the location in the source code. The subsystems and debug types used are as
</listitem>
</itemizedlist>
</section>
- <section xml:id="dbdoclet.lustre_msg_format">
+ <section xml:id="lustre_msg_format">
<title>Format of Lustre Debug Messages</title>
<para>The Lustre software uses the <literal>CDEBUG()</literal> and
<literal>CERROR()</literal> macros to print the debug or error messages. To print the
<para>Lustre debug messages are maintained in a buffer, with the maximum buffer size specified (in MBs) by the <literal>debug_mb</literal> parameter (<literal>lctl get_param debug_mb</literal>). The buffer is circular, so debug messages are kept until the allocated buffer limit is reached, and then the first messages are overwritten.</para>
</section>
</section>
- <section xml:id="dbdoclet.using_lctl_tool">
+ <section xml:id="using_lctl_tool">
<title><indexterm><primary>debugging</primary><secondary>using lctl</secondary></indexterm>Using the lctl Tool to View Debug Messages</title>
<para>The <literal>lctl</literal> tool allows debug messages to be
filtered based on subsystems and message types to extract information
useful for troubleshooting from a kernel debug log. For a command
- reference, see <xref linkend="dbdoclet.lctl"/>.</para>
+ reference, see <xref linkend="lctl"/>.</para>
<para>You can use <literal>lctl</literal> to:</para>
<itemizedlist>
<listitem>
<screen>modinfo libcfs</screen>
</section>
</section>
- <section xml:id="dbdoclet.debugging_for_devs">
+ <section xml:id="debugging_for_devs">
<title><indexterm><primary>debugging</primary><secondary>developers tools</secondary></indexterm>Lustre Debugging for Developers</title>
<para>The procedures in this section may be useful to developers debugging Lustre source
code.</para>
<orderedlist>
<listitem>
<para>Dump the log into a user-specified log file using lctl
- (see <xref linkend="dbdoclet.using_lctl_tool"/>).
+ (see <xref linkend="using_lctl_tool"/>).
</para>
</listitem>
<listitem>
git://git.whamcloud.com / doc / manual.git / blobdiff