2023-10-26 19:01:32

by Jakub Kicinski

[permalink] [raw]
Subject: [PATCH net-next 0/4] net: fill in 18 MODULE_DESCRIPTION()s

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().

Fill in the first 18 that jumped out at me, and those missing
in modules I maintain.

FWIW here is the list of places we're still missing some,
as far as I can grep. Please lend a hand and populate
the missing descriptions in your area of expertise if you have
the cycles:

CC: [email protected]
CC: [email protected]
CC: [email protected]
CC: [email protected]
CC: [email protected]
CC: [email protected]

46 in drivers/net/wireless
34 in net/sched
25 in net/netfilter
18 in net/dsa
17 in net/ipv4
11 in net/ipv6
11 in drivers/net/arcnet
6 in net/bridge
5 in drivers/net/ppp
5 in drivers/net/phy
5 in drivers/net/mdio
5 in drivers/net/ethernet/broadcom
4 in net/caif
3 in net/sunrpc
3 in net/nfc
3 in net/mptcp
3 in net/atm
3 in drivers/net/pcs
3 in drivers/net/ethernet/smsc
3 in drivers/net/ethernet/freescale
2 in net/xfrm
2 in net/packet
2 in net/ieee802154
2 in drivers/net/slip
2 in drivers/net/ethernet/qualcomm
1 in net/xdp
1 in net/vmw_vsock
1 in net/unix
1 in net/tipc
1 in net/smc
1 in net/sctp
1 in net/netlink
1 in net/key
1 in net/kcm
1 in net/hsr
1 in net/bpfilter
1 in net/6lowpan
1 in drivers/net/xen-netback
1 in drivers/net/wan
1 in drivers/net/ieee802154
1 in drivers/net/fddi
1 in drivers/net/ethernet/wangxun
1 in drivers/net/ethernet/ti
1 in drivers/net/ethernet/stmicro
1 in drivers/net/ethernet/neterion
1 in drivers/net/ethernet/mscc
1 in drivers/net/ethernet/microchip
1 in drivers/net/ethernet/marvell
1 in drivers/net/ethernet/litex
1 in drivers/net/ethernet/ezchip
1 in drivers/net/ethernet/ec_bhf.o
1 in drivers/net/ethernet/cirrus
1 in drivers/net/ethernet/cavium
1 in drivers/net/ethernet/8390
1 in drivers/net/dsa

Jakub Kicinski (4):
net: fill in MODULE_DESCRIPTION()s in kuba@'s modules
net: fill in MODULE_DESCRIPTION()s under net/core
net: fill in MODULE_DESCRIPTION()s under net/802*
net: fill in MODULE_DESCRIPTION()s under drivers/net/

drivers/net/amt.c | 1 +
drivers/net/dummy.c | 1 +
drivers/net/eql.c | 1 +
drivers/net/ifb.c | 1 +
drivers/net/macvtap.c | 1 +
drivers/net/netdevsim/netdev.c | 1 +
drivers/net/sungem_phy.c | 1 +
drivers/net/tap.c | 1 +
drivers/net/wireless/mediatek/mt7601u/usb.c | 1 +
net/802/fddi.c | 1 +
net/802/garp.c | 1 +
net/802/mrp.c | 1 +
net/802/p8022.c | 1 +
net/802/psnap.c | 1 +
net/802/stp.c | 1 +
net/8021q/vlan.c | 1 +
net/core/dev_addr_lists_test.c | 1 +
net/core/selftests.c | 1 +
18 files changed, 18 insertions(+)

--
2.41.0


2023-10-26 19:02:01

by Jakub Kicinski

[permalink] [raw]
Subject: [PATCH net-next 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Fill it in for the modules I maintain.

Signed-off-by: Jakub Kicinski <[email protected]>
---
CC: [email protected]
---
drivers/net/netdevsim/netdev.c | 1 +
drivers/net/wireless/mediatek/mt7601u/usb.c | 1 +
2 files changed, 2 insertions(+)

diff --git a/drivers/net/netdevsim/netdev.c b/drivers/net/netdevsim/netdev.c
index 2eac92f49631..aecaf5f44374 100644
--- a/drivers/net/netdevsim/netdev.c
+++ b/drivers/net/netdevsim/netdev.c
@@ -470,4 +470,5 @@ static void __exit nsim_module_exit(void)
module_init(nsim_module_init);
module_exit(nsim_module_exit);
MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Simulated networking device for testing");
MODULE_ALIAS_RTNL_LINK(DRV_NAME);
diff --git a/drivers/net/wireless/mediatek/mt7601u/usb.c b/drivers/net/wireless/mediatek/mt7601u/usb.c
index cc772045d526..d2ee6540ebb2 100644
--- a/drivers/net/wireless/mediatek/mt7601u/usb.c
+++ b/drivers/net/wireless/mediatek/mt7601u/usb.c
@@ -365,6 +365,7 @@ static int mt7601u_resume(struct usb_interface *usb_intf)

MODULE_DEVICE_TABLE(usb, mt7601u_device_table);
MODULE_FIRMWARE(MT7601U_FIRMWARE);
+MODULE_DESCRIPTION("MediaTek MT7601U USD Wireless LAN driver");
MODULE_LICENSE("GPL");

static struct usb_driver mt7601u_driver = {
--
2.41.0

2023-10-27 06:54:32

by Kalle Valo

[permalink] [raw]
Subject: Re: [PATCH net-next 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules

Jakub Kicinski <[email protected]> writes:

> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Fill it in for the modules I maintain.
>
> Signed-off-by: Jakub Kicinski <[email protected]>
> ---
> CC: [email protected]
> ---
> drivers/net/netdevsim/netdev.c | 1 +
> drivers/net/wireless/mediatek/mt7601u/usb.c | 1 +
> 2 files changed, 2 insertions(+)

For wireless:

Acked-by: Kalle Valo <[email protected]>

--
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

2023-10-27 14:16:41

by Jonathan Bither

[permalink] [raw]
Subject: Re: [PATCH net-next 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules


On 10/26/23 15:00, Jakub Kicinski wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Fill it in for the modules I maintain.
>
> Signed-off-by: Jakub Kicinski <[email protected]>
> ---
> CC: [email protected]
> ---
> drivers/net/netdevsim/netdev.c | 1 +
> drivers/net/wireless/mediatek/mt7601u/usb.c | 1 +
> 2 files changed, 2 insertions(+)
>
> diff --git a/drivers/net/netdevsim/netdev.c b/drivers/net/netdevsim/netdev.c
> index 2eac92f49631..aecaf5f44374 100644
> --- a/drivers/net/netdevsim/netdev.c
> +++ b/drivers/net/netdevsim/netdev.c
> @@ -470,4 +470,5 @@ static void __exit nsim_module_exit(void)
> module_init(nsim_module_init);
> module_exit(nsim_module_exit);
> MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Simulated networking device for testing");
> MODULE_ALIAS_RTNL_LINK(DRV_NAME);
> diff --git a/drivers/net/wireless/mediatek/mt7601u/usb.c b/drivers/net/wireless/mediatek/mt7601u/usb.c
> index cc772045d526..d2ee6540ebb2 100644
> --- a/drivers/net/wireless/mediatek/mt7601u/usb.c
> +++ b/drivers/net/wireless/mediatek/mt7601u/usb.c
> @@ -365,6 +365,7 @@ static int mt7601u_resume(struct usb_interface *usb_intf)
>
> MODULE_DEVICE_TABLE(usb, mt7601u_device_table);
> MODULE_FIRMWARE(MT7601U_FIRMWARE);
> +MODULE_DESCRIPTION("MediaTek MT7601U USD Wireless LAN driver");
Did you mean USB?
> MODULE_LICENSE("GPL");
>
> static struct usb_driver mt7601u_driver = {

2023-10-27 14:29:20

by Jakub Kicinski

[permalink] [raw]
Subject: Re: [PATCH net-next 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules

On Fri, 27 Oct 2023 10:15:02 -0400 Jonathan Bither wrote:
> > +MODULE_DESCRIPTION("MediaTek MT7601U USD Wireless LAN driver");
> Did you mean USB?

Ah, I do, thanks!