[PATCH 02/10] docs: Document memory bandwidth allocation limits more clearly

The meaning of the values as well as their maximums are hard to predict and accounting for all the possibilities (which by the way might change during daemon's execution) is borderline hallucinatory. There is already a way we represent them, which is the same as the Linux kernel. We do not interpret them at all, just blindly use them. In order to make this more apparent for the users change the documentation for the <memorytune/> (not <memtune/>) element more boldly. Signed-off-by: Martin Kletzander <mkletzan(a)redhat.com&gt; --- docs/formatdomain.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 47d3e2125e45..5eb7f918b4b5 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -1018,8 +1018,11 @@ CPU Tuning ``id`` Host node id from which to allocate memory bandwidth. ``bandwidth`` - The memory bandwidth to allocate from this node. The value by default - is in percentage. + The memory bandwidth to allocate from this node. The value is usually + in percent (Intel) but can also be in MB/s (if resctrl is mounted with + the ``mba_MBps`` option) or in 1/8 GB/s increments (AMD). The user is + responsible for making sure the value makes sense on their system and + configuration. Memory Allocation -- 2.46.0