[PATCH net v2 0/9] net: Fix MODULE_DESCRIPTION() for net (p5)

[PATCH net v2 0/9] net: Fix MODULE_DESCRIPTION() for net (p5)

[Breno Leitao]

There are hundreds of network modules that misses MODULE_DESCRIPTION(),
causing a warning when compiling with W=1. Example:

	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_cmp.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_nbyte.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_u32.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_meta.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_text.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/sched/em_canid.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/ip_tunnel.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/ipip.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/ip_gre.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/udp_tunnel.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/ip_vti.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/ah4.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/esp4.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/xfrm4_tunnel.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv4/tunnel4.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/xfrm/xfrm_algo.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/xfrm/xfrm_user.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv6/ah6.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv6/esp6.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv6/xfrm6_tunnel.o
	WARNING: modpost: missing MODULE_DESCRIPTION() in net/ipv6/tunnel6.o

This part5 of the patchset focus on the missing net/ module, which
are now warning free.

Here are all the MODULE_DESCRIPTION added:

 MODULE_DESCRIPTION("CAN Identifier comparison network helpers");
 MODULE_DESCRIPTION("DSA loopback fixed PHY library");
 MODULE_DESCRIPTION("IP-in-IPv6 tunnel driver");
 MODULE_DESCRIPTION("IP/IP protocol decoder library");
 MODULE_DESCRIPTION("IPv4 AH transformation library");
 MODULE_DESCRIPTION("IPv4 ESP transformation library");
 MODULE_DESCRIPTION("IPv4 GRE tunnels over IP library");
 MODULE_DESCRIPTION("IPv4 tunnel implementation library");
 MODULE_DESCRIPTION("IPv4 UDP tunnel driver");
 MODULE_DESCRIPTION("IPv4 XFRM tunnel driver");
 MODULE_DESCRIPTION("IPv4 XFRM tunnel library");
 MODULE_DESCRIPTION("IPv6 AH transformation helpers");
 MODULE_DESCRIPTION("IPv6 ESP transformation helpers");
 MODULE_DESCRIPTION("IPv6-in-IPv4 tunnel SIT driver");
 MODULE_DESCRIPTION("IPv6 Mobility driver");
 MODULE_DESCRIPTION("IPv6 over Low-Power Wireless Personal Area Network core module");
 MODULE_DESCRIPTION("IPv6 UDP tunnel driver");
 MODULE_DESCRIPTION("IPv6 XFRM tunnel driver");
 MODULE_DESCRIPTION("IP-VLAN based tap driver");
 MODULE_DESCRIPTION("Metadata comparison network helpers");
 MODULE_DESCRIPTION("Multi byte comparison network helpers");
 MODULE_DESCRIPTION("Multi-Protocol Over ATM (MPOA) driver");
 MODULE_DESCRIPTION("PF_KEY socket helpers");
 MODULE_DESCRIPTION("Simple packet data comparison network helpers");
 MODULE_DESCRIPTION("Textsearch comparison network helpers");
 MODULE_DESCRIPTION("U32 Key comparison network helpers");
 MODULE_DESCRIPTION("Virtual (secure) IP tunneling library");
 MODULE_DESCRIPTION("XFRM Algorithm interface");
 MODULE_DESCRIPTION("XFRM User interface");

Changelog:

v1:
 * https://lore.kernel.org/all/20240205101400.1480521-1-leitao@debian.org/

v2:
 * Remove the patch for the ieee802154 , since the fix is already in
   net-next. See discussion at:
   https://lore.kernel.org/all/ZcDs%2FGFkZ881bJR7@gmail.com/#t

