linux-kernel - [PATCH] Documentation/cgroup-v2: Update memory.numa_stat description to reflect possible units

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250110123019.423725-1-lizhijian@fujitsu.com>
Date: Fri, 10 Jan 2025 20:30:19 +0800
From: Li Zhijian <lizhijian@...itsu.com>
To: linux-doc@...r.kernel.org
Cc: Tejun Heo <tj@...nel.org>,
	Johannes Weiner <hannes@...xchg.org>,
	mkoutny@...e.com,
	Jonathan Corbet <corbet@....net>,
	cgroups@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Li Zhijian <lizhijian@...itsu.com>
Subject: [PATCH] Documentation/cgroup-v2: Update memory.numa_stat description to reflect possible units

The description of the memory.numa_stat file has been updated to clarify
that the output values can be in bytes or pages. This change ensures that
users are aware that the unit of measurement for memory values can vary
and should be verified by consulting the memory.stat

It's known that
workingset_*, pgdemote_* and pgpromote_success are counted in pages

Signed-off-by: Li Zhijian <lizhijian@...itsu.com>
---
 Documentation/admin-guide/cgroup-v2.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 315ede811c9d..5d1d44547409 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -1427,7 +1427,7 @@ The following nested keys are defined.
 	types of memory, type-specific details, and other information
 	on the state and past events of the memory management system.
 
-	All memory amounts are in bytes.
+	All memory amounts are in bytes or bytes.
 
 	The entries are ordered to be human readable, and new entries
 	can show up in the middle. Don't rely on items remaining in a
@@ -1673,11 +1673,12 @@ The following nested keys are defined.
 	application performance by combining this information with the
 	application's CPU allocation.
 
-	All memory amounts are in bytes.
-
 	The output format of memory.numa_stat is::
 
-	  type N0=<bytes in node 0> N1=<bytes in node 1> ...
+	  type N0=<value for node 0> N1=<value for node 1> ...
+
+        The 'value' can be in bytes or pages, depending on the specific
+        type of memory. To determine the unit, refer to the memory.stat.
 
 	The entries are ordered to be human readable, and new entries
 	can show up in the middle. Don't rely on items remaining in a
-- 
2.44.0