linux-kernel - Re: [PATCH] kunit: fix kernel-doc warnings in doc. build

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <70b0b0c4-47d0-7bb3-3bdd-688a91074bfb@infradead.org>
Date:   Tue, 5 Oct 2021 11:54:15 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Daniel Latypov <dlatypov@...gle.com>
Cc:     linux-kernel@...r.kernel.org,
        Brendan Higgins <brendanhiggins@...gle.com>,
        linux-kselftest@...r.kernel.org, kunit-dev@...glegroups.com,
        Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] kunit: fix kernel-doc warnings in doc. build

On 10/5/21 9:21 AM, Daniel Latypov wrote:
> On Mon, Oct 4, 2021 at 10:30 PM Randy Dunlap <rdunlap@...radead.org> wrote:
>>
>> Fix documentation build warnings in <kunit/test.h>:
>>
>> ../include/kunit/test.h:616: warning: Function parameter or member 'flags' not described in 'kunit_kmalloc_array'
>> ../include/kunit/test.h:616: warning: Excess function parameter 'gfp' description in 'kunit_kmalloc_array'
>> ../include/kunit/test.h:661: warning: Function parameter or member 'flags' not described in 'kunit_kcalloc'
>> ../include/kunit/test.h:661: warning: Excess function parameter 'gfp' description in 'kunit_kcalloc'
>>
>> Fixes: 0a756853586c ("kunit: test: add test resource management API")
>> Fixes: 7122debb4367 ("kunit: introduce kunit_kmalloc_array/kunit_kcalloc() helpers")
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> Cc: Brendan Higgins <brendanhiggins@...gle.com>
>> Cc: linux-kselftest@...r.kernel.org
>> Cc: kunit-dev@...glegroups.com
>> Cc: Daniel Latypov <dlatypov@...gle.com>
>> Cc: Shuah Khan <skhan@...uxfoundation.org>
>> ---
>>   include/kunit/test.h |    4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> --- lnx-515-rc4.orig/include/kunit/test.h
>> +++ lnx-515-rc4/include/kunit/test.h
>> @@ -607,7 +607,7 @@ void kunit_remove_resource(struct kunit
>>    * @test: The test context object.
>>    * @n: number of elements.
>>    * @size: The size in bytes of the desired memory.
>> - * @gfp: flags passed to underlying kmalloc().
>> + * @flags: gfp flags passed to underlying kmalloc().
> 
> Thanks for catching this.
> But can we instead rename the parameters?
> I can send out a patch for that if you'd prefer.
> 
> The other funcs here use `gfp_t gfp`, which is why this copy-pasted
> comment does too.
> In test.c, kmalloc_array() actually calls the parameter `gfp` as well.
> 

Sure, go ahead with it, please.

-- 
~Randy