[PATCH v4] Documentation: cgroup-v2: Sync manual toctree

[PATCH v4] Documentation: cgroup-v2: Sync manual toctree

[Bagas Sanjaya]

Manually-arranged toctree comment in cgroup v2 documentation is a rather
out-of-sync with actual contents: a few sections are missing and/or
named differently.

Sync the toctree.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Changes since v3 [1]:

  * Keep the manual toctree and sync it instead (the same approach in v2 [2])
    (Tejun)

[1]: https://lore.kernel.org/linux-doc/20250918074048.18563-2-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20250915081942.25077-5-bagasdotme@gmail.com/

 Documentation/admin-guide/cgroup-v2.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index a1e3d431974c20..0e6c67ac585a08 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -15,6 +15,9 @@ v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgrou
 
 .. CONTENTS
 
+   [Whenever any new section is added to this document, please also add
+    an entry here.]
+
    1. Introduction
      1-1. Terminology
      1-2. What is cgroup?
@@ -25,9 +28,10 @@ v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgrou
        2-2-2. Threads
      2-3. [Un]populated Notification
      2-4. Controlling Controllers
-       2-4-1. Enabling and Disabling
-       2-4-2. Top-down Constraint
-       2-4-3. No Internal Process Constraint
+       2-4-1. Availability
+       2-4-2. Enabling and Disabling
+       2-4-3. Top-down Constraint
+       2-4-4. No Internal Process Constraint
      2-5. Delegation
        2-5-1. Model of Delegation
        2-5-2. Delegation Containment
@@ -61,14 +65,15 @@ v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgrou
        5-4-1. PID Interface Files
      5-5. Cpuset
        5.5-1. Cpuset Interface Files
-     5-6. Device
+     5-6. Device controller
      5-7. RDMA
        5-7-1. RDMA Interface Files
      5-8. DMEM
+       5-8-1. DMEM Interface Files
      5-9. HugeTLB
        5.9-1. HugeTLB Interface Files
      5-10. Misc
-       5.10-1 Miscellaneous cgroup Interface Files
+       5.10-1 Misc Interface Files
        5.10-2 Migration and Ownership
      5-11. Others
        5-11-1. perf_event

base-commit: 1f783f733450f72725c0040a2b3075614fa0fb5c
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v4] Documentation: cgroup-v2: Sync manual toctree

[Michal Koutný]

[-- Attachment #1: Type: text/plain, Size: 829 bytes --]

On Fri, Sep 19, 2025 at 02:43:48PM +0700, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> Manually-arranged toctree comment in cgroup v2 documentation is a rather
> out-of-sync with actual contents: a few sections are missing and/or
> named differently.
> 
> Sync the toctree.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Changes since v3 [1]:
> 
>   * Keep the manual toctree and sync it instead (the same approach in v2 [2])
>     (Tejun)
> 
> [1]: https://lore.kernel.org/linux-doc/20250918074048.18563-2-bagasdotme@gmail.com/
> [2]: https://lore.kernel.org/linux-doc/20250915081942.25077-5-bagasdotme@gmail.com/
> 
>  Documentation/admin-guide/cgroup-v2.rst | 15 ++++++++++-----
>  1 file changed, 10 insertions(+), 5 deletions(-)

Acked-by: Michal Koutný <mkoutny@suse.com>

Thanks!

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 265 bytes --]

Re: [PATCH v4] Documentation: cgroup-v2: Sync manual toctree

[Tejun Heo]

On Fri, Sep 19, 2025 at 02:43:48PM +0700, Bagas Sanjaya wrote:
> Manually-arranged toctree comment in cgroup v2 documentation is a rather
> out-of-sync with actual contents: a few sections are missing and/or
> named differently.
> 
> Sync the toctree.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Applied to cgroup/for-6.18.

Thanks.

-- 
tejun