linux-next: build warning after merge of the akpm-current tree

linux-next: build warning after merge of the akpm-current tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 331 bytes --]

Hi all,

After merging the akpm-current tree, today's linux-next build (htmldocs)
produced this warning:

include/linux/kfence.h:138: warning: Function parameter or member 'addr' not described in 'kfence_object_start'

Introduced by patch

  mm: add Kernel Electric-Fence infrastructure

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH] kfence: Fix parameter description for kfence_object_start()

[Marco Elver]

Describe parameter @addr correctly by delimiting with ':'.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Marco Elver <elver@google.com>
---
 include/linux/kfence.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/kfence.h b/include/linux/kfence.h
index 98a97f9d43cd..76246889ecdb 100644
--- a/include/linux/kfence.h
+++ b/include/linux/kfence.h
@@ -125,7 +125,7 @@ size_t kfence_ksize(const void *addr);
 
 /**
  * kfence_object_start() - find the beginning of a KFENCE object
- * @addr - address within a KFENCE-allocated object
+ * @addr: address within a KFENCE-allocated object
  *
  * Return: address of the beginning of the object.
  *
-- 
2.29.2.222.g5d2a92d10f8-goog

Re: [PATCH] kfence: Fix parameter description for kfence_object_start()

[Alexander Potapenko]

On Fri, Nov 6, 2020 at 10:21 AM Marco Elver <elver@google.com> wrote:
>
> Describe parameter @addr correctly by delimiting with ':'.
>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Marco Elver <elver@google.com>
Reviewed-by: Alexander Potapenko <glider@google.com>

> ---
>  include/linux/kfence.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/kfence.h b/include/linux/kfence.h
> index 98a97f9d43cd..76246889ecdb 100644
> --- a/include/linux/kfence.h
> +++ b/include/linux/kfence.h
> @@ -125,7 +125,7 @@ size_t kfence_ksize(const void *addr);
>
>  /**
>   * kfence_object_start() - find the beginning of a KFENCE object
> - * @addr - address within a KFENCE-allocated object
> + * @addr: address within a KFENCE-allocated object
>   *
>   * Return: address of the beginning of the object.
>   *
> --
> 2.29.2.222.g5d2a92d10f8-goog
>


-- 
Alexander Potapenko
Software Engineer

Google Germany GmbH
Erika-Mann-Straße, 33
80636 München

Geschäftsführer: Paul Manicle, Halimah DeLaine Prado
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg