[PATCH] RAS/AMD/ATL: add missing MODULE_DESCRIPTION() macro

[PATCH] RAS/AMD/ATL: add missing MODULE_DESCRIPTION() macro

[Jeff Johnson]

make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/ras/amd/atl/amd_atl.o

Add the missing invocation of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/ras/amd/atl/core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/ras/amd/atl/core.c b/drivers/ras/amd/atl/core.c
index 6dc4e06305f7..7be4982fdf19 100644
--- a/drivers/ras/amd/atl/core.c
+++ b/drivers/ras/amd/atl/core.c
@@ -222,4 +222,5 @@ static void __exit amd_atl_exit(void)
 module_init(amd_atl_init);
 module_exit(amd_atl_exit);
 
+MODULE_DESCRIPTION("AMD Address Translation Library");
 MODULE_LICENSE("GPL");

---
base-commit: a693b9c95abd4947c2d06e05733de5d470ab6586
change-id: 20240604-md-ras-amd-atl-06fd2d780c86

Re: [PATCH] RAS/AMD/ATL: add missing MODULE_DESCRIPTION() macro

[Borislav Petkov]

On Tue, Jun 04, 2024 at 07:21:59PM -0700, Jeff Johnson wrote:
> make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/ras/amd/atl/amd_atl.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  drivers/ras/amd/atl/core.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/ras/amd/atl/core.c b/drivers/ras/amd/atl/core.c
> index 6dc4e06305f7..7be4982fdf19 100644
> --- a/drivers/ras/amd/atl/core.c
> +++ b/drivers/ras/amd/atl/core.c
> @@ -222,4 +222,5 @@ static void __exit amd_atl_exit(void)
>  module_init(amd_atl_init);
>  module_exit(amd_atl_exit);
>  
> +MODULE_DESCRIPTION("AMD Address Translation Library");
>  MODULE_LICENSE("GPL");
> 
> ---

Applied, thanks.

Btw, I'd suggest instead of sending those piecemeal-wise, one per
driver, just group them all by subsystem and whatnot so that each
maintainer can pick it up and this new thing modpost decided to complain
about, can be taken care of without noodling through each driver
one-by-one.

Better yet: do a coccinelle patch and convert the whole tree.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

Re: [PATCH] RAS/AMD/ATL: add missing MODULE_DESCRIPTION() macro

[Jeff Johnson]

On 6/5/2024 2:40 AM, Borislav Petkov wrote:
> Btw, I'd suggest instead of sending those piecemeal-wise, one per
> driver, just group them all by subsystem and whatnot so that each
> maintainer can pick it up and this new thing modpost decided to complain
> about, can be taken care of without noodling through each driver
> one-by-one.
> 
> Better yet: do a coccinelle patch and convert the whole tree.

I actually did use a simple script to do a conversion locally, but the hard
part is determining what text to use for the description. So my local
conversion just added:
MODULE_DESCRIPTION("TBD");

Then, on a per-directory basis, I look at documentation in the .c files and
the Kconfig to replace the TBD with an appropriate description. And I then
create patches for that directory based upon MAINTAINERS entries.

This was the only file in drivers/ras that had an issue.

In drivers/hid there were a large number of issues.
Some of the files had specific MAINTAINERS entries so I sent them separately:
https://lore.kernel.org/all/20240604-md-hid-letsketch-v1-1-ff38ae7b4cb0@quicinc.com/
https://lore.kernel.org/all/20240604-md-hid-lg-g15-v1-1-265b094db089@quicinc.com/
https://lore.kernel.org/all/20240604-md-hid-logitech-dj-v1-1-560f6b3cb54b@quicinc.com/
https://lore.kernel.org/all/20240603-md-hid-logitech-hidpp-v1-1-060f06e4529f@quicinc.com/

I then sent a large patch for all of the remaining drivers/hid patches:
https://lore.kernel.org/all/20240604-md-hid-misc-v1-1-4f9560796f3c@quicinc.com/

Re: [PATCH] RAS/AMD/ATL: add missing MODULE_DESCRIPTION() macro

[Borislav Petkov]

On Wed, Jun 05, 2024 at 07:10:14AM -0700, Jeff Johnson wrote:
> I actually did use a simple script to do a conversion locally, but the hard
> part is determining what text to use for the description. So my local
> conversion just added:
> MODULE_DESCRIPTION("TBD");

Ah, there's that. Can't script that. ;-\

> https://lore.kernel.org/all/20240604-md-hid-letsketch-v1-1-ff38ae7b4cb0@quicinc.com/
> https://lore.kernel.org/all/20240604-md-hid-lg-g15-v1-1-265b094db089@quicinc.com/
> https://lore.kernel.org/all/20240604-md-hid-logitech-dj-v1-1-560f6b3cb54b@quicinc.com/
> https://lore.kernel.org/all/20240603-md-hid-logitech-hidpp-v1-1-060f06e4529f@quicinc.com/

I would've merged them into one - it's not like it is really complicated
changes you're doing so that each maintainer must deal with it
separately.

> I then sent a large patch for all of the remaining drivers/hid patches:
> https://lore.kernel.org/all/20240604-md-hid-misc-v1-1-4f9560796f3c@quicinc.com/

Yap, exactly what I had in mind.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette