doc: cgroup: improve formatting of references
authorJakub Kicinski <kuba@kernel.org>
Fri, 28 Feb 2020 00:06:53 +0000 (16:06 -0800)
committerJonathan Corbet <corbet@lwn.net>
Mon, 2 Mar 2020 19:57:03 +0000 (12:57 -0700)
Annotate references to other documents to make them clickable.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-6-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/accounting/psi.rst
Documentation/admin-guide/cgroup-v1/index.rst
Documentation/admin-guide/cgroup-v2.rst

index 621111ce5740142786eef7f3f8177b58708cabb3..f2b3439edcc2cc772c7f92cd3510060df6b5e8b8 100644 (file)
@@ -1,3 +1,5 @@
+.. _psi:
+
 ================================
 PSI - Pressure Stall Information
 ================================
index 10bf48bae0b045d54d9d3d5cc9ab4399a7b391f6..226f64473e8e215cdb29d36214a0665db1c8e738 100644 (file)
@@ -1,3 +1,5 @@
+.. _cgroup-v1:
+
 ========================
 Control Groups version 1
 ========================
index 308d096af0710500464c700ce12e9bf66aca3e37..fbb11161670543159d114bb359af8de42df6ece2 100644 (file)
@@ -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