2024-02-14 15:29:20

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 0/7] Fix MODULE_DESCRIPTION() for net (p6)

There are a few network modules left that misses MODULE_DESCRIPTION(),
causing a warnning when compiling with W=1. Example:

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/net/arcnet/....

This last patchset solves the problem for all the missing driver. It is
not expect to see any warning for the driver/net and net/ directory once
all these patches have landed.

Changeloge:

v1:
* https://lore.kernel.org/all/[email protected]/

v2:
* Rewrote mdio_devres description as suggested by Andrew Lunn
* Added an acked-by from Paul Durrant in patch 1/7

Breno Leitao (7):
net: fill in MODULE_DESCRIPTION()s for xen-netback
net: fill in MODULE_DESCRIPTION()s for ieee802154/fakelb
net: fill in MODULE_DESCRIPTION()s for plip
net: fill in MODULE_DESCRIPTION()s for fddik/skfp
net: fill in MODULE_DESCRIPTION()s for ppp
net: fill in MODULE_DESCRIPTION()s for mdio_devres
net: fill in MODULE_DESCRIPTION()s for missing arcnet

drivers/net/arcnet/arc-rawmode.c | 1 +
drivers/net/arcnet/arc-rimi.c | 1 +
drivers/net/arcnet/capmode.c | 1 +
drivers/net/arcnet/com20020-pci.c | 1 +
drivers/net/arcnet/com20020.c | 1 +
drivers/net/arcnet/com20020_cs.c | 1 +
drivers/net/arcnet/com90io.c | 1 +
drivers/net/arcnet/com90xx.c | 1 +
drivers/net/arcnet/rfc1051.c | 1 +
drivers/net/arcnet/rfc1201.c | 1 +
drivers/net/fddi/skfp/skfddi.c | 1 +
drivers/net/ieee802154/fakelb.c | 1 +
drivers/net/phy/mdio_devres.c | 1 +
drivers/net/plip/plip.c | 1 +
drivers/net/ppp/bsd_comp.c | 1 +
drivers/net/ppp/ppp_async.c | 1 +
drivers/net/ppp/ppp_deflate.c | 1 +
drivers/net/ppp/ppp_generic.c | 1 +
drivers/net/ppp/ppp_synctty.c | 1 +
drivers/net/xen-netback/netback.c | 1 +
20 files changed, 20 insertions(+)

--
2.39.3


Breno Leitao (7):
net: fill in MODULE_DESCRIPTION()s for xen-netback
net: fill in MODULE_DESCRIPTION()s for ieee802154/fakelb
net: fill in MODULE_DESCRIPTION()s for plip
net: fill in MODULE_DESCRIPTION()s for fddik/skfp
net: fill in MODULE_DESCRIPTION()s for ppp
net: fill in MODULE_DESCRIPTION()s for mdio_devres
net: fill in MODULE_DESCRIPTION()s for missing arcnet

drivers/net/arcnet/arc-rawmode.c | 1 +
drivers/net/arcnet/arc-rimi.c | 1 +
drivers/net/arcnet/capmode.c | 1 +
drivers/net/arcnet/com20020-pci.c | 1 +
drivers/net/arcnet/com20020.c | 1 +
drivers/net/arcnet/com20020_cs.c | 1 +
drivers/net/arcnet/com90io.c | 1 +
drivers/net/arcnet/com90xx.c | 1 +
drivers/net/arcnet/rfc1051.c | 1 +
drivers/net/arcnet/rfc1201.c | 1 +
drivers/net/fddi/skfp/skfddi.c | 1 +
drivers/net/ieee802154/fakelb.c | 1 +
drivers/net/phy/mdio_devres.c | 1 +
drivers/net/plip/plip.c | 1 +
drivers/net/ppp/bsd_comp.c | 1 +
drivers/net/ppp/ppp_async.c | 1 +
drivers/net/ppp/ppp_deflate.c | 1 +
drivers/net/ppp/ppp_generic.c | 1 +
drivers/net/ppp/ppp_synctty.c | 1 +
drivers/net/xen-netback/netback.c | 1 +
20 files changed, 20 insertions(+)

--
2.39.3



2024-02-14 15:29:43

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 1/7] net: fill in MODULE_DESCRIPTION()s for xen-netback

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the Xen backend network module.

