diff mbox series

[net,v2,7/9] net: fill in MODULE_DESCRIPTION()s for net/sched

Message ID 20240207101929.484681-8-leitao@debian.org (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series net: Fix MODULE_DESCRIPTION() for net (p5) | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/ynl success 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: 1046 this patch: 1040
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 7 of 7 maintainers
netdev/build_clang success Errors and warnings before: 1060 this patch: 1054
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: 1063 this patch: 1057
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 42 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-02-08--12-00 (tests: 684)

Commit Message

Breno Leitao Feb. 7, 2024, 10:19 a.m. UTC 
W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the network schedulers.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 net/sched/em_canid.c | 1 +
 net/sched/em_cmp.c   | 1 +
 net/sched/em_meta.c  | 1 +
 net/sched/em_nbyte.c | 1 +
 net/sched/em_text.c  | 1 +
 net/sched/em_u32.c   | 1 +
 6 files changed, 6 insertions(+)

Comments

Simon Horman Feb. 7, 2024, 11:36 a.m. UTC | #1 
On Wed, Feb 07, 2024 at 02:19:26AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the network schedulers.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Hi Breno,

I wonder if it would be useful to mention Ematch somehow
in the module descriptions as that is the context in
which they operate.
Jakub Kicinski Feb. 7, 2024, 3:37 p.m. UTC | #2 
On Wed,  7 Feb 2024 02:19:26 -0800 Breno Leitao wrote:
> --- a/net/sched/em_canid.c
> +++ b/net/sched/em_canid.c
> @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
>  	tcf_em_unregister(&em_canid_ops);
>  }
>  
> +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");

That sounds like it as library for any code, but it's TC extended match.
Jamal, any suggestion for a good name template for em_ ?
Jamal Hadi Salim Feb. 7, 2024, 9:01 p.m. UTC | #3 
On Wed, Feb 7, 2024 at 10:37 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> On Wed,  7 Feb 2024 02:19:26 -0800 Breno Leitao wrote:
> > --- a/net/sched/em_canid.c
> > +++ b/net/sched/em_canid.c
> > @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
> >       tcf_em_unregister(&em_canid_ops);
> >  }
> >
> > +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");
>
> That sounds like it as library for any code, but it's TC extended match.
> Jamal, any suggestion for a good name template for em_ ?

At minimal what Simon said. But let me go over it and do individual responses.

cheers,
jamal
Jamal Hadi Salim Feb. 7, 2024, 9:27 p.m. UTC | #4 
On Wed, Feb 7, 2024 at 5:19 AM Breno Leitao <leitao@debian.org> wrote:
>
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the network schedulers.
>
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  net/sched/em_canid.c | 1 +
>  net/sched/em_cmp.c   | 1 +
>  net/sched/em_meta.c  | 1 +
>  net/sched/em_nbyte.c | 1 +
>  net/sched/em_text.c  | 1 +
>  net/sched/em_u32.c   | 1 +
>  6 files changed, 6 insertions(+)
>
> diff --git a/net/sched/em_canid.c b/net/sched/em_canid.c
> index 5ea84decec19..c1852d79c00a 100644
> --- a/net/sched/em_canid.c
> +++ b/net/sched/em_canid.c
> @@ -222,6 +222,7 @@ static void __exit exit_em_canid(void)
>         tcf_em_unregister(&em_canid_ops);
>  }
>
> +MODULE_DESCRIPTION("CAN Identifier comparison network helpers");

ematch classifier to match CAN IDs embedded in skb CAN frames

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_canid);
> diff --git a/net/sched/em_cmp.c b/net/sched/em_cmp.c
> index f17b049ea530..285b36c32c16 100644
> --- a/net/sched/em_cmp.c
> +++ b/net/sched/em_cmp.c
> @@ -87,6 +87,7 @@ static void __exit exit_em_cmp(void)
>         tcf_em_unregister(&em_cmp_ops);
>  }
>
> +MODULE_DESCRIPTION("Simple packet data comparison network helpers");

ematch classifier for basic data types(8/16/32 bit) against skb data

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_cmp);
> diff --git a/net/sched/em_meta.c b/net/sched/em_meta.c
> index 09d8afd04a2a..cab43356824a 100644
> --- a/net/sched/em_meta.c
> +++ b/net/sched/em_meta.c
> @@ -1006,6 +1006,7 @@ static void __exit exit_em_meta(void)
>         tcf_em_unregister(&em_meta_ops);
>  }
>
> +MODULE_DESCRIPTION("Metadata comparison network helpers");

