Skip to content

Commit 71da431

Browse files
bagasmehtejun
authored andcommitted
docs: cgroup-v1: fix footnotes
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 <[email protected]> Signed-off-by: Tejun Heo <[email protected]>
1 parent eb08489 commit 71da431

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

Documentation/admin-guide/cgroup-v1/memory.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Benefits and Purpose of the memory controller
2323
=============================================
2424

2525
The memory controller isolates the memory behaviour of a group of tasks
26-
from the rest of the system. The article on LWN [12] mentions some probable
26+
from the rest of the system. The article on LWN [12]_ mentions some probable
2727
uses of the memory controller. The memory controller can be used to
2828

2929
a. Isolate an application or a group of applications
@@ -107,16 +107,16 @@ Brief summary of control files.
107107
==========
108108

109109
The memory controller has a long history. A request for comments for the memory
110-
controller was posted by Balbir Singh [1]. At the time the RFC was posted
110+
controller was posted by Balbir Singh [1]_. At the time the RFC was posted
111111
there were several implementations for memory control. The goal of the
112112
RFC was to build consensus and agreement for the minimal features required
113-
for memory control. The first RSS controller was posted by Balbir Singh[2]
114-
in Feb 2007. Pavel Emelianov [3][4][5] has since posted three versions of the
115-
RSS controller. At OLS, at the resource management BoF, everyone suggested
116-
that we handle both page cache and RSS together. Another request was raised
117-
to allow user space handling of OOM. The current memory controller is
113+
for memory control. The first RSS controller was posted by Balbir Singh [2]_
114+
in Feb 2007. Pavel Emelianov [3]_ [4]_ [5]_ has since posted three versions
115+
of the RSS controller. At OLS, at the resource management BoF, everyone
116+
suggested that we handle both page cache and RSS together. Another request was
117+
raised to allow user space handling of OOM. The current memory controller is
118118
at version 6; it combines both mapped (RSS) and unmapped Page
119-
Cache Control [11].
119+
Cache Control [11]_.
120120

121121
2. Memory Control
122122
=================
@@ -960,15 +960,16 @@ commented and discussed quite extensively in the community.
960960
References
961961
==========
962962

963-
1. Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
964-
2. Singh, Balbir. Memory Controller (RSS Control),
963+
.. [1] Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
964+
.. [2] Singh, Balbir. Memory Controller (RSS Control),
965965
http://lwn.net/Articles/222762/
966-
3. Emelianov, Pavel. Resource controllers based on process cgroups
966+
.. [3] Emelianov, Pavel. Resource controllers based on process cgroups
967967
https://lore.kernel.org/r/[email protected]
968-
4. Emelianov, Pavel. RSS controller based on process cgroups (v2)
968+
.. [4] Emelianov, Pavel. RSS controller based on process cgroups (v2)
969969
https://lore.kernel.org/r/[email protected]
970-
5. Emelianov, Pavel. RSS controller based on process cgroups (v3)
970+
.. [5] Emelianov, Pavel. RSS controller based on process cgroups (v3)
971971
https://lore.kernel.org/r/[email protected]
972+
972973
6. Menage, Paul. Control Groups v10, http://lwn.net/Articles/236032/
973974
7. Vaidyanathan, Srinivasan, Control Groups: Pagecache accounting and control
974975
subsystem (v3), http://lwn.net/Articles/235534/
@@ -978,7 +979,8 @@ References
978979
https://lore.kernel.org/r/[email protected]
979980
10. Singh, Balbir. Memory controller v6 test results,
980981
https://lore.kernel.org/r/20070819094658.654.84837.sendpatchset@balbir-laptop
981-
11. Singh, Balbir. Memory controller introduction (v6),
982-
https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop
983-
12. Corbet, Jonathan, Controlling memory use in cgroups,
984-
http://lwn.net/Articles/243795/
982+
983+
.. [11] Singh, Balbir. Memory controller introduction (v6),
984+
https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop
985+
.. [12] Corbet, Jonathan, Controlling memory use in cgroups,
986+
http://lwn.net/Articles/243795/

0 commit comments

Comments
 (0)