Remove modules.txt

Thanks to Stephen Hemminger for pointing out how obsolete modules.txt is.

modules.txt contains mainly ancient information which is replicated in the kconfig help message, README, makefile.txt or the modprobe manual page. The only part which is not covered elsewhere is the "building external modules" which is still being debated (and belongs under the kbuild docs). kmod.txt reference removed from index, too.

Please sent patches to update Kconfig files which referred to modules.txt in small pieces to trivial at rustcorp.com.au. Please abbreviate wording, too, as follows:

 -	  To compile this driver as a module ( = code which can be inserted in
 -	  and removed from the running kernel whenever you want), say M here
 -	  and read <file:Documentation/modules.txt>. The module will be called
 -	  apm.
 +	  To compile this driver as a module, say M here: the
 +	  module will be called apm.

Thanks!
Rusty.

Name: Remove obsolete modules.txt, update module help
Author: Rusty Russell
Status: Trivial

D: Thanks to Stephen Hemminger for pointing out how obsolete modules.txt is. D:
D: modules.txt contains mainly ancient information which is replicated
D: in the kconfig help message, README, makefile.txt or the modprobe manual
D: page. The only part which is not covered elsewhere is the "building
D: external modules" which is still being debated (and belongs under the
D: kbuild docs). kmod.txt reference removed from index, too.
D:
D: Please sent patches to update Kconfig files which referred to
D: modules.txt in small pieces to trivial at rustcorp.com.au.
D: Please abbreviate wording, too, as follows:
D:
D: - To compile this driver as a module ( = code which can be inserted in
D: - and removed from the running kernel whenever you want), say M here
D: - and read <file:Documentation/modules.txt>. The module will be called
D: - apm.
D: + To compile this driver as a module, say M here: the
D: + module will be called apm.

diff -urpN --exclude TAGS -X /home/rusty/devel/kernel/kernel-patches/current-dontdiff --minimal .7926-linux-2.6.0-test5/Documentation/00-INDEX .7926-linux-2.6.0-test5.updated/Documentation/00-INDEX
@@ -116,8 +116,6 @@ kernel-docs.txt
 	- listing of various WWW + books that document kernel internals.
 kernel-parameters.txt
 	- summary listing of command line / boot prompt args for the kernel.
-kmod.txt
-	- info on the kernel module loader/unloader (kerneld replacement).
 ldm.txt
 	- a brief description of LDM (Windows Dynamic Disks).
 locks.txt

@@ -144,8 +142,6 @@ mkdev.cciss
 	- script to make /dev entries for SMART controllers (see cciss.txt)
 mkdev.ida
 	- script to make /dev entries for Intelligent Disk Array Controllers.
-modules.txt
-	- short guide on how to make kernel parts into loadable modules
 moxa-smartio
 	- info on installing/using Moxa multiport serial driver.
 mtrr.txt

--
Anyone who quotes me in their sig is an idiot. -- Rusty Russell.

I found another such gem in Documentation/smp.tex, which was last updated more than five years ago. Favorite quote:

"A single lock is maintained across all processors. This lock is
required to access the kernel space."

The whole file has only historic value and should probably be removed or have a comment that it does not apply to the current code.

	Arnd <><

In message <[email protected]> you write:

Agreed. Linus, please delete Documentation/smp.tex.

Cheers,
Rusty.
--
Anyone who quotes me in their sig is an idiot. -- Rusty Russell.