[system-administrators-guide] style, markup, and typos
stephenw
stephenw at fedoraproject.org
Tue Jul 29 07:08:51 UTC 2014
commit d866b4c6859e014c502e97bf74163d35a0c6bdcb
Author: Stephen Wadeley <swadeley at redhat.com>
Date: Tue Jul 29 09:05:37 2014 +0200
style, markup, and typos
en-US/Working_with_Kernel_Modules.xml | 69 +++++++++-----------------------
1 files changed, 20 insertions(+), 49 deletions(-)
---
diff --git a/en-US/Working_with_Kernel_Modules.xml b/en-US/Working_with_Kernel_Modules.xml
index e552be6..6988ab4 100644
--- a/en-US/Working_with_Kernel_Modules.xml
+++ b/en-US/Working_with_Kernel_Modules.xml
@@ -60,14 +60,10 @@
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>lsmod</command>
- </tertiary>
+ <tertiary><command>lsmod</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>lsmod</command>
- </primary>
+ <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, for example:</para>
@@ -123,9 +119,7 @@ kvm 253162 1 kvm_intel
<indexterm>
<primary>kernel module</primary>
<secondary>files</secondary>
- <tertiary>
- <filename>/proc/modules</filename>
- </tertiary>
+ <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>
@@ -140,14 +134,10 @@ kvm 253162 1 kvm_intel
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>modinfo</command>
- </tertiary>
+ <tertiary><command>modinfo</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>modinfo</command>
- </primary>
+ <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 <replaceable>module_name</replaceable></command> command.</para>
@@ -264,14 +254,10 @@ parm: WriteProtectNVM:Write-protect NVM [WARNING: disabling this can l
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>modprobe</command>
- </tertiary>
+ <tertiary><command>modprobe</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>modprobe</command>
- </primary>
+ <primary><command>modprobe</command></primary>
<seealso>kernel module</seealso>
</indexterm>
<para>To load a kernel module, run <command>modprobe <replaceable>module_name</replaceable></command> as <systemitem class="username">root</systemitem>. For example, to load the <systemitem class="resource">wacom</systemitem> module, run:</para>
@@ -285,10 +271,10 @@ parm: WriteProtectNVM:Write-protect NVM [WARNING: disabling this can l
class="directory">/lib/modules/<replaceable>kernel_version</replaceable>/kernel/drivers/</filename>
</tertiary>
</indexterm>
- <para>By default, <command>modprobe</command> attempts to load the module from <filename class="directory">/lib/modules/<replaceable>kernel_version</replaceable>/kernel/drivers/</filename>. In this directory, each type of module has its own subdirectory, such as <filename class="directory">net/</filename> and <filename class="directory">scsi/</filename>, for network and SCSI interface drivers respectively.</para>
+ <para>By default, <command>modprobe</command> attempts to load the module from <filename class="directory">/lib/modules/<replaceable>kernel_version</replaceable>/kernel/drivers/</filename>. In this directory, each type of module has its own subdirectory, such as <filename class="directory">net/</filename> and <filename class="directory">scsi/</filename>, for network and SCSI interface drivers respectively.</para>
<para>Some modules have dependencies, which are other kernel modules that must be loaded before the module in question can be loaded. The <command>modprobe</command> command always takes dependencies into account when performing operations. When you ask <command>modprobe</command> to load a specific kernel module, it first examines the dependencies of that module, if there are any, and loads them if they are not already loaded into the kernel. <command>modprobe</command> resolves dependencies recursively: it will load all dependencies of dependencies, and so on, if necessary, thus ensuring that all dependencies are always met.<!-- Because of this, there is no need to determine and resolve module dependencies manually.-->
</para>
- <para>You can use the <option>-v</option> (or <option>--verbose</option>) option to cause <command>modprobe</command> to display detailed information about what it is doing, which may include loading module dependencies.</para>
+ <para>You can use the <option>-v</option> (or <option>--verbose</option>) option to cause <command>modprobe</command> to display detailed information about what it is doing, which can include loading module dependencies.</para>
<example
id="ex-modprobe_-v_shows_module_dependencies_as_they_are_loaded">
<title>modprobe -v shows module dependencies as they are loaded</title>
@@ -304,14 +290,10 @@ insmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/scsi/fcoe/fcoe.ko</scree
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>insmod</command>
- </tertiary>
+ <tertiary><command>insmod</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>insmod</command>
- </primary>
+ <primary><command>insmod</command></primary>
<seealso>kernel module</seealso>
</indexterm>
<important
@@ -330,14 +312,10 @@ insmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/scsi/fcoe/fcoe.ko</scree
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>modprobe</command>
- </tertiary>
+ <tertiary><command>modprobe</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>modprobe</command>
- </primary>
+ <primary><command>modprobe</command></primary>
<seealso>kernel module</seealso>
</indexterm>
<para>You can unload a kernel module by running <command>modprobe -r <replaceable>module_name</replaceable> </command> as <systemitem class="username">root</systemitem>. For example, assuming that the <systemitem class="resource">wacom</systemitem> module is already loaded into the kernel, you can unload it by running:</para>
@@ -347,15 +325,15 @@ insmod /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/scsi/fcoe/fcoe.ko</scree
<itemizedlist>
<listitem>
<para>the <systemitem
- class="resource">wacom</systemitem> module,</para>
+ class="resource">wacom</systemitem> module;</para>
</listitem>
<listitem>
<para>a module that <systemitem
- class="resource">wacom</systemitem> directly depends on, or,</para>
+ class="resource">wacom</systemitem> directly depends on, or;</para>
</listitem>
<listitem>
<para>any module that <systemitem
- class="resource">wacom</systemitem>—through the dependency tree—depends on indirectly.</para>
+ class="resource">wacom</systemitem>, through the dependency tree, depends on indirectly.</para>
</listitem>
</itemizedlist>
<para>Refer to <xref linkend="sec-Listing_Currently-Loaded_Modules"/> for more information about using <command>lsmod</command> to obtain the names of the modules which are preventing you from unloading a certain module.</para>
@@ -379,14 +357,10 @@ rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/lib/crc-itu-t.ko</screen>
<indexterm>
<primary>kernel module</primary>
<secondary>utilities</secondary>
- <tertiary>
- <command>rmmod</command>
- </tertiary>
+ <tertiary><command>rmmod</command></tertiary>
</indexterm>
<indexterm>
- <primary>
- <command>rmmod</command>
- </primary>
+ <primary><command>rmmod</command></primary>
<seealso>kernel module</seealso>
</indexterm>
<important
@@ -477,10 +451,7 @@ rmmod /lib/modules/2.6.32-71.el6.x86_64/kernel/lib/crc-itu-t.ko</screen>
<indexterm>
<primary>kernel module</primary>
<secondary>directories</secondary>
- <tertiary>
- <filename
- class="directory">/etc/sysconfig/modules/</filename>
- </tertiary>
+ <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>file_name</replaceable>.modules</filename> file in the <filename class="directory">/etc/sysconfig/modules/</filename> directory, where <replaceable>file_name</replaceable> is any descriptive name of your choice. Your <filename><replaceable>file_name</replaceable>.modules</filename> files are treated by the system startup scripts as shell scripts, and as such should begin with an <firstterm>interpreter directive</firstterm> (also called a <quote>bang line</quote>) as their first line:</para>
@@ -518,7 +489,7 @@ fi</programlisting>
<para>For more information on kernel modules and their utilities, refer to the following resources.</para>
<section id="s2-kernel-modules-additional-resources-installed">
<title>Installed Documentation</title>
- <para>There is a number of manual pages for various utilities related to the kernel modules:</para>
+ <para>There are a number of manual pages for various utilities related to kernel modules:</para>
<variablelist>
<varlistentry>
<term><command>man lsmod</command></term>
More information about the docs-commits
mailing list