[system-administrators-guide] Improve markup for resources section

stephenw stephenw at fedoraproject.org
Thu Oct 23 19:43:40 UTC 2014


commit cfe4c6881bdae9d225ea10f7b3923385fd76b472
Author: Stephen Wadeley <swadeley at redhat.com>
Date:   Thu Oct 23 21:31:45 2014 +0200

    Improve markup for resources section
    
    in en-US/Working_with_Kernel_Modules.xml

 en-US/Working_with_Kernel_Modules.xml |  107 +++++++++++++-------------------
 1 files changed, 44 insertions(+), 63 deletions(-)
---
diff --git a/en-US/Working_with_Kernel_Modules.xml b/en-US/Working_with_Kernel_Modules.xml
index 3fb7b2b..cbabb95 100644
--- a/en-US/Working_with_Kernel_Modules.xml
+++ b/en-US/Working_with_Kernel_Modules.xml
@@ -491,69 +491,50 @@ fi</programlisting>
     id="s1-kernel-modules-additional-resources">
     <title>Additional Resources</title>
     <para>For more information on kernel modules and their utilities, see the following resources.</para>
-    <section id="s2-kernel-modules-additional-resources-installed">
-      <title>Installed Documentation</title>
-      <para>There are a number of manual pages for various utilities related to kernel modules:</para>
-      <variablelist>
-        <varlistentry>
-          <term><command>man lsmod</command></term>
-          <listitem>
-            <para>The manual page for the <command>lsmod</command> command.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><command>man modinfo</command></term>
-          <listitem>
-            <para>The manual page for the <command>modinfo</command> command.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><command>man modprobe</command></term>
-          <listitem>
-            <para>The manual page for the <command>modprobe</command> command.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><command>man rmmod</command></term>
-          <listitem>
-            <para>The manual page for the <command>rmmod</command> command.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><command>man ethtool</command></term>
-          <listitem>
-            <para>The manual page for the <command>ethtool</command> command.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><command>man mii-tool</command></term>
-          <listitem>
-            <para>The manual page for the <command>mii-tool</command> command.</para>
-          </listitem>
-        </varlistentry>
-      </variablelist>
-      <para>Additionally, you can refer to the documentation provided by the <package>kernel-doc</package> package:</para>
-      <variablelist>
-        <varlistentry>
-          <term><filename class="directory">/usr/share/doc/kernel-doc-<replaceable>kernel_version</replaceable>/Documentation/</filename></term>
-          <listitem>
-            <para>This directory contains information on the kernel, kernel modules, and their respective parameters. Note that before accessing the kernel documentation, you must run the following command as <systemitem class="username">root</systemitem>:</para>
-            <screen><command>yum install kernel-doc</command></screen>
-          </listitem>
-        </varlistentry>
-      </variablelist>
-    </section>
-    <section id="s2-kernel-modules-additional-resources-websites">
-      <title>Useful Websites</title>
-      <variablelist>
-        <varlistentry>
-          <term><ulink url="http://tldp.org/HOWTO/Module-HOWTO/">Linux Loadable Kernel Module HOWTO</ulink></term>
-          <listitem>
-            <para>The <citetitle>Linux Loadable Kernel Module HOWTO</citetitle> from the Linux Documentation Project contains further information on working with kernel modules.</para>
-          </listitem>
-        </varlistentry>
-      </variablelist>
-    </section>
+    <bridgehead
+      id="bh-Manual_Page_Documentation">Manual Page Documentation</bridgehead>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <filename>lsmod(8)</filename> — The manual page for the <command>lsmod</command> command.</para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>modinfo(8)</filename> — The manual page for the <command>modinfo</command> command.</para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>modprobe(8)</filename> — The manual page for the <command>modprobe</command> command.</para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>rmmod(8)</filename> — The manual page for the <command>rmmod</command> command.</para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>ethtool(8)</filename> — The manual page for the <command>ethtool</command> command.</para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>mii-tool(8)</filename> — The manual page for the <command>mii-tool</command> command.</para>
+      </listitem>
+    </itemizedlist>
+    <bridgehead
+      id="bh-Installable_and_External_Documentation">Installable and External Documentation</bridgehead>
+    <itemizedlist>
+      <!--<listitem>
+        <para>
+          <filename
+            class="directory">/usr/share/doc/kernel-doc-<replaceable>kernel_version</replaceable>/Documentation/</filename> — This directory, which is provided by the <package>kernel-doc</package> package, contains information on the kernel, kernel modules, and their respective parameters. Before accessing the kernel documentation, you must run the following command as <systemitem class="username">root</systemitem>:</para>
+        <screen>~]#&nbsp;<command>yum install kernel-doc</command>
+        </screen>
+      </listitem>-->
+      <listitem>
+        <para>
+          <ulink
+            url="http://tldp.org/HOWTO/Module-HOWTO/">Linux Loadable Kernel Module HOWTO</ulink> — The <citetitle>Linux Loadable Kernel Module HOWTO</citetitle> from the Linux Documentation Project contains further information on working with kernel modules.</para>
+      </listitem>
+    </itemizedlist>
   </section>
 </chapter>
 <!-- silas: entire section removed in favor of explaining how to use modinfo


More information about the docs-commits mailing list