From a8e68daf16f87401b2abab9f306c944bbc01a7b8 Mon Sep 17 00:00:00 2001 From: Jon Masters Date: Wed, 10 Mar 2010 01:12:24 -0500 Subject: [PATCH] modprobe: fix the softdep docs and re-order the modprobe.conf man page The softdep docs were great but I cleaned them up slightly, and I also added a warning to the new COMPATIBILITY section I had added recently. Also, re-order this file so that everything is in alphabetical order. Signed-off-by: Jon Masters --- doc/modprobe.conf.sgml | 65 ++++++++++++++++++++++++++------------------------ 1 file changed, 34 insertions(+), 31 deletions(-) diff --git a/doc/modprobe.conf.sgml b/doc/modprobe.conf.sgml index b1e19fa..a9c3d36 100644 --- a/doc/modprobe.conf.sgml +++ b/doc/modprobe.conf.sgml @@ -18,7 +18,7 @@ Jon Masters - 2010-03-01 + 2010-03-09 modprobe.conf @@ -86,21 +86,18 @@ - options modulename option... + blacklist modulename - This command allows you to add options to the module - modulename (which might be an - alias) every time it is inserted into the kernel: whether - directly (using modprobe - modulename or because the - module being inserted depends on this module. - - - All options are added together: they can come from an - option for the module itself, for an - alias, and on the command line. + Modules can contain their own aliases: usually these are + aliases describing the devices they support, such as + "pci:123...". These "internal" aliases can be overridden + by normal "alias" keywords, but there are cases where two + or more modules both support the same devices, or a module + invalidly claims to support a devicei that it does not: the + blacklist keyword indicates that all of + that particular module's internal aliases are to be ignored. @@ -148,43 +145,47 @@ - remove modulename command... + options modulename option... - This is similar to the install command - above, except it is invoked when "modprobe -r" is run. + This command allows you to add options to the module + modulename (which might be an + alias) every time it is inserted into the kernel: whether + directly (using modprobe + modulename or because the + module being inserted depends on this module. + + + All options are added together: they can come from an + option for the module itself, for an + alias, and on the command line. - blacklist modulename + remove modulename command... - Modules can contain their own aliases: usually these are - aliases describing the devices they support, such as - "pci:123...". These "internal" aliases can be overridden - by normal "alias" keywords, but there are cases where two - or more modules both support the same devices, or a module - invalidly claims to support a devicei that it does not: the - blacklist keyword indicates that all of - that particular module's internal aliases are to be ignored. + This is similar to the install command + above, except it is invoked when "modprobe -r" is run. - softdep modulename [pre: pre-deps...] [post: post-deps...] + softdep modulename pre: modules... post: modules... - The softdep command allows you to specify soft, or optional, module - dependencies. modulename can be used - without these optional modules installed, but usually with some - features missing. + The softdep command allows you to specify soft, + or optional, module dependencies. modulename + can be used without these optional modules installed, but usually with + some features missing. For example, a driver for a storage HBA might + require another module be loaded in order to use management features. - pre-deps and post-deps are lists of names and/or aliases of other + pre-deps and post-deps modules 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 modulename argument. @@ -212,6 +213,8 @@ A future version of module-init-tools will come with a strong warning to avoid use of the install as explained above. This will happen once support for soft dependencies in the kernel is complete. + That support will complement the existing softdep support within this + utility by providing such dependencies directly within the modules. -- 2.11.4.GIT