[libvirt] [PATCH] Document the need to free vir*Ptr objects

Ján Tomko jtomko at redhat.com
Tue Jul 8 08:28:29 UTC 2014

 docs/api.html.in | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/api.html.in b/docs/api.html.in
index eae7657..68ffa0b 100644
--- a/docs/api.html.in
+++ b/docs/api.html.in
@@ -159,6 +159,10 @@
+    <p>Note: functions returning vir*Ptr (like the virDomainLookup functions)
+    allocate memory which needs to be freed by the caller by the corresponding
+    vir*Free function (e.g. virDomainFree for a virDomainPtr object).
+    </p>
     <p> For more in-depth details of the storage related APIs see
       <a href="storage.html">the storage management page</a>.

More information about the libvir-list mailing list