[qemu-xen master] qom: Document object_get_canonical_path() returns malloced string

[patchbot@xxxxxxx]

commit 5bd929d2fff068f829688f27b54f2f159ff06eb6
Author:     Markus Armbruster <armbru@xxxxxxxxxx>
AuthorDate: Tue Jul 14 18:02:01 2020 +0200
Commit:     Markus Armbruster <armbru@xxxxxxxxxx>
CommitDate: Tue Jul 21 16:23:43 2020 +0200

    qom: Document object_get_canonical_path() returns malloced string
    
    Signed-off-by: Markus Armbruster <armbru@xxxxxxxxxx>
    Message-Id: <20200714160202.3121879-5-armbru@xxxxxxxxxx>
    Reviewed-by: Philippe Mathieu-Daudé <philmd@xxxxxxxxxx>
---
 include/qom/object.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index 55d925d2c8..0f3a60617c 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1467,8 +1467,9 @@ const char *object_get_canonical_path_component(const 
Object *obj);
 /**
  * object_get_canonical_path:
  *
- * Returns: The canonical path for a object.  This is the path within the
- * composition tree starting from the root.
+ * Returns: The canonical path for a object, newly allocated.  This is
+ * the path within the composition tree starting from the root.  Use
+ * g_free() to free it.
  */
 char *object_get_canonical_path(const Object *obj);
 
--
generated by git-patchbot for /home/xen/git/qemu-xen.git#master