netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s
@ 2023-10-27 21:13 Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules Jakub Kicinski
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: Jakub Kicinski @ 2023-10-27 21:13 UTC (permalink / raw)
  To: davem; +Cc: netdev, edumazet, pabeni, Jakub Kicinski

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.

v2: s/USD/USB/ in patch 1
v1: https://lore.kernel.org/all/20231026190101.1413939-1-kuba@kernel.org/

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


^ permalink raw reply	[flat|nested] 6+ messages in thread
* [PATCH net-next v2 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules
  2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
@ 2023-10-27 21:13 ` Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 2/4] net: fill in MODULE_DESCRIPTION()s under net/core Jakub Kicinski
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2023-10-27 21:13 UTC (permalink / raw)
  To: davem; +Cc: netdev, edumazet, pabeni, Jakub Kicinski, Kalle Valo, jonbither

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

Acked-by: Kalle Valo <kvalo@kernel.org>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
CC: jonbither@gmail.com

v2: s/USD/USB/

 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..c41ae251cb95 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 USB Wireless LAN driver");
 MODULE_LICENSE("GPL");
 
 static struct usb_driver mt7601u_driver = {
-- 
2.41.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread
* [PATCH net-next v2 2/4] net: fill in MODULE_DESCRIPTION()s under net/core
  2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules Jakub Kicinski
@ 2023-10-27 21:13 ` Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 3/4] net: fill in MODULE_DESCRIPTION()s under net/802* Jakub Kicinski
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2023-10-27 21:13 UTC (permalink / raw)
  To: davem; +Cc: netdev, edumazet, pabeni, Jakub Kicinski, Oleksij Rempel

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

Reviewed-by: Oleksij Rempel <o.rempel@pengutronix.de>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 net/core/dev_addr_lists_test.c | 1 +
 net/core/selftests.c           | 1 +
 2 files changed, 2 insertions(+)

diff --git a/net/core/dev_addr_lists_test.c b/net/core/dev_addr_lists_test.c
index 90e7e3811ae7..4dbd0dc6aea2 100644
--- a/net/core/dev_addr_lists_test.c
+++ b/net/core/dev_addr_lists_test.c
@@ -233,4 +233,5 @@ static struct kunit_suite dev_addr_test_suite = {
 };
 kunit_test_suite(dev_addr_test_suite);
 
+MODULE_DESCRIPTION("KUnit tests for struct netdev_hw_addr_list");
 MODULE_LICENSE("GPL");
diff --git a/net/core/selftests.c b/net/core/selftests.c
index 94fe3146a959..8f801e6e3b91 100644
--- a/net/core/selftests.c
+++ b/net/core/selftests.c
@@ -405,5 +405,6 @@ void net_selftest_get_strings(u8 *data)
 }
 EXPORT_SYMBOL_GPL(net_selftest_get_strings);
 
+MODULE_DESCRIPTION("Common library for generic PHY ethtool selftests");
 MODULE_LICENSE("GPL v2");
 MODULE_AUTHOR("Oleksij Rempel <o.rempel@pengutronix.de>");
-- 
2.41.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread
* [PATCH net-next v2 3/4] net: fill in MODULE_DESCRIPTION()s under net/802*
  2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 2/4] net: fill in MODULE_DESCRIPTION()s under net/core Jakub Kicinski
