Message ID | 687a2e724020d135bc7dfef0ec9010a00ecc0a3a.1656409369.git.mchehab@kernel.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | Fix kernel-doc warnings at linux-next | expand |
On Tue, 28 Jun 2022 at 11:46, Mauro Carvalho Chehab <mchehab@kernel.org> 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 <mchehab@kernel.org> Reviewed-by: Marco Elver <elver@google.com> 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/cover.1656409369.git.mchehab@kernel.org/ > > 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 >
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
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 <mchehab@kernel.org> --- 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/cover.1656409369.git.mchehab@kernel.org/ include/linux/kfence.h | 1 + 1 file changed, 1 insertion(+)