From 3701b519847c391e6d0755239f7e89e9362d15f5 Mon Sep 17 00:00:00 2001
From: =?utf8?q?J=C3=A1n=20Tomko?= <jtomko@redhat.com>
Date: Tue, 8 Jul 2014 10:27:51 +0200
Subject: [PATCH] Document the need to free vir*Ptr objects

https://bugzilla.redhat.com/show_bug.cgi?id=994731
---
 docs/api.html.in | 4 ++++
 1 file changed, 4 insertions(+)

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>
-- 
2.39.5