[PATCH] doc: specifiying module parameters

From: "Randy.Dunlap" <rddunlap@osdl.org>

kernel-parameters.txt: add info on how to specify loadable module
parameters vs.  built-in module parameters

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index ad50cadea84875d030055c0ad84d746baed01ba0..bc95536fcf2fbb44d51b4b9d5463e65f8dd221d6 100644 (file)
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -6,6 +6,17 @@ The following is a consolidated list of the kernel parameters as implemented
 (defined as ignoring all punctuation and sorting digits before letters in a
 case insensitive manner), and with descriptions where known.
 
+Module parameters for loadable modules are specified only as the
+parameter name with optional '=' and value as appropriate, such as:
+
+       modprobe usbcore blinkenlights=1
+
+Module parameters for modules that are built into the kernel image
+are specified on the kernel command line with the module name plus
+'.' plus parameter name, with '=' and value if appropriate, such as:
+
+       usbcore.blinkenlights=1
+
 The text in square brackets at the beginning of the description state the
 restrictions on the kernel for the said kernel parameter to be valid. The
 restrictions referred to are that the relevant option is valid if: