The default value of the @share option of the @MemoryBackendProperties
really depends on the backend type, so let's document the default
values in the same place where we define the option to avoid
dispersing the information.
Cc: David Hildenbrand <david@redhat.com>
Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
---
v2:
- documented @share's default right where it's defined [Markus]
v1: https://patchew.org/QEMU/20240523133302.103858-1-sgarzare@redhat.com/
---
qapi/qom.json | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/qapi/qom.json b/qapi/qom.json
index 8bd299265e..9b8f6a7ab5 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -600,7 +600,9 @@
# preallocation threads (default: none) (since 7.2)
#
# @share: if false, the memory is private to QEMU; if true, it is
-# shared (default: false)
+# shared (default false for backends memory-backend-file and
+# memory-backend-ram, true for backends memory-backend-epc and
+# memory-backend-memfd)
#
# @reserve: if true, reserve swap space (or huge pages) if applicable
# (default: true) (since 6.1)
@@ -700,8 +702,6 @@
#
# Properties for memory-backend-memfd objects.
#
-# The @share boolean option is true by default with memfd.
-#
# @hugetlb: if true, the file to be created resides in the hugetlbfs
# filesystem (default: false)
#
@@ -726,8 +726,6 @@
#
# Properties for memory-backend-epc objects.
#
-# The @share boolean option is true by default with epc
-#
# The @merge boolean option is false by default with epc
#
# The @dump boolean option is false by default with epc
--
2.45.2