Signed-off-by: Breno Leitao <[email protected]>
Acked-by: Paul Durrant <[email protected]>
---
drivers/net/xen-netback/netback.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/net/xen-netback/netback.c b/drivers/net/xen-netback/netback.c
index fab361a250d6..ef76850d9bcd 100644
--- a/drivers/net/xen-netback/netback.c
+++ b/drivers/net/xen-netback/netback.c
@@ -1778,5 +1778,6 @@ static void __exit netback_fini(void)
}
module_exit(netback_fini);

+MODULE_DESCRIPTION("Xen backend network device module");
MODULE_LICENSE("Dual BSD/GPL");
MODULE_ALIAS("xen-backend:vif");
--
2.39.3


2024-02-14 15:31:09

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 5/7] net: fill in MODULE_DESCRIPTION()s for ppp

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the PPP modules.

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/ppp/bsd_comp.c | 1 +
drivers/net/ppp/ppp_async.c | 1 +
drivers/net/ppp/ppp_deflate.c | 1 +
drivers/net/ppp/ppp_generic.c | 1 +
drivers/net/ppp/ppp_synctty.c | 1 +
5 files changed, 5 insertions(+)

diff --git a/drivers/net/ppp/bsd_comp.c b/drivers/net/ppp/bsd_comp.c
index db0dc36d12e3..55954594e157 100644
--- a/drivers/net/ppp/bsd_comp.c
+++ b/drivers/net/ppp/bsd_comp.c
@@ -1166,5 +1166,6 @@ static void __exit bsdcomp_cleanup(void)

module_init(bsdcomp_init);
module_exit(bsdcomp_cleanup);
+MODULE_DESCRIPTION("PPP BSD-Compress compression module");
MODULE_LICENSE("Dual BSD/GPL");
MODULE_ALIAS("ppp-compress-" __stringify(CI_BSD_COMPRESS));
diff --git a/drivers/net/ppp/ppp_async.c b/drivers/net/ppp/ppp_async.c
index 125793d8aefa..c33c3db3cc08 100644
--- a/drivers/net/ppp/ppp_async.c
+++ b/drivers/net/ppp/ppp_async.c
@@ -87,6 +87,7 @@ struct asyncppp {
static int flag_time = HZ;
module_param(flag_time, int, 0);
MODULE_PARM_DESC(flag_time, "ppp_async: interval between flagged packets (in clock ticks)");
+MODULE_DESCRIPTION("PPP async serial channel module");
MODULE_LICENSE("GPL");
MODULE_ALIAS_LDISC(N_PPP);

diff --git a/drivers/net/ppp/ppp_deflate.c b/drivers/net/ppp/ppp_deflate.c
index e6d48e5c65a3..4d2ff63f2ee2 100644
--- a/drivers/net/ppp/ppp_deflate.c
+++ b/drivers/net/ppp/ppp_deflate.c
@@ -630,6 +630,7 @@ static void __exit deflate_cleanup(void)

module_init(deflate_init);
module_exit(deflate_cleanup);
+MODULE_DESCRIPTION("PPP Deflate compression module");
MODULE_LICENSE("Dual BSD/GPL");
MODULE_ALIAS("ppp-compress-" __stringify(CI_DEFLATE));
MODULE_ALIAS("ppp-compress-" __stringify(CI_DEFLATE_DRAFT));
diff --git a/drivers/net/ppp/ppp_generic.c b/drivers/net/ppp/ppp_generic.c
index 0193af2d31c9..3dd52bf28f15 100644
--- a/drivers/net/ppp/ppp_generic.c
+++ b/drivers/net/ppp/ppp_generic.c
@@ -3604,6 +3604,7 @@ EXPORT_SYMBOL(ppp_input_error);
EXPORT_SYMBOL(ppp_output_wakeup);
EXPORT_SYMBOL(ppp_register_compressor);
EXPORT_SYMBOL(ppp_unregister_compressor);
+MODULE_DESCRIPTION("Generic PPP layer driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS_CHARDEV(PPP_MAJOR, 0);
MODULE_ALIAS_RTNL_LINK("ppp");
diff --git a/drivers/net/ppp/ppp_synctty.c b/drivers/net/ppp/ppp_synctty.c
index 52d05ce4a281..45bf59ac8f57 100644
--- a/drivers/net/ppp/ppp_synctty.c
+++ b/drivers/net/ppp/ppp_synctty.c
@@ -724,5 +724,6 @@ ppp_sync_cleanup(void)

module_init(ppp_sync_init);
module_exit(ppp_sync_cleanup);
+MODULE_DESCRIPTION("PPP synchronous TTY channel module");
MODULE_LICENSE("GPL");
MODULE_ALIAS_LDISC(N_SYNC_PPP);
--
2.39.3


2024-02-14 15:32:20

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 6/7] net: fill in MODULE_DESCRIPTION()s for mdio_devres

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the PHY MDIO helpers.

Suggested-by: Andrew Lunn <[email protected]>
Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/phy/mdio_devres.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/net/phy/mdio_devres.c b/drivers/net/phy/mdio_devres.c
index 69b829e6ab35..7fd3377dbd79 100644
--- a/drivers/net/phy/mdio_devres.c
+++ b/drivers/net/phy/mdio_devres.c
@@ -131,4 +131,5 @@ int __devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
EXPORT_SYMBOL(__devm_of_mdiobus_register);
#endif /* CONFIG_OF_MDIO */

+MODULE_DESCRIPTION("Network MDIO bus devres helpers");
MODULE_LICENSE("GPL");
--
2.39.3


2024-02-14 15:33:04

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 4/7] net: fill in MODULE_DESCRIPTION()s for fddik/skfp

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the SysKonnect FDDI PCI module.

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/fddi/skfp/skfddi.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/net/fddi/skfp/skfddi.c b/drivers/net/fddi/skfp/skfddi.c
index 2b6a607ac0b7..a273362c9e70 100644
--- a/drivers/net/fddi/skfp/skfddi.c
+++ b/drivers/net/fddi/skfp/skfddi.c
@@ -153,6 +153,7 @@ static const struct pci_device_id skfddi_pci_tbl[] = {
{ } /* Terminating entry */
};
MODULE_DEVICE_TABLE(pci, skfddi_pci_tbl);
+MODULE_DESCRIPTION("SysKonnect FDDI PCI driver");
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Mirko Lindner <[email protected]>");

