[net-next,14/22] net: fill in MODULE_DESCRIPTION()s for ocelot

Message ID 20240122184543.2501493-15-leitao@debian.org
State New
Headers
Series [net-next,01/22] net: fill in MODULE_DESCRIPTION()s for 8390 |

Commit Message

Breno Leitao Jan. 22, 2024, 6:45 p.m. UTC
  W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the Ocelot SoCs (VSC7514) helpers driver.

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

Comments

Horatiu Vultur Jan. 23, 2024, 7:40 a.m. UTC | #1
The 01/22/2024 10:45, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Ocelot SoCs (VSC7514) helpers driver.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Horatiu Vultur <horatiu.vultur@microchip.com>

> ---
>  drivers/net/ethernet/mscc/ocelot.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/net/ethernet/mscc/ocelot.c b/drivers/net/ethernet/mscc/ocelot.c
> index 56ccbd4c37fe..12999d9be3af 100644
> --- a/drivers/net/ethernet/mscc/ocelot.c
> +++ b/drivers/net/ethernet/mscc/ocelot.c
> @@ -3078,4 +3078,5 @@ void ocelot_deinit_port(struct ocelot *ocelot, int port)
>  }
>  EXPORT_SYMBOL(ocelot_deinit_port);
> 
> +MODULE_DESCRIPTION("Ocelot SoCs (VSC7514) helpers");
>  MODULE_LICENSE("Dual MIT/GPL");
> --
> 2.39.3
>
  
Alexandre Belloni Jan. 23, 2024, 7:48 a.m. UTC | #2
Hello,

On 22/01/2024 10:45:35-0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Ocelot SoCs (VSC7514) helpers driver.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  drivers/net/ethernet/mscc/ocelot.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/net/ethernet/mscc/ocelot.c b/drivers/net/ethernet/mscc/ocelot.c
> index 56ccbd4c37fe..12999d9be3af 100644
> --- a/drivers/net/ethernet/mscc/ocelot.c
> +++ b/drivers/net/ethernet/mscc/ocelot.c
> @@ -3078,4 +3078,5 @@ void ocelot_deinit_port(struct ocelot *ocelot, int port)
>  }
>  EXPORT_SYMBOL(ocelot_deinit_port);
>  
> +MODULE_DESCRIPTION("Ocelot SoCs (VSC7514) helpers");

Shouldn't that mention that this is related to the Ethernet switch?

>  MODULE_LICENSE("Dual MIT/GPL");
> -- 
> 2.39.3
>
  
Breno Leitao Jan. 23, 2024, 3:42 p.m. UTC | #3
On Tue, Jan 23, 2024 at 08:48:26AM +0100, Alexandre Belloni wrote:
> Hello,
> 
> On 22/01/2024 10:45:35-0800, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to the Ocelot SoCs (VSC7514) helpers driver.
> > 
> > Signed-off-by: Breno Leitao <leitao@debian.org>
> > ---
> >  drivers/net/ethernet/mscc/ocelot.c | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/drivers/net/ethernet/mscc/ocelot.c b/drivers/net/ethernet/mscc/ocelot.c
> > index 56ccbd4c37fe..12999d9be3af 100644
> > --- a/drivers/net/ethernet/mscc/ocelot.c
> > +++ b/drivers/net/ethernet/mscc/ocelot.c
> > @@ -3078,4 +3078,5 @@ void ocelot_deinit_port(struct ocelot *ocelot, int port)
> >  }
> >  EXPORT_SYMBOL(ocelot_deinit_port);
> >  
> > +MODULE_DESCRIPTION("Ocelot SoCs (VSC7514) helpers");
> 
> Shouldn't that mention that this is related to the Ethernet switch?

sure. let me update it.
  

Patch

diff --git a/drivers/net/ethernet/mscc/ocelot.c b/drivers/net/ethernet/mscc/ocelot.c
index 56ccbd4c37fe..12999d9be3af 100644
--- a/drivers/net/ethernet/mscc/ocelot.c
+++ b/drivers/net/ethernet/mscc/ocelot.c
@@ -3078,4 +3078,5 @@  void ocelot_deinit_port(struct ocelot *ocelot, int port)
 }
 EXPORT_SYMBOL(ocelot_deinit_port);
 
+MODULE_DESCRIPTION("Ocelot SoCs (VSC7514) helpers");
 MODULE_LICENSE("Dual MIT/GPL");