The kernel-doc markup is missing the slab pointer description:
include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info'
Document it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/
include/linux/kfence.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/include/linux/kfence.h b/include/linux/kfence.h
index 726857a4b680..9c242f4e9fab 100644
--- a/include/linux/kfence.h
+++ b/include/linux/kfence.h
@@ -210,6 +210,7 @@ struct kmem_obj_info;
* __kfence_obj_info() - fill kmem_obj_info struct
* @kpp: kmem_obj_info to be filled
* @object: the object
+ * @slab: pointer to slab
*
* Return:
* * false - not a KFENCE object
--
2.36.1
On Tue, 28 Jun 2022 at 11:46, Mauro Carvalho Chehab <[email protected]> wrote:
>
> The kernel-doc markup is missing the slab pointer description:
>
> include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info'
>
> Document it.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Reviewed-by: Marco Elver <[email protected]>
Thank you.
> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/
>
> include/linux/kfence.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/include/linux/kfence.h b/include/linux/kfence.h
> index 726857a4b680..9c242f4e9fab 100644
> --- a/include/linux/kfence.h
> +++ b/include/linux/kfence.h
> @@ -210,6 +210,7 @@ struct kmem_obj_info;
> * __kfence_obj_info() - fill kmem_obj_info struct
> * @kpp: kmem_obj_info to be filled
> * @object: the object
> + * @slab: pointer to slab
> *
> * Return:
> * * false - not a KFENCE object
> --
> 2.36.1
>