diff mbox series

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

Message ID 20240125193420.533604-3-leitao@debian.org (mailing list archive)
State Accepted
Commit 1c870c63d7d2474646472b13ac3d4a75d5aec368
Delegated to: Netdev Maintainers
Headers show
Series Fix MODULE_DESCRIPTION() for net (p3) | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/ynl success SINGLE THREAD; Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present fail Series targets non-next tree, but doesn't contain any Fixes tags
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1063 this patch: 1062
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 1080 this patch: 1079
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 1080 this patch: 1079
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 5 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-01-27--15-00 (tests: 614)

Commit Message

Breno Leitao Jan. 25, 2024, 7:34 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>
Reviewed-by: Horatiu Vultur <horatiu.vultur@microchip.com>
---
 drivers/net/ethernet/mscc/ocelot.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Simon Horman Jan. 30, 2024, 10:11 a.m. UTC | #1 
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@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..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
>
Vladimir Oltean Jan. 30, 2024, 12:03 p.m. UTC | #2 
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@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..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()".
diff mbox series

Patch

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