docs: More precisely describe memory-backend-*::id's user

'id' of memory-backend-{file,ram} is not only for '-numa''s reference, but
also other parameters like '-device nvdimm'.
More clearly call out this to avoid misinterpretation.

Signed-off-by: Robert Hoo <robert.hu@linux.intel.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <1619080922-83527-1-git-send-email-robert.hu@linux.intel.com>
Signed-off-by: Laurent Vivier <laurent@vivier.eu>
This commit is contained in:
Robert Hoo 2021-04-22 16:42:02 +08:00 committed by Laurent Vivier
parent e75941331e
commit 56c9f00ef9
1 changed files with 3 additions and 3 deletions

View File

@ -4508,11 +4508,11 @@ SRST
the guest RAM with huge pages.
The ``id`` parameter is a unique ID that will be used to
reference this memory region when configuring the ``-numa``
argument.
reference this memory region in other parameters, e.g. ``-numa``,
``-device nvdimm``, etc.
The ``size`` option provides the size of the memory region, and
accepts common suffixes, eg ``500M``.
accepts common suffixes, e.g. ``500M``.
The ``mem-path`` provides the path to either a shared memory or
huge page filesystem mount.