2022-01-31 22:34:40

by Yang Li

Subject: [PATCH -next] proc/vmcore: Fix vmcore_alloc_buf() kernel-doc comment

Fix a spelling problem to remove warnings found
by running scripts/kernel-doc, which is caused by
using 'make W=1'.

fs/proc/vmcore.c:492: warning: Function parameter or member 'size' not
described in 'vmcore_alloc_buf'
fs/proc/vmcore.c:492: warning: Excess function parameter 'sizez'
description in 'vmcore_alloc_buf'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
fs/proc/vmcore.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/proc/vmcore.c b/fs/proc/vmcore.c
index edeb01dfe05d..6f1b8ddc6f7a 100644
--- a/fs/proc/vmcore.c
+++ b/fs/proc/vmcore.c
@@ -480,7 +480,7 @@ static const struct vm_operations_struct vmcore_mmap_ops = {

/**
* vmcore_alloc_buf - allocate buffer in vmalloc memory
- * @sizez: size of buffer
+ * @size: size of buffer
*
* If CONFIG_MMU is defined, use vmalloc_user() to allow users to mmap
* the buffer to user-space by means of remap_vmalloc_range().
--
2.20.1.7.g153144c

2022-01-31 23:13:49

by Baoquan He

Subject: Re: [PATCH -next] proc/vmcore: Fix vmcore_alloc_buf() kernel-doc comment

On 01/29/22 at 09:14am, Yang Li wrote:
> Fix a spelling problem to remove warnings found
> by running scripts/kernel-doc, which is caused by
> using 'make W=1'.
>
> fs/proc/vmcore.c:492: warning: Function parameter or member 'size' not
> described in 'vmcore_alloc_buf'
> fs/proc/vmcore.c:492: warning: Excess function parameter 'sizez'
> description in 'vmcore_alloc_buf'

Acked-by: Baoquan He <[email protected]>

>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> fs/proc/vmcore.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/fs/proc/vmcore.c b/fs/proc/vmcore.c
> index edeb01dfe05d..6f1b8ddc6f7a 100644
> --- a/fs/proc/vmcore.c
> +++ b/fs/proc/vmcore.c
> @@ -480,7 +480,7 @@ static const struct vm_operations_struct vmcore_mmap_ops = {
>
> /**
> * vmcore_alloc_buf - allocate buffer in vmalloc memory
> - * @sizez: size of buffer
> + * @size: size of buffer
> *
> * If CONFIG_MMU is defined, use vmalloc_user() to allow users to mmap
> * the buffer to user-space by means of remap_vmalloc_range().
> --
> 2.20.1.7.g153144c
>