[PATCH] sched_deadline, docs: fix cpuset example for cgroupv2

[PATCH] sched_deadline, docs: fix cpuset example for cgroupv2

[Matteo Martelli]

Documenation/scheduler/sched-deadline.rst provides two examples for how
to setup cgroup and cpuset for deadline tasks: one for cgroup v1 and one
cgroup v2. The code block in the latter is not properly html rendered as
the :: marker is missing.

Add the :: marker before the code block for the cgroup v2 example to fix
html rendering.

Also make the example description more explicit for better clarity.

Fixes: 0116765035eb ("sched_deadline, docs: add affinity setting with cgroup2 cpuset controller")
Signed-off-by: Matteo Martelli <matteo.martelli@codethink.co.uk>
---
 Documentation/scheduler/sched-deadline.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/scheduler/sched-deadline.rst b/Documentation/scheduler/sched-deadline.rst
index ec543a12f848..d23e4afe1a9a 100644
--- a/Documentation/scheduler/sched-deadline.rst
+++ b/Documentation/scheduler/sched-deadline.rst
@@ -700,7 +700,8 @@ Deadline Task Scheduling
 5.2 Using cgroup v2 cpuset controller
 -------------------------------------
 
- Assuming the cgroup v2 root is mounted at ``/sys/fs/cgroup``.
+ Assuming the cgroup v2 root is mounted at ``/sys/fs/cgroup``, an example of a
+ simple configuration (pin a -deadline task to CPU0) follows::
 
    cd /sys/fs/cgroup
    echo '+cpuset' > cgroup.subtree_control

---
base-commit: e1e828a1e9a79af76a7cdc271e0a506e496c2eaa
change-id: 20260223-docs-sched-deadline-fix-example-1d4806d2525e

Best regards,
-- 
Matteo Martelli <matteo.martelli@codethink.co.uk>

Re: [PATCH] sched_deadline, docs: fix cpuset example for cgroupv2

[Jonathan Corbet]

Matteo Martelli <matteo.martelli@codethink.co.uk> writes:

> Documenation/scheduler/sched-deadline.rst provides two examples for how
> to setup cgroup and cpuset for deadline tasks: one for cgroup v1 and one
> cgroup v2. The code block in the latter is not properly html rendered as
> the :: marker is missing.
>
> Add the :: marker before the code block for the cgroup v2 example to fix
> html rendering.
>
> Also make the example description more explicit for better clarity.
>
> Fixes: 0116765035eb ("sched_deadline, docs: add affinity setting with cgroup2 cpuset controller")
> Signed-off-by: Matteo Martelli <matteo.martelli@codethink.co.uk>
> ---
>  Documentation/scheduler/sched-deadline.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/scheduler/sched-deadline.rst b/Documentation/scheduler/sched-deadline.rst
> index ec543a12f848..d23e4afe1a9a 100644
> --- a/Documentation/scheduler/sched-deadline.rst
> +++ b/Documentation/scheduler/sched-deadline.rst
> @@ -700,7 +700,8 @@ Deadline Task Scheduling
>  5.2 Using cgroup v2 cpuset controller
>  -------------------------------------
>  
> - Assuming the cgroup v2 root is mounted at ``/sys/fs/cgroup``.
> + Assuming the cgroup v2 root is mounted at ``/sys/fs/cgroup``, an example of a
> + simple configuration (pin a -deadline task to CPU0) follows::
>  
>     cd /sys/fs/cgroup
>     echo '+cpuset' > cgroup.subtree_control

Applied, thanks.

jon