From nobody Thu Oct 2 10:58:00 2025 Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4BBBE2E5B04 for ; Thu, 18 Sep 2025 07:41:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758181283; cv=none; b=I82/gcDYlAbIbfjgBg37mwTNCMrFGlnpobAGalyo40aSTC7p0ia+YqDFD5p5Ucj8Vz8LkH2AAu8SM4aejxixG6xoW18kCgF+laSv2ONLmLItjQSS74BiJRoZlwDkzjup9jVkvIEuKBShJF1+iyVVxT6aRo89scKHXVg0cLbSWDI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758181283; c=relaxed/simple; bh=CYo+ThRi9YLTkaPWPwEFZLSRw7Sr+EbigfCEpDbe8Ew=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=O9A8QS4KvQOS2FiliA+eOTQgozuYVHzKmQeBru32FYiEqWVTAmLmUyz9vAHK42d9uA/MBAJyrgMBtIEbNxlC7cwFN7zzXwag5cJoxFg2oqq9jTUz/WvAhxCWZpLsrejf33J+58jXsS9BJe+Mx9OfWGnYJ9sObZTbBh4ptuMSx2U= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=KBgds0F/; arc=none smtp.client-ip=209.85.214.174 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="KBgds0F/" Received: by mail-pl1-f174.google.com with SMTP id d9443c01a7336-24c8ef94e5dso5480835ad.1 for ; Thu, 18 Sep 2025 00:41:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758181280; x=1758786080; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=LP3Bd0aP9DzURHwOKIT419E9RC6+Q/KgVNOlgFr+0G0=; b=KBgds0F/cXRkx3KY4iMVJ4mymdq9NXiNlPyR3kUw0LWPPr2nj70JIaVQlZHbS/o+9X Yj8UJ6nKWKZuBYTODwMZrd9/QSqA6NuDeoWmMJzkT02tTz+FCgTZ8VNgevZYDU56PSTX CCAsfhk70LrSGe9Nic5GuBbqlJa/urQtWtaavSrP3aM+2uFp82CxMWEptI7D1EITR5nL 9lLJ+2m5YAZzX46LBn4IFpLEW5NS6A1f3lg4g6QRdoZdXu51lBjxAAVHiSilNFLLx+JP EA3q7Tt6Ira+F0kn6s/6aoxqUse/PHGWQN0edLs8VfWdFcdJyBmaqb0fJX7RqReRFbq5 imfg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758181280; x=1758786080; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=LP3Bd0aP9DzURHwOKIT419E9RC6+Q/KgVNOlgFr+0G0=; b=vVwOvNv7YYChbSXB66OsfIyBv601LAT4kK/3dXNsI0bMWi4NFHSVsup6t6rPDTiWLa frrblEr8XtfocejFXqpsl5tThtAF7ARIBNHvOQvhNAHBzjRj2pyjZzPf0WBqP2Xv/EcD XwZ52wx4Lbhal+zVuYoEim4SKucF15YjyofdBiXFbTvlZzxCWiw2i/HKC9VWV3xdp1nV d8L+3513d4LGG2qFRYocnZmI6PqMRGtID67b3Z8WLwVelF7Tr39vtQLXxSKByJTKokPz zWlfEo8eG9x9Aj2WlixdLm5jCdz2zvwNzJrNowfAMh2W1JzIJINOtiPTpYDnJiRAhF/Z x6RA== X-Gm-Message-State: AOJu0YxD1mOx4Ky0JVrBbq4MYIM/pMnXxuZ51m6Iul3cf2TdhGplWIH9 O8b9qxsJxgWlbhqJnWgqbV3nvec6IUQDr7Z0Jmqyal2qZd8oB9n7QrYR X-Gm-Gg: ASbGncv/1mt6o8Zp8eHCKH81S1ekGMa5hQ5CGykjaszMci10dfoElT0OjOCo3Ic8N/l ONjAVxzrxGAlkOoXQInZwHDKYODSEECvOkULkSF9A3f0A0kEo5TJudZY/rcIKT4kNN56ia1+1ie OWLntzJcCXAeO9LLhm0VR22tCrck2eu8fmXt4Ji6tRtqcoif1tXTZjAhRIY/lsMA51vHED8w3pA MIduLr+kd90YhsT+PADcT3kR3Rd8iGU1FvBjjbjOJY91ms12BQbMNFM6NjBUbowkM4a8bS0q5nn Nujm9QiQgsCl5TfovSdAlslAo/V42O6tNfls+dQzqdGKp+FFROrgFsqrykD14VGEVP0+niR61Ww +/rFHENk1+cXoZBrkAbo4+SckwuNidmA/IM8dr+kN X-Google-Smtp-Source: AGHT+IGi3Ysot5IFecJ/wpDgRLZt6n6fWBTeX763QBB3HvcW2dLPStQT8hc/gLqLnajn/K5Fb/M7rg== X-Received: by 2002:a17:902:e5d2:b0:24c:ba8e:c5bc with SMTP id d9443c01a7336-2697c8166b3mr34846665ad.8.1758181280234; Thu, 18 Sep 2025 00:41:20 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-26980053e77sm17158665ad.7.2025.09.18.00.41.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Sep 2025 00:41:19 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 037A34207D19; Thu, 18 Sep 2025 14:41:15 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux cgroups Cc: Tejun Heo , Johannes Weiner , =?UTF-8?q?Michal=20Koutn=C3=BD?= , Jonathan Corbet , Bagas Sanjaya Subject: [PATCH v3] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive Date: Thu, 18 Sep 2025 14:40:49 +0700 Message-ID: <20250918074048.18563-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=3815; i=bagasdotme@gmail.com; h=from:subject; bh=CYo+ThRi9YLTkaPWPwEFZLSRw7Sr+EbigfCEpDbe8Ew=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmnt72vtGax8Xuy9de5ENNTaU3hhg/u7T53WMnw7EURz 7sy613PdZSyMIhxMciKKbJMSuRrOr3LSORC+1pHmDmsTCBDGLg4BWAiM2oZ/ooxfNj0NX7yjUtb TDgVdjMZtT9Tu6AWdMa1XXr701nmslGMDFPu/Fzx5U3ahCNvlh3MOce3J2uGZlq8qhXvO6ZjNwu 3iTMDAA== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" cgroup v2 docs is a lengthy single docs, as compared to cgroup v1 which is split into several reST files. Meanwhile, its manually-arranged table of contents can get (and indeed) out-of-sync with actual contents when new sections forget to be added to it. Replace it with automatically-generated table of contents via contents:: directive. Signed-off-by: Bagas Sanjaya --- Changes since v2 [1]: * Revert back to v1 approach [2] (Michal) [1]: https://lore.kernel.org/lkml/20250915081942.25077-1-bagasdotme@gmail.c= om/ [2]: https://lore.kernel.org/lkml/20250910072334.30688-3-bagasdotme@gmail.c= om/ 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 a1e3d431974c20..fdd3ee6cfe87a4 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 behavio= rs. All future changes must be reflected in this document. Documentation for v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst = `. =20 -.. 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:: =20 Introduction =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D base-commit: 1f783f733450f72725c0040a2b3075614fa0fb5c --=20 An old man doll... just what I always wanted! - Clara