From: Cheng Lingfei via B4 Relay <devnull+chenglingfei.foxmail.com@kernel.org>
To: "Tejun Heo" <tj@kernel.org>,
"Johannes Weiner" <hannes@cmpxchg.org>,
"Michal Koutný" <mkoutny@suse.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Shuah Khan" <skhan@linuxfoundation.org>,
"Randy Dunlap" <rdunlap@infradead.org>
Cc: cgroups@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Cheng Lingfei <chenglingfei@foxmail.com>
Subject: [PATCH] docs: cgroup-v2: fix misc.events key format description
Date: Mon, 24 Aug 2026 18:55:04 +0800 [thread overview]
Message-ID: <20260824-master-v1-1-6866b77e1f62@foxmail.com> (raw)
From: Cheng Lingfei <chenglingfei@foxmail.com>
In misc cgroup, misc.events does not output a simple "max" key. Instead,
each registered misc resource outputs a separate key suffixed with ".max"
(e.g., "res_a.max <val>").
Update the documentation to clarify the per-resource nature of the events
file and provide an example matching the rest of the Misc section.
Signed-off-by: Cheng Lingfei <chenglingfei@foxmail.com>
---
Documentation/admin-guide/cgroup-v2.rst | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 7c2a8ed80..cfd6cdc0e 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -3059,14 +3059,17 @@ resources (res_a and res_b) are registered then:
file.
misc.events
- A read-only flat-keyed file which exists on non-root cgroups. The
- following entries are defined. Unless specified otherwise, a value
- change in this file generates a file modified event. All fields in
- this file are hierarchical.
+ A read-only flat-keyed file which exists on non-root cgroups. It
+ shows, per resource, the number of times the resource usage of the
+ cgroup and its children was about to go over the max boundary.
+ Unless specified otherwise, a value change in this file generates a
+ file modified event. All fields in this file are hierarchical::
- max
- The number of times the cgroup's resource usage was
- about to go over the max boundary.
+ $ cat misc.events
+ res_a.max 0
+ res_b.max 0
+
+ Each entry is keyed by the resource name suffixed with ``.max``.
misc.events.local
Similar to misc.events but the fields in the file are local to the
---
base-commit: 0a0d1d55dad570724bf8c7ea83409639cfb4be9b
change-id: 20260824-master-0bec5f79e6c8
Best regards,
--
Cheng Lingfei <chenglingfei@foxmail.com>
next reply other threads:[~2026-08-24 10:55 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-24 10:55 Cheng Lingfei via B4 Relay [this message]
2026-08-24 11:15 ` Michal Koutný
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=20260824-master-v1-1-6866b77e1f62@foxmail.com \
--to=devnull+chenglingfei.foxmail.com@kernel.org \
--cc=cgroups@vger.kernel.org \
--cc=chenglingfei@foxmail.com \
--cc=corbet@lwn.net \
--cc=hannes@cmpxchg.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mkoutny@suse.com \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
--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
all inboxes | Powered by JetHome®