linux-kernel - Re: [PATCH] kunit: fix kernel-doc warnings due to mismatched arg names

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]

Date:   Tue, 5 Oct 2021 13:58:38 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Daniel Latypov <dlatypov@...gle.com>, brendanhiggins@...gle.com,
        davidgow@...gle.com
Cc:     linux-kernel@...r.kernel.org, kunit-dev@...glegroups.com,
        linux-kselftest@...r.kernel.org, skhan@...uxfoundation.org
Subject: Re: [PATCH] kunit: fix kernel-doc warnings due to mismatched arg
 names

On 10/5/21 1:46 PM, Daniel Latypov wrote:
> Commit 7122debb4367 ("kunit: introduce
> kunit_kmalloc_array/kunit_kcalloc() helpers") added new functions but
> called last arg `flags`, unlike the existing code that used `gfp`.
> This only is an issue in test.h, test.c still used `gfp`.
> 
> But the documentation was copy-pasted with the old names, leading to
> kernel-doc warnings.
> 
> Do s/flags/gfp to make the names consistent and fix the warnings.
> 
> Fixes: 7122debb4367 ("kunit: introduce kunit_kmalloc_array/kunit_kcalloc() helpers")
> Reported-by: Randy Dunlap <rdunlap@...radead.org>
> Signed-off-by: Daniel Latypov <dlatypov@...gle.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>   include/kunit/test.h | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index 24b40e5c160b..018e776a34b9 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -613,7 +613,7 @@ void kunit_remove_resource(struct kunit *test, struct kunit_resource *res);
>    * and is automatically cleaned up after the test case concludes. See &struct
>    * kunit_resource for more information.
>    */
> -void *kunit_kmalloc_array(struct kunit *test, size_t n, size_t size, gfp_t flags);
> +void *kunit_kmalloc_array(struct kunit *test, size_t n, size_t size, gfp_t gfp);
>   
>   /**
>    * kunit_kmalloc() - Like kmalloc() except the allocation is *test managed*.
> @@ -657,9 +657,9 @@ static inline void *kunit_kzalloc(struct kunit *test, size_t size, gfp_t gfp)
>    *
>    * See kcalloc() and kunit_kmalloc_array() for more information.
>    */
> -static inline void *kunit_kcalloc(struct kunit *test, size_t n, size_t size, gfp_t flags)
> +static inline void *kunit_kcalloc(struct kunit *test, size_t n, size_t size, gfp_t gfp)
>   {
> -	return kunit_kmalloc_array(test, n, size, flags | __GFP_ZERO);
> +	return kunit_kmalloc_array(test, n, size, gfp | __GFP_ZERO);
>   }
>   
>   void kunit_cleanup(struct kunit *test);
> 
> base-commit: 3b29021ddd10cfb6b2565c623595bd3b02036f33
> 


-- 
~Randy