Skip to contentSkip to conversation

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

PATCH Applied Yang Li 2 participants 2 messages Jan 29, 2022

Subsystems (5)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 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'

---
 fs/proc/vmcore.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/proc/vmcore.c +1 -1
index edeb01dfe05d..6f1b8ddc6f7a 100644
@@ -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().
Signature · 1 line
2.20.1.7.g153144c
Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Yang Li

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'

Quoted 23 lines
---
 fs/proc/vmcore.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/proc/vmcore.c +1 -1
index edeb01dfe05d..6f1b8ddc6f7a 100644
@@ -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().
Signature · 1 line
2.20.1.7.g153144c