From: Ján Tomko <jtomko@redhat.com>
Date: Tue, 8 Jul 2014 08:27:51 +0000 (+0200)
Subject: Document the need to free vir*Ptr objects
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=3701b519847c391e6d0755239f7e89e9362d15f5;p=people%2Fliuw%2Flibxenctrl-split%2Flibvirt.git

Document the need to free vir*Ptr objects

https://bugzilla.redhat.com/show_bug.cgi?id=994731
---

diff --git a/docs/api.html.in b/docs/api.html.in
index eae7657f0..68ffa0b02 100644
--- a/docs/api.html.in
+++ b/docs/api.html.in
@@ -159,6 +159,10 @@
         </ul>
       </li>
     </ul>
+    <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>.
     </p>