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 10/10] docs: cgroup-v1: use numbered lists for user interface setup
Date: Mon, 19 Dec 2022 11:22:09 +0700 [thread overview]
Message-ID: <20221219042209.22898-11-bagasdotme@gmail.com> (raw)
In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com>
Setup instructions for memory resource controller UI uses a mix of
section headings and normal paragraphs, whereas numbered lists are
better fit for this purpose.
While at it, also slightly reword the instructions and add reference to
"Why are cgroups needed?" in the main cgroups documentation.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
.../admin-guide/cgroup-v1/cgroups.rst | 2 ++
.../admin-guide/cgroup-v1/memory.rst | 26 ++++++++-----------
2 files changed, 13 insertions(+), 15 deletions(-)
diff --git a/Documentation/admin-guide/cgroup-v1/cgroups.rst b/Documentation/admin-guide/cgroup-v1/cgroups.rst
index b0688011ed06de..9343148ee99366 100644
--- a/Documentation/admin-guide/cgroup-v1/cgroups.rst
+++ b/Documentation/admin-guide/cgroup-v1/cgroups.rst
@@ -80,6 +80,8 @@ access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rs
you to associate a set of CPUs and a set of memory nodes with the
tasks in each cgroup.
+.. _cgroups-why-needed:
+
1.2 Why are cgroups needed ?
----------------------------
diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst
index ae3a1d3873d73b..8cd46525b19c2e 100644
--- a/Documentation/admin-guide/cgroup-v1/memory.rst
+++ b/Documentation/admin-guide/cgroup-v1/memory.rst
@@ -389,30 +389,30 @@ U != 0, K >= U:
3. User Interface
=================
-3.0. Configuration
-------------------
+To use the user interface:
-a. Enable CONFIG_CGROUPS
-b. Enable CONFIG_MEMCG
-
-3.1. Prepare the cgroups (see cgroups.txt, Why are cgroups needed?)
--------------------------------------------------------------------
-
-::
+1. Enable CONFIG_CGROUPS and CONFIG_MEMCG options
+2. Prepare the cgroups (see :ref:`Why are cgroups needed?
+ <cgroups-why-needed>` for the background information)::
# mount -t tmpfs none /sys/fs/cgroup
# mkdir /sys/fs/cgroup/memory
# mount -t cgroup none /sys/fs/cgroup/memory -o memory
-3.2. Make the new group and move bash into it::
+3. Make the new group and move bash into it::
# mkdir /sys/fs/cgroup/memory/0
# echo $$ > /sys/fs/cgroup/memory/0/tasks
-Since now we're in the 0 cgroup, we can alter the memory limit::
+4. Since now we're in the 0 cgroup, we can alter the memory limit::
# echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes
+ The limit can now be queried::
+
+ # cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes
+ 4194304
+
.. note::
We can use a suffix (k, K, m, M, g or G) to indicate values in kilo,
mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes,
@@ -424,10 +424,6 @@ Since now we're in the 0 cgroup, we can alter the memory limit::
.. note::
We cannot set limits on the root cgroup any more.
-::
-
- # cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes
- 4194304
We can check the usage::
--
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 ` [PATCH 05/10] docs: cgroup-v1: fix footnotes Bagas Sanjaya
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 ` Bagas Sanjaya [this message]
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-11-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