[PATCH] blktrace: fix documentation for blk_fill_rw()

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Add missing ":" after rwbs function parameter documentation that fixes
following warning :-

./kernel/trace/blktrace.c:1877: warning: Function parameter or member 'rwbs' not described in 'blk_fill_rwbs'

Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Fixes: 1f83bb4b4914 ("blktrace: add blk_fill_rwbs documentation comment")
Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@xxxxxxx>
---

* This patch is generated with linux-block/for-next on the top follwing
  commit :-

Commit 61ce46f9b9ef2f5918ef784570c3ca668f58c8ce (origin/for-next)
Merge: 818b96ba6e27 452c0bf8754f
Author: Jens Axboe <axboe@xxxxxxxxx>
Date:   Tue Feb 23 20:31:20 2021 -0700

    Merge branch 'block-5.12' into for-next
    
    * block-5.12:
      block: fix logging on capacity change
      blk-settings: align max_sectors on "logical_block_size" boundary
      block: reopen the device in blkdev_reread_part
      block: don't skip empty device in in disk_uevent
      blktrace: remove debugfs file dentries from struct blk_trace

* Without this patch :-

# makej htmldocs 
SPHINX  htmldocs --> file:///mnt/sdb/linux-block/Documentation/output
make[3]: Nothing to be done for `html'.
WARNING: The kernel documentation build process
        support for Sphinx v3.0 and above is brand new. Be prepared for
        possible issues in the generated output.
        Warning: The Sphinx 'sphinx_rtd_theme' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.
WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org)
./kernel/trace/blktrace.c:1877: warning: Function parameter or member 'rwbs' not described in 'blk_fill_rwbs'
./include/linux/rcupdate.h:884: warning: Excess function parameter 'ptr' description in 'kfree_rcu'
./include/linux/rcupdate.h:884: warning: Excess function parameter 'rhf' description in 'kfree_rcu'

* With this patch :-

# makej htmldocs 
  SPHINX  htmldocs --> file:///mnt/sdb/linux-block/Documentation/output
make[3]: Nothing to be done for `html'.
WARNING: The kernel documentation build process
        support for Sphinx v3.0 and above is brand new. Be prepared for
        possible issues in the generated output.
        Warning: The Sphinx 'sphinx_rtd_theme' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.
WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org)
./include/linux/rcupdate.h:884: warning: Excess function parameter 'ptr' description in 'kfree_rcu'
./include/linux/rcupdate.h:884: warning: Excess function parameter 'rhf' description in 'kfree_rcu
---
 kernel/trace/blktrace.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
index 0c8690d9f6cd..ca6f0ceba09b 100644
--- a/kernel/trace/blktrace.c
+++ b/kernel/trace/blktrace.c
@@ -1865,7 +1865,7 @@ void blk_trace_remove_sysfs(struct device *dev)
 
 /**
  * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
- * @rwbs	buffer to be filled
+ * @rwbs:	buffer to be filled
  * @op:		REQ_OP_XXX for the tracepoint
  *
  * Description:
-- 
2.22.1




[Index of Archives]     [Linux RAID]     [Linux SCSI]     [Linux ATA RAID]     [IDE]     [Linux Wireless]     [Linux Kernel]     [ATH6KL]     [Linux Bluetooth]     [Linux Netdev]     [Kernel Newbies]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Device Mapper]

  Powered by Linux