add missing MODULE_DESCRIPTION to drivers/net/*
Subsystems (2)
Hello,
we would like to add a built-time check for missing MODULE_DESCRIPTION (as it exists for MODULE_LICENSE) and currently have >400 modules which are missing that field.
As modinfo should provide necessary basic information about a module to the end-user, it`s bad if he needs the whole kernel-source for getting that information.
Attached is a list of drivers from drivers/net/* currently lacking MODULE_DESCRIPTION.
I have created the description, mostly from what`s in Kconfig or the driver comments.
If welcomed, please could you give a comment if this list is ok or fix it appropriately ?
I will then create a patch from that and send it here (and continue with net/* )
regards
Roland Kletzing
drivers/net/8390.o - 8390 core for usual driversdrivers/net/appletalk/ipddp.o - IP<->Appletalk-IP Encapsulation/Decapsulation driver drivers/net/arcnet/arc-rawmode.o - ARCnet driver - "raw mode" packet encapsulation drivers/net/arcnet/arc-rimi.o - ARCnet driver for "RIM I" cardsdrivers/net/arcnet/arcnet.o - ARCnet driver - device-independent routines drivers/net/arcnet/capmode.o - ARCnet driver - "cap mode" packet encapsulation drivers/net/arcnet/com20020-pci.o - ARCnet driver - COM20020 PCI support drivers/net/arcnet/com20020.o - ARCnet driver - COM20020 chipset support drivers/net/arcnet/com90io.o - ARCnet driver - COM90xx chipsetdrivers/net/arcnet/com90xx.o - ARCnet driver - COM90xx chipsetdrivers/net/arcnet/rfc1051.o - ARCnet driver - RFC1051 ("simple" standard) packet encapsulation drivers/net/arcnet/rfc1201.o - ARCnet driver - RFC1201 (standard) packet encapsulation drivers/net/bsd_comp.o - PPP "BSD compress" compressiondrivers/net/de600.o - driver for the D-Link DE-600 Ethernet pocket adapterdrivers/net/de620.o - driver for the D-Link DE-620 Ethernet pocket adapterdrivers/net/dummy.o - dummy net driverdrivers/net/eql.o - Equalizer Load-balancer for serial network interfacesdrivers/net/ifb.o - Intermediate Functional Block supportdrivers/net/pcmcia/com20020_cs.o - ARCnet driver - COM20020 PCMCIA support drivers/net/pcmcia/ibmtr_cs.o - PCMCIA token-ring driver for IBM-based cards drivers/net/phy/mdio-bitbang.o - Bitbanged MDIO supportdrivers/net/plip.o - parallel port "network" driverdrivers/net/ppp_async.o - PPP async serial channel driverdrivers/net/ppp_deflate.o - PPP Deflate compressiondrivers/net/ppp_generic.o - Generic PPP layerdrivers/net/ppp_synctty.o - PPP synchronous tty channel driverdrivers/net/s2io.o - Linux PCI-X Ethernet driver for Neterion 10GbE Server NIC drivers/net/skfp/skfp.o - device driver supporting the SysKonnect FDDI PCI controller family drivers/net/slhc.o - Van Jacobsen serial line header compressiondrivers/net/slip.o - Serial Line Internet Protocol driverdrivers/net/smsc9420.o - SMSC LAN9420 PCI ethernet adapter driverdrivers/net/sungem_phy.o - PHY drivers for the sungem ethernet driver drivers/net/tokenring/abyss.o - network driver for the Madge Smart 16/4 PCI Mk2 token ring card drivers/net/tokenring/tms380tr.o - network driver library for Texas Instruments TMS380-based Token Ring Adapters drivers/net/tokenring/tmspci.o - generic network driver for TMS380-based PCI token ring cards drivers/net/tulip/de4x5.o - DIGITAL DC21x4x DECchip and DE425/DE434/DE435/DE450/DE500 ethernet driver drivers/net/wan/lmc/lmc.o - Driver for the LanMedia LMC5200, LMC5245, LMC1000, LMC1200 cards drivers/net/wan/sbni.o - Granch SBNI12 leased line adapters driverdrivers/net/wan/x25_asy.o - X.25 async driverdrivers/net/wireless/netwave_cs.o - Netwave AirSurfer Wireless LAN PC Card driver drivers/net/wireless/p54/p54spi.o - Prism54 SPI (stlc45xx) driver drivers/net/wireless/wavelan_cs.o - Wavelan Pcmcia driver
Quoted 12 lines
Von: Sam Ravnborg <[email protected]>
Gesendet: 16.04.09 13:23:46
An: [email protected]
CC: Randy Dunlap <[email protected]>, [email protected], [email protected]
Betreff: Re: ShouldMODULE_DESCRIPTIONbe mandatory ?Quoted 5 lines
Quoted 1 line
i can offer spending an afternoon (or more) on compiling a list of modulenames + missing description for review. if that list is complete and ack`ed, i could create a patch or patch series from that.
(maybe the list could be split into logical parts, too)
Quoted 6 lines
If you do this then you should feed the patches via the maintainers. I suggest to start out with the network stuff and see if netdev/David Miller will take them.
Sam
____________________________________________________________________
Psssst! Schon vom neuen WEB.DE MultiMessenger gehört?
Der kann`s mit allen: http://www.produkte.web.de/messenger/?did=3123
Quoted 12 lines · On Thu, Apr 16, 2009 at 11:32 AM, <[email protected]> wrote:
Hello,
we would like to add a built-time check for missing
MODULE_DESCRIPTION(as it exists forMODULE_LICENSE) and currently have >400 modules which are missing that field.As modinfo should provide necessary basic information about a module to the end-user, it`s bad if he needs the whole kernel-source for getting that information.
Attached is a list of drivers from
drivers/net/*currently lackingMODULE_DESCRIPTION.I have created the description, mostly from what`s in
Kconfigor the driver comments.If welcomed, please could you give a comment if this list is ok or fix it appropriately ?
Quoted 7 lines
I will then create a patch from that and send it here (and continue with
net/*)regards
Roland Kletzing
drivers/net/8390.o- 8390 core for usual drivers
core library for 8390 based ethernet cards
Quoted 5 lines
drivers/net/appletalk/ipddp.o- IP<->Appletalk-IP Encapsulation/Decapsulation driverdrivers/net/arcnet/arc-rawmode.o- ARCnet driver - "raw mode" packet encapsulationdrivers/net/arcnet/arc-rimi.o- ARCnet driver for "RIM I" cardsdrivers/net/arcnet/arcnet.o- ARCnet driver - device-independent routinesdrivers/net/arcnet/capmode.o- ARCnet driver - "cap mode" packet encapsulation
Not sure if embedding a " into the strings will pose any problems for any userspace, might be worth keeping in mind if there isn't a precedent for this already.
Quoted 9 lines
drivers/net/arcnet/com20020-pci.o- ARCnet driver - COM20020 PCI supportdrivers/net/arcnet/com20020.o- ARCnet driver - COM20020 chipset supportdrivers/net/arcnet/com90io.o- ARCnet driver - COM90xx chipsetdrivers/net/arcnet/com90xx.o- ARCnet driver - COM90xx chipsetdrivers/net/arcnet/rfc1051.o- ARCnet driver - RFC1051 ("simple" standard) packet encapsulationdrivers/net/arcnet/rfc1201.o- ARCnet driver - RFC1201 (standard) packet encapsulationdrivers/net/bsd_comp.o- PPP "BSD compress" compressiondrivers/net/de600.o- driver for the D-Link DE-600 Ethernet pocket adapterdrivers/net/de620.o- driver for the D-Link DE-620 Ethernet pocket adapter
We can probably drop the "driver for the" text from the above and any similar ones; it is kind of like starting git commit messages with "This patch does...." -- semi redundant information to indicate it is a driver.
Paul.
Quoted 60 lines
drivers/net/dummy.o- dummy net driverdrivers/net/eql.o- Equalizer Load-balancer for serial network interfacesdrivers/net/ifb.o- Intermediate Functional Block supportdrivers/net/pcmcia/com20020_cs.o- ARCnet driver - COM20020 PCMCIA supportdrivers/net/pcmcia/ibmtr_cs.o- PCMCIA token-ring driver for IBM-based cardsdrivers/net/phy/mdio-bitbang.o- Bitbanged MDIO supportdrivers/net/plip.o- parallel port "network" driverdrivers/net/ppp_async.o- PPP async serial channel driverdrivers/net/ppp_deflate.o- PPP Deflate compressiondrivers/net/ppp_generic.o- Generic PPP layerdrivers/net/ppp_synctty.o- PPP synchronous tty channel driverdrivers/net/s2io.o- Linux PCI-X Ethernet driver for Neterion 10GbE Server NICdrivers/net/skfp/skfp.o- device driver supporting the SysKonnect FDDI PCI controller familydrivers/net/slhc.o- Van Jacobsen serial line header compressiondrivers/net/slip.o- Serial Line Internet Protocol driverdrivers/net/smsc9420.o- SMSC LAN9420 PCI ethernet adapter driverdrivers/net/sungem_phy.o- PHY drivers for the sungem ethernet driverdrivers/net/tokenring/abyss.o- network driver for the Madge Smart 16/4 PCI Mk2 token ring carddrivers/net/tokenring/tms380tr.o- network driver library for Texas Instruments TMS380-based Token Ring Adaptersdrivers/net/tokenring/tmspci.o- generic network driver for TMS380-based PCI token ring cardsdrivers/net/tulip/de4x5.o- DIGITAL DC21x4x DECchip and DE425/DE434/DE435/DE450/DE500 ethernet driverdrivers/net/wan/lmc/lmc.o- Driver for the LanMedia LMC5200, LMC5245, LMC1000, LMC1200 cardsdrivers/net/wan/sbni.o- Granch SBNI12 leased line adapters driverdrivers/net/wan/x25_asy.o- X.25 async driverdrivers/net/wireless/netwave_cs.o- Netwave AirSurfer Wireless LAN PC Card driverdrivers/net/wireless/p54/p54spi.o- Prism54 SPI (stlc45xx) driverdrivers/net/wireless/wavelan_cs.o- Wavelan Pcmcia driverQuoted 12 lines
Von: Sam Ravnborg <[email protected]>
Gesendet: 16.04.09 13:23:46
An: [email protected]
CC: Randy Dunlap <[email protected]>, [email protected], [email protected]
Betreff: Re: ShouldMODULE_DESCRIPTIONbe mandatory ?Quoted 5 lines
Quoted 1 line
i can offer spending an afternoon (or more) on compiling a list of modulenames + missing description for review. if that list is complete and ack`ed, i could create a patch or patch series from that.
(maybe the list could be split into logical parts, too)Quoted 6 lines
If you do this then you should feed the patches via the maintainers. I suggest to start out with the network stuff and see if netdev/David Miller will take them.
Sam
____________________________________________________________________
Psssst! Schon vom neuen WEB.DE MultiMessenger gehört?
Der kann`s mit allen: http://www.produkte.web.de/messenger/?did=3123--
To unsubscribe from this list: send the line "unsubscribe netdev" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html