netdev - Re: [PATCH net 02/10] net: fill in MODULE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240130120328.rmmbgeywvj6jvqkm@skbuf>
Date: Tue, 30 Jan 2024 14:03:28 +0200
From: Vladimir Oltean <vladimir.oltean@....com>
To: Simon Horman <horms@...nel.org>
Cc: Breno Leitao <leitao@...ian.org>, kuba@...nel.org, davem@...emloft.net,
	pabeni@...hat.com, edumazet@...gle.com,
	Claudiu Manoil <claudiu.manoil@....com>,
	Alexandre Belloni <alexandre.belloni@...tlin.com>,
	UNGLinuxDriver@...rochip.com, dsahern@...nel.org, weiwan@...gle.com,
	netdev@...r.kernel.org, linux-kernel@...r.kernel.org,
	Horatiu Vultur <horatiu.vultur@...rochip.com>
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 <leitao@...ian.org>
> > Reviewed-by: Horatiu Vultur <horatiu.vultur@...rochip.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..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()".