Breno Leitao (10):
  net: fill in MODULE_DESCRIPTION()s for xfrm
  net: fill in MODULE_DESCRIPTION()s for mpoa
  net: fill in MODULE_DESCRIPTION()s for af_key
  net: fill in MODULE_DESCRIPTION()s for 6LoWPAN
  net: fill in MODULE_DESCRIPTION()s for ipv6 modules
  net: fill in MODULE_DESCRIPTION()s for ipv4 modules
  net: fill in MODULE_DESCRIPTION()s for net/sched
  net: fill in MODULE_DESCRIPTION()s for ieee802154
  net: fill in MODULE_DESCRIPTION()s for ipvtap
  net: fill in MODULE_DESCRIPTION()s for dsa_loop_bdinfo

 drivers/net/dsa/dsa_loop_bdinfo.c | 1 +
 drivers/net/ipvlan/ipvtap.c       | 1 +
 net/6lowpan/core.c                | 1 +
 net/atm/mpc.c                     | 1 +
 net/ieee802154/6lowpan/core.c     | 1 +
 net/ieee802154/socket.c           | 1 +
 net/ipv4/ah4.c                    | 1 +
 net/ipv4/esp4.c                   | 1 +
 net/ipv4/ip_gre.c                 | 1 +
 net/ipv4/ip_tunnel.c              | 1 +
 net/ipv4/ip_vti.c                 | 1 +
 net/ipv4/ipip.c                   | 1 +
 net/ipv4/tunnel4.c                | 1 +
 net/ipv4/udp_tunnel_core.c        | 1 +
 net/ipv4/xfrm4_tunnel.c           | 1 +
 net/ipv6/ah6.c                    | 1 +
 net/ipv6/esp6.c                   | 1 +
 net/ipv6/ip6_udp_tunnel.c         | 1 +
 net/ipv6/mip6.c                   | 1 +
 net/ipv6/sit.c                    | 1 +
 net/ipv6/tunnel6.c                | 1 +
 net/ipv6/xfrm6_tunnel.c           | 1 +
 net/key/af_key.c                  | 1 +
 net/sched/em_canid.c              | 1 +
 net/sched/em_cmp.c                | 1 +
 net/sched/em_meta.c               | 1 +
 net/sched/em_nbyte.c              | 1 +
 net/sched/em_text.c               | 1 +
 net/sched/em_u32.c                | 1 +
 net/xfrm/xfrm_algo.c              | 1 +
 net/xfrm/xfrm_user.c              | 1 +
 31 files changed, 31 insertions(+)

-- 
2.39.3


Breno Leitao (9):
  net: fill in MODULE_DESCRIPTION()s for xfrm
  net: fill in MODULE_DESCRIPTION()s for mpoa
  net: fill in MODULE_DESCRIPTION()s for af_key
  net: fill in MODULE_DESCRIPTION()s for 6LoWPAN
  net: fill in MODULE_DESCRIPTION()s for ipv6 modules
  net: fill in MODULE_DESCRIPTION()s for ipv4 modules
  net: fill in MODULE_DESCRIPTION()s for net/sched
  net: fill in MODULE_DESCRIPTION()s for ipvtap
  net: fill in MODULE_DESCRIPTION()s for dsa_loop_bdinfo

 drivers/net/dsa/dsa_loop_bdinfo.c | 1 +
 drivers/net/ipvlan/ipvtap.c       | 1 +
 net/6lowpan/core.c                | 1 +
 net/atm/mpc.c                     | 1 +
 net/ipv4/ah4.c                    | 1 +
 net/ipv4/esp4.c                   | 1 +
 net/ipv4/ip_gre.c                 | 1 +
 net/ipv4/ip_tunnel.c              | 1 +
 net/ipv4/ip_vti.c                 | 1 +
 net/ipv4/ipip.c                   | 1 +
 net/ipv4/tunnel4.c                | 1 +
 net/ipv4/udp_tunnel_core.c        | 1 +
 net/ipv4/xfrm4_tunnel.c           | 1 +
 net/ipv6/ah6.c                    | 1 +
 net/ipv6/esp6.c                   | 1 +
 net/ipv6/ip6_udp_tunnel.c         | 1 +
 net/ipv6/mip6.c                   | 1 +
 net/ipv6/sit.c                    | 1 +
 net/ipv6/tunnel6.c                | 1 +
 net/ipv6/xfrm6_tunnel.c           | 1 +
 net/key/af_key.c                  | 1 +
 net/sched/em_canid.c              | 1 +
 net/sched/em_cmp.c                | 1 +
 net/sched/em_meta.c               | 1 +
 net/sched/em_nbyte.c              | 1 +
 net/sched/em_text.c               | 1 +
 net/sched/em_u32.c                | 1 +
 net/xfrm/xfrm_algo.c              | 1 +
 net/xfrm/xfrm_user.c              | 1 +
 29 files changed, 29 insertions(+)

-- 
2.39.3

[PATCH net v2 1/9] net: fill in MODULE_DESCRIPTION()s for xfrm

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/xfrm/xfrm_algo.c | 1 +
 net/xfrm/xfrm_user.c | 1 +
 2 files changed, 2 insertions(+)

diff --git a/net/xfrm/xfrm_algo.c b/net/xfrm/xfrm_algo.c
index 41533c631431..e6da7e8495c9 100644
--- a/net/xfrm/xfrm_algo.c
+++ b/net/xfrm/xfrm_algo.c
@@ -858,4 +858,5 @@ int xfrm_count_pfkey_enc_supported(void)
 }
 EXPORT_SYMBOL_GPL(xfrm_count_pfkey_enc_supported);
 
