aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2017-05-22 18:42:13 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-05-31 16:04:05 +0200
commit8339fa266ccd03a43d4a9f196f1098fa3c6924f2 (patch)
tree63adc1a17c739cd5bd3808bba0f05ed4473fc74e
parent5891c388bbdd48ba0440d2738155f364589a432a (diff)
qapi: Document visit_type_any() issues with keyval input
It's already documented in keyval.c (commit 0ee9ae7), but visitor.h can use a note, too. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <1495471335-23707-3-git-send-email-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
-rw-r--r--include/qapi/visitor.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h
index b0e233df76..4721c39ae3 100644
--- a/include/qapi/visitor.h
+++ b/include/qapi/visitor.h
@@ -607,6 +607,10 @@ void visit_type_number(Visitor *v, const char *name, double *obj,
* @obj must be non-NULL. Input visitors set *@obj to the value;
* other visitors will leave *@obj unchanged. *@obj must be non-NULL
* for output visitors.
+ *
+ * Note that some kinds of input can't express arbitrary QObject.
+ * E.g. the visitor returned by qobject_input_visitor_new_keyval()
+ * can't create numbers or booleans, only strings.
*/
void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);