diff mbox series

[03/10] docs: cgroup-v1: wrap remaining admonitions in admonition blocks

Message ID 20221219042209.22898-4-bagasdotme@gmail.com
State New
Headers
Series docs: cgroup-v1: formatting improv for "Memory Resource Controller" doc |

Commit Message

Bagas Sanjaya Dec. 19, 2022, 4:22 a.m. UTC 
  Wrap two other admonitions in appropriate blocks in order for readers to
pay more attention to block contents:

  * hint:: for editor's note
  * warning:: for move charges deprecation

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../admin-guide/cgroup-v1/memory.rst          | 22 ++++++++++---------
 1 file changed, 12 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst
index ec99bcbd55c2e7..f828db2a671be4 100644
--- a/Documentation/admin-guide/cgroup-v1/memory.rst
+++ b/Documentation/admin-guide/cgroup-v1/memory.rst
@@ -13,11 +13,11 @@  Memory Resource Controller
       memory controller in this document. Do not confuse memory controller
       used here with the memory controller that is used in hardware.
 
-(For editors) In this document:
-      When we mention a cgroup (cgroupfs's directory) with memory controller,
-      we call it "memory cgroup". When you see git-log and source code, you'll
-      see patch's title and function names tend to use "memcg".
-      In this document, we avoid using it.
+.. hint::
+      (For editors) In this document, when we mention a cgroup (cgroupfs's
+      directory) with memory controller, we call it "memory cgroup". When you
+      see git-log and source code, you'll see patch's title and function names
+      tend to use "memcg". In this document, we avoid using it.
 
 Benefits and Purpose of the memory controller
 =============================================
@@ -723,12 +723,14 @@  If we want to change this to 1G, we can at any time use::
 8. Move charges at task migration (DEPRECATED!)
 ===============================================
 
-THIS IS DEPRECATED!
+.. warning::
 
-It's expensive and unreliable! It's better practice to launch workload
-tasks directly from inside their target cgroup. Use dedicated workload
-cgroups to allow fine-grained policy adjustments without having to
-move physical pages between control domains.
+   THIS IS DEPRECATED!
+
+   It's expensive and unreliable! It's better practice to launch workload
+   tasks directly from inside their target cgroup. Use dedicated workload
+   cgroups to allow fine-grained policy adjustments without having to
+   move physical pages between control domains.
 
 Users can move charges associated with a task along with task migration, that
 is, uncharge task's pages from the old cgroup and charge them to the new cgroup.