ematch classifier for various internal kernel metadata, skb metadata
and sk metadata

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_meta);
> diff --git a/net/sched/em_nbyte.c b/net/sched/em_nbyte.c
> index a83b237cbeb0..34c6e8c8b695 100644
> --- a/net/sched/em_nbyte.c
> +++ b/net/sched/em_nbyte.c
> @@ -68,6 +68,7 @@ static void __exit exit_em_nbyte(void)
>         tcf_em_unregister(&em_nbyte_ops);
>  }
>
> +MODULE_DESCRIPTION("Multi byte comparison network helpers");

ematch classifier for arbitrary skb multi-bytes

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_nbyte);
> diff --git a/net/sched/em_text.c b/net/sched/em_text.c
> index f176afb70559..7a89db8e5409 100644
> --- a/net/sched/em_text.c
> +++ b/net/sched/em_text.c
> @@ -147,6 +147,7 @@ static void __exit exit_em_text(void)
>         tcf_em_unregister(&em_text_ops);
>  }
>
> +MODULE_DESCRIPTION("Textsearch comparison network helpers");

ematch classifier for embedded text in skbs

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_text);
> diff --git a/net/sched/em_u32.c b/net/sched/em_u32.c
> index 71b070da0437..ea32e4e12a99 100644
> --- a/net/sched/em_u32.c
> +++ b/net/sched/em_u32.c
> @@ -52,6 +52,7 @@ static void __exit exit_em_u32(void)
>         tcf_em_unregister(&em_u32_ops);
>  }
>
> +MODULE_DESCRIPTION("U32 Key comparison network helpers");

ematch skb classifier using 32 bit chunks of data

>  MODULE_LICENSE("GPL");
>
>  module_init(init_em_u32);
> --
> 2.39.3
>
diff mbox series

Patch

diff --git a/net/sched/em_canid.c b/net/sched/em_canid.c
index 5ea84decec19..c1852d79c00a 100644
--- a/net/sched/em_canid.c
+++ b/net/sched/em_canid.c
@@ -222,6 +222,7 @@  static void __exit exit_em_canid(void)
 	tcf_em_unregister(&em_canid_ops);
 }
 
+MODULE_DESCRIPTION("CAN Identifier comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_canid);
diff --git a/net/sched/em_cmp.c b/net/sched/em_cmp.c
index f17b049ea530..285b36c32c16 100644
--- a/net/sched/em_cmp.c
+++ b/net/sched/em_cmp.c
@@ -87,6 +87,7 @@  static void __exit exit_em_cmp(void)
 	tcf_em_unregister(&em_cmp_ops);
 }
 
+MODULE_DESCRIPTION("Simple packet data comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_cmp);
diff --git a/net/sched/em_meta.c b/net/sched/em_meta.c
index 09d8afd04a2a..cab43356824a 100644
--- a/net/sched/em_meta.c
+++ b/net/sched/em_meta.c
@@ -1006,6 +1006,7 @@  static void __exit exit_em_meta(void)
 	tcf_em_unregister(&em_meta_ops);
 }
 
+MODULE_DESCRIPTION("Metadata comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_meta);
diff --git a/net/sched/em_nbyte.c b/net/sched/em_nbyte.c
index a83b237cbeb0..34c6e8c8b695 100644
--- a/net/sched/em_nbyte.c
+++ b/net/sched/em_nbyte.c
@@ -68,6 +68,7 @@  static void __exit exit_em_nbyte(void)
 	tcf_em_unregister(&em_nbyte_ops);
 }
 
+MODULE_DESCRIPTION("Multi byte comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_nbyte);
diff --git a/net/sched/em_text.c b/net/sched/em_text.c
index f176afb70559..7a89db8e5409 100644
--- a/net/sched/em_text.c
+++ b/net/sched/em_text.c
@@ -147,6 +147,7 @@  static void __exit exit_em_text(void)
 	tcf_em_unregister(&em_text_ops);
 }
 
+MODULE_DESCRIPTION("Textsearch comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_text);
diff --git a/net/sched/em_u32.c b/net/sched/em_u32.c
index 71b070da0437..ea32e4e12a99 100644
--- a/net/sched/em_u32.c
+++ b/net/sched/em_u32.c
@@ -52,6 +52,7 @@  static void __exit exit_em_u32(void)
 	tcf_em_unregister(&em_u32_ops);
 }
 
+MODULE_DESCRIPTION("U32 Key comparison network helpers");
 MODULE_LICENSE("GPL");
 
 module_init(init_em_u32);