linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux cgroups <cgroups@vger.kernel.org>
Cc: "Jonathan Corbet" <corbet@lwn.net>, "Tejun Heo" <tj@kernel.org>,
	"Johannes Weiner" <hannes@cmpxchg.org>,
	"Michal Koutný" <mkoutny@suse.com>,
	"Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Andrea Righi" <arighi@nvidia.com>,
	"Johannes Bechberger" <me@mostlynerdless.de>,
	"Changwoo Min" <changwoo@igalia.com>,
	"Shashank Balaji" <shashank.mahadasyam@sony.com>,
	"Ingo Molnar" <mingo@kernel.org>, "Jake Rice" <jake@jakerice.dev>,
	"Cengiz Can" <cengiz@kernel.wtf>
Subject: [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive
Date: Wed, 10 Sep 2025 14:23:34 +0700	[thread overview]
Message-ID: <20250910072334.30688-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250910072334.30688-1-bagasdotme@gmail.com>

cgroup v2 docs is a lengthy single docs as compared to cgroup v1 which
is split into several files. While new sections are continously added,
manually-arranged table of contents (as reST comments) gets out-of-sync
with actual toctree as not all of these are added to it.

Replace it with automatically-generated table of contents via contents::
directive.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/cgroup-v2.rst | 79 +------------------------
 1 file changed, 1 insertion(+), 78 deletions(-)

diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 83bb69e3ab12a4..2bf24aa6c08ebe 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -13,84 +13,7 @@ of cgroup including core and specific controller behaviors.  All
 future changes must be reflected in this document.  Documentation for
 v1 is available under Documentation/admin-guide/cgroup-v1/index.rst.
 
-.. CONTENTS
-
-   1. Introduction
-     1-1. Terminology
-     1-2. What is cgroup?
-   2. Basic Operations
-     2-1. Mounting
-     2-2. Organizing Processes and Threads
-       2-2-1. Processes
-       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-5. Delegation
-       2-5-1. Model of Delegation
-       2-5-2. Delegation Containment
-     2-6. Guidelines
-       2-6-1. Organize Once and Control
-       2-6-2. Avoid Name Collisions
-   3. Resource Distribution Models
-     3-1. Weights
-     3-2. Limits
-     3-3. Protections
-     3-4. Allocations
-   4. Interface Files
-     4-1. Format
-     4-2. Conventions
-     4-3. Core Interface Files
-   5. Controllers
-     5-1. CPU
-       5-1-1. CPU Interface Files
-     5-2. Memory
-       5-2-1. Memory Interface Files
-       5-2-2. Usage Guidelines
-       5-2-3. Memory Ownership
-     5-3. IO
-       5-3-1. IO Interface Files
-       5-3-2. Writeback
-       5-3-3. IO Latency
-         5-3-3-1. How IO Latency Throttling Works
-         5-3-3-2. IO Latency Interface Files
-       5-3-4. IO Priority
-     5-4. PID
-       5-4-1. PID Interface Files
-     5-5. Cpuset
-       5.5-1. Cpuset Interface Files
-     5-6. Device
-     5-7. RDMA
-       5-7-1. RDMA Interface Files
-     5-8. DMEM
-     5-9. HugeTLB
-       5.9-1. HugeTLB Interface Files
-     5-10. Misc
-       5.10-1 Miscellaneous cgroup Interface Files
-       5.10-2 Migration and Ownership
-     5-11. Others
-       5-11-1. perf_event
-     5-N. Non-normative information
-       5-N-1. CPU controller root cgroup process behaviour
-       5-N-2. IO controller root cgroup process behaviour
-   6. Namespace
-     6-1. Basics
-     6-2. The Root and Views
-     6-3. Migration and setns(2)
-     6-4. Interaction with Other Namespaces
-   P. Information on Kernel Programming
-     P-1. Filesystem Support for Writeback
-   D. Deprecated v1 Core Features
-   R. Issues with v1 and Rationales for v2
-     R-1. Multiple Hierarchies
-     R-2. Thread Granularity
-     R-3. Competition Between Inner Nodes and Threads
-     R-4. Other Interface Issues
-     R-5. Controller Issues and Remedies
-       R-5-1. Memory
-
+.. contents::
 
 Introduction
 ============
-- 
An old man doll... just what I always wanted! - Clara


  parent reply	other threads:[~2025-09-10  7:31 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-10  7:23 [PATCH 0/2] cgroup v2 docs update Bagas Sanjaya
2025-09-10  7:23 ` [PATCH 1/2] Documentation: cgroup-v2: Use document path for cross-references Bagas Sanjaya
2025-09-10  7:23 ` Bagas Sanjaya [this message]
2025-09-10  8:13   ` [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive Michal Koutný
2025-09-10 11:11     ` Bagas Sanjaya
2025-09-10 13:24     ` Jonathan Corbet
2025-09-10 13:50       ` Mauro Carvalho Chehab
2025-09-10 14:27         ` Jonathan Corbet
2025-09-10 16:44       ` Tejun Heo
2025-09-10 23:27         ` Bagas Sanjaya
2025-09-10 23:34       ` Bagas Sanjaya
2025-09-10 14:37   ` Michal Koutný

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250910072334.30688-3-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=arighi@nvidia.com \
    --cc=cengiz@kernel.wtf \
    --cc=cgroups@vger.kernel.org \
    --cc=changwoo@igalia.com \
    --cc=corbet@lwn.net \
    --cc=hannes@cmpxchg.org \
    --cc=jake@jakerice.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=me@mostlynerdless.de \
    --cc=mingo@kernel.org \
    --cc=mkoutny@suse.com \
    --cc=shashank.mahadasyam@sony.com \
    --cc=tj@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).