| Message ID | 20211222211532.24060-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [-next] bio.h: fix kernel-doc warnings | expand |
On Wed, 22 Dec 2021 13:15:32 -0800, Randy Dunlap wrote: > Fix all kernel-doc warnings in <linux/bio.h>: > > include/linux/bio.h:136: warning: Function parameter or member 'nbytes' not described in 'bio_advance' > include/linux/bio.h:136: warning: Excess function parameter 'bytes' description in 'bio_advance' > include/linux/bio.h:391: warning: No description found for return value of 'bio_next_split' > > > [...] Applied, thanks! [1/1] bio.h: fix kernel-doc warnings commit: 6fd3c510ee4b37f2f9fe3d3cafbfa459e15c5e11 Best regards,
--- linux-next-20211222.orig/include/linux/bio.h +++ linux-next-20211222/include/linux/bio.h @@ -124,7 +124,7 @@ void __bio_advance(struct bio *, unsigne /** * bio_advance - increment/complete a bio by some number of bytes * @bio: bio to advance - * @bytes: number of bytes to complete + * @nbytes: number of bytes to complete * * This updates bi_sector, bi_size and bi_idx; if the number of bytes to * complete doesn't align with a bvec boundary, then bv_len and bv_offset will @@ -383,7 +383,7 @@ extern struct bio *bio_split(struct bio * @gfp: gfp mask * @bs: bio set to allocate from * - * Returns a bio representing the next @sectors of @bio - if the bio is smaller + * Return: a bio representing the next @sectors of @bio - if the bio is smaller * than @sectors, returns the original bio unchanged. */ static inline struct bio *bio_next_split(struct bio *bio, int sectors,
Fix all kernel-doc warnings in <linux/bio.h>: include/linux/bio.h:136: warning: Function parameter or member 'nbytes' not described in 'bio_advance' include/linux/bio.h:136: warning: Excess function parameter 'bytes' description in 'bio_advance' include/linux/bio.h:391: warning: No description found for return value of 'bio_next_split' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Kent Overstreet <kent.overstreet@gmail.com> Cc: Jens Axboe <axboe@kernel.dk> Cc: linux-block@vger.kernel.org --- include/linux/bio.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)