diff mbox series

[for-5.1,4/5] qom: Document object_get_canonical_path() returns malloced string

Message ID 20200714160202.3121879-5-armbru@redhat.com
State New
Headers show
Series [for-5.1,1/5] qdev: Fix device_add DRIVER, help to print to monitor | expand

Commit Message

Markus Armbruster July 14, 2020, 4:02 p.m. UTC 
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 include/qom/object.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

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);