[PATCH] mm: slab.c: fix kernel-doc warning for __ksize()

[PATCH] mm: slab.c: fix kernel-doc warning for __ksize()

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning in mm/slab.c:

../mm/slab.c:4215: warning: Function parameter or member 'objp' not described in '__ksize'

Also add Return: documentation section for this function.

Fixes: 10d1f8cb3965 ("mm/slab: refactor common ksize KASAN logic into slab_common.c")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marco Elver <elver@google.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
 mm/slab.c |    3 +++
 1 file changed, 3 insertions(+)

--- linux-next-20191008.orig/mm/slab.c
+++ linux-next-20191008/mm/slab.c
@@ -4207,9 +4207,12 @@ void __check_heap_object(const void *ptr
 
 /**
  * __ksize -- Uninstrumented ksize.
+ * @objp: pointer to the object
  *
  * Unlike ksize(), __ksize() is uninstrumented, and does not provide the same
  * safety checks as ksize() with KASAN instrumentation enabled.
+ *
+ * Return: size of the actual memory used by @objp in bytes
  */
 size_t __ksize(const void *objp)
 {

Re: [PATCH] mm: slab.c: fix kernel-doc warning for __ksize()

[Marco Elver]

On Tue, 8 Oct 2019 at 22:45, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warning in mm/slab.c:
>
> ../mm/slab.c:4215: warning: Function parameter or member 'objp' not described in '__ksize'
>
> Also add Return: documentation section for this function.
>
> Fixes: 10d1f8cb3965 ("mm/slab: refactor common ksize KASAN logic into slab_common.c")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Marco Elver <elver@google.com>
> Cc: Andrew Morton <akpm@linux-foundation.org>

Thanks!

Acked-by: Marco Elver <elver@google.com>

> ---
>  mm/slab.c |    3 +++
>  1 file changed, 3 insertions(+)
>
> --- linux-next-20191008.orig/mm/slab.c
> +++ linux-next-20191008/mm/slab.c
> @@ -4207,9 +4207,12 @@ void __check_heap_object(const void *ptr
>
>  /**
>   * __ksize -- Uninstrumented ksize.
> + * @objp: pointer to the object
>   *
>   * Unlike ksize(), __ksize() is uninstrumented, and does not provide the same
>   * safety checks as ksize() with KASAN instrumentation enabled.
> + *
> + * Return: size of the actual memory used by @objp in bytes
>   */
>  size_t __ksize(const void *objp)
>  {
>