[libgovirt] api: Document that ovirt_api_get_* do no IO
- From: Christophe Fergeau <teuf src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgovirt] api: Document that ovirt_api_get_* do no IO
- Date: Thu, 6 Aug 2015 16:30:30 +0000 (UTC)
commit 6aff483e1b3cf808b3076329223d7bbb6e2899c3
Author: Christophe Fergeau <cfergeau redhat com>
Date: Fri Jul 24 14:23:58 2015 +0200
api: Document that ovirt_api_get_* do no IO
govirt/ovirt-api.c | 12 ++++++++++++
1 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/govirt/ovirt-api.c b/govirt/ovirt-api.c
index 0ff10ac..001ee42 100644
--- a/govirt/ovirt-api.c
+++ b/govirt/ovirt-api.c
@@ -115,6 +115,10 @@ OvirtApi *ovirt_api_new(void)
* ovirt_api_get_vms:
* @api: a #OvirtApi
*
+ * This method does not initiate any network activity, the collection
+ * must be fetched with ovirt_collection_fetch() before having up-to-date
+ * content.
+ *
* Return value: (transfer none):
*/
OvirtCollection *ovirt_api_get_vms(OvirtApi *api)
@@ -139,6 +143,10 @@ OvirtCollection *ovirt_api_get_vms(OvirtApi *api)
* ovirt_api_get_vm_pools:
* @api: a #OvirtApi
*
+ * This method does not initiate any network activity, the collection
+ * must be fetched with ovirt_collection_fetch() before having up-to-date
+ * content.
+ *
* Return value: (transfer none):
*/
OvirtCollection *ovirt_api_get_vm_pools(OvirtApi *api)
@@ -164,6 +172,10 @@ OvirtCollection *ovirt_api_get_vm_pools(OvirtApi *api)
* ovirt_api_get_storage_domains:
* @api: a #OvirtApi
*
+ * This method does not initiate any network activity, the collection
+ * must be fetched with ovirt_collection_fetch() before having up-to-date
+ * content.
+ *
* Return value: (transfer none):
*/
OvirtCollection *ovirt_api_get_storage_domains(OvirtApi *api)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]