From 24ed11723230e43f44e9a1aef72e7c71714288d1 Mon Sep 17 00:00:00 2001
From: Alexey Kardashevskiy <aik@ozlabs.ru>
Date: Wed, 30 May 2018 17:11:29 +1000
Subject: [PATCH] qom: Document qom/device-list-properties implementation
specific
The recently introduced qom-list-properties QMP command raised
a question what properties it (and its cousin - device-list-properties)
can possibly print - only those defined by DeviceClass::props
or dynamically created in TypeInfo::instance_init() so properties created
elsewhere won't show up and this behaviour might confuse the user.
For example, PIIX4 does that from piix4_pm_realize() via
piix4_pm_add_propeties():
object_property_add_uint8_ptr(OBJECT(s), ACPI_PM_PROP_ACPI_ENABLE_CMD,
&acpi_enable_cmd, NULL);
This adds a note to the command descriptions about the limitation.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Acked-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Alexey Kardashevskiy <aik@ozlabs.ru>
Message-Id: <20180530071129.9013-1-aik@ozlabs.ru>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
qapi/misc.json | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/qapi/misc.json b/qapi/misc.json
index f5988cc0b52..efc3d230570 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -1529,6 +1529,10 @@
#
# Returns: a list of ObjectPropertyInfo describing a devices properties
#
+# Note: objects can create properties at runtime, for example to describe
+# links between different devices and/or objects. These properties
+# are not included in the output of this command.
+#
# Since: 1.2
##
{ 'command': 'device-list-properties',
@@ -1542,6 +1546,10 @@
#
# @typename: the type name of an object
#
+# Note: objects can create properties at runtime, for example to describe
+# links between different devices and/or objects. These properties
+# are not included in the output of this command.
+#
# Returns: a list of ObjectPropertyInfo describing object properties
#
# Since: 2.12
--
GitLab