diff mbox series

script: modpost: require a MODULE_DESCRIPTION()

Message ID 20250311-moddesc-error-v1-1-79adedf48d0e@oss.qualcomm.com (mailing list archive)
State New
Headers show
Series script: modpost: require a MODULE_DESCRIPTION() | expand

Commit Message

Jeff Johnson March 11, 2025, 7:49 p.m. UTC
Since commit 1fffe7a34c89 ("script: modpost: emit a warning when the
description is missing"), a module without a MODULE_DESCRIPTION() has
resulted in a warning with make W=1. Since that time, all known
instances of this issue have been fixed. Therefore, now make it an
error if a MODULE_DESCRIPTION() is not present.

Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
---
did my treewide cleanup for v6.11, Arnd had a few more stragglers that
he was going to fix. I hope that by posting, some of the 0-day bots
will pick it up and hopefully provide some feedback.

Note: I'm not really sure if *all* of these have been fixed. After I
---
 scripts/mod/modpost.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


---
base-commit: 4d872d51bc9d7b899c1f61534e3dbde72613f627
change-id: 20250311-moddesc-error-2ad949dcc6ba

Comments

Jeff Johnson March 11, 2025, 7:54 p.m. UTC | #1
On 3/11/2025 12:49 PM, Jeff Johnson wrote:
> Since commit 1fffe7a34c89 ("script: modpost: emit a warning when the
> description is missing"), a module without a MODULE_DESCRIPTION() has
> resulted in a warning with make W=1. Since that time, all known
> instances of this issue have been fixed. Therefore, now make it an
> error if a MODULE_DESCRIPTION() is not present.
> 
> Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
> ---
> did my treewide cleanup for v6.11, Arnd had a few more stragglers that
> he was going to fix. I hope that by posting, some of the 0-day bots
> will pick it up and hopefully provide some feedback.
> 
> Note: I'm not really sure if *all* of these have been fixed. After I

guess I should have done another 'b4 send --reflect' after I modified my cover
letter <blush>

Pretend this line is immediately after the cut
Masahiro Yamada March 13, 2025, 12:34 a.m. UTC | #2
On Wed, Mar 12, 2025 at 4:49 AM Jeff Johnson
<jeff.johnson@oss.qualcomm.com> wrote:
>
> Since commit 1fffe7a34c89 ("script: modpost: emit a warning when the
> description is missing"), a module without a MODULE_DESCRIPTION() has
> resulted in a warning with make W=1. Since that time, all known
> instances of this issue have been fixed. Therefore, now make it an
> error if a MODULE_DESCRIPTION() is not present.
>
> Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
> ---
> did my treewide cleanup for v6.11, Arnd had a few more stragglers that
> he was going to fix. I hope that by posting, some of the 0-day bots
> will pick it up and hopefully provide some feedback.


I pushed this patch to a separate branch,
so that 0day bot can compile-test it.

If there is no error reported, I will move it to
the for-next branch.




> Note: I'm not really sure if *all* of these have been fixed. After I
> ---
>  scripts/mod/modpost.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/mod/modpost.c b/scripts/mod/modpost.c
> index c35d22607978..c0b7a869ed24 100644
> --- a/scripts/mod/modpost.c
> +++ b/scripts/mod/modpost.c
> @@ -1596,8 +1596,8 @@ static void read_symbols(const char *modname)
>                                                      namespace);
>                 }
>
> -               if (extra_warn && !get_modinfo(&info, "description"))
> -                       warn("missing MODULE_DESCRIPTION() in %s\n", modname);
> +               if (!get_modinfo(&info, "description"))
> +                       error("missing MODULE_DESCRIPTION() in %s\n", modname);
>         }
>
>         for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
>
> ---
> base-commit: 4d872d51bc9d7b899c1f61534e3dbde72613f627
> change-id: 20250311-moddesc-error-2ad949dcc6ba
>
Masahiro Yamada March 22, 2025, 3:45 p.m. UTC | #3
On Thu, Mar 13, 2025 at 9:34 AM Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Wed, Mar 12, 2025 at 4:49 AM Jeff Johnson
> <jeff.johnson@oss.qualcomm.com> wrote:
> >
> > Since commit 1fffe7a34c89 ("script: modpost: emit a warning when the
> > description is missing"), a module without a MODULE_DESCRIPTION() has
> > resulted in a warning with make W=1. Since that time, all known
> > instances of this issue have been fixed. Therefore, now make it an
> > error if a MODULE_DESCRIPTION() is not present.
> >
> > Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
> > ---
> > did my treewide cleanup for v6.11, Arnd had a few more stragglers that
> > he was going to fix. I hope that by posting, some of the 0-day bots
> > will pick it up and hopefully provide some feedback.
>
>
> I pushed this patch to a separate branch,
> so that 0day bot can compile-test it.
>
> If there is no error reported, I will move it to
> the for-next branch.

I have not got any build error report.
Moved to for-next.
diff mbox series

Patch

diff --git a/scripts/mod/modpost.c b/scripts/mod/modpost.c
index c35d22607978..c0b7a869ed24 100644
--- a/scripts/mod/modpost.c
+++ b/scripts/mod/modpost.c
@@ -1596,8 +1596,8 @@  static void read_symbols(const char *modname)
 						     namespace);
 		}
 
-		if (extra_warn && !get_modinfo(&info, "description"))
-			warn("missing MODULE_DESCRIPTION() in %s\n", modname);
+		if (!get_modinfo(&info, "description"))
+			error("missing MODULE_DESCRIPTION() in %s\n", modname);
 	}
 
 	for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {