[PATCH] docs: cgroup-v2: fix misc.events key format description
Cheng Lingfei <[email protected]>
| Newsgroups | org.kernel.feeds.b4-sent,org.kernel.vger.cgroups,org.kernel.vger.linux-doc,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
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 <[email protected]> --- 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 <[email protected]>