Received-SPF: pass (google.com: domain of linux-kernel+bounces-120342-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Precedence: bulk
MIME-Version: 1.0
References: <20240327044649.9199-1-rdunlap@infradead.org>
In-Reply-To: <20240327044649.9199-1-rdunlap@infradead.org>
From: Suren Baghdasaryan <surenb@google.com>
Date: Tue, 26 Mar 2024 22:49:11 -0700
Message-ID: <CAJuCfpG-ocGBZs96WbhEgj=AsVysswMV4M0HtQAK35ZBc6-rAQ@mail.gmail.com>
Subject: Re: [PATCH] mm/slab: fix kcalloc() kernel-doc warnings
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, Stephen Rothwell <sfr@canb.auug.org.au>, 
	Kent Overstreet <kent.overstreet@linux.dev>, Vlastimil Babka <vbabka@suse.cz>, 
	Andrew Morton <akpm@linux-foundation.org>, linux-mm@kvack.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Tue, Mar 26, 2024 at 9:46=E2=80=AFPM Randy Dunlap <rdunlap@infradead.org=
> wrote:
>
> Fix the parameter names for kcalloc() in slab.h to prevent kernel-doc
> warnings:
>
> include/linux/slab.h:730: warning: Function parameter or struct member '_=
n' not described in 'kcalloc'
> include/linux/slab.h:730: warning: Function parameter or struct member '_=
size' not described in 'kcalloc'
> include/linux/slab.h:730: warning: Function parameter or struct member '_=
flags' not described in 'kcalloc'
> include/linux/slab.h:730: warning: Excess function parameter 'n' descript=
ion in 'kcalloc'
> include/linux/slab.h:730: warning: Excess function parameter 'size' descr=
iption in 'kcalloc'
> include/linux/slab.h:730: warning: Excess function parameter 'flags' desc=
ription in 'kcalloc'
>
> Fixes: bc7b83f5e4bf ("mm/slab: enable slab allocation tagging for kmalloc=
 and friends")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Link: https://lore.kernel.org/linux-next/20240325123603.1bdd6588@canb.auu=
g.org.au/
> Cc: Suren Baghdasaryan <surenb@google.com>
> Cc: Kent Overstreet <kent.overstreet@linux.dev>
> Cc: Vlastimil Babka <vbabka@suse.cz>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: linux-mm@kvack.org

Doh! I noticed these warnings but completely forgot to fix them in my
fixup patchset :(
Thanks for the fix!

Tested-by: Suren Baghdasaryan <surenb@google.com>


> ---
>  include/linux/slab.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/include/linux/slab.h b/include/linux/slab.h
> --- a/include/linux/slab.h
> +++ b/include/linux/slab.h
> @@ -727,7 +727,7 @@ static inline __realloc_size(2, 3) void
>   * @size: element size.
>   * @flags: the type of memory to allocate (see kmalloc).
>   */
> -#define kcalloc(_n, _size, _flags)             kmalloc_array(_n, _size, =
(_flags) | __GFP_ZERO)
> +#define kcalloc(n, size, flags)                kmalloc_array(n, size, (f=
lags) | __GFP_ZERO)
>
>  void *kmalloc_node_track_caller_noprof(size_t size, gfp_t flags, int nod=
e,
>                                   unsigned long caller) __alloc_size(1);