From: Jakub Kicinski <kuba@kernel.org>
To: corbet@lwn.net
Cc: clm@fb.com, hannes@cmpxchg.org, tj@kernel.org,
lizefan@huawei.com, linux-doc@vger.kernel.org,
Jakub Kicinski <kuba@kernel.org>
Subject: [PATCH doc 5/5] doc: cgroup: improve formatting of references
Date: Thu, 27 Feb 2020 16:06:53 -0800 [thread overview]
Message-ID: <20200228000653.1572553-6-kuba@kernel.org> (raw)
In-Reply-To: <20200228000653.1572553-1-kuba@kernel.org>
Annotate references to other documents to make them clickable.
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
---
Documentation/accounting/psi.rst | 2 ++
Documentation/admin-guide/cgroup-v1/index.rst | 2 ++
Documentation/admin-guide/cgroup-v2.rst | 8 ++++----
3 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/accounting/psi.rst b/Documentation/accounting/psi.rst
index 621111ce5740..f2b3439edcc2 100644
--- a/Documentation/accounting/psi.rst
+++ b/Documentation/accounting/psi.rst
@@ -1,3 +1,5 @@
+.. _psi:
+
================================
PSI - Pressure Stall Information
================================
diff --git a/Documentation/admin-guide/cgroup-v1/index.rst b/Documentation/admin-guide/cgroup-v1/index.rst
index 10bf48bae0b0..226f64473e8e 100644
--- a/Documentation/admin-guide/cgroup-v1/index.rst
+++ b/Documentation/admin-guide/cgroup-v1/index.rst
@@ -1,3 +1,5 @@
+.. _cgroup-v1:
+
========================
Control Groups version 1
========================
diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 308d096af071..fbb111616705 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -9,7 +9,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 Documentation/admin-guide/cgroup-v1/.
+v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgroup-v1>`.
.. CONTENTS
@@ -1023,7 +1023,7 @@ All time durations are in microseconds.
A read-only nested-key file which exists on non-root cgroups.
Shows pressure stall information for CPU. See
- Documentation/accounting/psi.rst for details.
+ :ref:`Documentation/accounting/psi.rst <psi>` for details.
cpu.uclamp.min
A read-write single value file which exists on non-root cgroups.
@@ -1391,7 +1391,7 @@ PAGE_SIZE multiple when read back.
A read-only nested-key file which exists on non-root cgroups.
Shows pressure stall information for memory. See
- Documentation/accounting/psi.rst for details.
+ :ref:`Documentation/accounting/psi.rst <psi>` for details.
Usage Guidelines
@@ -1631,7 +1631,7 @@ IO Interface Files
A read-only nested-key file which exists on non-root cgroups.
Shows pressure stall information for IO. See
- Documentation/accounting/psi.rst for details.
+ :ref:`Documentation/accounting/psi.rst <psi>` for details.
Writeback
--
2.24.1
next prev parent reply other threads:[~2020-02-28 0:07 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-28 0:06 [PATCH doc 0/5] doc: cgroup: improve formatting Jakub Kicinski
2020-02-28 0:06 ` [PATCH doc 1/5] " Jakub Kicinski
2020-02-28 0:06 ` [PATCH doc 2/5] doc: cgroup: improve formatting of mem stats Jakub Kicinski
2020-02-28 0:06 ` [PATCH doc 3/5] doc: cgroup: improve formatting of io example Jakub Kicinski
2020-02-28 0:06 ` [PATCH doc 4/5] doc: cgroup: improve formatting of cpuset examples Jakub Kicinski
2020-02-28 0:06 ` Jakub Kicinski [this message]
2020-03-02 19:57 ` [PATCH doc 0/5] doc: cgroup: improve formatting Jonathan Corbet
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=20200228000653.1572553-6-kuba@kernel.org \
--to=kuba@kernel.org \
--cc=clm@fb.com \
--cc=corbet@lwn.net \
--cc=hannes@cmpxchg.org \
--cc=linux-doc@vger.kernel.org \
--cc=lizefan@huawei.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).