From: Bagas Sanjaya <bagasdotme@gmail.com>
To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Linux Memory Management List <linux-mm@kvack.org>
Cc: Tejun Heo <tj@kernel.org>, Zefan Li <lizefan.x@bytedance.com>,
Johannes Weiner <hannes@cmpxchg.org>,
Jonathan Corbet <corbet@lwn.net>, Michal Hocko <mhocko@suse.com>,
Andrew Morton <akpm@linux-foundation.org>,
Hugh Dickins <hughd@google.com>,
Shakeel Butt <shakeelb@google.com>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 05/10] docs: cgroup-v1: fix footnotes
Date: Mon, 19 Dec 2022 11:22:04 +0700 [thread overview]
Message-ID: <20221219042209.22898-6-bagasdotme@gmail.com> (raw)
In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com>
The documentation contains external references, which some of them are
marked as footnotes. Fix the syntax for them to be properly rendered as
such.
Non-footnote references aren't affected since the text for these is
aligned the same to the footnotes.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
.../admin-guide/cgroup-v1/memory.rst | 36 ++++++++++---------
1 file changed, 19 insertions(+), 17 deletions(-)
diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst
index c21ce0b906059f..642ef0bb20380a 100644
--- a/Documentation/admin-guide/cgroup-v1/memory.rst
+++ b/Documentation/admin-guide/cgroup-v1/memory.rst
@@ -23,7 +23,7 @@ Benefits and Purpose of the memory controller
=============================================
The memory controller isolates the memory behaviour of a group of tasks
-from the rest of the system. The article on LWN [12] mentions some probable
+from the rest of the system. The article on LWN [12]_ mentions some probable
uses of the memory controller. The memory controller can be used to
a. Isolate an application or a group of applications
@@ -109,16 +109,16 @@ Brief summary of control files.
==========
The memory controller has a long history. A request for comments for the memory
-controller was posted by Balbir Singh [1]. At the time the RFC was posted
+controller was posted by Balbir Singh [1]_. At the time the RFC was posted
there were several implementations for memory control. The goal of the
RFC was to build consensus and agreement for the minimal features required
-for memory control. The first RSS controller was posted by Balbir Singh[2]
-in Feb 2007. Pavel Emelianov [3][4][5] has since posted three versions of the
-RSS controller. At OLS, at the resource management BoF, everyone suggested
-that we handle both page cache and RSS together. Another request was raised
-to allow user space handling of OOM. The current memory controller is
+for memory control. The first RSS controller was posted by Balbir Singh [2]_
+in Feb 2007. Pavel Emelianov [3]_ [4]_ [5]_ has since posted three versions
+of the RSS controller. At OLS, at the resource management BoF, everyone
+suggested that we handle both page cache and RSS together. Another request was
+raised to allow user space handling of OOM. The current memory controller is
at version 6; it combines both mapped (RSS) and unmapped Page
-Cache Control [11].
+Cache Control [11]_.
2. Memory Control
=================
@@ -971,15 +971,16 @@ commented and discussed quite extensively in the community.
References
==========
-1. Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
-2. Singh, Balbir. Memory Controller (RSS Control),
+.. [1] Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
+.. [2] Singh, Balbir. Memory Controller (RSS Control),
http://lwn.net/Articles/222762/
-3. Emelianov, Pavel. Resource controllers based on process cgroups
+.. [3] Emelianov, Pavel. Resource controllers based on process cgroups
https://lore.kernel.org/r/45ED7DEC.7010403@sw.ru
-4. Emelianov, Pavel. RSS controller based on process cgroups (v2)
+.. [4] Emelianov, Pavel. RSS controller based on process cgroups (v2)
https://lore.kernel.org/r/461A3010.90403@sw.ru
-5. Emelianov, Pavel. RSS controller based on process cgroups (v3)
+.. [5] Emelianov, Pavel. RSS controller based on process cgroups (v3)
https://lore.kernel.org/r/465D9739.8070209@openvz.org
+
6. Menage, Paul. Control Groups v10, http://lwn.net/Articles/236032/
7. Vaidyanathan, Srinivasan, Control Groups: Pagecache accounting and control
subsystem (v3), http://lwn.net/Articles/235534/
@@ -989,7 +990,8 @@ References
https://lore.kernel.org/r/464D267A.50107@linux.vnet.ibm.com
10. Singh, Balbir. Memory controller v6 test results,
https://lore.kernel.org/r/20070819094658.654.84837.sendpatchset@balbir-laptop
-11. Singh, Balbir. Memory controller introduction (v6),
- https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop
-12. Corbet, Jonathan, Controlling memory use in cgroups,
- http://lwn.net/Articles/243795/
+
+.. [11] Singh, Balbir. Memory controller introduction (v6),
+ https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop
+.. [12] Corbet, Jonathan, Controlling memory use in cgroups,
+ http://lwn.net/Articles/243795/
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-12-19 4:22 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-19 4:21 [PATCH 00/10] docs: cgroup-v1: formatting improv for "Memory Resource Controller" doc Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 01/10] docs: cgroup-v1: extend underline of section 8 Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 02/10] docs: cgroup-v1: replace custom note constructs with appropriate admonition blocks Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 03/10] docs: cgroup-v1: wrap remaining admonitions in " Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 04/10] docs: cgroup-v1: use code block for locking order schema Bagas Sanjaya
2022-12-19 4:22 ` Bagas Sanjaya [this message]
2022-12-19 4:22 ` [PATCH 06/10] docs: cgroup-v1: move hierarchy of accounting caption Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 07/10] docs: cgroup-v1: use bullet lists for list of stat file tables Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 08/10] docs: cgroup-v1: use make swap extension subsections subsections Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 09/10] docs: cgroup-v1: add internal cross-references Bagas Sanjaya
2022-12-19 4:22 ` [PATCH 10/10] docs: cgroup-v1: use numbered lists for user interface setup Bagas Sanjaya
2023-01-02 23:35 ` [PATCH 00/10] docs: cgroup-v1: formatting improv for "Memory Resource Controller" doc Jonathan Corbet
2023-01-04 16:53 ` Tejun Heo
2023-01-04 21:27 ` Tejun Heo
2023-01-05 9:58 ` Bagas Sanjaya
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=20221219042209.22898-6-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=cgroups@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=hannes@cmpxchg.org \
--cc=hughd@google.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=lizefan.x@bytedance.com \
--cc=mhocko@suse.com \
--cc=shakeelb@google.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