[PATCH] block: blk-mq.c: fix @at_head kernel-doc warning

[PATCH] block: blk-mq.c: fix @at_head kernel-doc warning

[Randy Dunlap]

Fix a new kernel-doc warning in block/blk-mq.c:

../block/blk-mq.c:1844: warning: Function parameter or member 'at_head' not described in 'blk_mq_request_bypass_insert'

Fixes: 105663f73e71 ("blk-mq: Document functions for sending request")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: André Almeida <andrealmeid@collabora.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
---
 block/blk-mq.c |    1 +
 1 file changed, 1 insertion(+)

--- lnx-59-rc1.orig/block/blk-mq.c
+++ lnx-59-rc1/block/blk-mq.c
@@ -1834,6 +1834,7 @@ void __blk_mq_insert_request(struct blk_
 /**
  * blk_mq_request_bypass_insert - Insert a request at dispatch list.
  * @rq: Pointer to request to be inserted.
+ * @at_head: true if the request should be inserted at the head of the list.
  * @run_queue: If we should run the hardware queue after inserting the request.
  *
  * Should only be used carefully, when the caller knows we want to

Re: [PATCH] block: blk-mq.c: fix @at_head kernel-doc warning

[Jens Axboe]

On 8/16/20 3:25 PM, Randy Dunlap wrote:
> Fix a new kernel-doc warning in block/blk-mq.c:
> 
> ../block/blk-mq.c:1844: warning: Function parameter or member 'at_head' not described in 'blk_mq_request_bypass_insert'

Applied, thanks.

-- 
Jens Axboe

Re: [PATCH] block: blk-mq.c: fix @at_head kernel-doc warning

[André Almeida]

Hi Randy,

On 8/16/20 7:25 PM, Randy Dunlap wrote:
> Fix a new kernel-doc warning in block/blk-mq.c:
> 
> ../block/blk-mq.c:1844: warning: Function parameter or member 'at_head' not described in 'blk_mq_request_bypass_insert'
> 
> Fixes: 105663f73e71 ("blk-mq: Document functions for sending request")

By the time commit 105663f73e71 ("blk-mq: Document functions for sending
request") was merged, the parameter @at_head didn't exist[1].

The commit that inserted this warning is 01e99aeca397 ("blk-mq: insert
passthrough request into hctx->dispatch directly"), that added @at_head
without updating the documentation.

Thanks,
	André

[1]
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/block/blk-mq.c?id=105663f73e71b5e79ecf472c0499c9acde654b28#n1673

Re: [PATCH] block: blk-mq.c: fix @at_head kernel-doc warning

[Randy Dunlap]

On 8/16/20 3:50 PM, André Almeida wrote:
> Hi Randy,
> 
> On 8/16/20 7:25 PM, Randy Dunlap wrote:
>> Fix a new kernel-doc warning in block/blk-mq.c:
>>
>> ../block/blk-mq.c:1844: warning: Function parameter or member 'at_head' not described in 'blk_mq_request_bypass_insert'
>>
>> Fixes: 105663f73e71 ("blk-mq: Document functions for sending request")
> 
> By the time commit 105663f73e71 ("blk-mq: Document functions for sending
> request") was merged, the parameter @at_head didn't exist[1].
> 
> The commit that inserted this warning is 01e99aeca397 ("blk-mq: insert
> passthrough request into hctx->dispatch directly"), that added @at_head
> without updating the documentation.
> 
> Thanks,
> 	André

Hi André,

Sorry, I'll correct that.

thanks.

> [1]
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/block/blk-mq.c?id=105663f73e71b5e79ecf472c0499c9acde654b28#n1673


-- 
~Randy