linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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 03/10] docs: cgroup-v1: wrap remaining admonitions in admonition blocks
Date: Mon, 19 Dec 2022 11:22:02 +0700	[thread overview]
Message-ID: <20221219042209.22898-4-bagasdotme@gmail.com> (raw)
In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com>

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 --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.
-- 
An old man doll... just what I always wanted! - Clara


  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 ` Bagas Sanjaya [this message]
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 ` [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-4-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;
as well as URLs for NNTP newsgroup(s).