+MODULE_DESCRIPTION("XFRM Algorithm interface");
 MODULE_LICENSE("GPL");
diff --git a/net/xfrm/xfrm_user.c b/net/xfrm/xfrm_user.c
index ad01997c3aa9..f037be190bae 100644
--- a/net/xfrm/xfrm_user.c
+++ b/net/xfrm/xfrm_user.c
@@ -3888,5 +3888,6 @@ static void __exit xfrm_user_exit(void)
 
 module_init(xfrm_user_init);
 module_exit(xfrm_user_exit);
+MODULE_DESCRIPTION("XFRM User interface");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK, NETLINK_XFRM);
-- 
2.39.3

Re: [PATCH net v2 1/9] net: fill in MODULE_DESCRIPTION()s for xfrm

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:20AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the XFRM interface drivers.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>

[PATCH net v2 2/9] net: fill in MODULE_DESCRIPTION()s for mpoa

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the Multi-Protocol Over ATM (MPOA) driver.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/atm/mpc.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/atm/mpc.c b/net/atm/mpc.c
index 033871e718a3..324e3ab96bb3 100644
--- a/net/atm/mpc.c
+++ b/net/atm/mpc.c
@@ -1532,4 +1532,5 @@ static void __exit atm_mpoa_cleanup(void)
 module_init(atm_mpoa_init);
 module_exit(atm_mpoa_cleanup);
 
+MODULE_DESCRIPTION("Multi-Protocol Over ATM (MPOA) driver");
 MODULE_LICENSE("GPL");
-- 
2.39.3

Re: [PATCH net v2 2/9] net: fill in MODULE_DESCRIPTION()s for mpoa

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:21AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Multi-Protocol Over ATM (MPOA) driver.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>

[PATCH net v2 3/9] net: fill in MODULE_DESCRIPTION()s for af_key

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/key/af_key.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/key/af_key.c b/net/key/af_key.c
index d68d01804dc7..f79fb99271ed 100644
--- a/net/key/af_key.c
+++ b/net/key/af_key.c
@@ -3924,5 +3924,6 @@ static int __init ipsec_pfkey_init(void)
 
 module_init(ipsec_pfkey_init);
 module_exit(ipsec_pfkey_exit);
+MODULE_DESCRIPTION("PF_KEY socket helpers");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_NETPROTO(PF_KEY);
-- 
2.39.3

Re: [PATCH net v2 3/9] net: fill in MODULE_DESCRIPTION()s for af_key

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:22AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the PF_KEY socket helpers.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>

[PATCH net v2 4/9] net: fill in MODULE_DESCRIPTION()s for 6LoWPAN

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to IPv6 over Low power Wireless Personal Area Network.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/6lowpan/core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/6lowpan/core.c b/net/6lowpan/core.c
index 7b3341cef926..850d4a185f55 100644
--- a/net/6lowpan/core.c
+++ b/net/6lowpan/core.c
@@ -179,4 +179,5 @@ static void __exit lowpan_module_exit(void)
 module_init(lowpan_module_init);
 module_exit(lowpan_module_exit);
 
+MODULE_DESCRIPTION("IPv6 over Low-Power Wireless Personal Area Network core module");
 MODULE_LICENSE("GPL");
-- 
2.39.3

Re: [PATCH net v2 4/9] net: fill in MODULE_DESCRIPTION()s for 6LoWPAN

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:23AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to IPv6 over Low power Wireless Personal Area Network.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>

Re: [PATCH net v2 4/9] net: fill in MODULE_DESCRIPTION()s for 6LoWPAN

[patchwork-bot+bluetooth]

Hello:

This patch was applied to bluetooth/bluetooth-next.git (master)
by Jakub Kicinski <kuba@kernel.org>:

On Wed,  7 Feb 2024 02:19:23 -0800 you wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to IPv6 over Low power Wireless Personal Area Network.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  net/6lowpan/core.c | 1 +
>  1 file changed, 1 insertion(+)

Here is the summary with links:
  - [net,v2,4/9] net: fill in MODULE_DESCRIPTION()s for 6LoWPAN
    https://git.kernel.org/bluetooth/bluetooth-next/c/2898f3075e6a

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

[PATCH net v2 5/9] net: fill in MODULE_DESCRIPTION()s for ipv6 modules

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/ipv6/ah6.c            | 1 +
 net/ipv6/esp6.c           | 1 +
 net/ipv6/ip6_udp_tunnel.c | 1 +
 net/ipv6/mip6.c           | 1 +
 net/ipv6/sit.c            | 1 +
 net/ipv6/tunnel6.c        | 1 +
 net/ipv6/xfrm6_tunnel.c   | 1 +
 7 files changed, 7 insertions(+)

diff --git a/net/ipv6/ah6.c b/net/ipv6/ah6.c
index 2016e90e6e1d..eb474f0987ae 100644
--- a/net/ipv6/ah6.c
+++ b/net/ipv6/ah6.c
@@ -800,5 +800,6 @@ static void __exit ah6_fini(void)
 module_init(ah6_init);
 module_exit(ah6_fini);
 
+MODULE_DESCRIPTION("IPv6 AH transformation helpers");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_AH);
diff --git a/net/ipv6/esp6.c b/net/ipv6/esp6.c
index 2cc1a45742d8..6e6efe026cdc 100644
--- a/net/ipv6/esp6.c
+++ b/net/ipv6/esp6.c
@@ -1301,5 +1301,6 @@ static void __exit esp6_fini(void)
 module_init(esp6_init);
 module_exit(esp6_fini);
 
+MODULE_DESCRIPTION("IPv6 ESP transformation helpers");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_ESP);
diff --git a/net/ipv6/ip6_udp_tunnel.c b/net/ipv6/ip6_udp_tunnel.c
index a7bf0327b380..8820bf5b101a 100644
--- a/net/ipv6/ip6_udp_tunnel.c
+++ b/net/ipv6/ip6_udp_tunnel.c
@@ -182,4 +182,5 @@ struct dst_entry *udp_tunnel6_dst_lookup(struct sk_buff *skb,
 }
 EXPORT_SYMBOL_GPL(udp_tunnel6_dst_lookup);
 
+MODULE_DESCRIPTION("IPv6 UDP tunnel driver");
 MODULE_LICENSE("GPL");
diff --git a/net/ipv6/mip6.c b/net/ipv6/mip6.c
index 83d2a8be263f..6a16a5bd0d91 100644
--- a/net/ipv6/mip6.c
+++ b/net/ipv6/mip6.c
@@ -405,6 +405,7 @@ static void __exit mip6_fini(void)
 module_init(mip6_init);
 module_exit(mip6_fini);
 
+MODULE_DESCRIPTION("IPv6 Mobility driver");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_DSTOPTS);
 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_ROUTING);
diff --git a/net/ipv6/sit.c b/net/ipv6/sit.c
index cc24cefdb85c..5e9f625b76e3 100644
--- a/net/ipv6/sit.c
+++ b/net/ipv6/sit.c
@@ -1956,6 +1956,7 @@ static int __init sit_init(void)
 
 module_init(sit_init);
 module_exit(sit_cleanup);
+MODULE_DESCRIPTION("IPv6-in-IPv4 tunnel SIT driver");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_RTNL_LINK("sit");
 MODULE_ALIAS_NETDEV("sit0");
diff --git a/net/ipv6/tunnel6.c b/net/ipv6/tunnel6.c
index 00e8d8b1c9a7..dc4ea9b11794 100644
--- a/net/ipv6/tunnel6.c
+++ b/net/ipv6/tunnel6.c
@@ -302,4 +302,5 @@ static void __exit tunnel6_fini(void)
 
 module_init(tunnel6_init);
 module_exit(tunnel6_fini);
+MODULE_DESCRIPTION("IP-in-IPv6 tunnel driver");
 MODULE_LICENSE("GPL");
diff --git a/net/ipv6/xfrm6_tunnel.c b/net/ipv6/xfrm6_tunnel.c
index 1323f2f6928e..f6cb94f82cc3 100644
--- a/net/ipv6/xfrm6_tunnel.c
+++ b/net/ipv6/xfrm6_tunnel.c
@@ -401,5 +401,6 @@ static void __exit xfrm6_tunnel_fini(void)
 
 module_init(xfrm6_tunnel_init);
 module_exit(xfrm6_tunnel_fini);
+MODULE_DESCRIPTION("IPv6 XFRM tunnel driver");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_IPV6);
-- 
2.39.3

Re: [PATCH net v2 5/9] net: fill in MODULE_DESCRIPTION()s for ipv6 modules

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:24AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the IPv6 modules.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

...

> index a7bf0327b380..8820bf5b101a 100644
> --- a/net/ipv6/ip6_udp_tunnel.c
> +++ b/net/ipv6/ip6_udp_tunnel.c
> @@ -182,4 +182,5 @@ struct dst_entry *udp_tunnel6_dst_lookup(struct sk_buff *skb,
>  }
>  EXPORT_SYMBOL_GPL(udp_tunnel6_dst_lookup);
>  
> +MODULE_DESCRIPTION("IPv6 UDP tunnel driver");
>  MODULE_LICENSE("GPL");

