[PATCH 1/2] blk-mq-dma: fix kernel-doc for integrity DMA iterators

Bryan Boquel <[email protected]>
Newsgroups org.kernel.vger.linux-block,org.kernel.vger.linux-kernel
Message-ID <[email protected]>
blk_rq_integrity_dma_map_iter_next() documents a @state parameter it
has never had.  It takes (req, dma_dev, iter), as declared in
include/linux/blk-integrity.h, so scripts/kernel-doc reports an "Excess
function parameter 'state' description" warning at
block/blk-mq-dma.c:379.

The wrapped summary lines of both integrity helpers also indent with
tabs directly after "* ", which checkpatch flags as:

  block/blk-mq-dma.c:320: WARNING: please, no space before tabs
  block/blk-mq-dma.c:361: WARNING: please, no space before tabs

Drop the stale parameter description and use spaces for the alignment;
the rendered output is unchanged.  No functional change.

Both issues were found by running scripts/kernel-doc and
scripts/checkpatch.pl over block/, and verified against the prototype
in include/linux/blk-integrity.h.

Fixes: fec9b16dc555 ("blk-mq-dma: add scatter-less integrity data DMA mapping")
Assisted-by: Claude:claude-opus-5 kernel-doc checkpatch
Signed-off-by: Bryan Boquel <[email protected]>
---
 block/blk-mq-dma.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/block/blk-mq-dma.c b/block/blk-mq-dma.c
index 88fd9cbc951..fca7ac01e73 100644
--- a/block/blk-mq-dma.c
+++ b/block/blk-mq-dma.c
@@ -317,7 +317,7 @@ EXPORT_SYMBOL(__blk_rq_map_sg);
 #ifdef CONFIG_BLK_DEV_INTEGRITY
 /**
  * blk_rq_integrity_dma_map_iter_start - map the first integrity DMA segment
- * 					 for a request
+ *                                       for a request
  * @req:	request to map
  * @dma_dev:	device to map to
  * @state:	DMA IOVA state
@@ -358,10 +358,9 @@ EXPORT_SYMBOL_GPL(blk_rq_integrity_dma_map_iter_start);
 
 /**
  * blk_rq_integrity_dma_map_iter_next - map the next integrity DMA segment for
- * 					 a request
+ *                                       a request
  * @req:	request to map
  * @dma_dev:	device to map to
- * @state:	DMA IOVA state
  * @iter:	block layer DMA iterator
  *
  * Iterate to the next integrity mapping after a previous call to
-- 
2.39.2 (Apple Git-143)
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.