Whamcloud - gitweb
LUDOC-394 manual: Add meaningful ref names under ConfiguringLustre.xml
[doc/manual.git] / LustreDebugging.xml
index 9938cb9..089dd54 100644 (file)
@@ -90,9 +90,10 @@ Diagnostic and Debugging Tools</title>
           <para>
             <literal>
               <replaceable>lfs</replaceable>
-            </literal> - This utility provides access to the extended attributes (EAs) of a Lustre
-            file (along with other information). For more information about lfs, see <xref
-              linkend="dbdoclet.50438206_94597"/>.</para>
+            </literal> - This utility provides access to the layout of
+            of a Lustre file, along with other information relevant to users.
+            For more information about lfs, see <xref
+              linkend="userutilities.lfs"/>.</para>
         </listitem>
       </itemizedlist>
     </section>
@@ -128,38 +129,34 @@ Diagnostic and Debugging Tools</title>
         <para>The following logging and data collection tools can be used to collect information for debugging Lustre kernel issues:</para>
         <itemizedlist>
           <listitem>
-            <para><emphasis role="bold">
-                <literal>kdump</literal>
-              </emphasis> . A Linux kernel crash utility useful for debugging a system running Red Hat Enterprise Linux. For more information about <literal>kdump</literal>, see the Red Hat knowledge base article <link xl:href="http://kbase.redhat.com/faq/docs/DOC-6039">How do I configure kexec/kdump on Red Hat Enterprise Linux 5?</link>. To download <literal>kdump</literal>, go to the <link xl:href="http://fedoraproject.org/wiki/SystemConfig/kdump#Download">Fedora Project Download</link> site.</para>
+            <para><emphasis role="bold"><literal>kdump</literal></emphasis>.
+            A Linux kernel crash utility useful for debugging a system running
+            Red Hat Enterprise Linux. For more information about
+            <literal>kdump</literal>, see the Red Hat knowledge base article
+            <link xl:href="https://access.redhat.com/solutions/6038">How to
+            troubleshoot kernel crashes, hangs, or reboots with kdump on
+            Red Hat Enterprise Linux</link>. To download
+            <literal>kdump</literal>, install the RPM package via
+            <literal>yum install kexec-tools</literal>.
+            </para>
           </listitem>
           <listitem>
-            <para><emphasis role="bold">
-                <literal>netconsole</literal>
-              </emphasis>. Enables kernel-level network logging over UDP. A system requires (SysRq) allows users to collect relevant data through <literal>netconsole</literal>.</para>
+            <para><emphasis role="bold"><literal>netconsole</literal></emphasis>.
+            Enables kernel-level network logging over UDP. A system requires
+            (SysRq) allows users to collect relevant data through
+            <literal>netconsole</literal>.</para>
           </listitem>
           <listitem>
-            <para><emphasis role="bold">
-                <literal>netdump</literal>
-              </emphasis>. A crash dump utility from Red Hat that allows memory images to be dumped
-              over a network to a central server for analysis. The <literal>netdump</literal>
-              utility was replaced by <literal>kdump</literal> in Red Hat Enterprise Linux 5. For
-              more information about <literal>netdump</literal>, see <link
-                xl:href="http://www.redhat.com/support/wpapers/redhat/netdump/">Red Hat, Inc.&apos;s
-                Network Console and Crash Dump Facility</link>.</para>
+            <para><emphasis><literal>wireshark</literal> </emphasis>. A network
+            packet inspection tool that allows debugging of information that was
+            sent between the various Lustre nodes. This tool is built on top of
+            <literal>tcpdump</literal> and can read packet dumps generated by
+            it.  There are plug-ins available to dissassemble the LNet and
+            Lustre protocols.  They are included with
+            <literal>wireshark</literal> since version 2.6.0.  See also the
+            <link xl:href="https://www.wireshark.org/">Wireshark Website</link>
+            for more details.</para>
           </listitem>
-         <listitem>
-           <para><emphasis><literal>wireshark</literal> </emphasis> . A network
-           packet inspection tool that allows debugging of information that was
-           sent between the various Lustre nodes. This tool is built on top of
-           <literal>tcpdump</literal> and can read packet dumps generated by
-           it.  There are plug-ins available to dissassemble the LNet and
-           Lustre protocols.  They are located within the <link
-           xl:href="http://git.whamcloud.com/">Lustre git repository</link>
-           under <literal>lustre/contrib/wireshark/</literal>.  Installation
-           instruction are included in that directory. See also <link
-           xl:href="http://www.wireshark.org/">Wireshark Website</link> for
-           more details.</para>
-         </listitem>
         </itemizedlist>
       </section>
       <section remap="h4">
@@ -178,13 +175,26 @@ Diagnostic and Debugging Tools</title>
         <para>A virtual machine is often used to create an isolated development and test environment. Some commonly-used virtual machines are:</para>
         <itemizedlist>
           <listitem>
