2022-01-04 03:28:45

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] bfq: Fix __bfq_lookup_next_entity() kernel-doc comment

Add the description of @in_service to remove warning found
by running scripts/kernel-doc, which is caused by
using 'make W=1'.
block/bfq-wf2q.c:1399: warning: Function parameter or member
'in_service' not described in '__bfq_lookup_next_entity'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
block/bfq-wf2q.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/block/bfq-wf2q.c b/block/bfq-wf2q.c
index b74cc0da118e..ab05e973342e 100644
--- a/block/bfq-wf2q.c
+++ b/block/bfq-wf2q.c
@@ -1375,6 +1375,7 @@ static struct bfq_entity *bfq_first_active_entity(struct bfq_service_tree *st,
/**
* __bfq_lookup_next_entity - return the first eligible entity in @st.
* @st: the service tree.
+ * @in_service: Check whether an in-service entity exists.
*
* If there is no in-service entity for the sched_data st belongs to,
* then return the entity that will be set in service if:
--
2.20.1.7.g153144c