[Qemu-devel] [PATCH] qom: Document ways to retrieve child object added by object_property_add_child()

[alexander_barabash]

From: Alexander Barabash <address@hidden>

object_property_add_child() creates a property whose values as a string is
the child object's canonical path.

Signed-off-by: Alexander Barabash <address@hidden>
---
 include/qemu/object.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/include/qemu/object.h b/include/qemu/object.h
index ba2409d..d9e9221 100644
--- a/include/qemu/object.h
+++ b/include/qemu/object.h
@@ -808,6 +808,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);
-- 
1.7.5.4