Skip to content

blk-mq-dma: kernel-doc fixes - #112

Open
blktests-ci-block-trial[bot] wants to merge 2 commits into
master_basefrom
series/636=>master
Open

blk-mq-dma: kernel-doc fixes#112
blktests-ci-block-trial[bot] wants to merge 2 commits into
master_basefrom
series/636=>master

Conversation

@blktests-ci-block-trial

Copy link
Copy Markdown

Pull request for series with
subject: blk-mq-dma: kernel-doc fixes
version: 1
url: http://redsun45:8000/project/linux-block/list/?series=636

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 8d3ae59
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: ff68e5f
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 0f23d56
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 1200d84
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 3a0dd7b
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: b126f6f
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: bd5f485
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 59e6295
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 98f21c5
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: cb8a75e
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: a4ff2be
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 9d2ed02
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: c84d3e3
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 77ae27f
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

1 similar comment
@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 77ae27f
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 7f063b2
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 818bebe
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

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: fec9b16 ("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>
Reviewed-by: Christoph Hellwig <hch@lst.de>
blk_rq_dma_map_iter_start() and blk_rq_dma_map_iter_next() both
document their return value as "%true ft it did map a segment", where
"ft" should read "if".  The two integrity variants further down spell
it correctly.

No functional change.

Fixes: 858299d ("block: add scatterlist-less DMA mapping helpers")
Assisted-by: Claude:claude-opus-5
Signed-off-by: Bryan Boquel <boquelbryan6@gmail.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
@blktests-ci-block-trial

Copy link
Copy Markdown
Author

Upstream branch: 531ed94
series: http://redsun45:8000/project/linux-block/list/?series=636
version: 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant