Skip to content

Commit c1081a7

Browse files
Tang YizhouJonathan Corbet
authored andcommitted
doc: blk-ioprio: Bring the doc in line with the implementation
Our system administrator have noted that the names 'rt-to-be' and 'all-to-idle' in the I/O priority policies table appeared without explanations, leading to confusion. Let's bring these names in line with the naming in the 'attribute' section. Additionally, 1. Correct the interface name to 'io.prio.class'. 2. Add a table entry of 'promote-to-rt' for consistency. 3. Fix a typo of 'priority'. Suggested-by: Yingfu Zhou <yingfu.zhou@shopee.com> Reviewed-by: Hou Tao <houtao1@huawei.com> Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com> Reviewed-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231012024228.2161283-1-yizhou.tang@shopee.com
1 parent 16794ed commit c1081a7

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

Documentation/admin-guide/cgroup-v2.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2023,7 +2023,7 @@ IO Priority
20232023
~~~~~~~~~~~
20242024

20252025
A single attribute controls the behavior of the I/O priority cgroup policy,
2026-
namely the blkio.prio.class attribute. The following values are accepted for
2026+
namely the io.prio.class attribute. The following values are accepted for
20272027
that attribute:
20282028

20292029
no-change
@@ -2052,9 +2052,11 @@ The following numerical values are associated with the I/O priority policies:
20522052
+----------------+---+
20532053
| no-change | 0 |
20542054
+----------------+---+
2055-
| rt-to-be | 2 |
2055+
| promote-to-rt | 1 |
20562056
+----------------+---+
2057-
| all-to-idle | 3 |
2057+
| restrict-to-be | 2 |
2058+
+----------------+---+
2059+
| idle | 3 |
20582060
+----------------+---+
20592061

20602062
The numerical value that corresponds to each I/O priority class is as follows:
@@ -2074,7 +2076,7 @@ The algorithm to set the I/O priority class for a request is as follows:
20742076
- If I/O priority class policy is promote-to-rt, change the request I/O
20752077
priority class to IOPRIO_CLASS_RT and change the request I/O priority
20762078
level to 4.
2077-
- If I/O priorityt class is not promote-to-rt, translate the I/O priority
2079+
- If I/O priority class policy is not promote-to-rt, translate the I/O priority
20782080
class policy into a number, then change the request I/O priority class
20792081
into the maximum of the I/O priority class policy number and the numerical
20802082
I/O priority class.

0 commit comments

Comments
 (0)