aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Robinson <andr345@gmail.com>2009-10-16 11:50:11 +0200
committerAndreas Robinson <andr345@gmail.com>2009-10-16 11:50:11 +0200
commit32ce7c3bc5f830bb2289ae09979dacef9c5b2642 (patch)
treedacaed3663062a6ebf4a021b34b0ff263d1becd6
parent9127f56dd2d62cdbac99189984286f876b37a704 (diff)
downloadmodule-init-tools-32ce7c3bc5f830bb2289ae09979dacef9c5b2642.tar.gz
doc: add softdep command
Signed-off-by: Andreas Robinson <andr345@gmail.com>
-rw-r--r--doc/modprobe.conf.sgml31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/modprobe.conf.sgml b/doc/modprobe.conf.sgml
index cacc006..16fde3a 100644
--- a/doc/modprobe.conf.sgml
+++ b/doc/modprobe.conf.sgml
@@ -176,6 +176,37 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>softdep <replaceable>modulename</replaceable> &#91;pre: <replaceable>pre-deps...</replaceable>&#93; &#91;post: <replaceable>post-deps...</replaceable>&#93;
+ </term>
+ <listitem>
+ <para>
+ The softdep command allows you to specify soft, or optional, module
+ dependencies. <replaceable>modulename</replaceable> can be used
+ without these optional modules installed, but usually with some
+ features missing.
+ </para>
+ <para>
+ pre-deps and post-deps are lists of names and/or aliases of other
+ modules that modprobe will attempt to install (or remove) in order
+ before and after the main module given in the
+ <replaceable>modulename</replaceable> argument.
+ </para>
+ <para>
+ Example: Assume "softdep c pre: a b post: d e" is provided in the
+ configuration. Running "modprobe c" is now equivalent to
+ "modprobe a b c d e" without the softdep.
+ Flags such as --use-blacklist are applied to all the specified
+ modules, while module parameters only apply to module c.
+ </para>
+ <para>
+ Note: if there are <command>install</command> or
+ <command>remove</command> commands with the same
+ <replaceable>modulename</replaceable> argument,
+ <command>softdep</command> takes precedence.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>