[deployment-guide/comm-rel: 669/727] Updated the chapter indexing.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 13:22:00 UTC 2010


commit c746dc5401872f8f14159e3ac71c329892a18393
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Thu Sep 16 15:45:10 2010 +0200

    Updated the chapter indexing.

 en-US/Working_with_Kernel_Modules.xml |  155 +++++++++++++++++----------------
 1 files changed, 81 insertions(+), 74 deletions(-)
---
diff --git a/en-US/Working_with_Kernel_Modules.xml b/en-US/Working_with_Kernel_Modules.xml
index 35c6b1d..8e816d5 100644
--- a/en-US/Working_with_Kernel_Modules.xml
+++ b/en-US/Working_with_Kernel_Modules.xml
@@ -16,23 +16,6 @@
     <primary>drivers</primary>
     <see>kernel module</see>
   </indexterm>
-  <indexterm>
-    <primary>kernel module</primary>
-    <secondary>types of</secondary>
-  </indexterm>
-  <indexterm>
-    <primary>kernel module</primary>
-    <secondary>utilities</secondary>
-  </indexterm>
-  <indexterm>
-    <primary>kernel module</primary>
-    <secondary>commands</secondary>
-    <tertiary>group of</tertiary>
-  </indexterm>
-  <indexterm>
-    <primary>kernel module</primary>
-    <secondary>module-init-tools</secondary>
-  </indexterm>
   <para>The Linux kernel is modular, which means it can extend its capabilities through the use of dynamically loaded <firstterm>kernel modules</firstterm>. Kernel modules can provide:</para>
   <itemizedlist>
     <listitem>
@@ -73,17 +56,21 @@
     id="sec-Listing_Currently-Loaded_Modules">
     <title>Listing Currently-Loaded Modules</title>
     <indexterm>
-      <primary>
-        <command>lsmod</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>listing</secondary>
+      <tertiary>currently loaded modules</tertiary>
     </indexterm>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>listing</secondary>
+      <secondary>utilities</secondary>
+      <tertiary><command>lsmod</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>lsmod</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <para>You can list all kernel modules that are currently loaded into the kernel by running the <command>lsmod</command> command:</para>
     <screen>
-
 ~]$&#160;<command>lsmod</command>
 Module                  Size  Used by
 xfs                   803635  1
@@ -133,19 +120,29 @@ kvm                   253162  1 kvm_intel
             linkend="sec-Unloading_a_Module"/>.</para>
       </listitem>
     </itemizedlist>
+    <indexterm>
+      <primary>kernel module</primary>
+      <secondary>files</secondary>
+      <tertiary><filename>/proc/modules</filename></tertiary>
+    </indexterm>
     <para>Finally, note that <command>lsmod</command> output is less verbose and considerably easier to read than the content of the <filename>/proc/modules</filename> pseudo-file.</para>
   </section>
   <section
     id="sec-Displaying_Information_About_a_Module">
     <title>Displaying Information About a Module</title>
     <indexterm>
-      <primary>
-        <command>modinfo</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>listing</secondary>
+      <tertiary>module information</tertiary>
     </indexterm>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>examining</secondary>
+      <secondary>utilities</secondary>
+      <tertiary><command>modinfo</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>modinfo</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <para>You can display detailed information about a kernel module by running the <command>modinfo&#160;<replaceable>&lt;module_name&gt;</replaceable>
       </command> command.</para>
@@ -258,19 +255,29 @@ parm:           WriteProtectNVM:Write-protect NVM [WARNING: disabling this can l
     id="sec-Loading_a_Module">
     <title>Loading a Module</title>
     <indexterm>
-      <primary>
-        <command>modprobe</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>loading</secondary>
+      <tertiary>for the current session</tertiary>
     </indexterm>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>loading</secondary>
+      <secondary>utilities</secondary>
+      <tertiary><command>modprobe</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>modprobe</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <para>To load a kernel module, run <command>modprobe <replaceable>&lt;module_name&gt;</replaceable>
       </command> as root. For example, to load the <systemitem
         class="resource">wacom</systemitem> module, run:</para>
     <screen>~]#&#160;<command>modprobe wacom</command>
     </screen>
+    <indexterm>
+      <primary>kernel module</primary>
+      <secondary>directories</secondary>
+      <tertiary><filename class="directory">/lib/modules/<replaceable>&lt;kernel_version&gt;</replaceable>/kernel/drivers/</filename></tertiary>
+    </indexterm>
     <para>By default, <command>modprobe</command> attempts to load the module from <filename
         class="directory">/lib/modules/<replaceable>&lt;kernel_version&gt;</replaceable>/kernel/drivers/</filename>. In this directory, each type of module has its own subdirectory, such as <filename
         class="directory">net/</filename> and <filename
@@ -299,9 +306,13 @@ insmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/scsi/fcoe/fcoe.ko</scree
         class="resource">fcoe</systemitem>. Also note that <command>modprobe</command> used the more <quote>primitive</quote>
       <command>insmod</command> command to insert the modules into the running kernel.</para>
     <indexterm>
-      <primary>
-        <command>insmod</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>utilities</secondary>
+      <tertiary><command>insmod</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>insmod</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <important
       id="important-Always_use_modprobe_instead_of_insmod">
@@ -313,13 +324,17 @@ insmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/scsi/fcoe/fcoe.ko</scree
     id="sec-Unloading_a_Module">
     <title>Unloading a Module</title>
     <indexterm>
-      <primary>
-        <command>modprobe</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>unloading</secondary>
     </indexterm>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>unloading</secondary>
+      <secondary>utilities</secondary>
+      <tertiary><command>modprobe</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>modprobe</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <para>You can unload a kernel module by running <command>modprobe -r <replaceable>&lt;module_name&gt;</replaceable>
       </command> as root. For example, assuming that the <systemitem
@@ -364,9 +379,13 @@ rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/firewire/firewire-core.ko
 rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/lib/crc-itu-t.ko</screen>
     <para>The output shows that modules are unloaded in the reverse order that they are loaded, given that no proceses depend on any of the modules being unloaded.</para>
     <indexterm>
-      <primary>
-        <command>rmmod</command>
-      </primary>
+      <primary>kernel module</primary>
+      <secondary>utilities</secondary>
+      <tertiary><command>rmmod</command></tertiary>
+    </indexterm>
+    <indexterm>
+      <primary><command>rmmod</command></primary>
+      <seealso>kernel module</seealso>
     </indexterm>
     <important
       id="important-Do_not_use_rmmod_directly">
@@ -378,11 +397,6 @@ rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/lib/crc-itu-t.ko</screen>
     id="sec-Setting_Module_Parameters">
     <title>Setting Module Parameters</title>
     <indexterm>
-      <primary>kernel module</primary>
-      <secondary>module parameters</secondary>
-      <tertiary>specifying</tertiary>
-    </indexterm>
-    <indexterm>
       <primary>module parameters</primary>
       <see>kernel module</see>
     </indexterm>
@@ -462,11 +476,13 @@ rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/lib/crc-itu-t.ko</screen>
     <title>Persistent Module Loading</title>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>persistent loading</secondary>
+      <secondary>loading</secondary>
+      <tertiary>at the boot time</tertiary>
     </indexterm>
     <indexterm>
       <primary>kernel module</primary>
-      <secondary>/etc/sysconfig/modules/</secondary>
+      <secondary>directories</secondary>
+      <tertiary><filename class="directory">/etc/sysconfig/modules/</filename></tertiary>
     </indexterm>
     <para>As shown in <xref
         linkend="ex-Listing_information_about_a_kernel_module_with_lsmod"/>, many kernel modules are loaded automatically at boot time. You can specify additional modules to be loaded by creating a new <filename><replaceable>&lt;file_name&gt;</replaceable>.modules</filename> file in the <filename
@@ -515,10 +531,6 @@ fi</programlisting>
         <secondary>Ethernet module</secondary>
         <tertiary>supporting multiple cards</tertiary>
       </indexterm>
-      <indexterm>
-        <primary>Ethernet module</primary>
-        <see>kernel module</see>
-      </indexterm>
       <para>It is possible to use multiple Ethernet cards on a single machine. For each card there must be an <command>alias</command> and, possibly, <command>options</command> lines for each card in a user-created <filename><replaceable>&lt;module_name&gt;</replaceable>.conf</filename> file in the <filename>/etc/modprobe.d/</filename> directory.</para>
       <para>For additional information about using multiple Ethernet cards, refer to the <citetitle>Linux Ethernet-HOWTO</citetitle> online at <ulink
           url="http://www.redhat.com/mirrors/LDP/HOWTO/Ethernet-HOWTO.html">http://www.redhat.com/mirrors/LDP/HOWTO/Ethernet-HOWTO.html</ulink>.</para>
@@ -527,31 +539,35 @@ fi</programlisting>
       id="sec-Using_Channel_Bonding">
       <title>Using Channel Bonding</title>
       <indexterm>
+        <primary>kernel module</primary>
+        <secondary>bonding module</secondary>
+        <tertiary>description</tertiary>
+      </indexterm>
+      <indexterm>
         <primary>channel bonding</primary>
-        <secondary>bonding options</secondary>
+        <secondary>description</secondary>
       </indexterm>
-
       <indexterm>
-        <primary>kernel module</primary>
-        <secondary>channel bonding</secondary>
+        <primary>bonding</primary>
+        <see>channel bonding</see>
       </indexterm>
       <indexterm>
         <primary>NIC</primary>
         <secondary>binding into single channel</secondary>
       </indexterm>
       <indexterm>
-        <primary>kernel module</primary>
-        <secondary>bonding kernel module</secondary>
+        <primary>channel bonding interface</primary>
+        <see>kernel module</see>
       </indexterm>
+      <para>&MAJOROS; allows administrators to bind NICs together into a single channel using the <filename>bonding</filename> kernel module and a special network interface, called a <firstterm>channel bonding interface</firstterm>. Channel bonding enables two or more network interfaces to act as one, simultaneously increasing the bandwidth and providing redundancy.</para>
       <indexterm>
         <primary>kernel module</primary>
-        <secondary>channel bonding interface</secondary>
+        <secondary>bonding module</secondary>
       </indexterm>
       <indexterm>
-        <primary>channel bonding interface</primary>
-        <see>kernel module</see>
+        <primary>channel bonding</primary>
+        <secondary>configuration</secondary>
       </indexterm>
-      <para>&MAJOROS; allows administrators to bind NICs together into a single channel using the <filename>bonding</filename> kernel module and a special network interface, called a <firstterm>channel bonding interface</firstterm>. Channel bonding enables two or more network interfaces to act as one, simultaneously increasing the bandwidth and providing redundancy.</para>
       <para>To channel bond multiple network interfaces, the administrator must perform the following steps:</para>
       <orderedlist
         continuation="restarts"
@@ -575,26 +591,17 @@ fi</programlisting>
         <title>Bonding Module Directives</title>
         <indexterm>
           <primary>kernel module</primary>
-          <secondary>parameters</secondary>
-          <tertiary>bonding module parameters</tertiary>
-        </indexterm>
-        <indexterm>
-          <primary>channel bonding</primary>
-          <secondary>parameters to bonded interfaces</secondary>
-        </indexterm>
-        <indexterm>
-          <primary>kernel module</primary>
-          <secondary>bonding kernel module</secondary>
+          <secondary>bonding module</secondary>
           <tertiary>parameters to bonded interfaces</tertiary>
         </indexterm>
         <indexterm>
           <primary>kernel module</primary>
-          <secondary>bonding module</secondary>
-          <see>channel bonding</see>
+          <secondary>module parameters</secondary>
+          <tertiary>bonding module parameters</tertiary>
         </indexterm>
         <indexterm>
           <primary>channel bonding</primary>
-          <secondary>parameters</secondary>
+          <secondary>parameters to bonded interfaces</secondary>
         </indexterm>
         <para>It is a good idea to test which channel bonding module parameters work best for your bonded interfaces before adding them to the <parameter
             class="option">BONDING_OPTS="<replaceable>&lt;bonding parameters&gt;</replaceable>"</parameter> directive in your bonding interface configuration file (<filename>ifcfg-bond0</filename> for example). Parameters to bonded interfaces can be configured without unloading (and reloading) the bonding module by manipulating files in the <systemitem


More information about the docs-commits mailing list