Hi Breno,

I don't feel strongly about this,
but looking at NET_UDP_TUNNEL and NET_FOU in net/ipv4/Kconfig, maybe:

	IPv6 Foo over UDP tunnel driver

Likewise for the change to net/ipv4/udp_tunnel_core.c
in the following patch.


The above not withstanding, this looks good to me.

Reviewed-by: Simon Horman <horms@kernel.org>

...

[PATCH net v2 6/9] net: fill in MODULE_DESCRIPTION()s for ipv4 modules

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/ipv4/ah4.c             | 1 +
 net/ipv4/esp4.c            | 1 +
 net/ipv4/ip_gre.c          | 1 +
 net/ipv4/ip_tunnel.c       | 1 +
 net/ipv4/ip_vti.c          | 1 +
 net/ipv4/ipip.c            | 1 +
 net/ipv4/tunnel4.c         | 1 +
 net/ipv4/udp_tunnel_core.c | 1 +
 net/ipv4/xfrm4_tunnel.c    | 1 +
 9 files changed, 9 insertions(+)

diff --git a/net/ipv4/ah4.c b/net/ipv4/ah4.c
index a2e6e1fdf82b..64aec3dff8ec 100644
--- a/net/ipv4/ah4.c
+++ b/net/ipv4/ah4.c
@@ -597,5 +597,6 @@ static void __exit ah4_fini(void)
 
 module_init(ah4_init);
 module_exit(ah4_fini);
+MODULE_DESCRIPTION("IPv4 AH transformation library");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET, XFRM_PROTO_AH);
diff --git a/net/ipv4/esp4.c b/net/ipv4/esp4.c
index 4ccfc104f13a..4dd9e5040672 100644
--- a/net/ipv4/esp4.c
+++ b/net/ipv4/esp4.c
@@ -1247,5 +1247,6 @@ static void __exit esp4_fini(void)
 
 module_init(esp4_init);
 module_exit(esp4_fini);
+MODULE_DESCRIPTION("IPv4 ESP transformation library");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET, XFRM_PROTO_ESP);
diff --git a/net/ipv4/ip_gre.c b/net/ipv4/ip_gre.c
index 5169c3c72cff..6b9cf5a24c19 100644
--- a/net/ipv4/ip_gre.c
+++ b/net/ipv4/ip_gre.c
@@ -1793,6 +1793,7 @@ static void __exit ipgre_fini(void)
 
 module_init(ipgre_init);
 module_exit(ipgre_fini);
+MODULE_DESCRIPTION("IPv4 GRE tunnels over IP library");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_RTNL_LINK("gre");
 MODULE_ALIAS_RTNL_LINK("gretap");
diff --git a/net/ipv4/ip_tunnel.c b/net/ipv4/ip_tunnel.c
index beeae624c412..a4513ffb66cb 100644
--- a/net/ipv4/ip_tunnel.c
+++ b/net/ipv4/ip_tunnel.c
@@ -1298,4 +1298,5 @@ void ip_tunnel_setup(struct net_device *dev, unsigned int net_id)
 }
 EXPORT_SYMBOL_GPL(ip_tunnel_setup);
 
+MODULE_DESCRIPTION("IPv4 tunnel implementation library");
 MODULE_LICENSE("GPL");
diff --git a/net/ipv4/ip_vti.c b/net/ipv4/ip_vti.c
index 9ab9b3ebe0cd..d1d6bb28ed6e 100644
--- a/net/ipv4/ip_vti.c
+++ b/net/ipv4/ip_vti.c
@@ -721,6 +721,7 @@ static void __exit vti_fini(void)
 
 module_init(vti_init);
 module_exit(vti_fini);
+MODULE_DESCRIPTION("Virtual (secure) IP tunneling library");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_RTNL_LINK("vti");
 MODULE_ALIAS_NETDEV("ip_vti0");
diff --git a/net/ipv4/ipip.c b/net/ipv4/ipip.c
index 27b8f83c6ea2..03afa3871efc 100644
--- a/net/ipv4/ipip.c
+++ b/net/ipv4/ipip.c
@@ -658,6 +658,7 @@ static void __exit ipip_fini(void)
 
 module_init(ipip_init);
 module_exit(ipip_fini);
+MODULE_DESCRIPTION("IP/IP protocol decoder library");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_RTNL_LINK("ipip");
 MODULE_ALIAS_NETDEV("tunl0");
