Received-SPF: pass (google.com: domain of linux-kernel+bounces-193014-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Message-ID: <1d256e7d-2b39-42ce-ab19-94b8a48b90cc@quicinc.com>
Date: Tue, 28 May 2024 13:16:10 -0700
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] locking/ww_mutex/test: add MODULE_DESCRIPTION()
Content-Language: en-US
To: Boqun Feng <boqun.feng@gmail.com>
CC: Peter Zijlstra <peterz@infradead.org>, Ingo Molnar <mingo@redhat.com>,
        Will Deacon <will@kernel.org>, Waiman Long <longman@redhat.com>,
        <linux-kernel@vger.kernel.org>, <kernel-janitors@vger.kernel.org>
References: <20240524-md-test-ww_mutex-v1-1-4fb8c106fe21@quicinc.com>
 <ZlYbst1xppRKBxwm@boqun-archlinux>
From: Jeff Johnson <quic_jjohnson@quicinc.com>
In-Reply-To: <ZlYbst1xppRKBxwm@boqun-archlinux>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit

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 <quic_jjohnson@quicinc.com>
>> ---
>>  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