@ 2023-10-27 21:13 ` Jakub Kicinski
  2023-10-27 21:13 ` [PATCH net-next v2 4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/ Jakub Kicinski
  2023-10-28 10:40 ` [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s patchwork-bot+netdevbpf
  4 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2023-10-27 21:13 UTC (permalink / raw)
  To: davem
  Cc: netdev, edumazet, pabeni, Jakub Kicinski, Greg Kroah-Hartman,
	ulf.hansson, rostedt, sj, schspa, vladbu, idosch

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

Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
CC: ulf.hansson@linaro.org
CC: rostedt@goodmis.org
CC: sj@kernel.org
CC: schspa@gmail.com
CC: vladbu@nvidia.com
CC: idosch@nvidia.com
---
 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 +
 7 files changed, 7 insertions(+)

diff --git a/net/802/fddi.c b/net/802/fddi.c
index 7533ce26ba5f..888379ae35ec 100644
--- a/net/802/fddi.c
+++ b/net/802/fddi.c
@@ -175,4 +175,5 @@ struct net_device *alloc_fddidev(int sizeof_priv)
 }
 EXPORT_SYMBOL(alloc_fddidev);
 
+MODULE_DESCRIPTION("Core routines for FDDI network devices");
 MODULE_LICENSE("GPL");
diff --git a/net/802/garp.c b/net/802/garp.c
index ab24b21fbb49..6a743d004301 100644
--- a/net/802/garp.c
+++ b/net/802/garp.c
@@ -21,6 +21,7 @@
 static unsigned int garp_join_time __read_mostly = 200;
 module_param(garp_join_time, uint, 0644);
 MODULE_PARM_DESC(garp_join_time, "Join time in ms (default 200ms)");
+MODULE_DESCRIPTION("IEEE 802.1D Generic Attribute Registration Protocol (GARP)");
 MODULE_LICENSE("GPL");
 
 static const struct garp_state_trans {
diff --git a/net/802/mrp.c b/net/802/mrp.c
index eafc21ecc287..3154d7409493 100644
--- a/net/802/mrp.c
+++ b/net/802/mrp.c
@@ -26,6 +26,7 @@ static unsigned int mrp_periodic_time __read_mostly = 1000;
 module_param(mrp_periodic_time, uint, 0644);
 MODULE_PARM_DESC(mrp_periodic_time, "Periodic time in ms (default 1s)");
 
+MODULE_DESCRIPTION("IEEE 802.1Q Multiple Registration Protocol (MRP)");
 MODULE_LICENSE("GPL");
 
 static const u8
diff --git a/net/802/p8022.c b/net/802/p8022.c
index 79c23173116c..78c25168d7c9 100644
--- a/net/802/p8022.c
+++ b/net/802/p8022.c
@@ -60,4 +60,5 @@ void unregister_8022_client(struct datalink_proto *proto)
 EXPORT_SYMBOL(register_8022_client);
 EXPORT_SYMBOL(unregister_8022_client);
 
+MODULE_DESCRIPTION("Support for 802.2 demultiplexing off Ethernet");
 MODULE_LICENSE("GPL");
diff --git a/net/802/psnap.c b/net/802/psnap.c
index 1406bfdbda13..fca9d454905f 100644
--- a/net/802/psnap.c
+++ b/net/802/psnap.c
@@ -160,4 +160,5 @@ void unregister_snap_client(struct datalink_proto *proto)
 	kfree(proto);
 }
 
+MODULE_DESCRIPTION("SNAP data link layer. Derived from 802.2");
 MODULE_LICENSE("GPL");
diff --git a/net/802/stp.c b/net/802/stp.c
index d550d9f88f60..03c9f75e92c9 100644
--- a/net/802/stp.c
+++ b/net/802/stp.c
@@ -98,4 +98,5 @@ void stp_proto_unregister(const struct stp_proto *proto)
 }
 EXPORT_SYMBOL_GPL(stp_proto_unregister);
 
+MODULE_DESCRIPTION("SAP demux for IEEE 802.1D Spanning Tree Protocol (STP)");
 MODULE_LICENSE("GPL");
diff --git a/net/8021q/vlan.c b/net/8021q/vlan.c
index e40aa3e3641c..e45187b88220 100644
--- a/net/8021q/vlan.c
+++ b/net/8021q/vlan.c
@@ -738,5 +738,6 @@ static void __exit vlan_cleanup_module(void)
 module_init(vlan_proto_init);
 module_exit(vlan_cleanup_module);
 
+MODULE_DESCRIPTION("802.1Q/802.1ad VLAN Protocol");
 MODULE_LICENSE("GPL");
 MODULE_VERSION(DRV_VERSION);
-- 
2.41.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread
* [PATCH net-next v2 4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/
  2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
                   ` (2 preceding siblings ...)
  2023-10-27 21:13 ` [PATCH net-next v2 3/4] net: fill in MODULE_DESCRIPTION()s under net/802* Jakub Kicinski
@ 2023-10-27 21:13 ` Jakub Kicinski
  2023-10-28 10:40 ` [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s patchwork-bot+netdevbpf
  4 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2023-10-27 21:13 UTC (permalink / raw)
  To: davem
  Cc: netdev, edumazet, pabeni, Jakub Kicinski, Willem de Bruijn,
	Jamal Hadi Salim, Arnd Bergmann, Jason Wang, Taehee Yoo

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

Acked-by: Willem de Bruijn <willemb@google.com>
Acked-by: Jamal Hadi Salim <jhs@mojatatu.com>
Acked-by: Arnd Bergmann <arnd@arndb.de>
Acked-by: Jason Wang <jasowang@redhat.com>
Acked-by: Taehee Yoo <ap420073@gmail.com>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 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/sungem_phy.c | 1 +
 drivers/net/tap.c        | 1 +
 7 files changed, 7 insertions(+)

diff --git a/drivers/net/amt.c b/drivers/net/amt.c
index 2d20be6ffb7e..53415e83821c 100644
--- a/drivers/net/amt.c
+++ b/drivers/net/amt.c
@@ -3449,5 +3449,6 @@ static void __exit amt_fini(void)
 module_exit(amt_fini);
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Driver for Automatic Multicast Tunneling (AMT)");
 MODULE_AUTHOR("Taehee Yoo <ap420073@gmail.com>");
 MODULE_ALIAS_RTNL_LINK("amt");
diff --git a/drivers/net/dummy.c b/drivers/net/dummy.c
index c4b1b0aa438a..768454aa36d6 100644
--- a/drivers/net/dummy.c
+++ b/drivers/net/dummy.c
@@ -202,4 +202,5 @@ static void __exit dummy_cleanup_module(void)
 module_init(dummy_init_module);
 module_exit(dummy_cleanup_module);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Dummy netdevice driver which discards all packets sent to it");
 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
diff --git a/drivers/net/eql.c b/drivers/net/eql.c
index ca3e4700a813..3c2efda916f1 100644
--- a/drivers/net/eql.c
+++ b/drivers/net/eql.c
@@ -607,4 +607,5 @@ static void __exit eql_cleanup_module(void)
 
 module_init(eql_init_module);
 module_exit(eql_cleanup_module);
+MODULE_DESCRIPTION("Equalizer Load-balancer for serial network interfaces");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/ifb.c b/drivers/net/ifb.c
index 78253ad57b2e..2c1b5def4a0b 100644
--- a/drivers/net/ifb.c
+++ b/drivers/net/ifb.c
@@ -454,5 +454,6 @@ static void __exit ifb_cleanup_module(void)
 module_init(ifb_init_module);
 module_exit(ifb_cleanup_module);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Intermediate Functional Block (ifb) netdevice driver for sharing of resources and ingress packet queuing");
 MODULE_AUTHOR("Jamal Hadi Salim");
 MODULE_ALIAS_RTNL_LINK("ifb");
diff --git a/drivers/net/macvtap.c b/drivers/net/macvtap.c
index bddcc127812e..29a5929d48e5 100644
--- a/drivers/net/macvtap.c
+++ b/drivers/net/macvtap.c
@@ -250,5 +250,6 @@ static void __exit macvtap_exit(void)
 module_exit(macvtap_exit);
 
 MODULE_ALIAS_RTNL_LINK("macvtap");
+MODULE_DESCRIPTION("MAC-VLAN based tap driver");
 MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/sungem_phy.c b/drivers/net/sungem_phy.c
index 36803d932dff..d591e33268e5 100644
--- a/drivers/net/sungem_phy.c
+++ b/drivers/net/sungem_phy.c
@@ -1194,4 +1194,5 @@ int sungem_phy_probe(struct mii_phy *phy, int mii_id)
 }
 
 EXPORT_SYMBOL(sungem_phy_probe);
+MODULE_DESCRIPTION("PHY drivers for the sungem Ethernet MAC driver");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/tap.c b/drivers/net/tap.c
index 5c01cc7b9949..9f0495e8df4d 100644
--- a/drivers/net/tap.c
+++ b/drivers/net/tap.c
@@ -1399,6 +1399,7 @@ void tap_destroy_cdev(dev_t major, struct cdev *tap_cdev)
 }
 EXPORT_SYMBOL_GPL(tap_destroy_cdev);
 
+MODULE_DESCRIPTION("Common library for drivers implementing the TAP interface");
 MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
 MODULE_AUTHOR("Sainath Grandhi <sainath.grandhi@intel.com>");
 MODULE_LICENSE("GPL");
-- 
2.41.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread
* Re: [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s
  2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
                   ` (3 preceding siblings ...)
  2023-10-27 21:13 ` [PATCH net-next v2 4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/ Jakub Kicinski
@ 2023-10-28 10:40 ` patchwork-bot+netdevbpf
  4 siblings, 0 replies; 6+ messages in thread
From: patchwork-bot+netdevbpf @ 2023-10-28 10:40 UTC (permalink / raw)
  To: Jakub Kicinski; +Cc: davem, netdev, edumazet, pabeni

Hello:

This series was applied to netdev/net-next.git (main)
by David S. Miller <davem@davemloft.net>:

On Fri, 27 Oct 2023 14:13:07 -0700 you wrote:
> 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.
> 
> v2: s/USD/USB/ in patch 1
> v1: https://lore.kernel.org/all/20231026190101.1413939-1-kuba@kernel.org/
> 
> [...]

Here is the summary with links:
  - [net-next,v2,1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules
    https://git.kernel.org/netdev/net-next/c/1fff1f799038
  - [net-next,v2,2/4] net: fill in MODULE_DESCRIPTION()s under net/core
    https://git.kernel.org/netdev/net-next/c/beb5eed32a73
  - [net-next,v2,3/4] net: fill in MODULE_DESCRIPTION()s under net/802*
    https://git.kernel.org/netdev/net-next/c/ce1afe280419
  - [net-next,v2,4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/
    https://git.kernel.org/netdev/net-next/c/55c900477f5b

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



^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-10-28 10:40 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-10-27 21:13 [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s Jakub Kicinski
2023-10-27 21:13 ` [PATCH net-next v2 1/4] net: fill in MODULE_DESCRIPTION()s in kuba@'s modules Jakub Kicinski
2023-10-27 21:13 ` [PATCH net-next v2 2/4] net: fill in MODULE_DESCRIPTION()s under net/core Jakub Kicinski
2023-10-27 21:13 ` [PATCH net-next v2 3/4] net: fill in MODULE_DESCRIPTION()s under net/802* Jakub Kicinski
2023-10-27 21:13 ` [PATCH net-next v2 4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/ Jakub Kicinski
2023-10-28 10:40 ` [PATCH net-next v2 0/4] net: fill in 18 MODULE_DESCRIPTION()s patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).