Re: [PATCH v2] slab: recognize @GFP parameter as optional in kernel-doc
From: Vlastimil Babka (SUSE)
Date: Wed Jun 17 2026 - 14:16:58 EST
On 6/17/26 18:31, Randy Dunlap wrote:
> Since the @GFP parameter in kmalloc_obj() etc. is now optional, change
> the kernel-doc to indicate that it is optional. This avoids kernel-doc
> warnings:
>
> WARNING: include/linux/slab.h:1101 Excess function parameter 'GFP' description in 'kmalloc_obj'
> WARNING: include/linux/slab.h:1113 Excess function parameter 'GFP' description in 'kmalloc_objs'
> WARNING: include/linux/slab.h:1128 Excess function parameter 'GFP' description in 'kmalloc_flex'
>
> Fixes: e19e1b480ac7 ("add default_gfp() helper macro and use it in the new *alloc_obj() helpers")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Acked-by: Harry Yoo (Oracle) <harry@xxxxxxxxxx>
Added to slab/for-next, thanks!
> ---
> v2: add default value for GFP flags to the description (Harry)
>
> Cc: Vlastimil Babka <vbabka@xxxxxxxxxx>
> Cc: Harry Yoo <harry@xxxxxxxxxx>
> Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
> Cc: linux-mm@xxxxxxxxx
> Cc: stable@xxxxxxxxxxxxxxx
> Cc: Kees Cook <kees@xxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
>
> include/linux/slab.h | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> --- linux-next-20260615.orig/include/linux/slab.h
> +++ linux-next-20260615/include/linux/slab.h
> @@ -1094,7 +1094,7 @@ void *kmalloc_nolock(size_t size, gfp_t
> /**
> * kmalloc_obj - Allocate a single instance of the given type
> * @VAR_OR_TYPE: Variable or type to allocate.
> - * @GFP: GFP flags for the allocation.
> + * @...: optional GFP flags for the allocation (GFP_KERNEL when not specified).
> *
> * Returns: newly allocated pointer to a @VAR_OR_TYPE on success, or NULL
> * on failure.
> @@ -1106,7 +1106,7 @@ void *kmalloc_nolock(size_t size, gfp_t
> * kmalloc_objs - Allocate an array of the given type
> * @VAR_OR_TYPE: Variable or type to allocate an array of.
> * @COUNT: How many elements in the array.
> - * @GFP: GFP flags for the allocation.
> + * @...: optional GFP flags for the allocation (GFP_KERNEL when not specified).
> *
> * Returns: newly allocated pointer to array of @VAR_OR_TYPE on success,
> * or NULL on failure.
> @@ -1119,7 +1119,7 @@ void *kmalloc_nolock(size_t size, gfp_t
> * @VAR_OR_TYPE: Variable or type to allocate (with its flex array).
> * @FAM: The name of the flexible array member of the structure.
> * @COUNT: How many flexible array member elements are desired.
> - * @GFP: GFP flags for the allocation.
> + * @...: optional GFP flags for the allocation (GFP_KERNEL when not specified).
> *
> * Returns: newly allocated pointer to @VAR_OR_TYPE on success, NULL on
> * failure. If @FAM has been annotated with __counted_by(), the allocation