aboutsummaryrefslogtreecommitdiff
path: root/include/qom
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2020-07-14 18:02:01 +0200
committerMarkus Armbruster <armbru@redhat.com>2020-07-21 16:23:43 +0200
commit5bd929d2fff068f829688f27b54f2f159ff06eb6 (patch)
tree6ac772d30f5b58c15260b4fc9ccf513e748a3196 /include/qom
parent7a309cc95b862be74711e7a35997daa3f885651a (diff)
qom: Document object_get_canonical_path() returns malloced string
Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20200714160202.3121879-5-armbru@redhat.com> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Diffstat (limited to 'include/qom')
-rw-r--r--include/qom/object.h5
1 files 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);