On Fri, 20 Oct 2006 23:05:33 +0200 Adrian Bunk wrote:

On Thu, Oct 19, 2006 at 05:29:58PM +0100, Alan Cox wrote:

quoted

Ar Iau, 2006-10-19 am 18:13 +0200, ysgrifennodd Adrian Bunk:

quoted

quoted

Missing update to Documentation/kernel-parameters.txt ?
(maybe it's been missing forever?)

It's been missing forever.

I'm not sure whether documenting it now where it's deprecated and nearly 
dead makes sense..

Its not dead, its so useful that drivers/ata also supports it

But in the drivers/ata case it's a module parameter, not a __setup 
kernel parameter.

That's just an implementation nit/detail.  Users don't care which
way it's implemented, they just need to see some reasonable
documentation.

And I don't think it makes sense to manually add module parameters to 
kernel-parameters.txt

There are module parameters there already...
so we are being inconsistent.

If a documentation of all module parameters is considered useful, 
someone should write a script to automatically generate such a list.

I think that sounds great -- in theory.  Really, I do.
I even wrote a (simple) script for it last night.[1]
(but someone else is free to redo it, and probably not in
shell script :)

And maybe one "development community" answer is that this is
a distro problem, let them handle it.  (I don't like that answer,
but possibly the distros are OK with it.  I don't know.)

Ideally, users would be able to see/read documentation (like kernel
or module parameters) (a) without reading the source code and
(b) without building the module binary files.  Maybe that's too
much to ask of the development community, so the users can just
build all 1500 or so (and growing) loadable kernel modules
and run 'modinfo' on them to see what the possible module
parameters are.  Of course, if they need this information to be
able to install their (only) Linux system, then they are out of
luck, or they can use their other (or working) OS to search the
internet for such documenation.

Anyway, regarding your suggestion:  Yes, I think that it would be
good to generate such documentation instead of maintaining it
(and sometimes not doing that).  Maybe someone can & will make
that happen.

---
~Randy
[1] http://www.xenotime.net/linux/scripts/module-params