public inbox for cgroups@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH -next] blk-cgroup: Fix some kernel-doc comments
@ 2022-12-02  1:17 Yang Li
  2022-12-02  1:22 ` Jens Axboe
  2022-12-02  1:22 ` Jens Axboe
  0 siblings, 2 replies; 3+ messages in thread
From: Yang Li @ 2022-12-02  1:17 UTC (permalink / raw)
  To: tj; +Cc: josef, axboe, cgroups, linux-block, linux-kernel, Yang Li,
	Abaci Robot

Make the description of @gendisk to @disk in blkcg_schedule_throttle()
to clear the below warnings:

block/blk-cgroup.c:1850: warning: Function parameter or member 'disk' not described in 'blkcg_schedule_throttle'
block/blk-cgroup.c:1850: warning: Excess function parameter 'gendisk' description in 'blkcg_schedule_throttle'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3338
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 block/blk-cgroup.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/block/blk-cgroup.c b/block/blk-cgroup.c
index 1bb939d3b793..77f44472b41e 100644
--- a/block/blk-cgroup.c
+++ b/block/blk-cgroup.c
@@ -1831,7 +1831,7 @@ void blkcg_maybe_throttle_current(void)
 
 /**
  * blkcg_schedule_throttle - this task needs to check for throttling
- * @gendisk: disk to throttle
+ * @disk: disk to throttle
  * @use_memdelay: do we charge this to memory delay for PSI
  *
  * This is called by the IO controller when we know there's delay accumulated
-- 
2.20.1.7.g153144c


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH -next] blk-cgroup: Fix some kernel-doc comments
  2022-12-02  1:17 [PATCH -next] blk-cgroup: Fix some kernel-doc comments Yang Li
@ 2022-12-02  1:22 ` Jens Axboe
  2022-12-02  1:22 ` Jens Axboe
  1 sibling, 0 replies; 3+ messages in thread
From: Jens Axboe @ 2022-12-02  1:22 UTC (permalink / raw)
  To: Yang Li, tj; +Cc: josef, cgroups, linux-block, linux-kernel, Abaci Robot

On 12/1/22 6:17 PM, Yang Li wrote:
> Make the description of @gendisk to @disk in blkcg_schedule_throttle()
> to clear the below warnings:
> 
> block/blk-cgroup.c:1850: warning: Function parameter or member 'disk' not described in 'blkcg_schedule_throttle'
> block/blk-cgroup.c:1850: warning: Excess function parameter 'gendisk' description in 'blkcg_schedule_throttle'

Please always include a fixes line:

Fixes: de185b56e8a6 ("blk-cgroup: pass a gendisk to blkcg_schedule_throttle")

-- 
Jens Axboe



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH -next] blk-cgroup: Fix some kernel-doc comments
  2022-12-02  1:17 [PATCH -next] blk-cgroup: Fix some kernel-doc comments Yang Li
  2022-12-02  1:22 ` Jens Axboe
@ 2022-12-02  1:22 ` Jens Axboe
  1 sibling, 0 replies; 3+ messages in thread
From: Jens Axboe @ 2022-12-02  1:22 UTC (permalink / raw)
  To: tj, Yang Li; +Cc: josef, cgroups, linux-block, linux-kernel, Abaci Robot


On Fri, 02 Dec 2022 09:17:13 +0800, Yang Li wrote:
> Make the description of @gendisk to @disk in blkcg_schedule_throttle()
> to clear the below warnings:
> 
> block/blk-cgroup.c:1850: warning: Function parameter or member 'disk' not described in 'blkcg_schedule_throttle'
> block/blk-cgroup.c:1850: warning: Excess function parameter 'gendisk' description in 'blkcg_schedule_throttle'
> 
> 
> [...]

Applied, thanks!

[1/1] blk-cgroup: Fix some kernel-doc comments
      commit: 1d6df9d352bb2a3c2ddb32851dfcafb417c47762

Best regards,
-- 
Jens Axboe



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-12-02  1:22 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-12-02  1:17 [PATCH -next] blk-cgroup: Fix some kernel-doc comments Yang Li
2022-12-02  1:22 ` Jens Axboe
2022-12-02  1:22 ` Jens Axboe

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox