Skip to contentSkip to conversation

blk-ioprio: fix stale prio_policy kernel-doc

PATCH New Guopeng Zhang 1 participant 1 message Jul 7 Block layer

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 blk-ioprio: fix stale prio_policy kernel-doc

From: Guopeng Zhang <[email protected]>

Fix two stale kernel-doc entries in blk-ioprio. The POLICY_PROMOTE_TO_RT comment should describe promotion from non-IOPRIO_CLASS_RT classes, and @prio_policy stores enum prio_policy values rather than IOPRIO_CLASS_* values.

---
 block/blk-ioprio.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
block/blk-ioprio.c +3 -2
index 8fa8bca35062..a94c50233d90 100644
@@ -23,7 +23,8 @@
 /**
  * enum prio_policy - I/O priority class policy.
  * @POLICY_NO_CHANGE: (default) do not modify the I/O priority class.
- * @POLICY_PROMOTE_TO_RT: modify no-IOPRIO_CLASS_RT to IOPRIO_CLASS_RT.
+ * @POLICY_PROMOTE_TO_RT: promote non-IOPRIO_CLASS_RT classes to
+ *		IOPRIO_CLASS_RT.
  * @POLICY_RESTRICT_TO_BE: modify IOPRIO_CLASS_NONE and IOPRIO_CLASS_RT into
  *		IOPRIO_CLASS_BE.
  * @POLICY_ALL_TO_IDLE: change the I/O priority class into IOPRIO_CLASS_IDLE.
@@ -52,7 +53,7 @@ static struct blkcg_policy ioprio_policy;
 /**
  * struct ioprio_blkcg - Per cgroup data.
  * @cpd: blkcg_policy_data structure.
- * @prio_policy: One of the IOPRIO_CLASS_* values. See also <linux/ioprio.h>.
+ * @prio_policy: One of the POLICY_* values defined by enum prio_policy.
  */
 struct ioprio_blkcg {
 	struct blkcg_policy_data cpd;
Signature · 1 line
2.43.0