-            <para><emphasis role="bold">VirtualBox Open Source Edition</emphasis> . Provides enterprise-class virtualization capability for all major platforms and is available free at <link xl:href="http://www.sun.com/software/products/virtualbox/get.jsp?intcmp=2945">Get Sun VirtualBox</link>.</para>
+            <para>
+            <emphasis role="bold">VirtualBox Open Source Edition</emphasis>.
+            Provides enterprise-class virtualization capability for all major
+            platforms and is available free at
+            <link xl:href="https://www.virtualbox.org/wiki/Downloads">
+            https://www.virtualbox.org/wiki/Downloads</link>.</para>
           </listitem>
           <listitem>
-            <para><emphasis role="bold">VMware Server</emphasis> . Virtualization platform available as free introductory software at <link xl:href="http://downloads.vmware.com/d/info/datacenter_downloads/vmware_server/2_0">Download VMware Server</link>.</para>
+            <para><emphasis role="bold">VMware Server</emphasis>.
+            Virtualization platform available as free introductory software at
+            <link xl:href="https://my.vmware.com/web/vmware/downloads/">
+            https://my.vmware.com/web/vmware/downloads/</link>.</para>
           </listitem>
           <listitem>
-            <para><emphasis role="bold">Xen</emphasis> . A para-virtualized environment with virtualization capabilities similar to VMware Server and Virtual Box. However, Xen allows the use of modified kernels to provide near-native performance and the ability to emulate shared storage. For more information, go to <link xl:href="http://xen.org/">xen.org</link>.</para>
+            <para><emphasis role="bold">Xen</emphasis>. A para-virtualized
+            environment with virtualization capabilities similar to VMware
+            Server and Virtual Box. However, Xen allows the use of modified
+            kernels to provide near-native performance and the ability to
+            emulate shared storage. For more information, go to
+            <link xl:href="https://xen.org/">https://xen.org/</link>.</para>
           </listitem>
         </itemizedlist>
         <para>A variety of debuggers and analysis tools are available including:</para>
@@ -192,7 +202,14 @@ Diagnostic and Debugging Tools</title>
           <listitem>
             <para><emphasis role="bold">
                 <literal>kgdb</literal>
-              </emphasis> . The Linux Kernel Source Level Debugger kgdb is used in conjunction with the GNU Debugger <literal>gdb</literal> for debugging the Linux kernel. For more information about using <literal>kgdb</literal> with <literal>gdb</literal>, see <link xl:href="http://www.linuxtopia.org/online_books/redhat_linux_debugging_with_gdb/running.html">Chapter 6. Running Programs Under gdb</link> in the <emphasis>Red Hat Linux 4 Debugging with GDB</emphasis> guide.</para>
+              </emphasis> . The Linux Kernel Source Level Debugger kgdb is
+              used in conjunction with the GNU Debugger <literal>gdb</literal>
+              for debugging the Linux kernel. For more information about using
+              <literal>kgdb</literal> with <literal>gdb</literal>, see
+              <link xl:href="https://www.linuxtopia.org/online_books/redhat_linux_debugging_with_gdb/running.html">
+              Chapter 6. Running Programs Under gdb</link> in the
+              <emphasis>Red Hat Linux 4 Debugging with GDB</emphasis> guide.
+            </para>
           </listitem>
           <listitem>
             <para><emphasis role="bold">
@@ -200,16 +217,10 @@ Diagnostic and Debugging Tools</title>
               </emphasis> . Used to analyze saved crash dump data when a system had panicked or locked up or appears unresponsive. For more information about using crash to analyze a crash dump, see:</para>
             <itemizedlist>
               <listitem>
-                <para> Red Hat Magazine article: <link xl:href="http://magazine.redhat.com/2007/08/15/a-quick-overview-of-linux-kernel-crash-dump-analysis/">A quick overview of Linux kernel crash dump analysis</link></para>
-              </listitem>
-              <listitem>
-                <para><link xl:href="http://people.redhat.com/anderson/crash_whitepaper/#EXAMPLES">Crash Usage: A Case Study</link>  from the white paper <emphasis>Red Hat Crash Utility</emphasis> by David Anderson</para>
-              </listitem>
-              <listitem>
-                <para> Kernel Trap forum entry: <link xl:href="http://kerneltrap.org/node/5758">Linux: Kernel Crash Dumps</link></para>
-              </listitem>
-              <listitem>
-                <para> White paper: <link xl:href="http://www.google.com/url?sa=t&amp;source=web&amp;ct=res&amp;cd=8&amp;ved=0CCUQFjAH&amp;url=http%3A%2F%2Fwww.kernel.sg%2Fpapers%2Fcrash-dump-analysis.pdf&amp;rct=j&amp;q=redhat+crash+dump&amp;ei=6aQBS-ifK4T8tAPcjdiHCw&amp;usg=AFQjCNEk03E3GDtAsawG3gfpwc1gGNELAg">A Quick Overview of Linux Kernel Crash Dump Analysis</link></para>
+                <para> Overview on how to use crash by the author:
+                <link xl:href="https://crash-utility.github.io/crash_whitepaper.html">
+                White Paper: Red Hat Crash Utility</link>
+                </para>
               </listitem>
             </itemizedlist>
           </listitem>
@@ -1249,4 +1260,6 @@ freed 8bytes at a3116744 (called pathcopy)
     </section>
   </section>
 </chapter>
-<!--vim:expandtab:shiftwidth=2:tabstop=8:-->
+<!--
+  vim:expandtab:shiftwidth=2:tabstop=8:
+  -->