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

Message ID 20240207101929.484681-10-leitao@debian.org
State New
Headers
Series net: Fix MODULE_DESCRIPTION() for net (p5) |

Commit Message

Breno Leitao Feb. 7, 2024, 10:19 a.m. UTC
  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(+)
  

Comments

Simon Horman Feb. 7, 2024, 11:40 a.m. UTC | #1
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
  
Florian Fainelli Feb. 7, 2024, 10:21 p.m. UTC | #2
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");
  

Patch

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");