Rewrite the help descriptions for clarity, accuracy and consistency.
Kernel config options affected:
- MODULES
- MODULE_UNLOAD
- MODULE_FORCE_UNLOAD
- MODVERSIONS
- MODULE_SRCVERSION_ALL
- KMOD
Signed-off-by: Nick Andrew <[email protected]>
---
Try #3.
--- a/init/Kconfig 2008-02-20 09:34:48.000000000 +1100
+++ b/init/Kconfig 2008-02-22 09:17:11.000000000 +1100
@@ -769,20 +769,26 @@ config BASE_SMALL
menuconfig MODULES
bool "Enable loadable module support"
help
- Kernel modules are small pieces of compiled code which can
- be inserted in the running kernel, rather than being
- permanently built into the kernel. You use the "modprobe"
- tool to add (and sometimes remove) them. If you say Y here,
- many parts of the kernel can be built as modules (by
- answering M instead of Y where indicated): this is most
- useful for infrequently used options which are not required
- for booting. For more information, see the man pages for
- modprobe, lsmod, modinfo, insmod and rmmod.
-
- If you say Y here, you will need to run "make
- modules_install" to put the modules under /lib/modules/
- where modprobe can find them (you may need to be root to do
- this).
+ This option allows the kernel to load Kernel modules
+ at runtime to increase functionality, support new
+ devices and so on.
+
+ Kernel modules are compiled code such as device drivers
+ and filesystems. You can use the "lsmod" command to see
+ what modules are currently loaded, and "modprobe" to
+ add (and sometimes remove) them.
+
+ If you say Y here, many parts of the kernel can be built as
+ modules (by answering M instead of Y where indicated). This
+ reduces the size of the compiled kernel and allows you to
+ choose at runtime which modules will be loaded. With some
+ other options enabled, module loading and unloading can be
+ performed automatically by the kernel upon demand.
+
+ If you say Y here, you will need to run "make modules_install"
+ after building the kernel to put the modules under /lib/modules/
+ where "modprobe" can find them. You probably need to be root to
+ install the modules.
If unsure, say Y.
@@ -790,10 +796,16 @@ config MODULE_UNLOAD
bool "Module unloading"
depends on MODULES
help
- Without this option you will not be able to unload any
- modules (note that some modules may not be unloadable
- anyway), which makes your kernel slightly smaller and
- simpler. If unsure, say Y.
+ This option allows the kernel to unload unused modules.
+
+ A module can only be unloaded if it is not in use by
+ other modules, the kernel or running processes (for
+ example, using a device through the module).
+
+ Disabling this option will make the kernel slightly
+ smaller and simpler.
+
+ If unsure, say Y.
config MODULE_FORCE_UNLOAD
bool "Forced module unloading"
@@ -803,6 +815,7 @@ config MODULE_FORCE_UNLOAD
kernel believes it is unsafe: the kernel will remove the module
without waiting for anyone to stop using it (using the -f option to
rmmod). This is mainly for kernel developers and desperate users.
+
If unsure, say N.
config MODVERSIONS
@@ -813,8 +826,9 @@ config MODVERSIONS
Saying Y here makes it sometimes possible to use modules
compiled for different kernels, by adding enough information
to the modules to (hopefully) spot any changes which would
- make them incompatible with the kernel you are running. If
- unsure, say N.
+ make them incompatible with the kernel you are running.
+
+ If unsure, say N.
config MODULE_SRCVERSION_ALL
bool "Source checksum for all modules"
@@ -822,11 +836,15 @@ config MODULE_SRCVERSION_ALL
help
Modules which contain a MODULE_VERSION get an extra "srcversion"
field inserted into their modinfo section, which contains a
- sum of the source files which made it. This helps maintainers
- see exactly which source was used to build a module (since
- others sometimes change the module source without updating
- the version). With this option, such a "srcversion" field
- will be created for all modules. If unsure, say N.
+ checksum (using the MD4 algorithm) of the source files which
+ made it.
+
+ This helps maintainers see exactly which source was used
+ to build a module (since others sometimes change the module
+ source without updating the version). With this option, such
+ a "srcversion" field will be created for all modules.
+
+ If unsure, say N.
config KMOD
bool "Automatic kernel module loading"
@@ -834,11 +852,14 @@ config KMOD
help
Normally when you have selected some parts of the kernel to
be created as kernel modules, you must load them (using the
- "modprobe" command) before you can use them. If you say Y
- here, some parts of the kernel will be able to load modules
- automatically: when a part of the kernel needs a module, it
- runs modprobe with the appropriate arguments, thereby
- loading the module if it is available. If unsure, say Y.
+ "modprobe" command) before you can use them.
+
+ If you say Y here, some parts of the kernel will be able to
+ load modules automatically: when a part of the kernel needs a
+ module, it will run modprobe with the appropriate arguments,
+ thereby loading the module if it is available.
+
+ If unsure, say Y.
config STOP_MACHINE
bool