WANTED: .../modules.*map to (X)HTML

WANTED: .../modules.*map to (X)HTML

[David Brownell]

Searching for what should be a quick hack in  Perl,
Python, or XSLT.  Or the Docbook 3.1/Jade/SGML tools
that kernel doc currently uses.

Input:

    - the modutils 2.4.1 hotplug module listings and
      other output, for at least USB and PCI drivers.

    - "usb.ids", "pci.ids".

    - (ideally) some XML template file and/or stylesheet
      for the output tables (what text before/after,
      how to present tables/headings/captions, etc).

    - (dream on) module-specific documentation, in
      XML Docbook4 "section" format.

Output:

    - HTML file displaying each of these tables:

        * Products sorted by (OEM) vendor name and
          product ID(s), showing description and
          identifying the driver(s).

        * Same, but sorted by class, and maybe also
          subclass/protocol for the various kinds of
          USB class drivers.  

        * The same pair of tables for PCI/Cardbus

        * (ideally) The same pair for ISAPNP too.

    - (ideally) XML versions of "usbmap", "pcimap"
      and so forth, with no magic numbers saying which
      values are significant.  Easier to massage that
      with text processing tools, merging with other
      metadata like annotations (like Marcus' USB
      driver database at www.qbik.ch), docs, and:

    - (dream on) some XML file holding all the modutils
      data "MODULE_DESCRIPTION", "MODULE_PARM_DESC" and
      so forth, for each module.

    - (dream on) those tables tables are merged into
      a Docbook4 reference to document the drivers
      on each given system.  Click the driver name to
      go to its docbook documentation, show the data
      that "modutils" exposes (description, parameters
      and types, ...), and so on.

I'd like to see a list of all the products that the
Linux 2.4 kernel thinks it's able to hotplug, and that
seems like a fair way to maintain such a list.  Likely
it'd be good on the linux-hotplug website (which is
rather skeletal at this time).

Right now I'd just like some quick hack, but as I
imply above, there's surely potential for lots more
if anyone's interested in pursuing that direction.

- Dave






_______________________________________________
Linux-hotplug-devel mailing list
Linux-hotplug-devel@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: WANTED: .../modules.*map to (X)HTML

[Keith Owens]

On Sat, 13 Jan 2001 08:41:42 -0800, 
David Brownell <david-b@pacbell.net> wrote:
>    - (dream on) some XML file holding all the modutils
>      data "MODULE_DESCRIPTION", "MODULE_PARM_DESC" and
>      so forth, for each module.

There is a patch in my intray by Jaroslav Kysela that creates
modules.parms.  One line for each MODULE_AUTHOR, _DESCRIPTION, _PARM,
_PARM_DESC.  That patch will be in modutils 2.4.2 or maybe later.  I am
holding off on modutils work until Linus/Alan realises that we need the
kernel patch to add version numbers to device tables, I want an agreed
working base to extend on.


_______________________________________________
Linux-hotplug-devel mailing list
Linux-hotplug-devel@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: WANTED: .../modules.*map to (X)HTML

[David Brownell]

> >    - (dream on) some XML file holding all the modutils
> >      data "MODULE_DESCRIPTION", "MODULE_PARM_DESC" and
> >      so forth, for each module.

Actually that's one of the easier parts to deliver ... since
"modinfo" already exposes that, it's just a shell script to
dump it out into a form that a document generation system can
then play with.  No modutils patch necessary.

In fact, since I'm not always patient, I hacked that together
and put together part of the kind of system I want to see.
Take a peek at this (temporary?) URL, and send along any
comments that come to mind -- yes, none of the device or
class info shows up:

    http://linux-hotplug.sourceforge.net/kernel.html

The shell script that extracts "modinfo" data is "modinfo.sh",
and an example of its output is there, "modinfo.xml".  That's
for a kernel with most USB drivers as modules, but very few
PCI/Cardbus drivers configured.


>     I am
> holding off on modutils work until Linus/Alan realises that we need the
> kernel patch to add version numbers to device tables, I want an agreed
> working base to extend on.

Yes, that's a problem.  Sigh.

- Dave




_______________________________________________
Linux-hotplug-devel mailing list
Linux-hotplug-devel@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: WANTED: .../modules.*map to (X)HTML

[Keith Owens]

On Mon, 15 Jan 2001 09:17:22 -0800, 
David Brownell <david-b@pacbell.net> wrote:
>Keith Owens wrote
>>     I am
>> holding off on modutils work until Linus/Alan realises that we need the
>> kernel patch to add version numbers to device tables, I want an agreed
>> working base to extend on.
>
>Yes, that's a problem.  Sigh.

It should not be.  All the maintainers (modutils, usb) agree that it is
needed.  I do not understand why the patch to the kernel tables has not
been accepted.


_______________________________________________
Linux-hotplug-devel mailing list
Linux-hotplug-devel@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: WANTED: .../modules.*map to (X)HTML

[Miles Lane]

David Brownell wrote:

<snip>

>>     I am
>> holding off on modutils work until Linus/Alan realises that we need the
>> kernel patch to add version numbers to device tables, I want an agreed
>> working base to extend on.
> 
> 
> Yes, that's a problem.  Sigh.

Can someone confirm that Linus and Alan have joined this list?
They obviously need to be aware of hotplug-related development
and, preferably, add their comments and design concerns into
the mix.  If they are fully aware of the design and development
process, they are likely to be more responsive to patch submissions.

	Miles


_______________________________________________
Linux-hotplug-devel mailing list
Linux-hotplug-devel@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel