From: Bryan Boquel <boquelbryan6@gmail.com>
To: axboe@kernel.dk
Cc: linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
Bryan Boquel <boquelbryan6@gmail.com>
Subject: [PATCH 1/2] blk-mq-dma: fix kernel-doc for integrity DMA iterators
Date: Sun, 16 Aug 2026 15:14:55 +0200 [thread overview]
Message-ID: <20260816131456.16374-2-boquelbryan6@gmail.com> (raw)
In-Reply-To: <20260816131456.16374-1-boquelbryan6@gmail.com>
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 <boquelbryan6@gmail.com>
---
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)
next prev parent reply other threads:[~2026-08-16 13:15 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-16 13:14 [PATCH 0/2] blk-mq-dma: kernel-doc fixes Bryan Boquel
2026-08-16 13:14 ` Bryan Boquel [this message]
2026-08-16 13:14 ` [PATCH 2/2] blk-mq-dma: fix typo in DMA iterator kernel-doc Bryan Boquel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260816131456.16374-2-boquelbryan6@gmail.com \
--to=boquelbryan6@gmail.com \
--cc=axboe@kernel.dk \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox