linux-kernel - [PATCH -next] block: Add parameter description in kernel-doc comment

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20220316125327.126996-1-yang.lee@linux.alibaba.com>
Date:   Wed, 16 Mar 2022 20:53:27 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     paolo.valente@...aro.org
Cc:     tj@...nel.org, axboe@...nel.dk, cgroups@...r.kernel.org,
        linux-block@...r.kernel.org, linux-kernel@...r.kernel.org,
        Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: [PATCH -next] block: Add parameter description in kernel-doc comment

Add the description of @ioprio_class in bfq_reparent_leaf_entity()
and bfq_reparent_active_queues() kernel-doc comment to remove
warning found by running scripts/kernel-doc, which is caused by
using 'make W=1'.

block/bfq-cgroup.c:848: warning: Function parameter or member
'ioprio_class' not described in 'bfq_reparent_leaf_entity'
block/bfq-cgroup.c:878: warning: Function parameter or member
'ioprio_class' not described in 'bfq_reparent_active_queues'

Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 block/bfq-cgroup.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/block/bfq-cgroup.c b/block/bfq-cgroup.c
index 420eda2589c0..af92c2e5fd98 100644
--- a/block/bfq-cgroup.c
+++ b/block/bfq-cgroup.c
@@ -841,6 +841,7 @@ static void bfq_flush_idle_tree(struct bfq_service_tree *st)
  * @bfqd: the device data structure with the root group.
  * @entity: the entity to move, if entity is a leaf; or the parent entity
  *	    of an active leaf entity to move, if entity is not a leaf.
+ * @ioprio_class: the offset used to manipulate the service_tree
  */
 static void bfq_reparent_leaf_entity(struct bfq_data *bfqd,
 				     struct bfq_entity *entity,
@@ -870,6 +871,7 @@ static void bfq_reparent_leaf_entity(struct bfq_data *bfqd,
  * @bfqd: the device data structure with the root group.
  * @bfqg: the group to move from.
  * @st: the service tree to start the search from.
+ * @ioprio_class: the offset used to manipulate the service_tree
  */
 static void bfq_reparent_active_queues(struct bfq_data *bfqd,
 				       struct bfq_group *bfqg,
-- 
2.20.1.7.g153144c