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 1/2] Documentation: cgroup-v2: Use document path for cross-references
Date: Wed, 10 Sep 2025 14:23:33 +0700 [thread overview]
Message-ID: <20250910072334.30688-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250910072334.30688-1-bagasdotme@gmail.com>
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@gmail.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
next prev 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 ` Bagas Sanjaya [this message]
2025-09-10 7:23 ` [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive Bagas Sanjaya
2025-09-10 8:13 ` 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-2-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).