2024-05-25 00:18:56

by Jeff Johnson

Subject: [PATCH] locking/ww_mutex/test: add MODULE_DESCRIPTION()

Fix the 'make W=1' warning:
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/locking/test-ww_mutex.o

Signed-off-by: Jeff Johnson <[email protected]>
---
kernel/locking/test-ww_mutex.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/kernel/locking/test-ww_mutex.c b/kernel/locking/test-ww_mutex.c
index 78719e1ef1b1..0fab96137ddb 100644
--- a/kernel/locking/test-ww_mutex.c
+++ b/kernel/locking/test-ww_mutex.c
@@ -695,5 +695,6 @@ static void __exit test_ww_mutex_exit(void)
module_init(test_ww_mutex_init);
module_exit(test_ww_mutex_exit);

+MODULE_DESCRIPTION("API test facility for ww_mutexes");
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Intel Corporation");

---
base-commit: 07506d1011521a4a0deec1c69721c7405c40049b
change-id: 20240524-md-test-ww_mutex-c18c263bc483

2024-05-28 18:01:51

by Boqun Feng

Subject: Re: [PATCH] locking/ww_mutex/test: add MODULE_DESCRIPTION()

On Fri, May 24, 2024 at 05:18:11PM -0700, Jeff Johnson wrote:
> Fix the 'make W=1' warning:
> WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/locking/test-ww_mutex.o
>
> Signed-off-by: Jeff Johnson <[email protected]>
> ---
> kernel/locking/test-ww_mutex.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/kernel/locking/test-ww_mutex.c b/kernel/locking/test-ww_mutex.c
> index 78719e1ef1b1..0fab96137ddb 100644
> --- a/kernel/locking/test-ww_mutex.c
> +++ b/kernel/locking/test-ww_mutex.c
> @@ -695,5 +695,6 @@ static void __exit test_ww_mutex_exit(void)
> module_init(test_ww_mutex_init);
> module_exit(test_ww_mutex_exit);
>
> +MODULE_DESCRIPTION("API test facility for ww_mutexes");


This looks good to me, but seems to me MODULE_DESCRIPTION() is usually
placed after MODULE_AUTHOR(), could you reorder it a bit? Thanks!

Regards,
Boqun

> MODULE_LICENSE("GPL");
> MODULE_AUTHOR("Intel Corporation");
>
> ---
> base-commit: 07506d1011521a4a0deec1c69721c7405c40049b
> change-id: 20240524-md-test-ww_mutex-c18c263bc483
>

2024-05-28 20:16:33

by Jeff Johnson

Subject: Re: [PATCH] locking/ww_mutex/test: add MODULE_DESCRIPTION()

On 5/28/2024 11:00 AM, Boqun Feng wrote:
> On Fri, May 24, 2024 at 05:18:11PM -0700, Jeff Johnson wrote:
>> Fix the 'make W=1' warning:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/locking/test-ww_mutex.o
>>
>> Signed-off-by: Jeff Johnson <[email protected]>
>> ---
>> kernel/locking/test-ww_mutex.c | 1 +
>> 1 file changed, 1 insertion(+)
>>
>> diff --git a/kernel/locking/test-ww_mutex.c b/kernel/locking/test-ww_mutex.c
>> index 78719e1ef1b1..0fab96137ddb 100644
>> --- a/kernel/locking/test-ww_mutex.c
>> +++ b/kernel/locking/test-ww_mutex.c
>> @@ -695,5 +695,6 @@ static void __exit test_ww_mutex_exit(void)
>> module_init(test_ww_mutex_init);
>> module_exit(test_ww_mutex_exit);
>>
>> +MODULE_DESCRIPTION("API test facility for ww_mutexes");
>
>
> This looks good to me, but seems to me MODULE_DESCRIPTION() is usually
> placed after MODULE_AUTHOR(), could you reorder it a bit? Thanks!

Sure, no problem. v2 coming up.

(I had automated placing an empty MODULE_DESCRIPTION() before MODULE_LICENSE()
since every module has a license but not all have authors).

/jeff