diff mbox series

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

Message ID 20220129011449.105278-1-yang.lee@linux.alibaba.com (mailing list archive)
State New, archived
Headers show
Series [-next] proc/vmcore: Fix vmcore_alloc_buf() kernel-doc comment | expand

Commit Message

Yang Li Jan. 29, 2022, 1:14 a.m. UTC
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 <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/proc/vmcore.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Baoquan He Jan. 29, 2022, 7:53 a.m. UTC | #1
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 <bhe@redhat.com>

> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  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
>
diff mbox series

Patch

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().