diff --git a/net/ipv4/tunnel4.c b/net/ipv4/tunnel4.c
index 5048c47c79b2..4c1f836aae38 100644
--- a/net/ipv4/tunnel4.c
+++ b/net/ipv4/tunnel4.c
@@ -294,4 +294,5 @@ static void __exit tunnel4_fini(void)
 
 module_init(tunnel4_init);
 module_exit(tunnel4_fini);
+MODULE_DESCRIPTION("IPv4 XFRM tunnel library");
 MODULE_LICENSE("GPL");
diff --git a/net/ipv4/udp_tunnel_core.c b/net/ipv4/udp_tunnel_core.c
index a87defb2b167..b0a073ed590a 100644
--- a/net/ipv4/udp_tunnel_core.c
+++ b/net/ipv4/udp_tunnel_core.c
@@ -253,4 +253,5 @@ struct rtable *udp_tunnel_dst_lookup(struct sk_buff *skb,
 }
 EXPORT_SYMBOL_GPL(udp_tunnel_dst_lookup);
 
+MODULE_DESCRIPTION("IPv4 UDP tunnel driver");
 MODULE_LICENSE("GPL");
diff --git a/net/ipv4/xfrm4_tunnel.c b/net/ipv4/xfrm4_tunnel.c
index 8489fa106583..8cb266af1393 100644
--- a/net/ipv4/xfrm4_tunnel.c
+++ b/net/ipv4/xfrm4_tunnel.c
@@ -114,5 +114,6 @@ static void __exit ipip_fini(void)
 
 module_init(ipip_init);
 module_exit(ipip_fini);
+MODULE_DESCRIPTION("IPv4 XFRM tunnel driver");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_XFRM_TYPE(AF_INET, XFRM_PROTO_IPIP);
-- 
2.39.3

Re: [PATCH net v2 6/9] net: fill in MODULE_DESCRIPTION()s for ipv4 modules

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:25AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the IPv4 modules.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

My comment on the previous patch notwithstanding,
this looks good to me.

Reviewed-by: Simon Horman <horms@kernel.org>

[PATCH net v2 7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/sched/em_canid.c | 1 +
 net/sched/em_cmp.c   | 1 +
 net/sched/em_meta.c  | 1 +
 net/sched/em_nbyte.c | 1 +
 net/sched/em_text.c  | 1 +
 net/sched/em_u32.c   | 1 +
 6 files changed, 6 insertions(+)

diff --git a/net/sched/em_canid.c b/net/sched/em_canid.c
index 5ea84decec19..c1852d79c00a 100644
--- a/net/sched/em_canid.c
+++ b/net/sched/em_canid.c
@@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
 	tcf_em_unregister(&em_canid_ops);
 }
 
+MODULE_DESCRIPTION("CAN Identifier comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_canid);
diff --git a/net/sched/em_cmp.c b/net/sched/em_cmp.c
index f17b049ea530..285b36c32c16 100644
--- a/net/sched/em_cmp.c
+++ b/net/sched/em_cmp.c
@@ -87,6 +87,7 @@ static void __exit exit_em_cmp(void)
 	tcf_em_unregister(&em_cmp_ops);
 }
 
+MODULE_DESCRIPTION("Simple packet data comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_cmp);
diff --git a/net/sched/em_meta.c b/net/sched/em_meta.c
index 09d8afd04a2a..cab43356824a 100644
--- a/net/sched/em_meta.c
+++ b/net/sched/em_meta.c
@@ -1006,6 +1006,7 @@ static void __exit exit_em_meta(void)
 	tcf_em_unregister(&em_meta_ops);
 }
 
+MODULE_DESCRIPTION("Metadata comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_meta);
diff --git a/net/sched/em_nbyte.c b/net/sched/em_nbyte.c
index a83b237cbeb0..34c6e8c8b695 100644
--- a/net/sched/em_nbyte.c
+++ b/net/sched/em_nbyte.c
@@ -68,6 +68,7 @@ static void __exit exit_em_nbyte(void)
 	tcf_em_unregister(&em_nbyte_ops);
 }
 
+MODULE_DESCRIPTION("Multi byte comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_nbyte);
diff --git a/net/sched/em_text.c b/net/sched/em_text.c
index f176afb70559..7a89db8e5409 100644
--- a/net/sched/em_text.c
+++ b/net/sched/em_text.c
@@ -147,6 +147,7 @@ static void __exit exit_em_text(void)
 	tcf_em_unregister(&em_text_ops);
 }
 
+MODULE_DESCRIPTION("Textsearch comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_text);
diff --git a/net/sched/em_u32.c b/net/sched/em_u32.c
index 71b070da0437..ea32e4e12a99 100644
--- a/net/sched/em_u32.c
+++ b/net/sched/em_u32.c
@@ -52,6 +52,7 @@ static void __exit exit_em_u32(void)
 	tcf_em_unregister(&em_u32_ops);
 }
 
