Skip to contentSkip to conversation

blktrace: Fix some kernel-doc comments

PATCH In review Yang Li 2 participants 2 messages Jul 18, 2022

Subsystems (2)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 blktrace: Fix some kernel-doc comments

Remove warnings found by running scripts/kernel-doc, which is caused by
using 'make W=1'.
kernel/trace/blktrace.c:1884: warning: Function parameter or member 'opf' not described in 'blk_fill_rwbs' kernel/trace/blktrace.c:1884: warning: Excess function parameter 'op' description in 'blk_fill_rwbs'

---
 kernel/trace/blktrace.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/trace/blktrace.c +1 -1
index 150058f5daa9..5632b6159d88 100644
@@ -1873,7 +1873,7 @@ static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
 /**
  * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
  * @rwbs:	buffer to be filled
- * @op:		REQ_OP_XXX for the tracepoint
+ * @opf:	a combination of a request operation and request flags
  *
  * Description:
  *     Maps the REQ_OP_XXX to character and fills the buffer provided by the
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
Quoted 16 lines · Yang Li

Remove warnings found by running scripts/kernel-doc, which is caused by
using 'make W=1'.
kernel/trace/blktrace.c:1884: warning: Function parameter or member 'opf' not described in 'blk_fill_rwbs' kernel/trace/blktrace.c:1884: warning: Excess function parameter 'op' description in 'blk_fill_rwbs'

---
  kernel/trace/blktrace.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
kernel/trace/blktrace.c +0 -0
index 150058f5daa9..5632b6159d88 100644

kernel/trace/blktrace.c static ssize_t sysfs_blk_trace_attr_store(struct device *dev, · line 1879

Quoted 8 lines
kernel/trace/blktrace.c +1 -1
@@ -1873,7 +1873,7 @@ static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
  /**
   * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
   * @rwbs:	buffer to be filled
- * @op:		REQ_OP_XXX for the tracepoint
+ * @opf:	a combination of a request operation and request flags
   *
   * Description:
   *     Maps the REQ_OP_XXX to character and fills the buffer provided by the

A patch similar to the above patch should already have been queued by Jens Axboe. See also "[PATCH 0/2] Fix recently introduced kernel-doc warnings" (https://lore.kernel.org/all/[email protected]/).

Thanks,

Bart.