--
2.39.3


2024-02-14 15:33:32

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 7/7] net: fill in MODULE_DESCRIPTION()s for missing arcnet

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the ARC modules.

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/arcnet/arc-rawmode.c | 1 +
drivers/net/arcnet/arc-rimi.c | 1 +
drivers/net/arcnet/capmode.c | 1 +
drivers/net/arcnet/com20020-pci.c | 1 +
drivers/net/arcnet/com20020.c | 1 +
drivers/net/arcnet/com20020_cs.c | 1 +
drivers/net/arcnet/com90io.c | 1 +
drivers/net/arcnet/com90xx.c | 1 +
drivers/net/arcnet/rfc1051.c | 1 +
drivers/net/arcnet/rfc1201.c | 1 +
10 files changed, 10 insertions(+)

diff --git a/drivers/net/arcnet/arc-rawmode.c b/drivers/net/arcnet/arc-rawmode.c
index 8c651fdee039..57f1729066f2 100644
--- a/drivers/net/arcnet/arc-rawmode.c
+++ b/drivers/net/arcnet/arc-rawmode.c
@@ -186,4 +186,5 @@ static void __exit arcnet_raw_exit(void)
module_init(arcnet_raw_init);
module_exit(arcnet_raw_exit);

+MODULE_DESCRIPTION("ARCnet raw mode packet interface module");
MODULE_LICENSE("GPL");
diff --git a/drivers/net/arcnet/arc-rimi.c b/drivers/net/arcnet/arc-rimi.c
index 8c3ccc7c83cd..53d10a04d1bd 100644
--- a/drivers/net/arcnet/arc-rimi.c
+++ b/drivers/net/arcnet/arc-rimi.c
@@ -312,6 +312,7 @@ module_param(node, int, 0);
module_param(io, int, 0);
module_param(irq, int, 0);
module_param_string(device, device, sizeof(device), 0);
+MODULE_DESCRIPTION("ARCnet COM90xx RIM I chipset driver");
MODULE_LICENSE("GPL");

static struct net_device *my_dev;
diff --git a/drivers/net/arcnet/capmode.c b/drivers/net/arcnet/capmode.c
index c09b567845e1..7a0a79973769 100644
--- a/drivers/net/arcnet/capmode.c
+++ b/drivers/net/arcnet/capmode.c
@@ -265,4 +265,5 @@ static void __exit capmode_module_exit(void)
module_init(capmode_module_init);
module_exit(capmode_module_exit);

+MODULE_DESCRIPTION("ARCnet CAP mode packet interface module");
MODULE_LICENSE("GPL");
diff --git a/drivers/net/arcnet/com20020-pci.c b/drivers/net/arcnet/com20020-pci.c
index 7b5c8bb02f11..c5e571ec94c9 100644
--- a/drivers/net/arcnet/com20020-pci.c
+++ b/drivers/net/arcnet/com20020-pci.c
@@ -61,6 +61,7 @@ module_param(timeout, int, 0);
module_param(backplane, int, 0);
module_param(clockp, int, 0);
module_param(clockm, int, 0);
+MODULE_DESCRIPTION("ARCnet COM20020 chipset PCI driver");
MODULE_LICENSE("GPL");

