[PATCH 14/14] doc: document the depmod 'alternatives' feature

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Keegan McAllister <keegan@xxxxxxxxxxx>
---
 Makefile.am                  |    2 +-
 doc/depmod.alternatives.sgml |  120 ++++++++++++++++++++++++++++++++++++++++++
 doc/depmod.sgml              |    3 +
 3 files changed, 124 insertions(+), 1 deletions(-)
 create mode 100644 doc/depmod.alternatives.sgml

diff --git a/Makefile.am b/Makefile.am
index 6f83c12..1a30932 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -36,7 +36,7 @@ depmod_LDADD = $(LDADD) libmodtools.a
 modinfo_LDADD = $(LDADD) libmodtools.a
 modindex_LDADD = $(LDADD) libmodtools.a
 
-MAN5 = modprobe.conf.5 modules.dep.5 depmod.conf.5 modprobe.d.5
+MAN5 = modprobe.conf.5 modules.dep.5 depmod.conf.5 modprobe.d.5 depmod.alternatives.5
 MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8
 SGML = $(addprefix doc/,  $(MAN5:%.5=%.sgml) $(MAN8:%.8=%.sgml))
 dist_man_MANS = $(MAN5) $(MAN8)
diff --git a/doc/depmod.alternatives.sgml b/doc/depmod.alternatives.sgml
new file mode 100644
index 0000000..98ec571
--- /dev/null
+++ b/doc/depmod.alternatives.sgml
@@ -0,0 +1,120 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+  <!ENTITY debian  "<productname>Debian GNU/Linux</productname>">
+  <!ENTITY docbook "<productname>DocBook</productname>">
+  <!ENTITY sgml    "<abbrev>SGML</abbrev>">
+]>
+
+<!-- Stolen from manual page for docbook-to-man, DocBook source file
+     (C) 1999 W. Borgert debacle@xxxxxxxxxx
+
+     $Id: docbook-to-man.sgml,v 1.8 2002/04/27 15:28:02 debacle Exp $ -->
+
+<refentry>
+  <refentryinfo>
+    <address>
+      <email>keegan@xxxxxxxxxxx</email>
+    </address>
+    <author>
+      <firstname>Keegan</firstname>
+      <surname>McAllister</surname>
+    </author>
+    <date>2010-12-17</date>
+  </refentryinfo>
+  <refmeta>
+    <refentrytitle>depmod.alternatives</refentrytitle>
+    <manvolnum>5</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>depmod.alternatives</refname> <refpurpose>Configuring alternative module trees for depmod</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para><command>depmod</command> can be configured to maintain dependency
+    information for several independent trees of kernel modules.  We will call
+    each independent tree an "alternative".  Each invocation of
+    <command>depmod</command> processes every alternative, and performs the
+    requested action separately for each.</para>
+
+    <para>The default alternative is the original <command>depmod</command>
+    behavior: process the module tree rooted at
+    <filename>/lib/modules</filename>, using the config files under
+    <filename>/etc/depmod.d</filename>.  Each other alternative is specified by
+    a file in the directory <filename>/etc/depmod.alternatives</filename>.
+    This file's name must end in <filename>.conf</filename>.</para>
+
+    <para>The format of these files is similar to the format of
+    <filename>depmod.conf</filename>: one command per line, following the same
+    whitespace and comment rules.  No command may be given more than once in
+    the same file.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>COMMANDS</title>
+    <variablelist>
+      <varlistentry>
+        <term>moduledir <replaceable>path</replaceable>
+        </term>
+	<listitem>
+	  <para>
+            Required. Specifies the module tree directory to use instead of
+            <filename>/lib/modules</filename>.  As with the default
+            alternative, <command>depmod</command> will automatically append
+            the kernel version.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>config <replaceable>path</replaceable>
+        </term>
+	<listitem>
+	  <para>
+            Optional. Specifies a <command>depmod</command> configuration file
+            or directory for this alternative.
+          </para>
+          <para>
+            If <command>config</command> is not specified, this alternative will
+            use the same configuration files as the default alternative.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>COPYRIGHT</title>
+    <para>
+      This manual page Copyright 2010, Keegan McAllister, Ksplice Inc.
+    </para>
+  </refsect1>
+    <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+	<refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
+      </citrefentry>,
+      <citerefentry>
+	<refentrytitle>depmod.conf</refentrytitle><manvolnum>5</manvolnum>
+      </citrefentry>,
+      <citerefentry>
+	<refentrytitle>depmod.d</refentrytitle><manvolnum>5</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
diff --git a/doc/depmod.sgml b/doc/depmod.sgml
index 606a4bb..7aa44d5 100644
--- a/doc/depmod.sgml
+++ b/doc/depmod.sgml
@@ -223,6 +223,9 @@
 	<refentrytitle>depmod.d</refentrytitle><manvolnum>5</manvolnum>
       </citerefentry>,
       <citerefentry>
+	<refentrytitle>depmod.alternatives</refentrytitle><manvolnum>5</manvolnum>
+      </citerefentry>,
+      <citerefentry>
 	<refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
       </citerefentry>,
       <citerefentry>
-- 
1.7.2.3

--
To unsubscribe from this list: send the line "unsubscribe linux-modules" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux