+ mm-slabc-fix-kernel-doc-warning-for-__ksize.patch added to -mm tree

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The patch titled
     Subject: mm/slab.c: fix kernel-doc warning for __ksize()
has been added to the -mm tree.  Its filename is
     mm-slabc-fix-kernel-doc-warning-for-__ksize.patch

This patch should soon appear at
    http://ozlabs.org/~akpm/mmots/broken-out/mm-slabc-fix-kernel-doc-warning-for-__ksize.patch
and later at
    http://ozlabs.org/~akpm/mmotm/broken-out/mm-slabc-fix-kernel-doc-warning-for-__ksize.patch

Before you just go and hit "reply", please:
   a) Consider who else should be cc'ed
   b) Prefer to cc a suitable mailing list as well
   c) Ideally: find the original patch on the mailing list and do a
      reply-to-all to that, adding suitable additional cc's

*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***

The -mm tree is included into linux-next and is updated
there every 3-4 working days

------------------------------------------------------
From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Subject: mm/slab.c: fix kernel-doc warning for __ksize()

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.

Link: http://lkml.kernel.org/r/68c9fd7d-f09e-d376-e292-c7b2bdf1774d@xxxxxxxxxxxxx
Fixes: 10d1f8cb3965 ("mm/slab: refactor common ksize KASAN logic into slab_common.c")
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Acked-by: Marco Elver <elver@xxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---

 mm/slab.c |    3 +++
 1 file changed, 3 insertions(+)

--- a/mm/slab.c~mm-slabc-fix-kernel-doc-warning-for-__ksize
+++ a/mm/slab.c
@@ -4206,9 +4206,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)
 {
_

Patches currently in -mm which might be from rdunlap@xxxxxxxxxxxxx are

fs-fix-direct-ioc-kernel-doc-warning.patch
fs-fix-libfsc-kernel-doc-warning.patch
fs-fs-writebackc-fix-kernel-doc-warning.patch
bitmaph-fix-kernel-doc-warning-and-typo.patch
xarrayh-fix-kernel-doc-warning.patch
mm-slabc-fix-kernel-doc-warning-for-__ksize.patch
pinctrl-fix-pxa2xxc-build-warnings.patch




[Index of Archives]     [Kernel Archive]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]

  Powered by Linux