static void led_tx_set(struct led_classdev *led_cdev,
diff --git a/drivers/net/arcnet/com20020.c b/drivers/net/arcnet/com20020.c
index 06e1651b594b..a0053e3992a3 100644
--- a/drivers/net/arcnet/com20020.c
+++ b/drivers/net/arcnet/com20020.c
@@ -399,6 +399,7 @@ EXPORT_SYMBOL(com20020_found);
EXPORT_SYMBOL(com20020_netdev_ops);
#endif

+MODULE_DESCRIPTION("ARCnet COM20020 chipset core driver");
MODULE_LICENSE("GPL");

#ifdef MODULE
diff --git a/drivers/net/arcnet/com20020_cs.c b/drivers/net/arcnet/com20020_cs.c
index dc3253b318da..75f08aa7528b 100644
--- a/drivers/net/arcnet/com20020_cs.c
+++ b/drivers/net/arcnet/com20020_cs.c
@@ -97,6 +97,7 @@ module_param(backplane, int, 0);
module_param(clockp, int, 0);
module_param(clockm, int, 0);

+MODULE_DESCRIPTION("ARCnet COM20020 chipset PCMCIA driver");
MODULE_LICENSE("GPL");

/*====================================================================*/
diff --git a/drivers/net/arcnet/com90io.c b/drivers/net/arcnet/com90io.c
index 37b47749fc8b..3b463fbc6402 100644
--- a/drivers/net/arcnet/com90io.c
+++ b/drivers/net/arcnet/com90io.c
@@ -350,6 +350,7 @@ static char device[9]; /* use eg. device=arc1 to change name */
module_param_hw(io, int, ioport, 0);
module_param_hw(irq, int, irq, 0);
module_param_string(device, device, sizeof(device), 0);
+MODULE_DESCRIPTION("ARCnet COM90xx IO mapped chipset driver");
MODULE_LICENSE("GPL");

#ifndef MODULE
diff --git a/drivers/net/arcnet/com90xx.c b/drivers/net/arcnet/com90xx.c
index f49dae194284..b3b287c16561 100644
--- a/drivers/net/arcnet/com90xx.c
+++ b/drivers/net/arcnet/com90xx.c
@@ -645,6 +645,7 @@ static void com90xx_copy_from_card(struct net_device *dev, int bufnum,
TIME(dev, "memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
}

+MODULE_DESCRIPTION("ARCnet COM90xx normal chipset driver");
MODULE_LICENSE("GPL");

static int __init com90xx_init(void)
diff --git a/drivers/net/arcnet/rfc1051.c b/drivers/net/arcnet/rfc1051.c
index a7752a5b647f..46519ca63a0a 100644
--- a/drivers/net/arcnet/rfc1051.c
+++ b/drivers/net/arcnet/rfc1051.c
@@ -78,6 +78,7 @@ static void __exit arcnet_rfc1051_exit(void)
module_init(arcnet_rfc1051_init);
module_exit(arcnet_rfc1051_exit);

+MODULE_DESCRIPTION("ARCNet packet format (RFC 1051) module");
MODULE_LICENSE("GPL");

/* Determine a packet's protocol ID.
diff --git a/drivers/net/arcnet/rfc1201.c b/drivers/net/arcnet/rfc1201.c
index a4c856282674..0edf35d971c5 100644
--- a/drivers/net/arcnet/rfc1201.c
+++ b/drivers/net/arcnet/rfc1201.c
@@ -35,6 +35,7 @@

#include "arcdevice.h"

+MODULE_DESCRIPTION("ARCNet packet format (RFC 1201) module");
MODULE_LICENSE("GPL");

static __be16 type_trans(struct sk_buff *skb, struct net_device *dev);
--
2.39.3


2024-02-14 15:51:43

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 2/7] net: fill in MODULE_DESCRIPTION()s for ieee802154/fakelb

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the IEEE 802.15.4 loopback driver.

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/ieee802154/fakelb.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/net/ieee802154/fakelb.c b/drivers/net/ieee802154/fakelb.c
index 35e55f198e05..2930141d7dd2 100644
--- a/drivers/net/ieee802154/fakelb.c
+++ b/drivers/net/ieee802154/fakelb.c
@@ -259,4 +259,5 @@ static __exit void fake_remove_module(void)

module_init(fakelb_init_module);
module_exit(fake_remove_module);
+MODULE_DESCRIPTION("IEEE 802.15.4 loopback driver");
MODULE_LICENSE("GPL");
--
2.39.3


2024-02-14 15:52:01

by Breno Leitao

[permalink] [raw]
Subject: [PATCH net v2 3/7] net: fill in MODULE_DESCRIPTION()s for plip

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the PLIP (parallel port) network module

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/plip/plip.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/net/plip/plip.c b/drivers/net/plip/plip.c
index 40ce8abe6999..cc7d1113ece0 100644
--- a/drivers/net/plip/plip.c
+++ b/drivers/net/plip/plip.c
@@ -1437,4 +1437,5 @@ static int __init plip_init (void)

module_init(plip_init);
module_exit(plip_cleanup_module);
+MODULE_DESCRIPTION("PLIP (parallel port) network module");
MODULE_LICENSE("GPL");
--
2.39.3


2024-02-14 16:01:45

by Andrew Lunn

[permalink] [raw]
Subject: Re: [PATCH net v2 6/7] net: fill in MODULE_DESCRIPTION()s for mdio_devres

On Wed, Feb 14, 2024 at 07:27:40AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the PHY MDIO helpers.
>
> Suggested-by: Andrew Lunn <[email protected]>
> Signed-off-by: Breno Leitao <[email protected]>

Reviewed-by: Andrew Lunn <[email protected]>

Andrew

2024-02-15 16:16:07

by patchwork-bot+netdevbpf

[permalink] [raw]
Subject: Re: [PATCH net v2 0/7] Fix MODULE_DESCRIPTION() for net (p6)

Hello:

This series was applied to netdev/net.git (main)
by Jakub Kicinski <[email protected]>:

On Wed, 14 Feb 2024 07:27:34 -0800 you wrote:
> There are a few network modules left that misses MODULE_DESCRIPTION(),
> causing a warnning when compiling with W=1. Example:
>
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/net/arcnet/....
>
> This last patchset solves the problem for all the missing driver. It is
> not expect to see any warning for the driver/net and net/ directory once
> all these patches have landed.
>
> [...]

Here is the summary with links:
- [net,v2,1/7] net: fill in MODULE_DESCRIPTION()s for xen-netback
https://git.kernel.org/netdev/net/c/5b8e3464071a
- [net,v2,2/7] net: fill in MODULE_DESCRIPTION()s for ieee802154/fakelb
https://git.kernel.org/netdev/net/c/c0872309ac84
- [net,v2,3/7] net: fill in MODULE_DESCRIPTION()s for plip
https://git.kernel.org/netdev/net/c/44c1197bcef4
- [net,v2,4/7] net: fill in MODULE_DESCRIPTION()s for fddik/skfp
https://git.kernel.org/netdev/net/c/4ad9e8587439
- [net,v2,5/7] net: fill in MODULE_DESCRIPTION()s for ppp
https://git.kernel.org/netdev/net/c/e1e5ef2aefc2
- [net,v2,6/7] net: fill in MODULE_DESCRIPTION()s for mdio_devres
https://git.kernel.org/netdev/net/c/9de69f0e9958
- [net,v2,7/7] net: fill in MODULE_DESCRIPTION()s for missing arcnet
https://git.kernel.org/netdev/net/c/538b22e74287

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



2024-02-19 10:47:54

by Miquel Raynal

[permalink] [raw]
Subject: Re: [PATCH net v2 2/7] net: fill in MODULE_DESCRIPTION()s for ieee802154/fakelb

Hi Breno,

[email protected] wrote on Wed, 14 Feb 2024 07:27:36 -0800:

> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the IEEE 802.15.4 loopback driver.

Acked-by: Miquel Raynal <[email protected]>

>
> Signed-off-by: Breno Leitao <[email protected]>
> ---
> drivers/net/ieee802154/fakelb.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/net/ieee802154/fakelb.c b/drivers/net/ieee802154/fakelb.c
> index 35e55f198e05..2930141d7dd2 100644
> --- a/drivers/net/ieee802154/fakelb.c
> +++ b/drivers/net/ieee802154/fakelb.c
> @@ -259,4 +259,5 @@ static __exit void fake_remove_module(void)
>
> module_init(fakelb_init_module);
> module_exit(fake_remove_module);
> +MODULE_DESCRIPTION("IEEE 802.15.4 loopback driver");
> MODULE_LICENSE("GPL");


Thanks,
Miquèl