diff mbox series

[net-next,06/10] net: fill in MODULE_DESCRIPTION()s for ieee802154

Message ID 20240108181610.2697017-7-leitao@debian.org (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series Fix MODULE_DESCRIPTION() for net (p1) | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1070 this patch: 1068
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 1098 this patch: 1096
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: 1098 this patch: 1096
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 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

Commit Message

Breno Leitao Jan. 8, 2024, 6:16 p.m. UTC 
W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to ieee802154 modules.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/ieee802154/6lowpan/core.c | 1 +
 net/ieee802154/socket.c       | 1 +
 2 files changed, 2 insertions(+)

Comments

Stefan Schmidt Jan. 9, 2024, 7:25 a.m. UTC | #1 
Hello.

On 08.01.24 19:16, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to ieee802154 modules.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>   net/ieee802154/6lowpan/core.c | 1 +
>   net/ieee802154/socket.c       | 1 +
>   2 files changed, 2 insertions(+)
> 
> diff --git a/net/ieee802154/6lowpan/core.c b/net/ieee802154/6lowpan/core.c
> index 2c087b7f17c5..b88f6a96d961 100644
> --- a/net/ieee802154/6lowpan/core.c
> +++ b/net/ieee802154/6lowpan/core.c
> @@ -280,5 +280,6 @@ static void __exit lowpan_cleanup_module(void)
>   
>   module_init(lowpan_init_module);
>   module_exit(lowpan_cleanup_module);
> +MODULE_DESCRIPTION("IPv6 over Low power Wireless Personal Area Network IEEE802154.4 core");

If we want to nitpick you could write it as IEEE 802.15.4.

>   MODULE_LICENSE("GPL");
>   MODULE_ALIAS_RTNL_LINK("lowpan");
> diff --git a/net/ieee802154/socket.c b/net/ieee802154/socket.c
> index 00302e8b9615..db8df6e26159 100644
> --- a/net/ieee802154/socket.c
> +++ b/net/ieee802154/socket.c
> @@ -1137,4 +1137,5 @@ module_init(af_ieee802154_init);
>   module_exit(af_ieee802154_remove);
>   
>   MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("IEEE802154.4 socket interface");
>   MODULE_ALIAS_NETPROTO(PF_IEEE802154);

Same here.

Besides this:

Acked-by: Stefan Schmidt <stefan@datenfreihafen.org>

regards
Stefan Schmidt
Breno Leitao Jan. 9, 2024, 2:29 p.m. UTC | #2 
On Tue, Jan 09, 2024 at 08:25:21AM +0100, Stefan Schmidt wrote:
> Hello.
> 
> On 08.01.24 19:16, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to ieee802154 modules.
> > 
> > Signed-off-by: Breno Leitao <leitao@debian.org>
> > ---
> >   net/ieee802154/6lowpan/core.c | 1 +
> >   net/ieee802154/socket.c       | 1 +
> >   2 files changed, 2 insertions(+)
> > 
> > diff --git a/net/ieee802154/6lowpan/core.c b/net/ieee802154/6lowpan/core.c
> > index 2c087b7f17c5..b88f6a96d961 100644
> > --- a/net/ieee802154/6lowpan/core.c
> > +++ b/net/ieee802154/6lowpan/core.c
> > @@ -280,5 +280,6 @@ static void __exit lowpan_cleanup_module(void)
> >   module_init(lowpan_init_module);
> >   module_exit(lowpan_cleanup_module);
> > +MODULE_DESCRIPTION("IPv6 over Low power Wireless Personal Area Network IEEE802154.4 core");
> 
> If we want to nitpick you could write it as IEEE 802.15.4.

Thanks. I will update.
Miquel Raynal Jan. 24, 2024, 4:48 p.m. UTC | #3 
Hi,

stefan@datenfreihafen.org wrote on Tue, 9 Jan 2024 08:25:21 +0100:

> Hello.
> 
> On 08.01.24 19:16, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to ieee802154 modules.
> > 
> > Signed-off-by: Breno Leitao <leitao@debian.org>
> > ---
> >   net/ieee802154/6lowpan/core.c | 1 +
> >   net/ieee802154/socket.c       | 1 +
> >   2 files changed, 2 insertions(+)
> > 
> > diff --git a/net/ieee802154/6lowpan/core.c b/net/ieee802154/6lowpan/core.c
> > index 2c087b7f17c5..b88f6a96d961 100644
> > --- a/net/ieee802154/6lowpan/core.c
> > +++ b/net/ieee802154/6lowpan/core.c
> > @@ -280,5 +280,6 @@ static void __exit lowpan_cleanup_module(void)  
> >   >   module_init(lowpan_init_module);  
> >   module_exit(lowpan_cleanup_module);
> > +MODULE_DESCRIPTION("IPv6 over Low power Wireless Personal Area Network IEEE802154.4 core");  
> 
> If we want to nitpick you could write it as IEEE 802.15.4.

Also agreed, can you please post an update?

Thanks,
Miquèl
Breno Leitao Jan. 25, 2024, 10 a.m. UTC | #4 
Hello Miquèl,

On Wed, Jan 24, 2024 at 05:48:02PM +0100, Miquel Raynal wrote:
> Hi,
> 
> stefan@datenfreihafen.org wrote on Tue, 9 Jan 2024 08:25:21 +0100:
> 
> > Hello.
> > 
> > On 08.01.24 19:16, Breno Leitao wrote:
> > > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > > Add descriptions to ieee802154 modules.
> > > 
> > > Signed-off-by: Breno Leitao <leitao@debian.org>
> > > ---
> > >   net/ieee802154/6lowpan/core.c | 1 +
> > >   net/ieee802154/socket.c       | 1 +
> > >   2 files changed, 2 insertions(+)
> > > 
> > > diff --git a/net/ieee802154/6lowpan/core.c b/net/ieee802154/6lowpan/core.c
> > > index 2c087b7f17c5..b88f6a96d961 100644
> > > --- a/net/ieee802154/6lowpan/core.c
> > > +++ b/net/ieee802154/6lowpan/core.c
> > > @@ -280,5 +280,6 @@ static void __exit lowpan_cleanup_module(void)  
> > >   >   module_init(lowpan_init_module);  
> > >   module_exit(lowpan_cleanup_module);
> > > +MODULE_DESCRIPTION("IPv6 over Low power Wireless Personal Area Network IEEE802154.4 core");  
> > 
> > If we want to nitpick you could write it as IEEE 802.15.4.
> 
> Also agreed, can you please post an update?

Sure. I will send it soon, since I am splitting the patches in a set of
10. According to the maintainer's request:
https://lore.kernel.org/all/20240122105708.52d33fa0@kernel.org/

For now, I am focusing on Ethernet drivers.

Thanks!
diff mbox series

Patch

diff --git a/net/ieee802154/6lowpan/core.c b/net/ieee802154/6lowpan/core.c
index 2c087b7f17c5..b88f6a96d961 100644
--- a/net/ieee802154/6lowpan/core.c
+++ b/net/ieee802154/6lowpan/core.c
@@ -280,5 +280,6 @@  static void __exit lowpan_cleanup_module(void)
 
 module_init(lowpan_init_module);
 module_exit(lowpan_cleanup_module);
+MODULE_DESCRIPTION("IPv6 over Low power Wireless Personal Area Network IEEE802154.4 core");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_RTNL_LINK("lowpan");
diff --git a/net/ieee802154/socket.c b/net/ieee802154/socket.c
index 00302e8b9615..db8df6e26159 100644
--- a/net/ieee802154/socket.c
+++ b/net/ieee802154/socket.c
@@ -1137,4 +1137,5 @@  module_init(af_ieee802154_init);
 module_exit(af_ieee802154_remove);
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("IEEE802154.4 socket interface");
 MODULE_ALIAS_NETPROTO(PF_IEEE802154);