Re: Documentation of module parameters.

john slee (indigoid@higherplane.net)
Sat, 21 Apr 2001 03:19:20 +1000


--H8ygTp4AXg6deix2
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Fri, Apr 20, 2001 at 01:37:22PM -0300, Harald Welte wrote:
> On Mon, Apr 16, 2001 at 10:07:56PM -0700, Jonathan Lundell wrote:
> > At 11:30 PM -0400 2001-04-16, Chris Kloiber wrote:
> > >I was recently looking for a single location where all the possible
> > >module parameters for the linux kernel was located.
> >
> > Hear him. A DocBook document would be a dandy place for this to get pulled
> > together, too.
>
> good idea. One could just grab all the MODULE_PARM_DESC out of all sourcefiles,
> look to which module the particular sourcefile belongs (looking into
> Makefile?), and create a Documentation/DocBook/... document out of it.
>
> Sounds like something doable, only somebody needs to get around doing
> it. Any volunteers?

it sounded like a challenge. this might help someone who can't be
bothered extracting all the data by hand. it spits it out in tab
delimited form, as sanely as i could manage in 5 minutes.

j.

-- 
"Bobby, jiggle Grandpa's rat so it looks alive, please" -- gary larson

--H8ygTp4AXg6deix2 Content-Type: text/x-sh; charset=us-ascii Content-Disposition: attachment; filename="kernel-module-info.sh"

#!/bin/sh

# john slee <indigoid@higherplane.net> # Sat Apr 21 03:17:55 EST 2001 # quick and dirty. run from a kernel source dir somewhere.

find . -name "*.c" | xargs egrep 'MODULE_DESCRIPTION|MODULE_PARM_DESC' \ | sed '/#undef/d; s/^\.\///; s/[:()]/ /g; s/[";]//g; /MODULE_PARM_DESC/s/,[ ]*/ /; /^[ ]*$/d'

--H8ygTp4AXg6deix2-- - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/