[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 02/29] qapi: Correct balloon documentation
From: |
Markus Armbruster |
Subject: |
[PULL 02/29] qapi: Correct balloon documentation |
Date: |
Tue, 29 Sep 2020 22:18:59 +0200 |
From: Philippe Mathieu-Daudé <philmd@redhat.com>
The documentation incorrectly uses the "size of the balloon"
description when it should be "logical size of the VM". Fix it.
The relation between both values is:
logical_vm_size = vm_ram_size - balloon_size
Reported-by: David Hildenbrand <david@redhat.com>
Suggested-by: David Hildenbrand <david@redhat.com>
Reviewed-by: David Hildenbrand <david@redhat.com>
Acked-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-Id: <20200913195348.1064154-3-philmd@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/misc.json | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/qapi/misc.json b/qapi/misc.json
index b21963a176..a667fdf03e 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -192,7 +192,8 @@
#
# Information about the guest balloon device.
#
-# @actual: the number of bytes the balloon currently contains
+# @actual: the logical size of the VM in bytes
+# Formula used: logical_vm_size = vm_ram_size - balloon_size
#
# Since: 0.14.0
#
@@ -228,7 +229,8 @@
# Emitted when the guest changes the actual BALLOON level. This value is
# equivalent to the @actual field return by the 'query-balloon' command
#
-# @actual: actual level of the guest memory balloon in bytes
+# @actual: the logical size of the VM in bytes
+# Formula used: logical_vm_size = vm_ram_size - balloon_size
#
# Note: this event is rate-limited.
#
@@ -759,7 +761,10 @@
#
# Request the balloon driver to change its balloon size.
#
-# @value: the target size of the balloon in bytes
+# @value: the target logical size of the VM in bytes
+# We can deduce the size of the balloon using this formula:
+# logical_vm_size = vm_ram_size - balloon_size
+# From it we have: balloon_size = vm_ram_size - @value
#
# Returns: - Nothing on success
# - If the balloon driver is enabled but not functional because the
KVM
@@ -777,6 +782,8 @@
# -> { "execute": "balloon", "arguments": { "value": 536870912 } }
# <- { "return": {} }
#
+# With a 2.5GiB guest this command inflated the balloon to 3GiB.
+#
##
{ 'command': 'balloon', 'data': {'value': 'int'} }
--
2.26.2
- [PULL 26/29] scripts/texi2pod: Delete unused script, (continued)
- [PULL 26/29] scripts/texi2pod: Delete unused script, Markus Armbruster, 2020/09/29
- [PULL 28/29] configure: Drop texinfo requirement, Markus Armbruster, 2020/09/29
- [PULL 23/29] tests/qapi-schema: Add test of the rST QAPI doc-comment output, Markus Armbruster, 2020/09/29
- [PULL 17/29] docs/interop: Convert qemu-qmp-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 24/29] scripts/qapi: Remove texinfo generation support, Markus Armbruster, 2020/09/29
- [PULL 18/29] qapi: Use rST markup for literal blocks, Markus Armbruster, 2020/09/29
- [PULL 13/29] scripts/qapi/parser.py: improve doc comment indent handling, Markus Armbruster, 2020/09/29
- [PULL 15/29] docs/sphinx: Add new qapi-doc Sphinx extension, Markus Armbruster, 2020/09/29
- [PULL 22/29] meson.build: Make manuals depend on source to Sphinx extensions, Markus Armbruster, 2020/09/29
- [PULL 12/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Markus Armbruster, 2020/09/29
- [PULL 02/29] qapi: Correct balloon documentation,
Markus Armbruster <=
- [PULL 14/29] qapi/machine.json: Escape a literal '*' in doc comment, Markus Armbruster, 2020/09/29
- [PULL 05/29] qapi: Restrict query-uuid command to machine code, Markus Armbruster, 2020/09/29
- [PULL 25/29] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Markus Armbruster, 2020/09/29
- Re: [PULL 00/29] QAPI patches patches for 2020-09-29, Peter Maydell, 2020/09/30