aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAlexander Barabash <alexander_barabash@mentor.com>2012-02-21 12:14:22 +0200
committerAnthony Liguori <aliguori@us.ibm.com>2012-02-22 09:02:18 -0600
commit358b54654aa85f97402aca4be3b1a7b7d08bab70 (patch)
tree7cdc16d30a28b8d27c742d66eb457148fdd0a175 /include
parent1b89fafe47b74e458f5e179b6c0e56c8b2633b62 (diff)
downloadqemu-358b54654aa85f97402aca4be3b1a7b7d08bab70.zip
qemu-358b54654aa85f97402aca4be3b1a7b7d08bab70.tar.gz
qemu-358b54654aa85f97402aca4be3b1a7b7d08bab70.tar.bz2
qom: Document ways to retrieve child object added by object_property_add_child()
object_property_add_child() creates a property whose values as a string is the child object's canonical path. Acked-by: Paolo Bonzini <pbonzini@redhat.com> Signed-off-by: Alexander Barabash <alexander_barabash@mentor.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
Diffstat (limited to 'include')
-rw-r--r--include/qemu/object.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/qemu/object.h b/include/qemu/object.h
index ff6be14..69e4b7b 100644
--- a/include/qemu/object.h
+++ b/include/qemu/object.h
@@ -837,6 +837,10 @@ Object *object_resolve_path_type(const char *path, const char *typename,
*
* There is no way for a child to determine what its parent is. It is not
* a bidirectional relationship. This is by design.
+ *
+ * The value of a child property as a C string will be the child object's
+ * canonical path. It can be retrieved using object_property_get_str().
+ * The child object itself can be retrieved using object_property_get_link().
*/
void object_property_add_child(Object *obj, const char *name,
Object *child, struct Error **errp);