Linux-mm Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] mm: slab.c: fix kernel-doc warning for __ksize()
@ 2019-10-08 20:45 Randy Dunlap
  2019-10-09  8:45 ` Marco Elver
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2019-10-08 20:45 UTC (permalink / raw)
  To: Linux MM, Andrew Morton; +Cc: Marco Elver

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)
 {



^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] mm: slab.c: fix kernel-doc warning for __ksize()
  2019-10-08 20:45 [PATCH] mm: slab.c: fix kernel-doc warning for __ksize() Randy Dunlap
@ 2019-10-09  8:45 ` Marco Elver
  0 siblings, 0 replies; 2+ messages in thread
From: Marco Elver @ 2019-10-09  8:45 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: Linux MM, Andrew Morton

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)
>  {
>


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-08 20:45 [PATCH] mm: slab.c: fix kernel-doc warning for __ksize() Randy Dunlap
2019-10-09  8:45 ` Marco Elver

Linux-mm Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-mm/0 linux-mm/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-mm linux-mm/ https://lore.kernel.org/linux-mm \
		linux-mm@kvack.org
	public-inbox-index linux-mm

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kvack.linux-mm


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git