+MODULE_DESCRIPTION("U32 Key comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_u32);
-- 
2.39.3

Re: [PATCH net v2 7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:26AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the network schedulers.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Hi Breno,

I wonder if it would be useful to mention Ematch somehow
in the module descriptions as that is the context in
which they operate.

Re: [PATCH net v2 7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

[Jakub Kicinski]

On Wed,  7 Feb 2024 02:19:26 -0800 Breno Leitao wrote:
> --- a/net/sched/em_canid.c
> +++ b/net/sched/em_canid.c
> @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
>  	tcf_em_unregister(&em_canid_ops);
>  }
>  
> +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");

That sounds like it as library for any code, but it's TC extended match.
Jamal, any suggestion for a good name template for em_ ?

Re: [PATCH net v2 7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

[Jamal Hadi Salim]

On Wed, Feb 7, 2024 at 10:37 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> On Wed,  7 Feb 2024 02:19:26 -0800 Breno Leitao wrote:
> > --- a/net/sched/em_canid.c
> > +++ b/net/sched/em_canid.c
> > @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
> >       tcf_em_unregister(&em_canid_ops);
> >  }
> >
> > +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");
>
> That sounds like it as library for any code, but it's TC extended match.
> Jamal, any suggestion for a good name template for em_ ?

At minimal what Simon said. But let me go over it and do individual responses.

cheers,
jamal

Re: [PATCH net v2 7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

[Jamal Hadi Salim]

On Wed, Feb 7, 2024 at 5:19 AM Breno Leitao <leitao@debian.org> wrote:
>
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the network schedulers.
>
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  net/sched/em_canid.c | 1 +
>  net/sched/em_cmp.c   | 1 +
>  net/sched/em_meta.c  | 1 +
>  net/sched/em_nbyte.c | 1 +
>  net/sched/em_text.c  | 1 +
>  net/sched/em_u32.c   | 1 +
>  6 files changed, 6 insertions(+)
>
> diff --git a/net/sched/em_canid.c b/net/sched/em_canid.c
> index 5ea84decec19..c1852d79c00a 100644
> --- a/net/sched/em_canid.c
> +++ b/net/sched/em_canid.c
> @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
>         tcf_em_unregister(&em_canid_ops);
>  }
>
> +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");

ematch classifier to match CAN IDs embedded in skb CAN frames

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_canid);
> diff --git a/net/sched/em_cmp.c b/net/sched/em_cmp.c
> index f17b049ea530..285b36c32c16 100644
> --- a/net/sched/em_cmp.c
> +++ b/net/sched/em_cmp.c
> @@ -87,6 +87,7 @@ static void __exit exit_em_cmp(void)
>         tcf_em_unregister(&em_cmp_ops);
>  }
>
> +MODULE_DESCRIPTION("Simple packet data comparison network helpers");

ematch classifier for basic data types(8/16/32 bit) against skb data

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_cmp);
> diff --git a/net/sched/em_meta.c b/net/sched/em_meta.c
> index 09d8afd04a2a..cab43356824a 100644
> --- a/net/sched/em_meta.c
> +++ b/net/sched/em_meta.c
> @@ -1006,6 +1006,7 @@ static void __exit exit_em_meta(void)
>         tcf_em_unregister(&em_meta_ops);
>  }
>
> +MODULE_DESCRIPTION("Metadata comparison network helpers");

ematch classifier for various internal kernel metadata, skb metadata
and sk metadata

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_meta);
> diff --git a/net/sched/em_nbyte.c b/net/sched/em_nbyte.c
> index a83b237cbeb0..34c6e8c8b695 100644
> --- a/net/sched/em_nbyte.c
> +++ b/net/sched/em_nbyte.c
> @@ -68,6 +68,7 @@ static void __exit exit_em_nbyte(void)
>         tcf_em_unregister(&em_nbyte_ops);
>  }
>
> +MODULE_DESCRIPTION("Multi byte comparison network helpers");

ematch classifier for arbitrary skb multi-bytes

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_nbyte);
> diff --git a/net/sched/em_text.c b/net/sched/em_text.c
> index f176afb70559..7a89db8e5409 100644
> --- a/net/sched/em_text.c
> +++ b/net/sched/em_text.c
> @@ -147,6 +147,7 @@ static void __exit exit_em_text(void)
>         tcf_em_unregister(&em_text_ops);
>  }
>
> +MODULE_DESCRIPTION("Textsearch comparison network helpers");

