This commit finishes the script work and adds docstring to types that
are not documented.
From this commit onwards, all exported typedefs are versioned.
Further commits will enforce that it stays like that with new
additions.
Signed-off-by: Victor Toso <victortoso(a)redhat.com>
---
include/libvirt/libvirt-domain-checkpoint.h | 16 ++-
include/libvirt/libvirt-domain-snapshot.h | 16 ++-
include/libvirt/libvirt-domain.h | 147 ++++++++++++++++++--
include/libvirt/libvirt-host.h | 20 ++-
include/libvirt/libvirt-interface.h | 12 ++
include/libvirt/libvirt-network.h | 27 +++-
include/libvirt/libvirt-nwfilter.h | 13 +-
include/libvirt/libvirt-qemu.h | 6 +
include/libvirt/libvirt-secret.h | 14 +-
include/libvirt/libvirt-storage.h | 52 ++++++-
include/libvirt/virterror.h | 7 +
11 files changed, 303 insertions(+), 27 deletions(-)
diff --git a/include/libvirt/libvirt-domain-checkpoint.h
b/include/libvirt/libvirt-domain-checkpoint.h
index 1a1631b9cf..5a53717175 100644
--- a/include/libvirt/libvirt-domain-checkpoint.h
+++ b/include/libvirt/libvirt-domain-checkpoint.h
@@ -77,7 +77,12 @@ typedef enum {
virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain,
const char *xmlDesc,
unsigned int flags);
-
+/**
+ * virDomainCheckpointXMLFlags:
+ *
+ * Since: v5.6.0
+ *
+ */
typedef enum {
VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data
(Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN = (1 << 1), /* Suppress <domain>
@@ -139,7 +144,14 @@ virDomainCheckpointPtr virDomainCheckpointLookupByName(virDomainPtr
domain,
virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint,
unsigned int flags);
-/* Delete a checkpoint */
+/**
+ * virDomainCheckpointDeleteFlags:
+ *
+ * Delete a checkpoint
+ *
+ * Since: v5.6.0
+ *
+ */
typedef enum {
VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children
(Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata
(Since: v5.6.0) */
diff --git a/include/libvirt/libvirt-domain-snapshot.h
b/include/libvirt/libvirt-domain-snapshot.h
index aa7bfa903a..9cbbcb5650 100644
--- a/include/libvirt/libvirt-domain-snapshot.h
+++ b/include/libvirt/libvirt-domain-snapshot.h
@@ -91,7 +91,12 @@ typedef enum {
virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain,
const char *xmlDesc,
unsigned int flags);
-
+/**
+ * virDomainSnapshotXMLFlags:
+ *
+ * Since: v5.1.0
+ *
+ */
typedef enum {
VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security
sensitive information too (Since: v5.1.0) */
} virDomainSnapshotXMLFlags;
@@ -230,7 +235,14 @@ typedef enum {
int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
unsigned int flags);
-/* Delete a snapshot */
+/**
+ * virDomainSnapshotDeleteFlags:
+ *
+ * Delete a snapshot
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children
(Since: v1.0.0) */
VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata
(Since: v1.0.0) */
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 8d04a0b989..77c6e6f3a7 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -885,7 +885,7 @@ struct _virDomainMemoryStat {
};
/**
- * *virDomainMemoryStatPtr:
+ * virDomainMemoryStatPtr:
*
* Since: v1.0.0
*
@@ -893,7 +893,14 @@ struct _virDomainMemoryStat {
typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr;
-/* Domain core dump flags. */
+/**
+ * virDomainCoreDumpFlags:
+ *
+ * Domain core dump flags.
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: v1.0.0) */
VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: v1.0.0) */
@@ -2032,7 +2039,12 @@ int virDomainSetMemoryStatsPeriod (virDomainPtr
domain,
int virDomainGetMaxVcpus (virDomainPtr domain);
int virDomainGetSecurityLabel (virDomainPtr domain,
virSecurityLabelPtr seclabel);
-
+/**
+ * virDomainGetHostnameFlags:
+ *
+ * Since: v6.1.0
+ *
+ */
typedef enum {
VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file (Since:
v6.1.0) */
VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent (Since:
v6.1.0) */
@@ -2297,8 +2309,14 @@ int virDomainMemoryStats (virDomainPtr dom,
unsigned int nr_stats,
unsigned int flags);
-/* Memory peeking flags. */
-
+/**
+ * virDomainMemoryFlags:
+ *
+ * Memory peeking flags.
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses
(Since: v1.0.0) */
VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses
(Since: v1.0.0) */
@@ -2310,6 +2328,12 @@ int virDomainMemoryPeek (virDomainPtr dom,
void *buffer,
unsigned int flags);
+/**
+ * virDomainDefineFlags:
+ *
+ * Since: v1.2.12
+ *
+ */
typedef enum {
VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against
schema (Since: v1.2.12) */
} virDomainDefineFlags;
@@ -2423,6 +2447,12 @@ typedef enum {
# endif
} virVcpuState;
+/**
+ * virVcpuHostCpuState:
+ *
+ * Since: v6.10.0
+ *
+ */
typedef enum {
VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline (Since: v6.10.0) */
VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU
information (Since: v6.10.0) */
@@ -2443,7 +2473,7 @@ struct _virVcpuInfo {
};
/**
- * *virVcpuInfoPtr:
+ * virVcpuInfoPtr:
*
* Since: v1.0.0
*
@@ -2513,6 +2543,14 @@ int virDomainGetEmulatorPinInfo (virDomainPtr
domain,
*
*/
typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo;
+
+
+/**
+ * virDomainIOThreadInfoPtr:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr;
struct _virDomainIOThreadInfo {
unsigned int iothread_id; /* IOThread ID */
@@ -2746,6 +2784,13 @@ int virDomainDetachDeviceAlias(virDomainPtr domain,
*
*/
typedef struct _virDomainStatsRecord virDomainStatsRecord;
+
+/**
+ * virDomainStatsRecordPtr:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef virDomainStatsRecord *virDomainStatsRecordPtr;
struct _virDomainStatsRecord {
virDomainPtr dom;
@@ -2772,6 +2817,12 @@ typedef enum {
VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since:
v7.2.0) */
} virDomainStatsTypes;
+/**
+ * virConnectGetAllDomainStatsFlags:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef enum {
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE,
@@ -3180,13 +3231,27 @@ typedef enum {
int virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
unsigned int flags);
-/* Flags for use with virDomainGetBlockJobInfo */
+/**
+ * virDomainBlockJobInfoFlags:
+ *
+ * Flags for use with virDomainGetBlockJobInfo
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
instead of MiB/s (Since:
v1.2.9) */
} virDomainBlockJobInfoFlags;
-/* An iterator for monitoring block job operations */
+/**
+ * virDomainBlockJobCursor:
+ *
+ * An iterator for monitoring block job operations
+ *
+ * Since: v1.0.0
+ *
+ */
typedef unsigned long long virDomainBlockJobCursor;
/**
@@ -3211,7 +3276,7 @@ struct _virDomainBlockJobInfo {
};
/**
- * *virDomainBlockJobInfoPtr:
+ * virDomainBlockJobInfoPtr:
*
* Since: v1.0.0
*
@@ -3222,7 +3287,14 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk,
virDomainBlockJobInfoPtr info,
unsigned int flags);
-/* Flags for use with virDomainBlockJobSetSpeed */
+/**
+ * virDomainBlockJobSetSpeedFlags:
+ *
+ * Flags for use with virDomainBlockJobSetSpeed
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
instead of MiB/s (Since:
v1.2.9) */
@@ -3231,8 +3303,15 @@ typedef enum {
int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk,
unsigned long bandwidth, unsigned int flags);
-/* Flags for use with virDomainBlockPull (values chosen to be a subset
- * of the flags for virDomainBlockRebase) */
+/**
+ * virDomainBlockPullFlags:
+ *
+ * Flags for use with virDomainBlockPull (values chosen to be a subset of the
+ * flags for virDomainBlockRebase)
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s
instead of MiB/s (Since: v1.2.9)
*/
@@ -3635,7 +3714,7 @@ typedef enum {
typedef struct _virDomainDiskError virDomainDiskError;
/**
- * *virDomainDiskErrorPtr:
+ * virDomainDiskErrorPtr:
*
* Since: v1.0.0
*
@@ -4177,7 +4256,7 @@ typedef enum {
typedef struct _virDomainJobInfo virDomainJobInfo;
/**
- * *virDomainJobInfoPtr:
+ * virDomainJobInfoPtr:
*
* Since: v1.0.0
*
@@ -6081,7 +6160,15 @@ int virDomainFSThaw(virDomainPtr dom,
*
*/
typedef struct _virDomainFSInfo virDomainFSInfo;
+
+/**
+ * virDomainFSInfoPtr:
+ *
+ * Since: v1.2.11
+ *
+ */
typedef virDomainFSInfo *virDomainFSInfoPtr;
+
struct _virDomainFSInfo {
char *mountpoint; /* path to mount point */
char *name; /* device name in the guest (e.g. "sda1") */
@@ -6100,7 +6187,12 @@ int virDomainGetTime(virDomainPtr dom,
long long *seconds,
unsigned int *nseconds,
unsigned int flags);
-
+/**
+ * virDomainSetTimeFlags:
+ *
+ * Since: v1.2.5
+ *
+ */
typedef enum {
VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC
(Since: v1.2.5) */
} virDomainSetTimeFlags;
@@ -6319,6 +6411,13 @@ struct _virDomainInterfaceIPAddress {
*
*/
typedef struct _virDomainInterface virDomainInterface;
+
+/**
+ * virDomainInterfacePtr:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef virDomainInterface *virDomainInterfacePtr;
struct _virDomainInterface {
char *name; /* interface name */
@@ -6334,6 +6433,12 @@ int virDomainInterfaceAddresses(virDomainPtr dom,
void virDomainInterfaceFree(virDomainInterfacePtr iface);
+/**
+ * virDomainSetUserPasswordFlags:
+ *
+ * Since: v1.2.16
+ *
+ */
typedef enum {
VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted
(Since: v1.2.16) */
} virDomainSetUserPasswordFlags;
@@ -6554,6 +6659,12 @@ int virDomainAgentSetResponseTimeout(virDomainPtr domain,
int timeout,
unsigned int flags);
+/**
+ * virDomainBackupBeginFlags:
+ *
+ * Since: v6.0.0
+ *
+ */
typedef enum {
VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL = (1 << 0), /* reuse separately
provided images (Since: v6.0.0)
*/
@@ -6572,6 +6683,12 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain,
char ***keys,
unsigned int flags);
+/**
+ * virDomainAuthorizedSSHKeysSetFlags:
+ *
+ * Since: v6.10.0
+ *
+ */
typedef enum {
VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate
file, just append (Since: v6.10.0) */
VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead
of adding them (Since: v6.10.0) */
diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h
index d366cc903e..74d3583bd7 100644
--- a/include/libvirt/libvirt-host.h
+++ b/include/libvirt/libvirt-host.h
@@ -645,7 +645,12 @@ typedef enum {
VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases
(Since: v1.0.0) */
} virConnectFlags;
-
+/**
+ * virConnectCredentialType:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_CRED_USERNAME = 1, /* Identity to act as (Since: v1.0.0) */
VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: v1.0.0) */
@@ -724,6 +729,12 @@ struct _virConnectAuth {
*/
typedef struct _virConnectAuth virConnectAuth;
+/**
+ * virConnectAuthPtr:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef virConnectAuth *virConnectAuthPtr;
/*
@@ -1049,7 +1060,12 @@ int virNodeGetFreePages(virConnectPtr conn,
unsigned int cellcount,
unsigned long long *counts,
unsigned int flags);
-
+/**
+ * virNodeAllocPagesFlags:
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_NODE_ALLOC_PAGES_ADD = 0, /* Add @pageCounts to the pages pool. This
can be used only to size up the pool. (Since:
v1.2.9) */
diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-interface.h
index 22a90a6452..bf7e915432 100644
--- a/include/libvirt/libvirt-interface.h
+++ b/include/libvirt/libvirt-interface.h
@@ -84,10 +84,22 @@ virInterfacePtr virInterfaceLookupByMACString (virConnectPtr
conn,
const char* virInterfaceGetName (virInterfacePtr iface);
const char* virInterfaceGetMACString (virInterfacePtr iface);
+/**
+ * virInterfaceXMLFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information
(Since: v1.0.0) */
} virInterfaceXMLFlags;
+/**
+ * virInterfaceDefineFlags:
+ *
+ * Since: v7.7.0
+ *
+ */
typedef enum {
VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.7.0) */
} virInterfaceDefineFlags;
diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-network.h
index 0457771fb7..953a11e8f3 100644
--- a/include/libvirt/libvirt-network.h
+++ b/include/libvirt/libvirt-network.h
@@ -27,6 +27,12 @@
# error "Don't include this file directly, only use libvirt/libvirt.h"
# endif
+/**
+ * virNetworkXMLFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information
(Since: v1.0.0) */
} virNetworkXMLFlags;
@@ -127,7 +133,12 @@ virNetworkPtr virNetworkLookupByUUID
(virConnectPtr conn,
const unsigned char *uuid);
virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn,
const char *uuid);
-
+/**
+ * virNetworkCreateFlags:
+ *
+ * Since: v7.8.0
+ *
+ */
typedef enum {
VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.8.0) */
} virNetworkCreateFlags;
@@ -140,7 +151,12 @@ virNetworkPtr virNetworkCreateXML (virConnectPtr conn,
virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn,
const char *xmlDesc,
unsigned int flags);
-
+/**
+ * virNetworkDefineFlags:
+ *
+ * Since: v7.7.0
+ *
+ */
typedef enum {
VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.7.0) */
} virNetworkDefineFlags;
@@ -362,6 +378,13 @@ typedef enum {
*
*/
typedef struct _virNetworkDHCPLease virNetworkDHCPLease;
+
+/**
+ * virNetworkDHCPLeasePtr:
+ *
+ * Since: v1.2.6
+ *
+ */
typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr;
struct _virNetworkDHCPLease {
char *iface; /* Network interface name */
diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-nwfilter.h
index 5c78ea9d8b..8497d85f48 100644
--- a/include/libvirt/libvirt-nwfilter.h
+++ b/include/libvirt/libvirt-nwfilter.h
@@ -91,7 +91,12 @@ virNWFilterPtr virNWFilterLookupByUUID (virConnectPtr
conn,
const unsigned char *uuid);
virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn,
const char *uuid);
-
+/**
+ * virNWFilterDefineFlags:
+ *
+ * Since: v7.7.0
+ *
+ */
typedef enum {
VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.7.0) */
} virNWFilterDefineFlags;
@@ -120,6 +125,12 @@ int virNWFilterFree (virNWFilterPtr
nwfilter);
* NWFilter information
*/
+/**
+ * virNWFilterBindingCreateFlags:
+ *
+ * Since: v7.8.0
+ *
+ */
typedef enum {
VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document
against schema (Since: v7.8.0) */
} virNWFilterBindingCreateFlags;
diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h
index b85e77f5b1..e4c74d72c6 100644
--- a/include/libvirt/libvirt-qemu.h
+++ b/include/libvirt/libvirt-qemu.h
@@ -30,6 +30,12 @@
extern "C" {
# endif
+/**
+ * virDomainQemuMonitorCommandFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0,
VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since:
v1.0.0) */
diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h
index 1f0fc41c0c..a33cbc8779 100644
--- a/include/libvirt/libvirt-secret.h
+++ b/include/libvirt/libvirt-secret.h
@@ -38,6 +38,13 @@
*
*/
typedef struct _virSecret virSecret;
+
+/**
+ * virSecretPtr:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef virSecret *virSecretPtr;
/**
@@ -100,7 +107,12 @@ virSecretPtr virSecretLookupByUUIDString(virConnectPtr
conn,
virSecretPtr virSecretLookupByUsage(virConnectPtr conn,
int usageType,
const char *usageID);
-
+/**
+ * virSecretDefineFlags:
+ *
+ * Since: v7.7.0
+ *
+ */
typedef enum {
VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.7.0) */
} virSecretDefineFlags;
diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h
index 8f0352237c..3ce8ca92d6 100644
--- a/include/libvirt/libvirt-storage.h
+++ b/include/libvirt/libvirt-storage.h
@@ -68,6 +68,12 @@ typedef enum {
# endif
} virStoragePoolState;
+/**
+ * virStoragePoolBuildFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: v1.0.0) */
VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since:
v1.0.0) */
@@ -76,6 +82,12 @@ typedef enum {
VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: v1.0.0)
*/
} virStoragePoolBuildFlags;
+/**
+ * virStoragePoolDeleteFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v1.0.0)
*/
VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow)
(Since: v1.0.0) */
@@ -255,8 +267,21 @@ struct _virStorageVolInfo {
unsigned long long allocation; /* Current allocation bytes */
};
+
+/**
+ * virStorageVolInfoPtr:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef virStorageVolInfo *virStorageVolInfoPtr;
+/**
+ * virStorageXMLFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume
information (Since: v1.0.0) */
} virStorageXMLFlags;
@@ -346,7 +371,12 @@ virStoragePoolPtr
virStoragePoolLookupByUUIDString(virConnectPtr conn,
virStoragePoolPtr virStoragePoolLookupByVolume (virStorageVolPtr vol);
virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn,
const char *path);
-
+/**
+ * virStoragePoolDefineFlags:
+ *
+ * Since: v7.7.0
+ *
+ */
typedef enum {
VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against
schema (Since: v7.7.0) */
} virStoragePoolDefineFlags;
@@ -438,7 +468,12 @@ virStorageVolPtr virStorageVolCreateXMLFrom
(virStoragePoolPtr pool,
const char *xmldesc,
virStorageVolPtr clonevol,
unsigned int flags);
-
+/**
+ * virStorageVolDownloadFlags:
+ *
+ * Since: v3.4.0
+ *
+ */
typedef enum {
VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since:
v3.4.0) */
} virStorageVolDownloadFlags;
@@ -448,6 +483,13 @@ int virStorageVolDownload
(virStorageVolPtr vol,
unsigned long long offset,
unsigned long long length,
unsigned int flags);
+
+/**
+ * virStorageVolUploadFlags:
+ *
+ * Since: v3.4.0
+ *
+ */
typedef enum {
VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since:
v3.4.0) */
} virStorageVolUploadFlags;
@@ -477,6 +519,12 @@ char * virStorageVolGetXMLDesc
(virStorageVolPtr pool,
char * virStorageVolGetPath (virStorageVolPtr vol);
+/**
+ * virStorageVolResizeFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size
(Since: v1.0.0) */
VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current
(Since: v1.0.0) */
diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h
index 76b20e410c..aa47d59ba1 100644
--- a/include/libvirt/virterror.h
+++ b/include/libvirt/virterror.h
@@ -164,6 +164,13 @@ typedef enum {
*/
typedef struct _virError virError;
+
+/**
+ * virErrorPtr:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef virError *virErrorPtr;
struct _virError {
int code; /* The error code, a virErrorNumber */
--
2.35.1