[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20250910072334.30688-2-bagasdotme@gmail.com>
Date: Wed, 10 Sep 2025 14:23:33 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
Linux Documentation <linux-doc@...r.kernel.org>,
Linux cgroups <cgroups@...r.kernel.org>
Cc: Jonathan Corbet <corbet@....net>,
Tejun Heo <tj@...nel.org>,
Johannes Weiner <hannes@...xchg.org>,
Michal Koutný <mkoutny@...e.com>,
Bagas Sanjaya <bagasdotme@...il.com>,
Andrea Righi <arighi@...dia.com>,
Johannes Bechberger <me@...tlynerdless.de>,
Changwoo Min <changwoo@...lia.com>,
Shashank Balaji <shashank.mahadasyam@...y.com>,
Ingo Molnar <mingo@...nel.org>,
Jake Rice <jake@...erice.dev>,
Cengiz Can <cengiz@...nel.wtf>
Subject: [PATCH 1/2] Documentation: cgroup-v2: Use document path for cross-references
Cross-references in cgroup v2 docs are written using :ref: directive
with full document path as anchor text. As there is a facility on
kernel docs that allows simply cross-references with target docs path,
replace the directive.
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
Documentation/accounting/psi.rst | 2 --
Documentation/admin-guide/cgroup-v1/index.rst | 2 --
Documentation/admin-guide/cgroup-v2.rst | 12 ++++++------
Documentation/scheduler/sched-ext.rst | 2 --
4 files changed, 6 insertions(+), 12 deletions(-)
diff --git a/Documentation/accounting/psi.rst b/Documentation/accounting/psi.rst
index d455db3e580838..460e11f988fa89 100644
--- a/Documentation/accounting/psi.rst
+++ b/Documentation/accounting/psi.rst
@@ -1,5 +1,3 @@
-.. _psi:
-
================================
PSI - Pressure Stall Information
================================
diff --git a/Documentation/admin-guide/cgroup-v1/index.rst b/Documentation/admin-guide/cgroup-v1/index.rst
index 99fbc8a64ba9e2..c0c6ac522569d4 100644
--- a/Documentation/admin-guide/cgroup-v1/index.rst
+++ b/Documentation/admin-guide/cgroup-v1/index.rst
@@ -1,5 +1,3 @@
-.. _cgroup-v1:
-
========================
Control Groups version 1
========================
diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index a1e3d431974c20..83bb69e3ab12a4 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -11,7 +11,7 @@ This is the authoritative documentation on the design, interface and
conventions of cgroup v2. It describes all userland-visible aspects
of cgroup including core and specific controller behaviors. All
future changes must be reflected in this document. Documentation for
-v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgroup-v1>`.
+v1 is available under Documentation/admin-guide/cgroup-v1/index.rst.
.. CONTENTS
@@ -1081,7 +1081,7 @@ All cgroup core files are prefixed with "cgroup."
A read-write nested-keyed file.
Shows pressure stall information for IRQ/SOFTIRQ. See
- :ref:`Documentation/accounting/psi.rst <psi>` for details.
+ Documentation/accounting/psi.rst for details.
Controllers
===========
@@ -1132,7 +1132,7 @@ processes can be categorized as follows:
without the ``cgroup_set_weight`` callback
For details on when a process is under the fair-class scheduler or a BPF scheduler,
-check out :ref:`Documentation/scheduler/sched-ext.rst <sched-ext>`.
+check out Documentation/scheduler/sched-ext.rst.
For each of the following interface files, the above categories
will be referred to. All time durations are in microseconds.
@@ -1213,7 +1213,7 @@ will be referred to. All time durations are in microseconds.
A read-write nested-keyed file.
Shows pressure stall information for CPU. See
- :ref:`Documentation/accounting/psi.rst <psi>` for details.
+ Documentation/accounting/psi.rst for details.
This file accounts for all the processes in the cgroup.
@@ -1903,7 +1903,7 @@ The following nested keys are defined.
A read-only nested-keyed file.
Shows pressure stall information for memory. See
- :ref:`Documentation/accounting/psi.rst <psi>` for details.
+ Documentation/accounting/psi.rst for details.
Usage Guidelines
@@ -2142,7 +2142,7 @@ IO Interface Files
A read-only nested-keyed file.
Shows pressure stall information for IO. See
- :ref:`Documentation/accounting/psi.rst <psi>` for details.
+ Documentation/accounting/psi.rst for details.
Writeback
diff --git a/Documentation/scheduler/sched-ext.rst b/Documentation/scheduler/sched-ext.rst
index 404fe6126a7694..1e614958dd96c3 100644
--- a/Documentation/scheduler/sched-ext.rst
+++ b/Documentation/scheduler/sched-ext.rst
@@ -1,5 +1,3 @@
-.. _sched-ext:
-
==========================
Extensible Scheduler Class
==========================
--
An old man doll... just what I always wanted! - Clara
Powered by blists - more mailing lists