[libvirt] [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 eae7657..68ffa0b 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> -- 1.8.5.5