LUDOC-123: provide instruction on listing debug masks.

Clarifies instructions for the subsystem_mask parameter of lctl debug.
Provides examples.

Change-Id: I51e2104469721d15a29dda1dbaf3caeebe65b252
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Cliff White <cliff.white@intel.com>
Reviewed-on: http://review.whamcloud.com/5320
Tested-by: Hudson
Reviewed-by: John Hammond <johnlockwoodhammond@gmail.com>

diff --git a/LustreDebugging.xml b/LustreDebugging.xml
index c9ec606..b875a4d 100644 (file)
--- a/LustreDebugging.xml
+++ b/LustreDebugging.xml
@@ -574,11 +574,13 @@ Debug log: 324 lines, 258 kept, 66 dropped.
     </section>
     <section remap="h3">
       <title><indexterm><primary>debugging</primary><secondary>kernel debug log</secondary></indexterm>Controlling Information Written to the Kernel Debug Log</title>
-      <para>The <literal>lctl set_param subsystem_debug=<replaceable>subsystem_mask</replaceable></literal> and <literal>lctl set_param debug=<replaceable>debug_mask</replaceable></literal> are used to determine which information is written to the debug log. The subsystem_debug mask determines the information written to the log based on the functional area of the code (such as lnet, osc, or ldlm). The debug mask controls information based on the message type (such as info, error, trace, or malloc).</para>
+      <para>The <literal>lctl set_param subsystem_debug=<replaceable>subsystem_mask</replaceable></literal> and <literal>lctl set_param debug=<replaceable>debug_mask</replaceable></literal> are used to determine which information is written to the debug log. The subsystem_debug mask determines the information written to the log based on the functional area of the code (such as lnet, osc, or ldlm). The debug mask controls information based on the message type (such as info, error, trace, or malloc). For a complete list of possible debug masks use the <literal>lctl debug_list types</literal> command.</para>
       <para>To turn off Lustre debugging completely:</para>
       <screen>lctl set_param debug=0 </screen>
       <para>To turn on full Lustre debugging:</para>
       <screen>lctl set_param debug=-1 </screen>
+      <para>To list all possible debug masks:</para>
+      <screen>lctl debug_list types</screen>
       <para>To log only messages related to network communications:</para>
       <screen>lctl set_param debug=net </screen>
       <para>To turn on logging of messages related to network communications and existing debug flags:</para>