[PATCH] docs: Fix dimm example

Michal Privoznik posted 1 patch 2 years, 7 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/590303d68d568673f83ea37f92ebdb15c6adad53.1631524997.git.mprivozn@redhat.com
docs/formatdomain.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: Fix dimm example
Posted by Michal Privoznik 2 years, 7 months ago
In the example for <memory model='dimm'/> we show how to
configure hugepages as backend. In the example we show 4MiB
hugepages which are non-standard and thus at the first glance may
mislead users thinking that a regular sized pages (4K) will be
used. Use 2MiB as the value instead.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
---
 docs/formatdomain.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 67cb934881..7dc93d6abe 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -7745,7 +7745,7 @@ Example: usage of the memory devices
      </memory>
      <memory model='dimm'>
        <source>
-         <pagesize unit='KiB'>4096</pagesize>
+         <pagesize unit='KiB'>2048</pagesize>
          <nodemask>1-3</nodemask>
        </source>
        <target>
-- 
2.32.0

Re: [PATCH] docs: Fix dimm example
Posted by Pavel Hrdina 2 years, 7 months ago
On Mon, Sep 13, 2021 at 11:23:17AM +0200, Michal Privoznik wrote:
> In the example for <memory model='dimm'/> we show how to
> configure hugepages as backend. In the example we show 4MiB
> hugepages which are non-standard and thus at the first glance may
> mislead users thinking that a regular sized pages (4K) will be
> used. Use 2MiB as the value instead.
> 
> Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
> ---
>  docs/formatdomain.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Pavel Hrdina <phrdina@redhat.com>