ematch classifier for embedded text in skbs

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_text);
> diff --git a/net/sched/em_u32.c b/net/sched/em_u32.c
> index 71b070da0437..ea32e4e12a99 100644
> --- a/net/sched/em_u32.c
> +++ b/net/sched/em_u32.c
> @@ -52,6 +52,7 @@ static void __exit exit_em_u32(void)
>         tcf_em_unregister(&em_u32_ops);
>  }
>
> +MODULE_DESCRIPTION("U32 Key comparison network helpers");

ematch skb classifier using 32 bit chunks of data

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_u32);
> --
> 2.39.3
>

[PATCH net v2 8/9] net: fill in MODULE_DESCRIPTION()s for ipvtap

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the IP-VLAN based tap driver.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/ipvlan/ipvtap.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/net/ipvlan/ipvtap.c b/drivers/net/ipvlan/ipvtap.c
index 60944a4beada..1afc4c47be73 100644
--- a/drivers/net/ipvlan/ipvtap.c
+++ b/drivers/net/ipvlan/ipvtap.c
@@ -237,4 +237,5 @@ static void __exit ipvtap_exit(void)
 module_exit(ipvtap_exit);
 MODULE_ALIAS_RTNL_LINK("ipvtap");
 MODULE_AUTHOR("Sainath Grandhi <sainath.grandhi@intel.com>");
+MODULE_DESCRIPTION("IP-VLAN based tap driver");
 MODULE_LICENSE("GPL");
-- 
2.39.3

Re: [PATCH net v2 8/9] net: fill in MODULE_DESCRIPTION()s for ipvtap

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:27AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the IP-VLAN based tap driver.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>

[PATCH net v2 9/9] net: fill in MODULE_DESCRIPTION()s for dsa_loop_bdinfo

[Breno Leitao]

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

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/dsa/dsa_loop_bdinfo.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/net/dsa/dsa_loop_bdinfo.c b/drivers/net/dsa/dsa_loop_bdinfo.c
index 237066d30704..fd412ae4e84b 100644
--- a/drivers/net/dsa/dsa_loop_bdinfo.c
+++ b/drivers/net/dsa/dsa_loop_bdinfo.c
@@ -32,4 +32,5 @@ static int __init dsa_loop_bdinfo_init(void)
 }
 arch_initcall(dsa_loop_bdinfo_init)
 
+MODULE_DESCRIPTION("DSA loopback fixed PHY library");
 MODULE_LICENSE("GPL");
-- 
2.39.3

Re: [PATCH net v2 9/9] net: fill in MODULE_DESCRIPTION()s for dsa_loop_bdinfo

[Simon Horman]

On Wed, Feb 07, 2024 at 02:19:28AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the DSA loopback fixed PHY module.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  drivers/net/dsa/dsa_loop_bdinfo.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/net/dsa/dsa_loop_bdinfo.c b/drivers/net/dsa/dsa_loop_bdinfo.c
> index 237066d30704..fd412ae4e84b 100644
> --- a/drivers/net/dsa/dsa_loop_bdinfo.c
> +++ b/drivers/net/dsa/dsa_loop_bdinfo.c
> @@ -32,4 +32,5 @@ static int __init dsa_loop_bdinfo_init(void)
>  }
>  arch_initcall(dsa_loop_bdinfo_init)
>  
> +MODULE_DESCRIPTION("DSA loopback fixed PHY library");
>  MODULE_LICENSE("GPL");

Hi Breno,

I'm not sure, but perhaps something like "mock-up Ethernet switch"
is better than loopback.

I'm looking at NET_DSA_LOOP in drivers/net/dsa/Kconfig

Re: [PATCH net v2 9/9] net: fill in MODULE_DESCRIPTION()s for dsa_loop_bdinfo

[Florian Fainelli]

On 2/7/24 02:19, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the DSA loopback fixed PHY module.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>   drivers/net/dsa/dsa_loop_bdinfo.c | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/net/dsa/dsa_loop_bdinfo.c b/drivers/net/dsa/dsa_loop_bdinfo.c
> index 237066d30704..fd412ae4e84b 100644
> --- a/drivers/net/dsa/dsa_loop_bdinfo.c
> +++ b/drivers/net/dsa/dsa_loop_bdinfo.c
> @@ -32,4 +32,5 @@ static int __init dsa_loop_bdinfo_init(void)
>   }
>   arch_initcall(dsa_loop_bdinfo_init)
>   
> +MODULE_DESCRIPTION("DSA loopback fixed PHY library");

Should be:

DSA mock-up switch driver

>   MODULE_LICENSE("GPL");

-- 
Florian