2024-01-25 19:37:50

by Breno Leitao

Subject: [PATCH net 02/10] net: fill in MODULE_DESCRIPTION()s for ocelot

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 <[email protected]>
Reviewed-by: Horatiu Vultur <[email protected]>
---
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..2194f2a7ab27 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("Microsemi Ocelot (VSC7514) Switch driver");
MODULE_LICENSE("Dual MIT/GPL");
--
2.39.3

2024-01-30 10:15:34

by Simon Horman

Subject: Re: [PATCH net 02/10] net: fill in MODULE_DESCRIPTION()s for ocelot

On Thu, Jan 25, 2024 at 11:34:12AM -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 <[email protected]>
> Reviewed-by: Horatiu Vultur <[email protected]>
> ---
> 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..2194f2a7ab27 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("Microsemi Ocelot (VSC7514) Switch driver");

Hi Breno,

I really appreciate your work in this area.

WRT this patch, I could well be wrong, but I think this code is also used
by Felix (VSC9959). If so the description might want tweaking.

Vladimir, can you shed some light on this?

> MODULE_LICENSE("Dual MIT/GPL");
> --
> 2.39.3
>

2024-01-30 12:30:49

by Vladimir Oltean

Subject: Re: [PATCH net 02/10] net: fill in MODULE_DESCRIPTION()s for ocelot

On Tue, Jan 30, 2024 at 10:11:34AM +0000, Simon Horman wrote:
> On Thu, Jan 25, 2024 at 11:34:12AM -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 <[email protected]>
> > Reviewed-by: Horatiu Vultur <[email protected]>
> > ---
> > 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..2194f2a7ab27 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("Microsemi Ocelot (VSC7514) Switch driver");
>
> Hi Breno,
>
> I really appreciate your work in this area.
>
> WRT this patch, I could well be wrong, but I think this code is also used
> by Felix (VSC9959). If so the description might want tweaking.
>
> Vladimir, can you shed some light on this?

Thanks for pointing this out, Simon, you are correct. This would be better:

MODULE_DESCRIPTION("Microsemi Ocelot switch family library");

Also, the commit prefix for this driver should be "net: mscc: ocelot:
fill in MODULE_DESCRIPTION()".