This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 19/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-storage.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index b23961cad5..94802bb2c5 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -292,7 +292,7 @@ int virConnectListDefinedStoragePools(virConnectPtr conn, * Note that these flags come in groups; if all bits from a group are 0, * then that group is not used to filter results. * - * Since: v1.0.0 + * Since: v0.10.2 */ typedef enum { VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, -- 2.35.1

This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 21/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-domain.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index ad920f230d..1b2d50e7c6 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1755,7 +1755,7 @@ int virDomainGetMemoryParameters(virDomainPtr domain, * * Memory size modification flags. * - * Since: v1.0.0 + * Since: v0.9.0 */ typedef enum { /* See virDomainModificationImpact for these flags. */ -- 2.35.1

scripts/apibuild.py does not handle well enum's with comments between values. The outcome depends on whether the enum value has its own docstring or not and if there is spaces between the enum values or not. This commit removes some generic comments that I have spotted. Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-domain.h | 6 ------ include/libvirt/libvirt-storage.h | 1 - 2 files changed, 7 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 138133b719..0fa4509b73 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1758,12 +1758,10 @@ int virDomainGetMemoryParameters(virDomainPtr domain, * Since: v0.9.0 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, - /* Additionally, these flags may be bitwise-OR'd in. */ VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current */ } virDomainMemoryModFlags; @@ -2267,12 +2265,10 @@ typedef virVcpuInfo *virVcpuInfoPtr; * Since: v0.8.5 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, - /* Additionally, these flags may be bitwise-OR'd in. */ VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count */ VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest */ VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable */ @@ -2514,12 +2510,10 @@ int virDomainGetVcpus (virDomainPtr domain, * Since: v0.7.7 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, - /* Additionally, these flags may be bitwise-OR'd in. */ VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) */ } virDomainDeviceModifyFlags; diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index 94802bb2c5..46803eba2d 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -304,7 +304,6 @@ typedef enum { VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, - /* List pools by type */ VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, -- 2.35.1

Either create or append to existing docstring, the version (git tag) that a given enum value was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-domain-checkpoint.h | 28 +- include/libvirt/libvirt-domain-snapshot.h | 60 +- include/libvirt/libvirt-domain.h | 1196 +++++++++++-------- include/libvirt/libvirt-event.h | 8 +- include/libvirt/libvirt-host.h | 58 +- include/libvirt/libvirt-interface.h | 8 +- include/libvirt/libvirt-network.h | 88 +- include/libvirt/libvirt-nodedev.h | 66 +- include/libvirt/libvirt-nwfilter.h | 4 +- include/libvirt/libvirt-secret.h | 36 +- include/libvirt/libvirt-storage.h | 166 +-- include/libvirt/libvirt-stream.h | 12 +- include/libvirt/virterror.h | 406 +++---- 13 files changed, 1150 insertions(+), 986 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/libvirt-domain-checkpoint.h index d5dea750db..5476325503 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -61,13 +61,13 @@ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint); */ typedef enum { VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE = (1 << 0), /* Restore or alter - metadata */ + metadata (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_QUIESCE = (1 << 1), /* use guest agent to quiesce all mounted file systems within - the domain */ + the domain (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE_VALIDATE = (1 << 2), /* validate disk data state - when redefining a checkpoint */ + when redefining a checkpoint (Since: v6.10.0) */ } virDomainCheckpointCreateFlags; /* Create a checkpoint using the current VM state. */ @@ -80,11 +80,11 @@ virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, * Since: v5.6.0 */ typedef enum { - VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data */ + VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN = (1 << 1), /* Suppress <domain> - subelement */ + subelement (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_SIZE = (1 << 2), /* Include dynamic - per-<disk> size */ + per-<disk> size (Since: v5.6.0) */ } virDomainCheckpointXMLFlags; /* Dump the XML of a checkpoint */ @@ -106,18 +106,18 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, typedef enum { VIR_DOMAIN_CHECKPOINT_LIST_ROOTS = (1 << 0), /* Filter by checkpoints with no parents, when - listing a domain */ + listing a domain (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_DESCENDANTS = (1 << 0), /* List all descendants, not just children, when - listing a checkpoint */ + listing a checkpoint (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL = (1 << 1), /* Ensure parents occur before children in - the resulting list */ + the resulting list (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_LEAVES = (1 << 2), /* Filter by checkpoints - with no children */ + with no children (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES = (1 << 3), /* Filter by checkpoints - that have children */ + that have children (Since: v5.6.0) */ } virDomainCheckpointListFlags; /* Get all checkpoint objects for this domain */ @@ -147,9 +147,9 @@ virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr check * Since: v5.6.0 */ typedef enum { - VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children */ - VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata */ - VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children */ + 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) */ + VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v5.6.0) */ } virDomainCheckpointDeleteFlags; int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/libvirt-domain-snapshot.h index 35eeb21e27..0f4124925c 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -60,28 +60,28 @@ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot); */ typedef enum { VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE = (1 << 0), /* Restore or alter - metadata */ + metadata (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT = (1 << 1), /* With redefine, make - snapshot current */ + snapshot current (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA = (1 << 2), /* Make snapshot without - remembering it */ + remembering it (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_HALT = (1 << 3), /* Stop running guest - after snapshot */ + after snapshot (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY = (1 << 4), /* disk snapshot, not - full system */ + full system (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT = (1 << 5), /* reuse any existing - external files */ + external files (Since: v0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE = (1 << 6), /* use guest agent to quiesce all mounted file systems within - the domain */ + the domain (Since: v0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC = (1 << 7), /* atomically avoid - partial changes */ + partial changes (Since: v0.9.11) */ VIR_DOMAIN_SNAPSHOT_CREATE_LIVE = (1 << 8), /* create the snapshot while the guest is - running */ + running (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_CREATE_VALIDATE = (1 << 9), /* validate the XML - against the schema */ + against the schema (Since: v5.6.0) */ } virDomainSnapshotCreateFlags; /* Take a snapshot of the current VM state */ @@ -94,7 +94,7 @@ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, * Since: v5.1.0 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too */ + VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */ } virDomainSnapshotXMLFlags; /* Dump the XML of a snapshot */ @@ -118,45 +118,45 @@ char *virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, typedef enum { VIR_DOMAIN_SNAPSHOT_LIST_ROOTS = (1 << 0), /* Filter by snapshots with no parents, when - listing a domain */ + listing a domain (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS = (1 << 0), /* List all descendants, not just children, when listing a snapshot */ - /* For historical reasons, groups do not use contiguous bits. */ + /* For historical reasons, groups do not use contiguous bits. (Since: v0.9.7) */ VIR_DOMAIN_SNAPSHOT_LIST_LEAVES = (1 << 2), /* Filter by snapshots - with no children */ + with no children (Since: v0.9.7) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_LEAVES = (1 << 3), /* Filter by snapshots - that have children */ + that have children (Since: v0.9.13) */ VIR_DOMAIN_SNAPSHOT_LIST_METADATA = (1 << 1), /* Filter by snapshots - which have metadata */ + which have metadata (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_METADATA = (1 << 4), /* Filter by snapshots - with no metadata */ + with no metadata (Since: v0.9.13) */ VIR_DOMAIN_SNAPSHOT_LIST_INACTIVE = (1 << 5), /* Filter by snapshots taken while guest was - shut off */ + shut off (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_ACTIVE = (1 << 6), /* Filter by snapshots taken while guest was active, and with - memory state */ + memory state (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_DISK_ONLY = (1 << 7), /* Filter by snapshots taken while guest was active, but without - memory state */ + memory state (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_INTERNAL = (1 << 8), /* Filter by snapshots stored internal to - disk images */ + disk images (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_EXTERNAL = (1 << 9), /* Filter by snapshots that use files external - to disk images */ + to disk images (Since: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_TOPOLOGICAL = (1 << 10), /* Ensure parents occur before children in - the resulting list */ + the resulting list (Since: v5.2.0) */ } virDomainSnapshotListFlags; /* Return the number of snapshots for this domain */ @@ -216,10 +216,10 @@ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, * Since: v0.9.5 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert */ - VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert */ - VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts */ - VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template */ + VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: v0.9.7) */ + VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */ } virDomainSnapshotRevertFlags; /* Revert the domain to a point-in-time snapshot. The @@ -237,9 +237,9 @@ int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children */ - VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata */ - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v0.8.0) */ + VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v0.9.5) */ } virDomainSnapshotDeleteFlags; int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 0fa4509b73..5e165f60ed 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -55,15 +55,15 @@ typedef virDomain *virDomainPtr; * Since: v0.0.1 */ typedef enum { - VIR_DOMAIN_NOSTATE = 0, /* no state */ - VIR_DOMAIN_RUNNING = 1, /* the domain is running */ - VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource */ - VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user */ - VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down */ - VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off */ - VIR_DOMAIN_CRASHED = 6, /* the domain is crashed */ + VIR_DOMAIN_NOSTATE = 0, /* no state (Since: v0.0.1) */ + VIR_DOMAIN_RUNNING = 1, /* the domain is running (Since: v0.0.1) */ + VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource (Since: v0.0.1) */ + VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user (Since: v0.0.1) */ + VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down (Since: v0.0.1) */ + VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off (Since: v0.0.1) */ + VIR_DOMAIN_CRASHED = 6, /* the domain is crashed (Since: v0.0.2) */ VIR_DOMAIN_PMSUSPENDED = 7, /* the domain is suspended by guest - power management */ + power management (Since: v0.9.11) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_LAST @@ -71,6 +71,8 @@ typedef enum { * NB: this enum value will increase over time as new states are * added to the libvirt API. It reflects the last state supported * by this version of the libvirt API. + * + * Since: v0.9.5 */ # endif } virDomainState; @@ -81,10 +83,10 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_NOSTATE_UNKNOWN = 0, + VIR_DOMAIN_NOSTATE_UNKNOWN = 0, /* (Since: v0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_NOSTATE_LAST + VIR_DOMAIN_NOSTATE_LAST /* (Since: v0.9.10) */ # endif } virDomainNostateReason; @@ -94,21 +96,21 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_RUNNING_UNKNOWN = 0, - VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot */ - VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host */ - VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file */ - VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot */ - VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state */ - VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration */ - VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process */ + VIR_DOMAIN_RUNNING_UNKNOWN = 0, /* (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process (Since: v0.9.2) */ VIR_DOMAIN_RUNNING_WAKEUP = 8, /* returned from pmsuspended due to - wakeup event */ - VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed */ - VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode */ + wakeup event (Since: v0.9.11) */ + VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed (Since: v1.1.1) */ + VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode (Since: v1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_RUNNING_LAST + VIR_DOMAIN_RUNNING_LAST /* (Since: v0.9.10) */ # endif } virDomainRunningReason; @@ -118,10 +120,10 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown */ + VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCKED_LAST + VIR_DOMAIN_BLOCKED_LAST /* (Since: v0.9.10) */ # endif } virDomainBlockedReason; @@ -131,23 +133,23 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown */ - VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request */ - VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration */ - VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save */ - VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump */ - VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error */ - VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event */ - VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot */ - VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process */ - VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot */ - VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash */ - VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started */ - VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration */ - VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy */ + VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process (Since: v0.9.5) */ + VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot (Since: v1.0.1) */ + VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash (Since: v1.1.1) */ + VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started (Since: v1.2.14) */ + VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration (Since: v1.3.3) */ + VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy (Since: v1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PAUSED_LAST + VIR_DOMAIN_PAUSED_LAST /* (Since: v0.9.10) */ # endif } virDomainPausedReason; @@ -157,11 +159,11 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown */ - VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request */ + VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ + VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: v0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_SHUTDOWN_LAST + VIR_DOMAIN_SHUTDOWN_LAST /* (Since: v0.9.10) */ # endif } virDomainShutdownReason; @@ -171,19 +173,19 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown */ - VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown */ - VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff */ - VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed */ - VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host */ - VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file */ - VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start */ + VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start (Since: v0.9.2) */ VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT = 7, /* restored from a snapshot which was - * taken while domain was shutoff */ + * taken while domain was shutoff (Since: v0.9.2) */ VIR_DOMAIN_SHUTOFF_DAEMON = 8, /* daemon decides to kill domain - during reconnection processing */ + during reconnection processing (Since: v4.10.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_SHUTOFF_LAST + VIR_DOMAIN_SHUTOFF_LAST /* (Since: v0.9.10) */ # endif } virDomainShutoffReason; @@ -193,11 +195,11 @@ typedef enum { * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason */ - VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked */ + VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: v0.9.2) */ + VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: v1.1.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CRASHED_LAST + VIR_DOMAIN_CRASHED_LAST /* (Since: v0.9.10) */ # endif } virDomainCrashedReason; @@ -207,10 +209,10 @@ typedef enum { * Since: v0.9.11 */ typedef enum { - VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, + VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, /* (Since: v0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_LAST + VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: v0.9.11) */ # endif } virDomainPMSuspendedReason; @@ -220,10 +222,10 @@ typedef enum { * Since: v1.0.0 */ typedef enum { - VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, + VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, /* (Since: v1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_DISK_LAST + VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: v1.0.0) */ # endif } virDomainPMSuspendedDiskReason; @@ -235,17 +237,17 @@ typedef enum { * Since: v0.9.3 */ typedef enum { - VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands */ + VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: v0.9.3) */ VIR_DOMAIN_CONTROL_JOB = 1, /* background job is running (can be monitored by virDomainGetJobInfo); only - limited set of commands may be allowed */ - VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command */ + limited set of commands may be allowed (Since: v0.9.3) */ + VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command (Since: v0.9.3) */ VIR_DOMAIN_CONTROL_ERROR = 3, /* unusable, domain cannot be fully operated, possible reason is provided - in the details field */ + in the details field (Since: v0.9.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CONTROL_LAST + VIR_DOMAIN_CONTROL_LAST /* (Since: v0.9.10) */ # endif } virDomainControlState; @@ -258,16 +260,16 @@ typedef enum { */ typedef enum { VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0, /* server didn't provide a - reason */ + reason (Since: v1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_UNKNOWN = 1, /* unknown reason for the - error */ + error (Since: v1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_MONITOR = 2, /* monitor connection is - broken */ + broken (Since: v1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_INTERNAL = 3, /* error caused due to - internal failure in libvirt + internal failure in libvirt (Since: v1.2.14) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CONTROL_ERROR_REASON_LAST + VIR_DOMAIN_CONTROL_ERROR_REASON_LAST /* (Since: v1.2.14) */ # endif } virDomainControlErrorReason; @@ -319,10 +321,10 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * Since: v0.9.2 */ typedef enum { - VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. */ - VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. */ + VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: v0.9.2) */ + VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. (Since: v0.9.2) */ VIR_DOMAIN_AFFECT_CONFIG = 1 << 1, /* Affect persistent domain state. */ - /* 1 << 2 is reserved for virTypedParameterFlags */ + /* 1 << 2 is reserved for virTypedParameterFlags (Since: v0.9.2) */ } virDomainModificationImpact; /** @@ -361,13 +363,13 @@ typedef virDomainInfo *virDomainInfoPtr; * Since: v0.0.1 */ typedef enum { - VIR_DOMAIN_NONE = 0, /* Default behavior */ - VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state */ - VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed */ - VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution */ - VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save */ - VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema */ - VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template */ + VIR_DOMAIN_NONE = 0, /* Default behavior (Since: v0.0.1) */ + VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state (Since: v0.8.2) */ + VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed (Since: v0.9.3) */ + VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution (Since: v0.9.4) */ + VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save (Since: v0.9.5) */ + VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema (Since: v1.2.12) */ + VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template (Since: v8.1.0) */ } virDomainCreateFlags; @@ -710,9 +712,9 @@ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr; * Since: v0.7.5 */ typedef enum { - /* The total amount of data read from swap space (in kB). */ + /* The total amount of data read from swap space (in kB). (Since: v0.7.5) */ VIR_DOMAIN_MEMORY_STAT_SWAP_IN = 0, - /* The total amount of memory written out to swap space (in kB). */ + /* The total amount of memory written out to swap space (in kB). (Since: v0.7.5) */ VIR_DOMAIN_MEMORY_STAT_SWAP_OUT = 1, /* @@ -720,14 +722,24 @@ typedef enum { * that is not available. When servicing the page fault, if disk IO is * required, it is considered a major fault. If not, it is a minor fault. * These are expressed as the number of faults that have occurred. + * + * Since: v0.7.5 + * */ VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT = 2, + + /* + * Since: v0.7.5 + */ VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT = 3, /* * The amount of memory left completely unused by the system. Memory that * is available but used for reclaimable caches should NOT be reported as * free. This value is expressed in kB. + * + * Since: v0.7.5 + * */ VIR_DOMAIN_MEMORY_STAT_UNUSED = 4, @@ -736,52 +748,82 @@ typedef enum { * may be less than the amount of memory assigned to the domain if a * balloon driver is in use or if the guest OS does not initialize all * assigned pages. This value is expressed in kB. + * + * Since: v0.7.5 + * */ VIR_DOMAIN_MEMORY_STAT_AVAILABLE = 5, - /* Current balloon value (in KB). */ + /* + * Current balloon value (in KB). + * + * Since: v0.9.3 + * + */ VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON = 6, /* Resident Set Size of the process running the domain. This value - * is in kB */ + * is in kB + * + * Since: v0.9.10 + */ VIR_DOMAIN_MEMORY_STAT_RSS = 7, /* * How much the balloon can be inflated without pushing the guest system * to swap, corresponds to 'Available' in /proc/meminfo + * + * Since: v2.1.0 + * */ VIR_DOMAIN_MEMORY_STAT_USABLE = 8, - /* Timestamp of the last update of statistics, in seconds. */ + /* + * Timestamp of the last update of statistics, in seconds. + * + * Since: v2.1.0 + */ VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE = 9, /* * The amount of memory, that can be quickly reclaimed without * additional I/O (in kB). Typically these pages are used for caching files * from disk. + * + * Since: v4.6.0 + * */ VIR_DOMAIN_MEMORY_STAT_DISK_CACHES = 10, /* * The number of successful huge page allocations from inside the domain via * virtio balloon. + * + * Since: v5.4.0 + * */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGALLOC = 11, /* * The number of failed huge page allocations from inside the domain via * virtio balloon. + * + * Since: v5.4.0 + * */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGFAIL = 12, /* * The number of statistics supported by this version of the interface. * To add new statistics, add them to the enum and increase this value. + * + * Since: v0.7.5 + * */ VIR_DOMAIN_MEMORY_STAT_NR = 13, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR + VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR /* (Since: v0.9.10) */ # endif } virDomainMemoryStatTags; @@ -813,11 +855,11 @@ typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; * Since: v0.7.5 */ typedef enum { - VIR_DUMP_CRASH = (1 << 0), /* crash after dump */ - VIR_DUMP_LIVE = (1 << 1), /* live dump */ - VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution */ - VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes */ - VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory */ + VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: v0.7.5) */ + VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: v0.7.5) */ + VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution (Since: v0.9.4) */ + VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes (Since: v0.9.7) */ + VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory (Since: v0.9.13) */ } virDomainCoreDumpFlags; /** @@ -828,20 +870,22 @@ typedef enum { * Since: v1.2.3 */ typedef enum { - VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format */ + VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: v1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB, /* kdump-compressed format, with - * zlib compression */ + * zlib compression (Since: v1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_LZO, /* kdump-compressed format, with - * lzo compression */ + * lzo compression (Since: v1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_SNAPPY, /* kdump-compressed format, with - * snappy compression */ - VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format */ + * snappy compression (Since: v1.2.3) */ + VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format (Since: v7.4.0) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_CORE_DUMP_FORMAT_LAST /* * NB: this enum value will increase over time as new formats are * added to the libvirt API. It reflects the last format supported * by this version of the libvirt API. + * + * Since: v1.2.3 */ # endif } virDomainCoreDumpFormat; @@ -859,6 +903,9 @@ typedef enum { * The migration may never converge if the domain is changing its memory * faster then it can be transferred. The domain can be manually paused * anytime during migration using virDomainSuspend. + * + * Since: v0.3.2 + * */ VIR_MIGRATE_LIVE = (1 << 0), @@ -867,6 +914,9 @@ typedef enum { * controls the migration process. In peer-to-peer mode, the source * libvirtd controls the migration by calling the destination daemon * directly. + * + * Since: v0.7.2 + * */ VIR_MIGRATE_PEER2PEER = (1 << 1), @@ -877,6 +927,9 @@ typedef enum { * * Note the less-common spelling that we're stuck with: * VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED. + * + * Since: v0.7.2 + * */ VIR_MIGRATE_TUNNELLED = (1 << 2), @@ -884,17 +937,26 @@ typedef enum { * migration. If the domain was persistent on the source host and * VIR_MIGRATE_UNDEFINE_SOURCE is not used, it will end up persistent on * both hosts. + * + * Since: v0.7.3 + * */ VIR_MIGRATE_PERSIST_DEST = (1 << 3), /* Undefine the domain on the source host once migration successfully * finishes. + * + * Since: v0.7.3 + * */ VIR_MIGRATE_UNDEFINE_SOURCE = (1 << 4), /* Leave the domain suspended on the destination host. virDomainResume (on * the virDomainPtr returned by the migration API) has to be called * explicitly to resume domain's virtual CPUs. + * + * Since: v0.7.5 + * */ VIR_MIGRATE_PAUSED = (1 << 5), @@ -904,6 +966,9 @@ typedef enum { * disks should be migrated. * * This flag and VIR_MIGRATE_NON_SHARED_INC are mutually exclusive. + * + * Since: v0.8.2 + * */ VIR_MIGRATE_NON_SHARED_DISK = (1 << 6), @@ -914,6 +979,9 @@ typedef enum { * on the source host. * * This flag and VIR_MIGRATE_NON_SHARED_DISK are mutually exclusive. + * + * Since: v0.8.2 + * */ VIR_MIGRATE_NON_SHARED_INC = (1 << 7), @@ -921,6 +989,9 @@ typedef enum { * process. This flag is used automatically when both sides support it. * Explicitly setting this flag will cause migration to fail if either the * source or the destination does not support it. + * + * Since: v0.9.4 + * */ VIR_MIGRATE_CHANGE_PROTECTION = (1 << 8), @@ -931,6 +1002,9 @@ typedef enum { * without explicitly setting cache mode to "none". Migrating such domains * is unsafe unless the disk images are stored on coherent clustered * filesystem, such as GFS2 or GPFS. + * + * Since: v0.9.11 + * */ VIR_MIGRATE_UNSAFE = (1 << 9), @@ -940,6 +1014,9 @@ typedef enum { * * Offline migration may not copy disk storage or any other file based * storage (such as UEFI variables). + * + * Since: v1.0.1 + * */ VIR_MIGRATE_OFFLINE = (1 << 10), @@ -947,11 +1024,17 @@ typedef enum { * VIR_MIGRATE_PARAM_COMPRESSION. A hypervisor default method will be used * if this parameter is omitted. Individual compression methods can be * tuned via their specific VIR_MIGRATE_PARAM_COMPRESSION_* parameters. + * + * Since: v1.0.3 + * */ VIR_MIGRATE_COMPRESSED = (1 << 11), /* Cancel migration if a soft error (such as I/O error) happens during * migration. + * + * Since: v1.1.0 + * */ VIR_MIGRATE_ABORT_ON_ERROR = (1 << 12), @@ -960,6 +1043,9 @@ typedef enum { * not change its memory faster than a hypervisor can transfer the changed * memory to the destination host. VIR_MIGRATE_PARAM_AUTO_CONVERGE_* * parameters can be used to tune the algorithm. + * + * Since: v1.2.3 + * */ VIR_MIGRATE_AUTO_CONVERGE = (1 << 13), @@ -977,6 +1063,9 @@ typedef enum { * most of the host's memory). Doing so may be dangerous to both the * domain and the host itself since the host's kernel may run out of * memory. + * + * Since: v1.2.9 + * */ VIR_MIGRATE_RDMA_PIN_ALL = (1 << 14), @@ -984,6 +1073,9 @@ typedef enum { * migration. However, the migration will start normally and * virDomainMigrateStartPostCopy needs to be called to switch it into the * post-copy mode. See virDomainMigrateStartPostCopy for more details. + * + * Since: v1.3.3 + * */ VIR_MIGRATE_POSTCOPY = (1 << 15), @@ -991,12 +1083,18 @@ typedef enum { * to use the TLS environment configured by the hypervisor in order to * perform the migration. If incorrectly configured on either source or * destination, the migration will fail. + * + * Since: v3.2.0 + * */ VIR_MIGRATE_TLS = (1 << 16), /* Send memory pages to the destination host through several network * connections. See VIR_MIGRATE_PARAM_PARALLEL_* parameters for * configuring the parallel migration. + * + * Since: v5.2.0 + * */ VIR_MIGRATE_PARALLEL = (1 << 17), @@ -1007,6 +1105,9 @@ typedef enum { * * Requires one of VIR_MIGRATE_NON_SHARED_DISK, VIR_MIGRATE_NON_SHARED_INC * to be present as well. + * + * Since: v8.0.0 + * */ VIR_MIGRATE_NON_SHARED_SYNCHRONOUS_WRITES = (1 << 18), @@ -1333,7 +1434,7 @@ int virDomainMigrateSetCompressionCache(virDomainPtr domain, * Since: v5.1.0 */ typedef enum { - /* Set or get maximum speed of post-copy migration. */ + /* Set or get maximum speed of post-copy migration. (Since: v5.1.0) */ VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY = (1 << 0), } virDomainMigrateMaxSpeedFlags; @@ -1400,12 +1501,12 @@ virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn, * Since: v0.9.10 */ typedef enum { - VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice */ - VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event */ - VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent */ - VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl */ - VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal */ - VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control */ + VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */ + VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */ + VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */ } virDomainShutdownFlagValues; int virDomainShutdown (virDomainPtr domain); @@ -1418,12 +1519,12 @@ int virDomainShutdownFlags (virDomainPtr domain, * Since: v0.9.10 */ typedef enum { - VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice */ - VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event */ - VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent */ - VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl */ - VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal */ - VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control */ + VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */ + VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */ + VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */ + VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */ + VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */ + VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */ } virDomainRebootFlagValues; int virDomainReboot (virDomainPtr domain, @@ -1442,9 +1543,9 @@ int virDomainDestroy (virDomainPtr domain); * Since: v0.9.4 */ typedef enum { - VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! */ - VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL */ - VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy */ + VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: v0.9.10) */ + VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL (Since: v0.9.10) */ + VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy (Since: v8.3.0) */ } virDomainDestroyFlagsValues; int virDomainDestroyFlags (virDomainPtr domain, @@ -1477,10 +1578,10 @@ int virDomainPMWakeup (virDomainPtr domain, * Since: v0.9.4 */ typedef enum { - VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution */ - VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused */ - VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running */ - VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template */ + VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: v0.9.4) */ + VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused (Since: v0.9.5) */ + VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running (Since: v0.9.5) */ + VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */ } virDomainSaveRestoreFlags; int virDomainSave (virDomainPtr domain, @@ -1758,11 +1859,11 @@ int virDomainGetMemoryParameters(virDomainPtr domain, * Since: v0.9.0 */ typedef enum { - VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, + VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.1) */ + VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.9.0) */ + VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.9.0) */ - VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current */ + VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: v0.9.1) */ } virDomainMemoryModFlags; @@ -1776,13 +1877,13 @@ typedef enum { * Since: v0.9.9 */ typedef enum { - VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, - VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, - VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, - VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, + VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, /* (Since: v7.3.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change */ + VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change (Since: v0.9.9) */ # endif } virDomainNumatuneMemMode; @@ -1843,8 +1944,8 @@ int virDomainGetSecurityLabel (virDomainPtr domain, * Since: v6.1.0 */ typedef enum { - VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file */ - VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent */ + 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) */ } virDomainGetHostnameFlags; char * virDomainGetHostname (virDomainPtr domain, @@ -1858,12 +1959,12 @@ int virDomainGetSecurityLabelList (virDomainPtr domain, * Since: v0.9.10 */ typedef enum { - VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> */ - VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> */ - VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> */ + VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: v0.9.10) */ + VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: v0.9.10) */ + VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> (Since: v0.9.10) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_METADATA_LAST + VIR_DOMAIN_METADATA_LAST /* (Since: v0.9.10) */ # endif } virDomainMetadataType; @@ -1893,10 +1994,10 @@ virDomainGetMetadata(virDomainPtr domain, * Since: v0.3.3 */ typedef enum { - VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too */ - VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information */ - VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU */ - VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration */ + VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: v0.3.3) */ + VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: v0.3.3) */ + VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU (Since: v0.8.0) */ + VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: v1.0.0) */ } virDomainXMLFlags; /** @@ -1905,7 +2006,7 @@ typedef enum { * Since: v5.1.0 */ typedef enum { - VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too */ + VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */ } virDomainSaveImageXMLFlags; char * virDomainGetXMLDesc (virDomainPtr domain, @@ -2026,7 +2127,7 @@ int virDomainBlockPeek (virDomainPtr dom, * Since: v0.9.11 */ typedef enum { - VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB */ + VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: v0.9.11) */ } virDomainBlockResizeFlags; int virDomainBlockResize (virDomainPtr dom, @@ -2101,8 +2202,8 @@ int virDomainMemoryStats (virDomainPtr dom, * Since: v0.4.4 */ typedef enum { - VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses */ - VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses */ + VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses (Since: v0.4.4) */ + VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses (Since: v0.7.0) */ } virDomainMemoryFlags; int virDomainMemoryPeek (virDomainPtr dom, @@ -2117,7 +2218,7 @@ int virDomainMemoryPeek (virDomainPtr dom, * Since: v1.2.12 */ typedef enum { - VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema */ + VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema (Since: v1.2.12) */ } virDomainDefineFlags; /* @@ -2138,18 +2239,18 @@ int virDomainUndefine (virDomainPtr domain); */ typedef enum { VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = (1 << 0), /* Also remove any - managed save */ + managed save (Since: v0.9.4) */ VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA = (1 << 1), /* If last use of domain, then also remove any - snapshot metadata */ + snapshot metadata (Since: v0.9.5) */ VIR_DOMAIN_UNDEFINE_NVRAM = (1 << 2), /* Also remove any - nvram file */ - VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file */ + nvram file (Since: v1.2.9) */ + VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file (Since: v2.3.0) */ VIR_DOMAIN_UNDEFINE_CHECKPOINTS_METADATA = (1 << 4), /* If last use of domain, then also remove any checkpoint metadata */ - /* Future undefine control flags should come here. */ + /* Future undefine control flags should come here. (Since: v5.6.0) */ } virDomainUndefineFlagsValues; @@ -2169,28 +2270,28 @@ int virConnectListDefinedDomains (virConnectPtr conn, * Since: v0.9.13 */ typedef enum { - VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, - VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, + VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, - VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, + VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, - VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, - VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, - VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, + VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, - VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, + VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, - VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, + VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, - VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, + VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, - VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, + VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, /* (Since: v5.6.0) */ + VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, /* (Since: v5.6.0) */ } virConnectListAllDomainsFlags; int virConnectListAllDomains (virConnectPtr conn, @@ -2218,12 +2319,12 @@ int virDomainSetAutostart (virDomainPtr domain, * Since: v0.1.4 */ typedef enum { - VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline */ - VIR_VCPU_RUNNING = 1, /* the virtual CPU is running */ - VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource */ + VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: v0.1.4) */ + VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: v0.1.4) */ + VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource (Since: v0.1.4) */ # ifdef VIR_ENUM_SENTINELS - VIR_VCPU_LAST + VIR_VCPU_LAST /* (Since: v0.9.10) */ # endif } virVcpuState; @@ -2233,8 +2334,8 @@ typedef enum { * Since: v6.10.0 */ typedef enum { - VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline */ - VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information */ + 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) */ } virVcpuHostCpuState; /** @@ -2265,13 +2366,13 @@ typedef virVcpuInfo *virVcpuInfoPtr; * Since: v0.8.5 */ typedef enum { - VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, + VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.4) */ + VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.8.5) */ + VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.8.5) */ - VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count */ - VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest */ - VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable */ + VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count (Since: v0.8.5) */ + VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest (Since: v1.1.0) */ + VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable (Since: v2.4.0) */ } virDomainVcpuFlags; int virDomainSetVcpus (virDomainPtr domain, @@ -2510,12 +2611,11 @@ int virDomainGetVcpus (virDomainPtr domain, * Since: v0.7.7 */ typedef enum { - VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, + VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.7.7) */ - VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device - (ex. force eject a cdrom) */ + VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) (Since: v0.8.6) */ } virDomainDeviceModifyFlags; int virDomainAttachDevice(virDomainPtr domain, const char *xml); @@ -2556,16 +2656,16 @@ struct _virDomainStatsRecord { * Since: v1.2.8 */ typedef enum { - VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state */ - VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info */ - VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info */ - VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info */ - VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info */ - VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info */ - VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info */ - VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info */ - VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info */ - VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info */ + VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state (Since: v1.2.8) */ + VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info (Since: v1.2.9) */ + VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info (Since: v1.2.9) */ + VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info (Since: v1.2.9) */ + VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info (Since: v1.2.9) */ + VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info (Since: v1.2.9) */ + VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info (Since: v1.3.3) */ + VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info (Since: v4.10.0) */ + VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info (Since: v6.0.0) */ + VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since: v7.2.0) */ } virDomainStatsTypes; /** @@ -2574,21 +2674,21 @@ typedef enum { * 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, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, /* (Since: v1.2.8) */ VIR_CONNECT_GET_ALL_DOMAINS_STATS_NOWAIT = 1 << 29, /* report statistics that can be obtained - immediately without any blocking */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats */ + immediately without any blocking (Since: v4.5.0) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats (Since: v1.2.12) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats (Since: v1.2.8) */ } virConnectGetAllDomainStatsFlags; int virConnectGetAllDomainStats(virConnectPtr conn, @@ -2897,30 +2997,45 @@ int virDomainSetPerfEvents(virDomainPtr dom, * Since: v0.9.4 */ typedef enum { - /* Placeholder */ + /* Placeholder (Since: v0.9.4) */ VIR_DOMAIN_BLOCK_JOB_TYPE_UNKNOWN = 0, /* Block Pull (virDomainBlockPull, or virDomainBlockRebase without - * flags), job ends on completion */ + * flags), job ends on completion + * + * Since: v0.9.4 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_PULL = 1, /* Block Copy (virDomainBlockCopy, or virDomainBlockRebase with - * flags), job exists as long as mirroring is active */ + * flags), job exists as long as mirroring is active + * + * Since: v0.9.12 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_COPY = 2, /* Block Commit (virDomainBlockCommit without flags), job ends on - * completion */ + * completion + * + * Since: v0.10.2 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT = 3, /* Active Block Commit (virDomainBlockCommit with flags), job - * exists as long as sync is active */ + * exists as long as sync is active + * + * Since: v1.2.6 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT = 4, - /* Backup (virDomainBackupBegin) */ + /* Backup (virDomainBackupBegin) + * + * Since: v6.0.0 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_BACKUP = 5, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_TYPE_LAST + VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: v0.9.10) */ # endif } virDomainBlockJobType; @@ -2934,8 +3049,8 @@ typedef enum { * Since: v0.9.12 */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, - VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, + VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, /* (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, /* (Since: v0.9.12) */ } virDomainBlockJobAbortFlags; int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, @@ -2950,7 +3065,7 @@ int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, */ typedef enum { VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s - instead of MiB/s */ + instead of MiB/s (Since: v1.2.9) */ } virDomainBlockJobInfoFlags; /** @@ -3002,7 +3117,7 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, */ typedef enum { VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s - instead of MiB/s */ + instead of MiB/s (Since: v1.2.9) */ } virDomainBlockJobSetSpeedFlags; int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, @@ -3018,7 +3133,7 @@ int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, */ typedef enum { VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s - instead of MiB/s */ + instead of MiB/s (Since: v1.2.9) */ } virDomainBlockPullFlags; int virDomainBlockPull(virDomainPtr dom, const char *disk, @@ -3033,18 +3148,18 @@ int virDomainBlockPull(virDomainPtr dom, const char *disk, */ typedef enum { VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1 << 0, /* Limit copy to top of source - backing chain */ + backing chain (Since: v0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT = 1 << 1, /* Reuse existing external - file for a copy */ - VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw */ - VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job */ + file for a copy (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job (Since: v0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_RELATIVE = 1 << 4, /* Keep backing chain referenced using relative - names */ + names (Since: v1.2.7) */ VIR_DOMAIN_BLOCK_REBASE_COPY_DEV = 1 << 5, /* Treat destination as block - device instead of file */ + device instead of file (Since: v1.2.9) */ VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s - instead of MiB/s */ + instead of MiB/s (Since: v1.2.9) */ } virDomainBlockRebaseFlags; int virDomainBlockRebase(virDomainPtr dom, const char *disk, @@ -3059,17 +3174,20 @@ int virDomainBlockRebase(virDomainPtr dom, const char *disk, * Since: v1.2.8 */ typedef enum { - /* Limit copy to top of source backing chain */ + /* Limit copy to top of source backing chain (Since: v1.2.8) */ VIR_DOMAIN_BLOCK_COPY_SHALLOW = 1 << 0, - /* Reuse existing external file for a copy */ + /* Reuse existing external file for a copy (Since: v1.2.8) */ VIR_DOMAIN_BLOCK_COPY_REUSE_EXT = 1 << 1, - /* Don't force usage of recoverable job for the copy operation */ + /* Don't force usage of recoverable job for the copy operation (Since: v3.5.0) */ VIR_DOMAIN_BLOCK_COPY_TRANSIENT_JOB = 1 << 2, /* Force the copy job to synchronously propagate guest writes into - * the destination image, so that the copy is guaranteed to converge */ + * the destination image, so that the copy is guaranteed to converge + * + * Since: v8.0.0 + */ VIR_DOMAIN_BLOCK_COPY_SYNCHRONOUS_WRITES = 1 << 3, } virDomainBlockCopyFlags; @@ -3133,17 +3251,17 @@ int virDomainBlockCopy(virDomainPtr dom, const char *disk, */ typedef enum { VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1 << 0, /* NULL base means next backing - file, not whole chain */ + file, not whole chain (Since: v0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_DELETE = 1 << 1, /* Delete any files that are now invalid after their contents - have been committed */ + have been committed (Since: v0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_ACTIVE = 1 << 2, /* Allow a two-phase commit when - top is the active layer */ + top is the active layer (Since: v1.2.6) */ VIR_DOMAIN_BLOCK_COMMIT_RELATIVE = 1 << 3, /* keep the backing chain referenced using relative - names */ + names (Since: v1.2.7) */ VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES = 1 << 4, /* bandwidth in bytes/s - instead of MiB/s */ + instead of MiB/s (Since: v1.2.9) */ } virDomainBlockCommitFlags; int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, @@ -3370,12 +3488,12 @@ virDomainGetBlockIoTune(virDomainPtr dom, * Since: v0.9.10 */ typedef enum { - VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error */ - VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error */ - VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device */ + VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error (Since: v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device (Since: v0.9.10) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DISK_ERROR_LAST + VIR_DOMAIN_DISK_ERROR_LAST /* (Since: v0.9.10) */ # endif } virDomainDiskErrorCode; @@ -3413,16 +3531,16 @@ int virDomainGetDiskErrors(virDomainPtr dom, * Since: v0.9.3 */ typedef enum { - VIR_KEYCODE_SET_LINUX = 0, - VIR_KEYCODE_SET_XT = 1, - VIR_KEYCODE_SET_ATSET1 = 2, - VIR_KEYCODE_SET_ATSET2 = 3, - VIR_KEYCODE_SET_ATSET3 = 4, - VIR_KEYCODE_SET_OSX = 5, - VIR_KEYCODE_SET_XT_KBD = 6, - VIR_KEYCODE_SET_USB = 7, - VIR_KEYCODE_SET_WIN32 = 8, - VIR_KEYCODE_SET_QNUM = 9, + VIR_KEYCODE_SET_LINUX = 0, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_XT = 1, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET1 = 2, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET2 = 3, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET3 = 4, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_OSX = 5, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_XT_KBD = 6, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_USB = 7, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_WIN32 = 8, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_QNUM = 9, /* (Since: v4.2.0) */ # ifdef VIR_ENUM_SENTINELS VIR_KEYCODE_SET_LAST @@ -3430,6 +3548,8 @@ typedef enum { * NB: this enum value will increase over time as new keycode sets are * added to the libvirt API. It reflects the last keycode set supported * by this version of the libvirt API. + * + * Since: v0.9.4 */ # endif } virKeycodeSet; @@ -3474,80 +3594,80 @@ int virDomainSendKey(virDomainPtr domain, * Since: v1.0.1 */ typedef enum { - VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux */ - VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP */ - VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT */ - VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT */ - VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL */ - VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP */ - VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT */ - VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS */ - VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE */ - VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL */ - - VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 */ - VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV */ - VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 */ - VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE */ - VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM */ - VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM */ - VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux )*/ - VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD */ - VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT */ - VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP */ - - VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP */ - VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN */ - VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU */ - VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG */ - VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU */ - VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ */ - VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM */ - VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF */ - VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) */ - - VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN */ - VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX */ + VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux (Since: v1.0.1) )*/ + VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX (Since: v1.0.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PROCESS_SIGNAL_LAST + VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: v1.0.1) */ # endif } virDomainProcessSignal; @@ -3576,18 +3696,18 @@ virDomainPtr virDomainCreateLinux (virConnectPtr conn, * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED = 0, - VIR_DOMAIN_EVENT_UNDEFINED = 1, - VIR_DOMAIN_EVENT_STARTED = 2, - VIR_DOMAIN_EVENT_SUSPENDED = 3, - VIR_DOMAIN_EVENT_RESUMED = 4, - VIR_DOMAIN_EVENT_STOPPED = 5, - VIR_DOMAIN_EVENT_SHUTDOWN = 6, - VIR_DOMAIN_EVENT_PMSUSPENDED = 7, - VIR_DOMAIN_EVENT_CRASHED = 8, + VIR_DOMAIN_EVENT_DEFINED = 0, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED = 1, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED = 2, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED = 3, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED = 4, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED = 5, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SHUTDOWN = 6, /* (Since: v0.9.8) */ + VIR_DOMAIN_EVENT_PMSUSPENDED = 7, /* (Since: v0.10.2) */ + VIR_DOMAIN_EVENT_CRASHED = 8, /* (Since: v1.1.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_LAST + VIR_DOMAIN_EVENT_LAST /* (Since: v0.9.10) */ # endif } virDomainEventType; @@ -3599,13 +3719,13 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file */ - VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file */ - VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed */ - VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot */ + VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed (Since: v1.2.19) */ + VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot (Since: v1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DEFINED_LAST + VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventDefinedDetailType; @@ -3617,11 +3737,11 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file */ - VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed */ + VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed (Since: v1.2.19) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_UNDEFINED_LAST + VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventUndefinedDetailType; @@ -3633,14 +3753,14 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot */ - VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host */ - VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file */ - VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot */ - VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event */ + VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event (Since: v0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STARTED_LAST + VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventStartedDetailType; @@ -3652,18 +3772,18 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause */ - VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration */ - VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error */ - VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing */ - VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file */ - VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot */ - VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy */ + VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file (Since: v0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot (Since: v0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call (Since: v1.0.1) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy (Since: v1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SUSPENDED_LAST + VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventSuspendedDetailType; @@ -3675,14 +3795,14 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause */ - VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration */ - VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot */ + VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot (Since: v0.9.5) */ VIR_DOMAIN_EVENT_RESUMED_POSTCOPY = 3, /* Resumed, but migration is still - running in post-copy mode */ + running in post-copy mode (Since: v1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_RESUMED_LAST + VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventResumedDetailType; @@ -3694,16 +3814,16 @@ typedef enum { * Since: v0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown */ - VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host */ - VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed */ - VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host */ - VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file */ - VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed */ - VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded */ + VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded (Since: v0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STOPPED_LAST + VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventStoppedDetailType; @@ -3716,19 +3836,22 @@ typedef enum { * Since: v0.9.8 */ typedef enum { - /* Guest finished shutdown sequence */ + /* Guest finished shutdown sequence (Since: v0.9.8) */ VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED = 0, /* Domain finished shutting down after request from the guest itself - * (e.g. hardware-specific action) */ + * (e.g. hardware-specific action) (Since: v3.4.0) */ VIR_DOMAIN_EVENT_SHUTDOWN_GUEST = 1, /* Domain finished shutting down after request from the host (e.g. killed by - * a signal) */ + * a signal) + * + * Since: v3.4.0 + */ VIR_DOMAIN_EVENT_SHUTDOWN_HOST = 2, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SHUTDOWN_LAST + VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: v0.9.10) */ # endif } virDomainEventShutdownDetailType; @@ -3740,11 +3863,11 @@ typedef enum { * Since: v0.10.2 */ typedef enum { - VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory */ - VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk */ + VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: v0.10.2) */ + VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk (Since: v1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_PMSUSPENDED_LAST + VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: v0.10.2) */ # endif } virDomainEventPMSuspendedDetailType; @@ -3756,11 +3879,11 @@ typedef enum { * Since: v1.1.1 */ typedef enum { - VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked */ - VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded */ + VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: v1.1.1) */ + VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded (Since: v6.1.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_CRASHED_LAST + VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: v1.1.1) */ # endif } virDomainEventCrashedDetailType; @@ -3772,14 +3895,14 @@ typedef enum { * Since: v6.9.0 */ typedef enum { - /* memory failure at hypersivor memory address space */ + /* memory failure at hypersivor memory address space (Since: v6.9.0) */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_HYPERVISOR = 0, - /* memory failure at guest memory address space */ + /* memory failure at guest memory address space (Since: v6.9.0) */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_GUEST = 1, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST + VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: v6.9.0) */ # endif } virDomainMemoryFailureRecipientType; @@ -3793,24 +3916,36 @@ typedef enum { */ typedef enum { /* the memory failure could be ignored. This will only be the case for - * action-optional failures. */ + * action-optional failures. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_IGNORE = 0, /* memory failure occurred in guest memory, the guest enabled MCE handling * mechanism, and hypervisor could inject the MCE into the guest - * successfully. */ + * successfully. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_INJECT = 1, /* the failure is unrecoverable. This occurs for action-required failures - * if the recipient is the hypervisor; hypervisor will exit. */ + * if the recipient is the hypervisor; hypervisor will exit. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_FATAL = 2, /* the failure is unrecoverable but confined to the guest. This occurs if - * the recipient is a guest which is not ready to handle memory failures. */ + * the recipient is a guest which is not ready to handle memory failures. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_RESET = 3, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST + VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: v6.9.0) */ # endif } virDomainMemoryFailureActionType; @@ -3822,11 +3957,14 @@ typedef enum { */ typedef enum { /* whether a memory failure event is action-required or action-optional - * (e.g. a failure during memory scrub). */ + * (e.g. a failure during memory scrub). (Since: v6.9.0) */ VIR_DOMAIN_MEMORY_FAILURE_ACTION_REQUIRED = (1 << 0), /* whether the failure occurred while the previous failure was still in - * progress. */ + * progress. + * + * Since: v6.9.0 + */ VIR_DOMAIN_MEMORY_FAILURE_RECURSIVE = (1 << 1), } virDomainMemoryFailureFlags; @@ -3868,15 +4006,15 @@ int virDomainIsUpdated(virDomainPtr dom); * Since: v0.7.7 */ typedef enum { - VIR_DOMAIN_JOB_NONE = 0, /* No job is active */ - VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time */ - VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time */ - VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up */ - VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up */ - VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up */ + VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: v0.7.7) */ + VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: v0.7.7) */ + VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time (Since: v0.7.7) */ + VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up (Since: v0.7.7) */ + VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up (Since: v0.7.7) */ + VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up (Since: v0.7.7) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_LAST + VIR_DOMAIN_JOB_LAST /* (Since: v0.9.10) */ # endif } virDomainJobType; @@ -3937,9 +4075,9 @@ struct _virDomainJobInfo { */ typedef enum { VIR_DOMAIN_JOB_STATS_COMPLETED = 1 << 0, /* return stats of a recently - * completed job */ + * completed job (Since: v1.2.9) */ VIR_DOMAIN_JOB_STATS_KEEP_COMPLETED = 1 << 1, /* don't remove completed - stats when reading them */ + stats when reading them (Since: v6.0.0) */ } virDomainGetJobStatsFlags; int virDomainGetJobInfo(virDomainPtr dom, @@ -3957,19 +4095,19 @@ int virDomainAbortJob(virDomainPtr dom); * Since: v3.3.0 */ typedef enum { - VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, - VIR_DOMAIN_JOB_OPERATION_START = 1, - VIR_DOMAIN_JOB_OPERATION_SAVE = 2, - VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, - VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, - VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, - VIR_DOMAIN_JOB_OPERATION_DUMP = 8, - VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, + VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_START = 1, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SAVE = 2, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_DUMP = 8, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, /* (Since: v6.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_OPERATION_LAST + VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: v3.3.0) */ # endif } virDomainJobOperation; @@ -4416,16 +4554,16 @@ typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn, * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored */ - VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused */ - VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset */ - VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off */ - VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown */ - VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged */ - VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest */ + VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest (Since: v1.2.17) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_WATCHDOG_LAST + VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: v0.9.10) */ # endif } virDomainEventWatchdogAction; @@ -4453,12 +4591,12 @@ typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn, * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored */ - VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused */ - VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS */ + VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS (Since: v0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_IO_ERROR_LAST + VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: v0.9.10) */ # endif } virDomainEventIOErrorAction; @@ -4518,12 +4656,12 @@ typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr conn, * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established */ - VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed */ - VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection */ + VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection (Since: v0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_LAST + VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: v0.9.10) */ # endif } virDomainEventGraphicsPhase; @@ -4535,12 +4673,12 @@ typedef enum { * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address */ - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address */ - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path (Since: v0.9.7) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: v0.9.10) */ # endif } virDomainEventGraphicsAddressType; @@ -4663,13 +4801,13 @@ typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn, * Since: v0.9.4 */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, - VIR_DOMAIN_BLOCK_JOB_FAILED = 1, - VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, - VIR_DOMAIN_BLOCK_JOB_READY = 3, + VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, /* (Since: v0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_FAILED = 1, /* (Since: v0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, /* (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_READY = 3, /* (Since: v1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_LAST + VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: v0.9.10) */ # endif } virConnectDomainEventBlockJobStatus; @@ -4713,15 +4851,21 @@ typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn, */ typedef enum { /* Removable media changed to empty according to startup policy as source - * was missing. oldSrcPath is set, newSrcPath is NULL */ + * was missing. oldSrcPath is set, newSrcPath is NULL + * + * Since: v0.9.7 + * */ VIR_DOMAIN_EVENT_DISK_CHANGE_MISSING_ON_START = 0, /* Disk was dropped from domain as source file was missing. - * oldSrcPath is set, newSrcPath is NULL */ + * oldSrcPath is set, newSrcPath is NULL + * + * Since: v1.1.2 + * */ VIR_DOMAIN_EVENT_DISK_DROP_MISSING_ON_START = 1, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DISK_CHANGE_LAST + VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: v0.9.10) */ # endif } virConnectDomainEventDiskChangeReason; @@ -4760,11 +4904,11 @@ typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn, * Since: v0.9.11 */ typedef enum { - VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, - VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, + VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, /* (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: v0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST + VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: v0.9.11) */ # endif } virDomainEventTrayChangeReason; @@ -5348,11 +5492,11 @@ typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn, * Since: v1.2.11 */ typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected (Since: v1.2.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST /* (Since: v1.2.11) */ # endif } virConnectDomainEventAgentLifecycleState; @@ -5362,12 +5506,12 @@ typedef enum { * Since: v1.2.11 */ typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed (Since: v1.2.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: v1.2.11) */ # endif } virConnectDomainEventAgentLifecycleReason; @@ -5491,33 +5635,33 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPt * Since: v0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback */ - VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback */ - VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback */ - VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback */ - VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback */ - VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback */ - VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback */ - VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback */ - VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback */ - VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback */ - VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback */ - VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback */ - VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback */ - VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback */ - VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback */ - VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback */ - VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback */ - VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback */ - VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback */ + VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback (Since: v0.8.1) */ + VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback (Since: v0.9.2) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback (Since: v0.9.4) */ + VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback (Since: v0.9.7) */ + VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback (Since: v0.10.0) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback (Since: v1.0.0) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback (Since: v1.1.1) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback (Since: v1.2.6) */ + VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback (Since: v1.2.9) */ + VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback (Since: v1.2.11) */ + VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback (Since: v1.2.15) */ + VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback (Since: v1.3.2) */ + VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback (Since: v1.3.4) */ + VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback (Since: v3.0.0) */ + VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback (Since: v3.2.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback (Since: v6.9.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback (Since: v7.9.0) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_EVENT_ID_LAST @@ -5525,6 +5669,8 @@ typedef enum { * NB: this enum value will increase over time as new events are * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. + * + * Since: v0.8.0 */ # endif } virDomainEventID; @@ -5551,9 +5697,9 @@ typedef enum { VIR_DOMAIN_CONSOLE_FORCE = (1 << 0), /* abort a (possibly) active console connection to force a new - connection */ + connection (Since: v0.9.11) */ VIR_DOMAIN_CONSOLE_SAFE = (1 << 1), /* check if the console driver supports - safe console operations */ + safe console operations (Since: v0.9.11) */ } virDomainConsoleFlags; int virDomainOpenConsole(virDomainPtr dom, @@ -5569,7 +5715,7 @@ int virDomainOpenConsole(virDomainPtr dom, typedef enum { VIR_DOMAIN_CHANNEL_FORCE = (1 << 0), /* abort a (possibly) active channel connection to force a new - connection */ + connection (Since: v1.0.2) */ } virDomainChannelFlags; int virDomainOpenChannel(virDomainPtr dom, @@ -5583,7 +5729,7 @@ int virDomainOpenChannel(virDomainPtr dom, * Since: v0.9.7 */ typedef enum { - VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), + VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), /* (Since: v0.9.7) */ } virDomainOpenGraphicsFlags; int virDomainOpenGraphics(virDomainPtr dom, @@ -5652,7 +5798,7 @@ int virDomainGetTime(virDomainPtr dom, * Since: v1.2.5 */ typedef enum { - VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC */ + VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC (Since: v1.2.5) */ } virDomainSetTimeFlags; int virDomainSetTime(virDomainPtr dom, @@ -5669,12 +5815,12 @@ int virDomainSetTime(virDomainPtr dom, * Since: v0.2.3 */ typedef enum { - VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, - VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.2.3) */ } virSchedParameterType; /** @@ -5726,12 +5872,12 @@ typedef virSchedParameter *virSchedParameterPtr; * Since: v0.9.0 */ typedef enum { - VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, - VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.9.0) */ } virBlkioParameterType; /** @@ -5783,12 +5929,12 @@ typedef virBlkioParameter *virBlkioParameterPtr; * Since: v0.8.5 */ typedef enum { - VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, - VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.8.5) */ } virMemoryParameterType; /** @@ -5837,12 +5983,12 @@ typedef virMemoryParameter *virMemoryParameterPtr; * Since: v1.2.14 */ typedef enum { - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file (Since: v1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent (Since: v1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables (Since: v4.2.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: v1.2.14) */ # endif } virDomainInterfaceAddressesSource; @@ -5898,7 +6044,7 @@ void virDomainInterfaceFree(virDomainInterfacePtr iface); * Since: v1.2.16 */ typedef enum { - VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted */ + VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted (Since: v1.2.16) */ } virDomainSetUserPasswordFlags; int virDomainSetUserPassword(virDomainPtr dom, @@ -5936,12 +6082,12 @@ int virDomainSetBlockThreshold(virDomainPtr domain, * Since: v3.9.0 */ typedef enum { - VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, - VIR_DOMAIN_LIFECYCLE_REBOOT = 1, - VIR_DOMAIN_LIFECYCLE_CRASH = 2, + VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_REBOOT = 1, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_CRASH = 2, /* (Since: v3.9.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_LAST + VIR_DOMAIN_LIFECYCLE_LAST /* (Since: v3.9.0) */ # endif } virDomainLifecycle; @@ -5951,15 +6097,15 @@ typedef enum { * Since: v3.9.0 */ typedef enum { - VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, - VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, + VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, /* (Since: v3.9.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_ACTION_LAST + VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: v3.9.0) */ # endif } virDomainLifecycleAction; @@ -6075,13 +6221,13 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain, * Since: v5.7.0 */ typedef enum { - VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users */ - VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information */ - VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information */ - VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information */ - VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information */ - VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information */ - VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information */ + VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information (Since: v7.0.0) */ + VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information (Since: v7.10.0) */ } virDomainGuestInfoTypes; int virDomainGetGuestInfo(virDomainPtr domain, @@ -6096,9 +6242,9 @@ int virDomainGetGuestInfo(virDomainPtr domain, * Since: v5.10.0 */ typedef enum { - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, /* (Since: v5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, /* (Since: v5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, /* (Since: v5.10.0) */ } virDomainAgentResponseTimeoutValues; int virDomainAgentSetResponseTimeout(virDomainPtr domain, @@ -6112,7 +6258,7 @@ int virDomainAgentSetResponseTimeout(virDomainPtr domain, */ typedef enum { VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL = (1 << 0), /* reuse separately - provided images */ + provided images (Since: v6.0.0) */ } virDomainBackupBeginFlags; int virDomainBackupBegin(virDomainPtr domain, @@ -6134,8 +6280,8 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, * Since: v6.10.0 */ typedef enum { - VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate file, just append */ - VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead of adding them */ + 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) */ } virDomainAuthorizedSSHKeysSetFlags; @@ -6151,8 +6297,8 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, * Since: v7.1.0 */ typedef enum { - VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), - VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), + VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), /* (Since: v7.1.0) */ + VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), /* (Since: v7.1.0) */ } virDomainMessageType; int virDomainGetMessages(virDomainPtr domain, @@ -6168,14 +6314,14 @@ int virDomainGetMessages(virDomainPtr domain, */ typedef enum { VIR_DOMAIN_DIRTYRATE_UNSTARTED = 0, /* the dirtyrate calculation has - not been started */ + not been started (Since: v7.2.0) */ VIR_DOMAIN_DIRTYRATE_MEASURING = 1, /* the dirtyrate calculation is - measuring */ + measuring (Since: v7.2.0) */ VIR_DOMAIN_DIRTYRATE_MEASURED = 2, /* the dirtyrate calculation is - completed */ + completed (Since: v7.2.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DIRTYRATE_LAST + VIR_DOMAIN_DIRTYRATE_LAST /* (Since: v7.2.0) */ # endif } virDomainDirtyRateStatus; @@ -6189,9 +6335,9 @@ typedef enum { * Since: v8.1.0 */ typedef enum { - VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode */ + VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: v8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode (Since: v8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode (Since: v8.1.0) */ } virDomainDirtyRateCalcFlags; int virDomainStartDirtyRateCalc(virDomainPtr domain, diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-event.h index 76b06eca38..89dea437c0 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -38,10 +38,10 @@ * Since: v0.5.0 */ typedef enum { - VIR_EVENT_HANDLE_READABLE = (1 << 0), - VIR_EVENT_HANDLE_WRITABLE = (1 << 1), - VIR_EVENT_HANDLE_ERROR = (1 << 2), - VIR_EVENT_HANDLE_HANGUP = (1 << 3), + VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: v0.5.0) */ } virEventHandleType; /** diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 763c5fe774..aa4d2a583f 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -57,12 +57,12 @@ typedef virConnect *virConnectPtr; * Since: v0.9.8 */ typedef enum { - VIR_NODE_SUSPEND_TARGET_MEM = 0, - VIR_NODE_SUSPEND_TARGET_DISK = 1, - VIR_NODE_SUSPEND_TARGET_HYBRID = 2, + VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: v0.9.8) */ # ifdef VIR_ENUM_SENTINELS - VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change */ + VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: v0.9.8) */ # endif } virNodeSuspendTarget; @@ -214,7 +214,7 @@ struct _virNodeInfo { * Since: v0.9.8 */ typedef enum { - VIR_NODE_CPU_STATS_ALL_CPUS = -1, + VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: v0.9.3) */ } virNodeGetCPUStatsAllCPUs; /** @@ -310,7 +310,7 @@ struct _virNodeCPUStats { * Since: v0.9.8 */ typedef enum { - VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, + VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: v0.9.3) */ } virNodeGetMemoryStatsAllCells; /** @@ -589,8 +589,8 @@ int virNodeGetSEVInfo (virConnectPtr conn, * Since: v0.4.1 */ typedef enum { - VIR_CONNECT_RO = (1 << 0), /* A readonly connection */ - VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases */ + VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: v0.4.1) */ + VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: v0.9.7) */ } virConnectFlags; /** @@ -599,18 +599,18 @@ typedef enum { * Since: v0.4.1 */ typedef enum { - VIR_CRED_USERNAME = 1, /* Identity to act as */ - VIR_CRED_AUTHNAME = 2, /* Identify to authorize as */ - VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated */ - VIR_CRED_CNONCE = 4, /* client supplies a nonce */ - VIR_CRED_PASSPHRASE = 5, /* Passphrase secret */ - VIR_CRED_ECHOPROMPT = 6, /* Challenge response */ - VIR_CRED_NOECHOPROMPT = 7, /* Challenge response */ - VIR_CRED_REALM = 8, /* Authentication realm */ - VIR_CRED_EXTERNAL = 9, /* Externally managed credential */ + VIR_CRED_USERNAME = 1, /* Identity to act as (Since: v0.4.1) */ + VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: v0.4.1) */ + VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: v0.4.1) */ + VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: v0.4.1) */ + VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: v0.4.1) */ + VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: v0.4.1) */ + VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: v0.4.1) */ + VIR_CRED_REALM = 8, /* Authentication realm (Since: v0.4.1) */ + VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: v0.4.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_CRED_LAST /* More may be added - expect the unexpected */ + VIR_CRED_LAST /* More may be added - expect the unexpected (Since: v0.9.10) */ # endif } virConnectCredentialType; @@ -909,13 +909,13 @@ int virConnectIsAlive(virConnectPtr conn); * Since: v0.7.5 */ typedef enum { - VIR_CPU_COMPARE_ERROR = -1, - VIR_CPU_COMPARE_INCOMPATIBLE = 0, - VIR_CPU_COMPARE_IDENTICAL = 1, - VIR_CPU_COMPARE_SUPERSET = 2, + VIR_CPU_COMPARE_ERROR = -1, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: v0.7.5) */ # ifdef VIR_ENUM_SENTINELS - VIR_CPU_COMPARE_LAST + VIR_CPU_COMPARE_LAST /* (Since: v0.9.10) */ # endif } virCPUCompareResult; @@ -926,9 +926,9 @@ typedef enum { */ typedef enum { VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = (1 << 0), /* treat incompatible - CPUs as failure */ + CPUs as failure (Since: v1.2.6) */ VIR_CONNECT_COMPARE_CPU_VALIDATE_XML = (1 << 1), /* validate the xml - document */ + document (Since: v6.9.0) */ } virConnectCompareCPUFlags; int virConnectCompareCPU(virConnectPtr conn, @@ -955,8 +955,8 @@ int virConnectGetCPUModelNames(virConnectPtr conn, * Since: v1.1.2 */ typedef enum { - VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features */ - VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features */ + VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: v1.1.2) */ + VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: v1.2.14) */ } virConnectBaselineCPUFlags; char *virConnectBaselineCPU(virConnectPtr conn, @@ -987,10 +987,10 @@ int virNodeGetFreePages(virConnectPtr conn, */ typedef enum { VIR_NODE_ALLOC_PAGES_ADD = 0, /* Add @pageCounts to the pages pool. This - can be used only to size up the pool. */ + can be used only to size up the pool. (Since: v1.2.9) */ VIR_NODE_ALLOC_PAGES_SET = (1 << 0), /* Don't add @pageCounts, instead set passed number of pages. This can be - used to free allocated pages. */ + used to free allocated pages. (Since: v1.2.9) */ } virNodeAllocPagesFlags; int virNodeAllocPages(virConnectPtr conn, diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-interface.h index 9d140b27bb..66ede43f43 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -65,8 +65,8 @@ int virConnectListDefinedInterfaces (virConnectPtr conn, * Since: v0.10.2 */ typedef enum { - VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, - VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, + VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ } virConnectListAllInterfacesFlags; int virConnectListAllInterfaces (virConnectPtr conn, @@ -87,7 +87,7 @@ const char* virInterfaceGetMACString (virInterfacePtr iface); * Since: v0.7.3 */ typedef enum { - VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information */ + VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: v0.7.3) */ } virInterfaceXMLFlags; /** @@ -96,7 +96,7 @@ typedef enum { * Since: v7.7.0 */ typedef enum { - VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ } virInterfaceDefineFlags; char * virInterfaceGetXMLDesc (virInterfacePtr iface, diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-network.h index 0eb60700e2..39a38f0c3f 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -33,7 +33,7 @@ * Since: v0.9.10 */ typedef enum { - VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information */ + VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: v0.9.10) */ } virNetworkXMLFlags; /** @@ -104,14 +104,14 @@ int virConnectListDefinedNetworks (virConnectPtr conn, * Since: v0.10.2 */ typedef enum { - VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, - VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, + VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, - VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, + VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, - VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, + VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */ } virConnectListAllNetworksFlags; int virConnectListAllNetworks (virConnectPtr conn, @@ -133,7 +133,7 @@ virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn, * Since: v7.8.0 */ typedef enum { - VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */ } virNetworkCreateFlags; /* @@ -150,7 +150,7 @@ virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, * Since: v7.7.0 */ typedef enum { - VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ } virNetworkDefineFlags; /* @@ -176,13 +176,13 @@ int virNetworkUndefine (virNetworkPtr network); * Since: v0.10.2 */ typedef enum { - VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid) */ - VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element */ - VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element */ - VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list */ - VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list */ + VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: v0.10.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_UPDATE_COMMAND_LAST + VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: v0.10.2) */ # endif } virNetworkUpdateCommand; @@ -195,21 +195,21 @@ typedef enum { * Since: v0.10.2 */ typedef enum { - VIR_NETWORK_SECTION_NONE = 0, /* (invalid) */ - VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> */ - VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> */ - VIR_NETWORK_SECTION_IP = 3, /* <ip> */ - VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> */ - VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> */ - VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> */ - VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> */ - VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> */ - VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> */ - VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> */ - VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> */ - VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> */ + VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: v0.10.2) */ + VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: v0.10.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_SECTION_LAST + VIR_NETWORK_SECTION_LAST /* (Since: v0.10.2) */ # endif } virNetworkUpdateSection; @@ -222,9 +222,9 @@ typedef enum { */ typedef enum { VIR_NETWORK_UPDATE_AFFECT_CURRENT = 0, /* affect live if network is active, - config if it's not active */ - VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only */ - VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only */ + config if it's not active (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: v0.10.2) */ } virNetworkUpdateFlags; /* @@ -277,13 +277,13 @@ int virNetworkIsPersistent(virNetworkPtr net); * Since: v1.2.1 */ typedef enum { - VIR_NETWORK_EVENT_DEFINED = 0, - VIR_NETWORK_EVENT_UNDEFINED = 1, - VIR_NETWORK_EVENT_STARTED = 2, - VIR_NETWORK_EVENT_STOPPED = 3, + VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_STARTED = 2, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: v1.2.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_EVENT_LAST + VIR_NETWORK_EVENT_LAST /* (Since: v1.2.1) */ # endif } virNetworkEventLifecycleType; @@ -327,7 +327,7 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, * Since: v1.2.1 */ typedef enum { - VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback */ + VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: v1.2.1) */ # ifdef VIR_ENUM_SENTINELS VIR_NETWORK_EVENT_ID_LAST @@ -335,6 +335,8 @@ typedef enum { * NB: this enum value will increase over time as new events are * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. + * + * Since: v1.2.1 */ # endif } virNetworkEventID; @@ -345,11 +347,11 @@ typedef enum { * Since: v1.2.6 */ typedef enum { - VIR_IP_ADDR_TYPE_IPV4, - VIR_IP_ADDR_TYPE_IPV6, + VIR_IP_ADDR_TYPE_IPV4, /* (Since: v1.2.6) */ + VIR_IP_ADDR_TYPE_IPV6, /* (Since: v1.2.6) */ # ifdef VIR_ENUM_SENTINELS - VIR_IP_ADDR_TYPE_LAST + VIR_IP_ADDR_TYPE_LAST /* (Since: v1.2.6) */ # endif } virIPAddrType; @@ -427,8 +429,8 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, * Since: v5.5.0 */ typedef enum { - VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources */ - VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema */ + VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: v5.5.0) */ + VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: v7.8.0) */ } virNetworkPortCreateFlags; virNetworkPortPtr diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-nodedev.h index cdf0df9e0a..7d4dbd58b9 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -68,31 +68,31 @@ int virNodeListDevices (virConnectPtr conn, * Since: v0.10.2 */ typedef enum { - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD */ - - VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices */ - VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: v1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: v1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: v1.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: v3.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: v6.8.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: v6.9.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: v7.9.0) */ + + VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: v7.3.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: v7.3.0) */ } virConnectListAllNodeDeviceFlags; int virConnectListAllNodeDevices (virConnectPtr conn, @@ -176,8 +176,8 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * Since: v2.2.0 */ typedef enum { - VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback */ - VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback */ + VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: v2.2.0) */ # ifdef VIR_ENUM_SENTINELS VIR_NODE_DEVICE_EVENT_ID_LAST @@ -185,6 +185,8 @@ typedef enum { * NB: this enum value will increase over time as new events are * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. + * + * Since: v2.2.0 */ # endif } virNodeDeviceEventID; @@ -225,13 +227,13 @@ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, * Since: v2.2.0 */ typedef enum { - VIR_NODE_DEVICE_EVENT_CREATED = 0, - VIR_NODE_DEVICE_EVENT_DELETED = 1, - VIR_NODE_DEVICE_EVENT_DEFINED = 2, - VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, + VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: v7.3.0) */ + VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: v7.3.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_NODE_DEVICE_EVENT_LAST + VIR_NODE_DEVICE_EVENT_LAST /* (Since: v2.2.0) */ # endif } virNodeDeviceEventLifecycleType; diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-nwfilter.h index e08616f5e2..279cc3740e 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -93,7 +93,7 @@ virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn, * Since: v7.7.0 */ typedef enum { - VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ } virNWFilterDefineFlags; /* @@ -126,7 +126,7 @@ int virNWFilterFree (virNWFilterPtr nwfilter); * Since: v7.8.0 */ typedef enum { - VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */ } virNWFilterBindingCreateFlags; const char* virNWFilterGetName (virNWFilterPtr nwfilter); diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h index 5af6f13b6d..537b5595b4 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -51,12 +51,12 @@ typedef virSecret *virSecretPtr; * Since: v0.7.1 */ typedef enum { - VIR_SECRET_USAGE_TYPE_NONE = 0, - VIR_SECRET_USAGE_TYPE_VOLUME = 1, - VIR_SECRET_USAGE_TYPE_CEPH = 2, - VIR_SECRET_USAGE_TYPE_ISCSI = 3, - VIR_SECRET_USAGE_TYPE_TLS = 4, - VIR_SECRET_USAGE_TYPE_VTPM = 5, + VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: v0.7.1) */ + VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: v0.7.1) */ + VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: v0.9.7) */ + VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: v1.0.4) */ + VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: v2.3.0) */ + VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: v5.6.0) */ # ifdef VIR_ENUM_SENTINELS VIR_SECRET_USAGE_TYPE_LAST @@ -64,6 +64,8 @@ typedef enum { * NB: this enum value will increase over time as new usage types are * added to the libvirt API. It reflects the last usage type supported * by this version of the libvirt API. + * + * Since: v0.9.7 */ # endif } virSecretUsageType; @@ -84,13 +86,13 @@ int virConnectListSecrets (virConnectPtr conn, */ typedef enum { VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never - stored persistently */ - VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, + stored persistently (Since: v0.10.2) */ + VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: v0.10.2) */ VIR_CONNECT_LIST_SECRETS_PRIVATE = 1 << 2, /* not revealed to any caller of libvirt, nor to any other - node */ - VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, + node (Since: v0.10.2) */ + VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: v0.10.2) */ } virConnectListAllSecretsFlags; int virConnectListAllSecrets(virConnectPtr conn, @@ -109,7 +111,7 @@ virSecretPtr virSecretLookupByUsage(virConnectPtr conn, * Since: v7.7.0 */ typedef enum { - VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ } virSecretDefineFlags; virSecretPtr virSecretDefineXML (virConnectPtr conn, @@ -154,8 +156,8 @@ int virSecretFree (virSecretPtr secret); * Since: v3.0.0 */ typedef enum { - VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback */ - VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback */ + VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: v3.0.0) */ + VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: v3.0.0) */ # ifdef VIR_ENUM_SENTINELS VIR_SECRET_EVENT_ID_LAST @@ -163,6 +165,8 @@ typedef enum { * NB: this enum value will increase over time as new events are * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. + * + * Since: v3.0.0 */ # endif } virSecretEventID; @@ -203,11 +207,11 @@ int virConnectSecretEventDeregisterAny(virConnectPtr conn, * Since: v3.0.0 */ typedef enum { - VIR_SECRET_EVENT_DEFINED = 0, - VIR_SECRET_EVENT_UNDEFINED = 1, + VIR_SECRET_EVENT_DEFINED = 0, /* (Since: v3.0.0) */ + VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: v3.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_SECRET_EVENT_LAST + VIR_SECRET_EVENT_LAST /* (Since: v3.0.0) */ # endif } virSecretEventLifecycleType; diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index 381a8d95bc..8f62b6f87a 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -54,14 +54,14 @@ typedef virStoragePool *virStoragePoolPtr; * Since: v0.4.1 */ typedef enum { - VIR_STORAGE_POOL_INACTIVE = 0, /* Not running */ - VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available */ - VIR_STORAGE_POOL_RUNNING = 2, /* Running normally */ - VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded */ - VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible */ + VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: v0.4.1) */ + VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: v0.4.1) */ + VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: v0.4.1) */ + VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: v0.8.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_STATE_LAST + VIR_STORAGE_POOL_STATE_LAST /* (Since: v0.9.10) */ # endif } virStoragePoolState; @@ -71,11 +71,11 @@ typedef enum { * Since: v0.4.1 */ typedef enum { - VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch */ - VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize */ - VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool */ - VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool */ - VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data */ + VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: v0.9.5) */ + VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: v0.9.5) */ } virStoragePoolBuildFlags; /** @@ -84,8 +84,8 @@ typedef enum { * Since: v0.4.1 */ typedef enum { - VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) */ - VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) */ + VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */ + VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */ } virStoragePoolDeleteFlags; /** @@ -94,20 +94,26 @@ typedef enum { * Since: v1.3.1 */ typedef enum { - /* Create the pool but do not perform pool build */ + /* Create the pool but do not perform pool build (Since: v1.3.1) */ VIR_STORAGE_POOL_CREATE_NORMAL = 0, - /* Create the pool and perform pool build without any flags */ + /* Create the pool and perform pool build without any flags (Since: v1.3.1) */ VIR_STORAGE_POOL_CREATE_WITH_BUILD = 1 << 0, /* Create the pool and perform pool build using the * VIR_STORAGE_POOL_BUILD_OVERWRITE flag. This is mutually - * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE */ + * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE + * + * Since: v1.3.1 + */ VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE = 1 << 1, /* Create the pool and perform pool build using the * VIR_STORAGE_POOL_BUILD_NO_OVERWRITE flag. This is mutually - * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE */ + * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE + * + * Since: v1.3.1 + */ VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE = 1 << 2, } virStoragePoolCreateFlags; @@ -159,16 +165,16 @@ typedef virStorageVol *virStorageVolPtr; * Since: v0.4.1 */ typedef enum { - VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes */ - VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes */ - VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume */ - VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) */ + VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: v0.4.1) */ + VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: v0.4.1) */ + VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: v0.9.5) */ + VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: v0.9.13) */ VIR_STORAGE_VOL_NETDIR = 4, /* Network accessible directory that can - * contain other network volumes */ - VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes */ + * contain other network volumes (Since: v1.2.0) */ + VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: v1.3.4) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_VOL_LAST + VIR_STORAGE_VOL_LAST /* (Since: v0.9.10) */ # endif } virStorageVolType; @@ -178,9 +184,9 @@ typedef enum { * Since: v0.4.1 */ typedef enum { - VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) */ - VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) */ - VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use */ + VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */ + VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */ + VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: v1.2.21) */ } virStorageVolDeleteFlags; /** @@ -189,26 +195,26 @@ typedef enum { * Since: v0.9.10 */ typedef enum { - VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes */ + VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_NNSA = 1, /* 4-pass NNSA Policy Letter - NAP-14.1-C (XVI-8) */ + NAP-14.1-C (XVI-8) (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_DOD = 2, /* 4-pass DoD 5220.22-M section - 8-306 procedure */ + 8-306 procedure (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_BSI = 3, /* 9-pass method recommended by the German Center of Security in - Information Technologies */ - VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence */ + Information Technologies (Since: v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_SCHNEIER = 5, /* 7-pass method described by Bruce Schneier in "Applied - Cryptography" (1996) */ - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data */ + Cryptography" (1996) (Since: v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: v0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: v0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data */ + VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_TRIM = 9, /* 1-pass, trim all data on the - volume by using TRIM or DISCARD */ + volume by using TRIM or DISCARD (Since: v1.3.2) */ # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_VOL_WIPE_ALG_LAST @@ -216,6 +222,8 @@ typedef enum { * NB: this enum value will increase over time as new algorithms are * added to the libvirt API. It reflects the last algorithm supported * by this version of the libvirt API. + * + * Since: v0.9.10 */ # endif } virStorageVolWipeAlgorithm; @@ -257,7 +265,7 @@ typedef virStorageVolInfo *virStorageVolInfoPtr; * Since: v0.9.13 */ typedef enum { - VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information */ + VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: v0.9.13) */ } virStorageXMLFlags; /* @@ -295,29 +303,29 @@ int virConnectListDefinedStoragePools(virConnectPtr conn, * Since: v0.10.2 */ typedef enum { - VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, - VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, - - VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, - VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, - - VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, - VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, - - VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, - VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, - VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, - VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, - VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, - VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, - VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, - VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, - VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, - VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, - VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, - VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, + VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: v1.2.1) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: v1.2.8) */ + VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: v3.1.0) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: v5.6.0) */ } virConnectListAllStoragePoolsFlags; int virConnectListAllStoragePools(virConnectPtr conn, @@ -349,7 +357,7 @@ virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn, * Since: v7.7.0 */ typedef enum { - VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema */ + VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ } virStoragePoolDefineFlags; /* @@ -427,8 +435,8 @@ const char* virStorageVolGetKey (virStorageVolPtr vol); * Since: v1.0.1 */ typedef enum { - VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, - VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy */ + VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: v1.0.1) */ + VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: v1.2.13) */ } virStorageVolCreateFlags; virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool, @@ -444,7 +452,7 @@ virStorageVolPtr virStorageVolCreateXMLFrom (virStoragePoolPtr pool, * Since: v3.4.0 */ typedef enum { - VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream */ + VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */ } virStorageVolDownloadFlags; int virStorageVolDownload (virStorageVolPtr vol, @@ -459,7 +467,7 @@ int virStorageVolDownload (virStorageVolPtr vol, * Since: v3.4.0 */ typedef enum { - VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream */ + VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */ } virStorageVolUploadFlags; int virStorageVolUpload (virStorageVolPtr vol, @@ -493,9 +501,9 @@ char * virStorageVolGetPath (virStorageVolPtr vol); * Since: v0.9.10 */ typedef enum { - VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size */ - VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current */ - VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity */ + VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: v0.9.10) */ + VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: v0.9.10) */ + VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: v0.9.10) */ } virStorageVolResizeFlags; int virStorageVolResize (virStorageVolPtr vol, @@ -525,8 +533,8 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * Since: v2.0.0 */ typedef enum { - VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback */ - VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback */ + VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: v2.0.0) */ # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_POOL_EVENT_ID_LAST @@ -534,6 +542,8 @@ typedef enum { * NB: this enum value will increase over time as new events are * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. + * + * Since: v2.0.0 */ # endif } virStoragePoolEventID; @@ -574,15 +584,15 @@ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, * Since: v2.0.0 */ typedef enum { - VIR_STORAGE_POOL_EVENT_DEFINED = 0, - VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, - VIR_STORAGE_POOL_EVENT_STARTED = 2, - VIR_STORAGE_POOL_EVENT_STOPPED = 3, - VIR_STORAGE_POOL_EVENT_CREATED = 4, - VIR_STORAGE_POOL_EVENT_DELETED = 5, + VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: v3.8.0) */ + VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: v3.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_EVENT_LAST + VIR_STORAGE_POOL_EVENT_LAST /* (Since: v2.0.0) */ # endif } virStoragePoolEventLifecycleType; diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-stream.h index 7c320e278e..a44612cd88 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -34,7 +34,7 @@ * Since: v0.7.2 */ typedef enum { - VIR_STREAM_NONBLOCK = (1 << 0), + VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: v0.7.2) */ } virStreamFlags; virStreamPtr virStreamNew(virConnectPtr conn, @@ -55,7 +55,7 @@ int virStreamRecv(virStreamPtr st, * Since: v3.4.0 */ typedef enum { - VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), + VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: v3.4.0) */ } virStreamRecvFlagsValues; int virStreamRecvFlags(virStreamPtr st, @@ -245,10 +245,10 @@ int virStreamSparseRecvAll(virStreamPtr stream, * Since: v0.7.2 */ typedef enum { - VIR_STREAM_EVENT_READABLE = (1 << 0), - VIR_STREAM_EVENT_WRITABLE = (1 << 1), - VIR_STREAM_EVENT_ERROR = (1 << 2), - VIR_STREAM_EVENT_HANGUP = (1 << 3), + VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: v0.7.2) */ } virStreamEventType; diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 2ae2b93be3..c4bcdf88bf 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -38,9 +38,9 @@ extern "C" { * Since: v0.1.0 */ typedef enum { - VIR_ERR_NONE = 0, - VIR_ERR_WARNING = 1, /* A simple warning */ - VIR_ERR_ERROR = 2 /* An error */ + VIR_ERR_NONE = 0, /* (Since: v0.1.0) */ + VIR_ERR_WARNING = 1, /* A simple warning (Since: v0.1.0) */ + VIR_ERR_ERROR = 2 /* An error (Since: v0.1.0) */ } virErrorLevel; /** @@ -52,98 +52,98 @@ typedef enum { * Since: v0.1.0 */ typedef enum { - VIR_FROM_NONE = 0, - VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer */ - VIR_FROM_XEND = 2, /* Error at connection with xend daemon */ - VIR_FROM_XENSTORE = 3, /* Error at connection with xen store */ - VIR_FROM_SEXPR = 4, /* Error in the S-Expression code */ - - VIR_FROM_XML = 5, /* Error in the XML code */ - VIR_FROM_DOM = 6, /* Error when operating on a domain */ - VIR_FROM_RPC = 7, /* Error in the XML-RPC code */ + VIR_FROM_NONE = 0, /* (Since: v0.1.0) */ + VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: v0.1.0) */ + VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: v0.1.0) */ + VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: v0.1.0) */ + VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: v0.1.0) */ + + VIR_FROM_XML = 5, /* Error in the XML code (Since: v0.1.0) */ + VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: v0.1.0) */ + VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: v0.1.1) */ VIR_FROM_PROXY = 8, /* Error in the proxy code; unused since - 0.8.6 */ - VIR_FROM_CONF = 9, /* Error in the configuration file handling */ - - VIR_FROM_QEMU = 10, /* Error at the QEMU daemon */ - VIR_FROM_NET = 11, /* Error when operating on a network */ - VIR_FROM_TEST = 12, /* Error from test driver */ - VIR_FROM_REMOTE = 13, /* Error from remote driver */ - VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver */ - - VIR_FROM_XENXM = 15, /* Error at Xen XM layer */ - VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code */ - VIR_FROM_LXC = 17, /* Error from Linux Container driver */ - VIR_FROM_STORAGE = 18, /* Error from storage driver */ - VIR_FROM_NETWORK = 19, /* Error from network config */ - - VIR_FROM_DOMAIN = 20, /* Error from domain config */ - VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 */ - VIR_FROM_NODEDEV = 22, /* Error from node device monitor */ - VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer */ - VIR_FROM_SECURITY = 24, /* Error from security framework */ - - VIR_FROM_VBOX = 25, /* Error from VirtualBox driver */ - VIR_FROM_INTERFACE = 26, /* Error when operating on an interface */ + 0.8.6 (Since: v0.1.3) */ + VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: v0.1.6) */ + + VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: v0.2.0) */ + VIR_FROM_NET = 11, /* Error when operating on a network (Since: v0.2.0) */ + VIR_FROM_TEST = 12, /* Error from test driver (Since: v0.2.3) */ + VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: v0.2.3) */ + VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: v0.3.1) */ + + VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: v0.4.1) */ + VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: v0.4.1) */ + VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: v0.4.2) */ + VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: v0.4.1) */ + VIR_FROM_NETWORK = 19, /* Error from network config (Since: v0.4.6) */ + + VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: v0.4.6) */ + VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: v0.5.0) */ + VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: v0.5.0) */ + VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: v0.5.0) */ + VIR_FROM_SECURITY = 24, /* Error from security framework (Since: v0.6.1) */ + + VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: v0.6.3) */ + VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: v0.6.4) */ VIR_FROM_ONE = 27, /* The OpenNebula driver no longer exists. - Retained for ABI/API compat only */ - VIR_FROM_ESX = 28, /* Error from ESX driver */ - VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 */ - - VIR_FROM_SECRET = 30, /* Error from secret storage */ - VIR_FROM_CPU = 31, /* Error from CPU driver */ - VIR_FROM_XENAPI = 32, /* Error from XenAPI */ - VIR_FROM_NWFILTER = 33, /* Error from network filter driver */ - VIR_FROM_HOOK = 34, /* Error from Synchronous hooks */ - - VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot */ - VIR_FROM_AUDIT = 36, /* Error from auditing subsystem */ - VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS */ - VIR_FROM_STREAMS = 38, /* Error from I/O streams */ - VIR_FROM_VMWARE = 39, /* Error from VMware driver */ - - VIR_FROM_EVENT = 40, /* Error from event loop impl */ - VIR_FROM_LIBXL = 41, /* Error from libxenlight driver */ - VIR_FROM_LOCKING = 42, /* Error from lock manager */ - VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver */ - VIR_FROM_CAPABILITIES = 44, /* Error from capabilities */ - - VIR_FROM_URI = 45, /* Error from URI handling */ - VIR_FROM_AUTH = 46, /* Error from auth handling */ - VIR_FROM_DBUS = 47, /* Error from DBus */ - VIR_FROM_PARALLELS = 48, /* Error from Parallels */ - VIR_FROM_DEVICE = 49, /* Error from Device */ - - VIR_FROM_SSH = 50, /* Error from libssh2 connection transport */ - VIR_FROM_LOCKSPACE = 51, /* Error from lockspace */ - VIR_FROM_INITCTL = 52, /* Error from initctl device communication */ - VIR_FROM_IDENTITY = 53, /* Error from identity code */ - VIR_FROM_CGROUP = 54, /* Error from cgroups */ - - VIR_FROM_ACCESS = 55, /* Error from access control manager */ - VIR_FROM_SYSTEMD = 56, /* Error from systemd code */ - VIR_FROM_BHYVE = 57, /* Error from bhyve driver */ - VIR_FROM_CRYPTO = 58, /* Error from crypto code */ - VIR_FROM_FIREWALL = 59, /* Error from firewall */ - - VIR_FROM_POLKIT = 60, /* Error from polkit code */ - VIR_FROM_THREAD = 61, /* Error from thread utils */ - VIR_FROM_ADMIN = 62, /* Error from admin backend */ - VIR_FROM_LOGGING = 63, /* Error from log manager */ - VIR_FROM_XENXL = 64, /* Error from Xen xl config code */ - - VIR_FROM_PERF = 65, /* Error from perf */ - VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport */ - VIR_FROM_RESCTRL = 67, /* Error from resource control */ - VIR_FROM_FIREWALLD = 68, /* Error from firewalld */ - VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint */ - - VIR_FROM_TPM = 70, /* Error from TPM */ - VIR_FROM_BPF = 71, /* Error from BPF code */ - VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver */ + Retained for ABI/API compat only (Since: v0.6.4) */ + VIR_FROM_ESX = 28, /* Error from ESX driver (Since: v0.7.0) */ + VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: v0.7.0) */ + + VIR_FROM_SECRET = 30, /* Error from secret storage (Since: v0.7.1) */ + VIR_FROM_CPU = 31, /* Error from CPU driver (Since: v0.7.5) */ + VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: v0.8.0) */ + VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: v0.8.0) */ + VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: v0.8.0) */ + + VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: v0.8.0) */ + VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: v0.8.5) */ + VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: v0.8.6) */ + VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: v0.8.6) */ + VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: v0.8.7) */ + + VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: v0.9.0) */ + VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: v0.9.0) */ + VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: v0.9.2) */ + VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: v0.9.5) */ + VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: v0.9.8) */ + + VIR_FROM_URI = 45, /* Error from URI handling (Since: v0.9.11) */ + VIR_FROM_AUTH = 46, /* Error from auth handling (Since: v0.9.11) */ + VIR_FROM_DBUS = 47, /* Error from DBus (Since: v0.9.12) */ + VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: v0.10.0) */ + VIR_FROM_DEVICE = 49, /* Error from Device (Since: v0.10.0) */ + + VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: v0.10.0) */ + VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: v1.0.0) */ + VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: v1.0.1) */ + VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: v1.0.4) */ + VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: v1.0.5) */ + + VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: v1.1.0) */ + VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: v1.1.1) */ + VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: v1.2.2) */ + VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: v1.2.3) */ + VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: v1.2.4) */ + + VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: v1.2.9) */ + VIR_FROM_THREAD = 61, /* Error from thread utils (Since: v1.2.14) */ + VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: v1.2.17) */ + VIR_FROM_LOGGING = 63, /* Error from log manager (Since: v1.3.0) */ + VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: v1.3.2) */ + + VIR_FROM_PERF = 65, /* Error from perf (Since: v1.3.3) */ + VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: v2.5.0) */ + VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: v3.7.0) */ + VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: v5.1.0) */ + VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: v5.2.0) */ + + VIR_FROM_TPM = 70, /* Error from TPM (Since: v5.6.0) */ + VIR_FROM_BPF = 71, /* Error from BPF code (Since: v5.10.0) */ + VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: v7.5.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_ERR_DOMAIN_LAST + VIR_ERR_DOMAIN_LAST /* (Since: v0.9.13) */ # endif } virErrorDomain; @@ -220,137 +220,137 @@ struct _virError { * Since: v0.1.0 */ typedef enum { - VIR_ERR_OK = 0, - VIR_ERR_INTERNAL_ERROR = 1, /* internal error */ - VIR_ERR_NO_MEMORY = 2, /* memory allocation failure */ - VIR_ERR_NO_SUPPORT = 3, /* no support for this function */ - VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname */ - VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor */ - VIR_ERR_INVALID_CONN = 6, /* invalid connection object */ - VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object */ - VIR_ERR_INVALID_ARG = 8, /* invalid function argument */ - VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed */ - VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed */ - VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed */ - VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code */ - VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr */ + VIR_ERR_OK = 0, /* (Since: v0.1.0) */ + VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: v0.1.0) */ + VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: v0.1.0) */ + VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: v0.1.0) */ + VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: v0.1.0) */ + VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: v0.1.0) */ + VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: v0.1.0) */ + VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: v0.1.0) */ + VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: v0.1.0) */ + VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: v0.1.0) */ + VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: v0.1.0) */ + VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: v0.1.0) */ + VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: v0.1.0) */ + VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: v0.1.0) */ VIR_ERR_NO_XEN = 14, /* could not open Xen hypervisor - control */ - VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call */ - VIR_ERR_OS_TYPE = 16, /* unknown OS type */ - VIR_ERR_NO_KERNEL = 17, /* missing kernel information */ - VIR_ERR_NO_ROOT = 18, /* missing root device information */ - VIR_ERR_NO_SOURCE = 19, /* missing source device information */ - VIR_ERR_NO_TARGET = 20, /* missing target device information */ - VIR_ERR_NO_NAME = 21, /* missing domain name information */ - VIR_ERR_NO_OS = 22, /* missing domain OS information */ - VIR_ERR_NO_DEVICE = 23, /* missing domain devices information */ - VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control */ - VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered */ + control (Since: v0.1.0) */ + VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: v0.1.0) */ + VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: v0.1.0) */ + VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: v0.1.0) */ + VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: v0.1.0) */ + VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: v0.1.0) */ + VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: v0.1.0) */ + VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: v0.1.0) */ + VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: v0.1.0) */ + VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: v0.1.0) */ + VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: v0.1.0) */ + VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: v0.1.0) */ VIR_ERR_CALL_FAILED = 26, /* not supported by the drivers - (DEPRECATED) */ + (DEPRECATED) (Since: v0.1.0) */ VIR_ERR_XML_ERROR = 27, /* an XML description is not well - formed or broken */ - VIR_ERR_DOM_EXIST = 28, /* the domain already exist */ + formed or broken (Since: v0.1.1) */ + VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: v0.1.1) */ VIR_ERR_OPERATION_DENIED = 29, /* operation forbidden on read-only - connections */ - VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file */ - VIR_ERR_READ_FAILED = 31, /* failed to read a conf file */ - VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file */ + connections (Since: v0.1.4) */ + VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: v0.1.6) */ + VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: v0.1.6) */ + VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: v0.1.6) */ VIR_ERR_CONF_SYNTAX = 33, /* failed to parse the syntax of a - conf file */ - VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file */ - VIR_ERR_XML_DETAIL = 35, /* detail of an XML error */ - VIR_ERR_INVALID_NETWORK = 36, /* invalid network object */ - VIR_ERR_NETWORK_EXIST = 37, /* the network already exist */ - VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure */ - VIR_ERR_RPC = 39, /* some sort of RPC error */ - VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call */ - VIR_WAR_NO_NETWORK = 41, /* failed to start network */ + conf file (Since: v0.1.6) */ + VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: v0.1.6) */ + VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: v0.1.9) */ + VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: v0.2.0) */ + VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: v0.2.0) */ + VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: v0.2.1) */ + VIR_ERR_RPC = 39, /* some sort of RPC error (Since: v0.2.3) */ + VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: v0.2.3) */ + VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: v0.2.3) */ VIR_ERR_NO_DOMAIN = 42, /* domain not found or unexpectedly - disappeared */ - VIR_ERR_NO_NETWORK = 43, /* network not found */ - VIR_ERR_INVALID_MAC = 44, /* invalid MAC address */ - VIR_ERR_AUTH_FAILED = 45, /* authentication failed */ - VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object */ - VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object */ - VIR_WAR_NO_STORAGE = 48, /* failed to start storage */ - VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found */ - VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found */ - VIR_WAR_NO_NODE = 51, /* failed to start node driver */ - VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object */ - VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found */ - VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found */ + disappeared (Since: v0.3.0) */ + VIR_ERR_NO_NETWORK = 43, /* network not found (Since: v0.3.0) */ + VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: v0.3.1) */ + VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: v0.4.1) */ + VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: v0.4.1) */ + VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: v0.4.1) */ + VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: v0.4.1) */ + VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: v0.4.1) */ + VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: v0.4.1) */ + VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: v0.5.0) */ + VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: v0.5.0) */ + VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: v0.5.0) */ + VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: v0.6.1) */ VIR_ERR_OPERATION_INVALID = 55, /* operation is not applicable at this - time */ - VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver */ - VIR_ERR_NO_INTERFACE = 57, /* interface driver not running */ - VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object */ + time (Since: v0.6.4) */ + VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: v0.6.4) */ + VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: v0.6.4) */ + VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: v0.6.4) */ VIR_ERR_MULTIPLE_INTERFACES = 59, /* more than one matching interface - found */ - VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver */ - VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object */ - VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found */ - VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found */ - VIR_WAR_NO_SECRET = 64, /* failed to start secret storage */ - VIR_ERR_INVALID_SECRET = 65, /* invalid secret */ - VIR_ERR_NO_SECRET = 66, /* secret not found */ + found (Since: v0.7.0) */ + VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: v0.8.0) */ + VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: v0.8.0) */ + VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: v0.8.0) */ + VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: v0.8.0) */ + VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: v0.7.1) */ + VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: v0.7.1) */ + VIR_ERR_NO_SECRET = 66, /* secret not found (Since: v0.7.1) */ VIR_ERR_CONFIG_UNSUPPORTED = 67, /* unsupported configuration - construct */ - VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation */ + construct (Since: v0.7.3) */ + VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: v0.7.3) */ VIR_ERR_MIGRATE_PERSIST_FAILED = 69,/* a migration worked, but making the - VM persist on the dest host failed */ - VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed */ - VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot */ - VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found */ - VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid */ + VM persist on the dest host failed (Since: v0.7.3) */ + VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: v0.8.0) */ + VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: v0.8.0) */ + VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: v0.8.0) */ + VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: v0.9.0) */ VIR_ERR_ARGUMENT_UNSUPPORTED = 74, /* valid API use but unsupported by - the given driver */ - VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed */ - VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built */ + the given driver (Since: v0.9.4) */ + VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: v0.9.5) */ + VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: v0.9.5) */ VIR_ERR_SNAPSHOT_REVERT_RISKY = 77, /* force was not requested for a - risky domain snapshot revert */ + risky domain snapshot revert (Since: v0.9.7) */ VIR_ERR_OPERATION_ABORTED = 78, /* operation on a domain was - canceled/aborted by user */ - VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled */ - VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present */ - VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe */ - VIR_ERR_OVERFLOW = 82, /* integer overflow */ - VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job */ + canceled/aborted by user (Since: v0.9.9) */ + VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: v0.9.10) */ + VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: v0.9.10) */ + VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: v0.9.11) */ + VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: v0.9.11) */ + VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: v0.9.12) */ VIR_ERR_OPERATION_UNSUPPORTED = 84, /* The requested operation is not - supported */ - VIR_ERR_SSH = 85, /* error in ssh transport driver */ + supported (Since: v0.10.0) */ + VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: v0.10.0) */ VIR_ERR_AGENT_UNRESPONSIVE = 86, /* guest agent is unresponsive, - not running or not usable */ - VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use */ + not running or not usable (Since: v0.10.0) */ + VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: v1.0.0) */ VIR_ERR_ACCESS_DENIED = 88, /* operation on the object/resource - was denied */ - VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service */ - VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists */ - VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU */ - VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema */ - VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL */ - VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable */ - VIR_ERR_NO_SERVER = 95, /* Server was not found */ - VIR_ERR_NO_CLIENT = 96, /* Client was not found */ + was denied (Since: v1.1.0) */ + VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: v1.1.1) */ + VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: v1.1.4) */ + VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: v1.2.6) */ + VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: v1.2.12) */ + VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: v1.2.18) */ + VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: v1.3.3) */ + VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: v1.3.3) */ + VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: v1.3.5) */ VIR_ERR_AGENT_UNSYNCED = 97, /* guest agent replies with wrong id - to guest-sync command (DEPRECATED) */ - VIR_ERR_LIBSSH = 98, /* error in libssh transport driver */ - VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device */ - VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding */ - VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding */ - VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint */ - VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found */ - VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found */ - VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object */ - VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist */ - VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found */ - VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found */ - VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used */ - VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found */ + to guest-sync command (DEPRECATED) (Since: v2.3.0) */ + VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: v2.5.0) */ + VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: v4.1.0) */ + VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: v4.5.0) */ + VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: v4.5.0) */ + VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: v5.2.0) */ + VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: v5.2.0) */ + VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: v5.2.0) */ + VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: v5.5.0) */ + VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: v5.5.0) */ + VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: v5.5.0) */ + VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: v6.1.0) */ + VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: v6.10.0) */ + VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: v7.1.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_ERR_NUMBER_LAST + VIR_ERR_NUMBER_LAST /* (Since: v5.0.0) */ # endif } virErrorNumber; -- 2.35.1

Either create or append to existing docstring, the version (git tag) that a given enum value was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-admin.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h index e414f776e4..e77dbada53 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -205,12 +205,12 @@ int virAdmClientGetTransport(virAdmClientPtr client); int virAdmClientFree(virAdmClientPtr client); typedef enum { - VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket */ - VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket */ - VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket */ + VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */ + VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v2.0.0) */ + VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: v2.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_CLIENT_TRANS_LAST + VIR_CLIENT_TRANS_LAST /* (Since: v2.0.0) */ # endif } virClientTransport; -- 2.35.1

Either create or append to existing docstring, the version (git tag) that a given typedef was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-admin.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h index d24067b304..67b17fe0c0 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -37,6 +37,8 @@ extern "C" { * * a virAdmConnect is a private structure representing a connection to * libvirt daemon. + * + * Since: v2.0.0 */ typedef struct _virAdmConnect virAdmConnect; @@ -45,6 +47,8 @@ typedef struct _virAdmConnect virAdmConnect; * * a virAdmServer is a private structure and client-side representation of * a remote server object + * + * Since: v2.0.0 */ typedef struct _virAdmServer virAdmServer; @@ -53,6 +57,8 @@ typedef struct _virAdmServer virAdmServer; * * a virAdmClient is a private structure and client-side representation of * a remote server's client object (as server sees clients connected to it) + * + * Since: v2.0.0 */ typedef struct _virAdmClient virAdmClient; @@ -62,6 +68,8 @@ typedef struct _virAdmClient virAdmClient; * a virAdmConnectPtr is pointer to a virAdmConnect private structure, * this is the type used to reference a connection to the daemon * in the API. + * + * Since: v2.0.0 */ typedef virAdmConnect *virAdmConnectPtr; @@ -71,6 +79,8 @@ typedef virAdmConnect *virAdmConnectPtr; * a virAdmServerPtr is a pointer to a virAdmServer structure, * this is the type used to reference client-side representation of a * remote server object throughout all the APIs. + * + * Since: v2.0.0 */ typedef virAdmServer *virAdmServerPtr; @@ -80,6 +90,8 @@ typedef virAdmServer *virAdmServerPtr; * a virAdmClientPtr is a pointer to a virAdmClient structure, * this is the type used to reference client-side representation of a * client object throughout all the APIs. + * + * Since: v2.0.0 */ typedef virAdmClient *virAdmClientPtr; @@ -216,6 +228,11 @@ long long virAdmClientGetTimestamp(virAdmClientPtr client); int virAdmClientGetTransport(virAdmClientPtr client); int virAdmClientFree(virAdmClientPtr client); +/** + * virClientTransport: + * + * Since: v2.0.0 + */ typedef enum { VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */ VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v2.0.0) */ -- 2.35.1

Either create or append to existing docstring, the version (git tag) that a given function was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-admin.h | 2 ++ src/admin/libvirt-admin.c | 62 +++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h index 67b17fe0c0..989348ee7b 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -120,6 +120,8 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * @opaque: opaque client data * * A callback to be registered, in case a connection was closed. + * + * Since: v2.0.0 */ typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn, int reason, diff --git a/src/admin/libvirt-admin.c b/src/admin/libvirt-admin.c index 01546a7bc2..3cdaaf1de2 100644 --- a/src/admin/libvirt-admin.c +++ b/src/admin/libvirt-admin.c @@ -84,6 +84,8 @@ virAdmGlobalInit(void) * necessary for the application to call virAdmInitialize. * * Returns 0 in case of success, -1 in case of error + * + * Since: v2.0.0 */ int virAdmInitialize(void) @@ -200,6 +202,8 @@ virAdmGetDefaultURI(virConf *conf, char **uristr) * Opens connection to admin interface of the daemon. * * Returns @virAdmConnectPtr object or NULL on error + * + * Since: v2.0.0 */ virAdmConnectPtr virAdmConnectOpen(const char *name, unsigned int flags) @@ -284,6 +288,8 @@ virAdmConnectOpen(const char *name, unsigned int flags) * some other object still has a temporary reference to the connection, but the * application should not try to further use a connection after the * virAdmConnectClose that matches the initial open. + * + * Since: v2.0.0 */ int virAdmConnectClose(virAdmConnectPtr conn) @@ -319,6 +325,8 @@ virAdmConnectClose(virAdmConnectPtr conn) * would increment the reference count. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v2.0.0 */ int virAdmConnectRef(virAdmConnectPtr conn) @@ -346,6 +354,8 @@ virAdmConnectRef(virAdmConnectPtr conn) * instead. * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmGetVersion(unsigned long long *libVer) @@ -377,6 +387,8 @@ virAdmGetVersion(unsigned long long *libVer) * * Returns 1, if the connection is alive, 0 if there isn't an existing * connection at all or the channel has already been closed, or -1 on error. + * + * Since: v2.0.0 */ int virAdmConnectIsAlive(virAdmConnectPtr conn) @@ -411,6 +423,8 @@ virAdmConnectIsAlive(virAdmConnectPtr conn) * * Returns an URI string related to the connection or NULL in case of an error. * Caller is responsible for freeing the string. + * + * Since: v2.0.0 */ char * virAdmConnectGetURI(virAdmConnectPtr conn) @@ -445,6 +459,8 @@ virAdmConnectGetURI(virAdmConnectPtr conn) * context. * * Returns 0 on success, -1 on error + * + * Since: v2.0.0 */ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb, @@ -498,6 +514,8 @@ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, * registration, it will be invoked. * * Returns 0 on success, -1 on error + * + * Since: v2.0.0 */ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb) @@ -528,6 +546,8 @@ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, * major * 1,000,000 + minor * 1,000 + release. * * Returns 0 on success, -1 on failure and @libVer follows this format: + * + * Since: v2.0.0 */ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, unsigned long long *libVer) @@ -556,6 +576,8 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * * Returns a pointer to the name or NULL. The string doesn't need to be * deallocated since its lifetime will be the same as the server object. + * + * Since: v2.0.0 */ const char * virAdmServerGetName(virAdmServerPtr srv) @@ -576,6 +598,8 @@ virAdmServerGetName(virAdmServerPtr srv) * The data structure is freed and should not be used thereafter. * * Returns 0 on success, -1 on failure. + * + * Since: v2.0.0 */ int virAdmServerFree(virAdmServerPtr srv) { @@ -599,6 +623,8 @@ int virAdmServerFree(virAdmServerPtr srv) * Get client's unique numeric ID. * * Returns numeric value used for client's ID or -1 in case of an error. + * + * Since: v2.0.0 */ unsigned long long virAdmClientGetID(virAdmClientPtr client) @@ -622,6 +648,8 @@ virAdmClientGetID(virAdmClientPtr client) * Returns client's connection timestamp (seconds from epoch in UTC) or 0 * (epoch time) if libvirt doesn't have any information about client's * connection time, or -1 in case of an error. + * + * Since: v2.0.0 */ long long virAdmClientGetTimestamp(virAdmClientPtr client) @@ -647,6 +675,8 @@ virAdmClientGetTimestamp(virAdmClientPtr client) * * Returns integer representation of the connection transport used by @client * (this will be one of virClientTransport) or -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmClientGetTransport(virAdmClientPtr client) @@ -666,6 +696,8 @@ virAdmClientGetTransport(virAdmClientPtr client) * structure is freed and should not be used thereafter. * * Returns 0 in success, -1 on failure. + * + * Since: v2.0.0 */ int virAdmClientFree(virAdmClientPtr client) { @@ -697,6 +729,8 @@ int virAdmClientFree(virAdmClientPtr client) * this extra element from the final count. * Caller is responsible to call virAdmServerFree() on each list element, * followed by freeing @servers. + * + * Since: v2.0.0 */ int virAdmConnectListServers(virAdmConnectPtr conn, @@ -735,6 +769,8 @@ virAdmConnectListServers(virAdmConnectPtr conn, * * Returns the requested server or NULL in case of failure. If the * server cannot be found, then VIR_ERR_NO_SERVER error is raised. + * + * Since: v2.0.0 */ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, @@ -776,6 +812,8 @@ virAdmConnectLookupServer(virAdmConnectPtr conn, * VIR_THREADPOOL_WORKERS_CURRENT * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, @@ -815,6 +853,8 @@ virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, * failure. * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, @@ -856,6 +896,8 @@ virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, * excluding this extra element from the final count. * Caller is responsible to call virAdmClientFree() on each list element, * followed by freeing @clients. + * + * Since: v2.0.0 */ int virAdmServerListClients(virAdmServerPtr srv, @@ -894,6 +936,8 @@ virAdmServerListClients(virAdmServerPtr srv, * * Returns the requested client or NULL in case of failure. If the * client could not be found, then VIR_ERR_NO_CLIENT error is raised. + * + * Since: v2.0.0 */ virAdmClientPtr virAdmServerLookupClient(virAdmServerPtr srv, @@ -940,6 +984,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * Returns 0 if the information has been successfully retrieved or -1 in case * of an error. + * + * Since: v2.0.0 */ int virAdmClientGetInfo(virAdmClientPtr client, @@ -974,6 +1020,8 @@ virAdmClientGetInfo(virAdmClientPtr client, * * Returns 0 if the daemon's connection with @client was closed successfully * or -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmClientClose(virAdmClientPtr client, unsigned int flags) @@ -1011,6 +1059,8 @@ int virAdmClientClose(virAdmClientPtr client, * * Returns 0 on success, allocating @params to size returned in @nparams, or * -1 in case of an error. Caller is responsible for deallocating @params. + * + * Since: v2.0.0 */ int virAdmServerGetClientLimits(virAdmServerPtr srv, @@ -1051,6 +1101,8 @@ virAdmServerGetClientLimits(virAdmServerPtr srv, * * Returns 0 if the limits have been changed successfully or -1 in case of an * error. + * + * Since: v2.0.0 */ int virAdmServerSetClientLimits(virAdmServerPtr srv, @@ -1089,6 +1141,8 @@ virAdmServerSetClientLimits(virAdmServerPtr srv, * * Returns 0 if the TLS files have been updated successfully or -1 in case of an * error. + * + * Since: v6.2.0 */ int virAdmServerUpdateTlsFiles(virAdmServerPtr srv, @@ -1127,6 +1181,8 @@ virAdmServerUpdateTlsFiles(virAdmServerPtr srv, * caller. Caller is also responsible for freeing @outputs correctly. * * Returns the count of outputs in @outputs, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, @@ -1168,6 +1224,8 @@ virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, * * Returns the number of filters returned in @filters, or -1 in case of * an error. + * + * Since: v3.0.0 */ int virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, @@ -1208,6 +1266,8 @@ virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, * * Returns 0 if the new output or the set of outputs has been defined * successfully, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, @@ -1246,6 +1306,8 @@ virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, * * Returns 0 if the new filter or the set of filters has been defined * successfully, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectSetLoggingFilters(virAdmConnectPtr conn, -- 2.35.1

On Fri, Apr 22, 2022 at 09:23:38PM +0200, Victor Toso wrote: This is a very peculiar way to format the signature. I'll change it to the more common def retrieve_comment_tags(self, name: str, comment: str) -> (str, str): before pushing. Reviewed-by: Andrea Bolognani <abologna(a)redhat.com&gt; -- Andrea Bolognani / Red Hat / Virtualization

This patch adds 'version' parameter to the generated XML API for typedefs It'll require, for new additions, to add a comment with the version that the typedef value was added. An example bellow of code diff and the change in the generated XML. Note that the Since tag is removed from the comment as there is a proper field for it in the XML. Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- scripts/apibuild.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index ddc2fff7af..24ca98bd1c 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -2298,9 +2298,11 @@ class docBuilder: def serialize_typedef(self, output, name): id = self.idx.typedefs[name] + (since, comment) = self.retrieve_comment_tags(name, id.extra) + version_tag = len(since) > 0 and f" version='{since}'" or "" if id.info[0:7] == 'struct ': - output.write(" <struct name='%s' file='%s' type='%s'" % ( - name, self.modulename_file(id.header), id.info)) + output.write(" <struct name='%s' file='%s' type='%s'%s" % ( + name, self.modulename_file(id.header), id.info, version_tag)) name = id.info[7:] if (name in self.idx.structs and isinstance(self.idx.structs[name].info, (list, tuple))): @@ -2323,12 +2325,11 @@ class docBuilder: else: output.write("/>\n") else: - output.write(" <typedef name='%s' file='%s' type='%s'" % ( - name, self.modulename_file(id.header), id.info)) + output.write(" <typedef name='%s' file='%s' type='%s'%s" % ( + name, self.modulename_file(id.header), id.info, version_tag)) try: - desc = id.extra - if desc is not None and desc != "": - output.write(">\n <info><![CDATA[%s]]></info>\n" % (desc)) + if comment is not None and comment != "": + output.write(">\n <info><![CDATA[%s]]></info>\n" % (comment)) output.write(" </typedef>\n") else: output.write("/>\n") -- 2.35.1

This patch adds 'version' parameter to generated XML API for functions and functypes. The 'version' metadata has been added with e0e0bf6628 by parsing .syms files. This commit does not override that but it will warn if there is not 'Since' metadata with new additions. There is not clear benefit for keeping both. For now, I've added a warning in case there is a mismatch between the version provided by .syms and docstring. Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- scripts/apibuild.py | 70 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 13 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index b77eea0624..b86d20e364 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -111,6 +111,17 @@ ignored_functions = { "virErrorCopyNew": "private", } +# The version in the .sym file might differnt from +# the real version that the function was introduced. +# This dict's value is the correct version, as it should +# be in the docstrings. +ignored_function_versions = { + 'virDomainSetBlockThreshold': '3.2.0', + 'virAdmServerUpdateTlsFiles': '6.2.0', + 'virDomainBlockPeek': '0.4.3', + 'virDomainMemoryPeek': '0.4.3', +} + ignored_macros = { "_virSchedParameter": "backward compatibility macro for virTypedParameter", "_virBlkioParameter": "backward compatibility macro for virTypedParameter", @@ -2185,9 +2196,10 @@ class docBuilder: self.scanVersions() # Fetch tags from the comment. Only 'Since' supported at the moment. - # Return the tags and the original comment without the tags. - def retrieve_comment_tags(self, name: str, comment: str - ) -> (str, str): + # For functions, since tags are on Return comments. + # Return the tags and the original comments, but without the tags. + def retrieve_comment_tags(self, name: str, comment: str, return_comment="" + ) -> (str, str, str): since = "" if comment is not None: comment_match = re.search(r"\(?Since: v?(\d+\.\d+\.\d+\.?\d?)\)?", @@ -2200,9 +2212,20 @@ class docBuilder: # Only the version since = comment_match.group(1) + if since == "" and return_comment is not None: + return_match = re.search(r"\(?Since: v?(\d+\.\d+\.\d+\.?\d?)\)?", + return_comment) + if return_match: + # Remove Since tag from the comment + (start, end) = return_match.span() + return_comment = return_comment[:start] + return_comment[end:] + return_comment = return_comment.strip() + # Only the version + since = return_match.group(1) + if since == "": self.warning("Missing 'Since' tag for: " + name) - return (since, comment) + return (since, comment, return_comment) def modulename_file(self, file): module = os.path.basename(file) @@ -2238,7 +2261,7 @@ class docBuilder: output.write(" type='%s'" % info[2]) if info[1] is not None and info[1] != '': # Search for 'Since' version tag - (since, comment) = self.retrieve_comment_tags(name, info[1]) + (since, comment, _) = self.retrieve_comment_tags(name, info[1]) if len(since) > 0: output.write(" version='%s'" % escape(since)) if len(comment) > 0: @@ -2268,7 +2291,7 @@ class docBuilder: else: output.write(" raw='%s'" % escape(rawValue)) - (since, comment) = self.retrieve_comment_tags(name, desc) + (since, comment, _) = self.retrieve_comment_tags(name, desc) if len(since) > 0: output.write(" version='%s'" % escape(since)) output.write(">\n") @@ -2302,7 +2325,7 @@ class docBuilder: def serialize_typedef(self, output, name): id = self.idx.typedefs[name] - (since, comment) = self.retrieve_comment_tags(name, id.extra) + (since, comment, _) = self.retrieve_comment_tags(name, id.extra) version_tag = len(since) > 0 and f" version='{since}'" or "" if id.info[0:7] == 'struct ': output.write(" <struct name='%s' file='%s' type='%s'%s" % ( @@ -2354,6 +2377,12 @@ class docBuilder: if name == debugsym and not quiet: print("=>", id) + (ret, params, desc) = id.info + return_comment = (ret is not None and ret[1] is not None) and ret[1] or "" + (since, comment, return_comment) = self.retrieve_comment_tags(name, desc, return_comment) + # Simple way to avoid setting empty version + version_tag = len(since) > 0 and f" version='{since}'" or "" + # NB: this is consumed by a regex in 'getAPIFilenames' in hvsupport.pl if id.type == "function": ver = self.versions[name] @@ -2363,9 +2392,10 @@ class docBuilder: name, self.modulename_file(id.header), self.modulename_file(id.module), self.versions[name])) else: - output.write(" <functype name='%s' file='%s' module='%s'>\n" % ( + output.write(" <functype name='%s' file='%s' module='%s'%s>\n" % ( name, self.modulename_file(id.header), - self.modulename_file(id.module))) + self.modulename_file(id.module), + version_tag)) # # Processing of conditionals modified by Bill 1/1/05 # @@ -2376,19 +2406,33 @@ class docBuilder: apstr = apstr + " &amp;&amp; " apstr = apstr + cond output.write(" <cond>%s</cond>\n" % (apstr)) + try: - (ret, params, desc) = id.info - output.write(" <info><![CDATA[%s]]></info>\n" % (desc)) + # For functions, we get the since version from .syms files. + # This is an extra check to see that docstrings are correct + # and to avoid wrong versions in the .sym files too. + ver = name in self.versions and self.versions[name] or None + if len(since) > 0 and ver is not None and since != ver: + if name in ignored_function_versions: + allowedver = ignored_function_versions[name] + if allowedver != since: + self.warning(f"Function {name} has allowed version {allowedver} but docstring says {since}") + else: + self.warning(f"Function {name} has symversion {ver} but docstring says {since}") + + output.write(" <info><![CDATA[%s]]></info>\n" % (comment)) self.indexString(name, desc) + if ret[0] is not None: if ret[0] == "void": output.write(" <return type='void'/>\n") - elif (ret[1] is None or ret[1] == '') and name not in ignored_functions: + elif (return_comment == '') and name not in ignored_functions: self.error("Missing documentation for return of function `%s'" % name) else: output.write(" <return type='%s' info='%s'/>\n" % ( - ret[0], escape(ret[1]))) + ret[0], escape(return_comment))) self.indexString(name, ret[1]) + for param in params: if param[0] == 'void': continue -- 2.35.1

So we can use for comments that are being hold in helper variables. Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- scripts/apibuild.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index b86d20e364..40ee0a3c63 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -733,15 +733,18 @@ class CParser: line = line.replace('*', '', 1) return line - def cleanupComment(self): - if not isinstance(self.comment, str): - return - # remove the leading * on multi-line comments - lines = self.comment.splitlines(True) + def cleanup_code_comment(self, comment: str) -> str: + if not isinstance(comment, str) or comment == "": + return "" + + lines = comment.splitlines(True) com = "" for line in lines: com = com + self.strip_lead_star(line) - self.comment = com.strip() + return com.strip() + + def cleanupComment(self): + self.comment = self.cleanup_code_comment(self.comment) def parseComment(self, token): com = token[1] -- 2.35.1

Since: v1.2.3 -> Since: 1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-admin.h | 64 +- include/libvirt/libvirt-common.h.in | 46 +- include/libvirt/libvirt-domain-checkpoint.h | 40 +- include/libvirt/libvirt-domain-snapshot.h | 74 +- include/libvirt/libvirt-domain.h | 1862 +++++++++---------- include/libvirt/libvirt-event.h | 26 +- include/libvirt/libvirt-host.h | 200 +- include/libvirt/libvirt-interface.h | 18 +- include/libvirt/libvirt-network.h | 142 +- include/libvirt/libvirt-nodedev.h | 82 +- include/libvirt/libvirt-nwfilter.h | 16 +- include/libvirt/libvirt-qemu.h | 26 +- include/libvirt/libvirt-secret.h | 56 +- include/libvirt/libvirt-storage.h | 220 +-- include/libvirt/libvirt-stream.h | 30 +- include/libvirt/virterror.h | 418 ++--- src/admin/libvirt-admin.c | 62 +- src/libvirt-domain-checkpoint.c | 24 +- src/libvirt-domain-snapshot.c | 42 +- src/libvirt-domain.c | 370 ++-- src/libvirt-host.c | 68 +- src/libvirt-interface.c | 42 +- src/libvirt-lxc.c | 8 +- src/libvirt-network.c | 90 +- src/libvirt-nodedev.c | 54 +- src/libvirt-nwfilter.c | 48 +- src/libvirt-qemu.c | 12 +- src/libvirt-secret.c | 40 +- src/libvirt-storage.c | 114 +- src/libvirt-stream.c | 34 +- src/libvirt.c | 12 +- src/util/virerror.c | 30 +- src/util/virevent.c | 18 +- src/util/virtypedparam-public.c | 38 +- 34 files changed, 2213 insertions(+), 2213 deletions(-) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h index 989348ee7b..8533658932 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -38,7 +38,7 @@ extern "C" { * a virAdmConnect is a private structure representing a connection to * libvirt daemon. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef struct _virAdmConnect virAdmConnect; @@ -48,7 +48,7 @@ typedef struct _virAdmConnect virAdmConnect; * a virAdmServer is a private structure and client-side representation of * a remote server object * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef struct _virAdmServer virAdmServer; @@ -58,7 +58,7 @@ typedef struct _virAdmServer virAdmServer; * a virAdmClient is a private structure and client-side representation of * a remote server's client object (as server sees clients connected to it) * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef struct _virAdmClient virAdmClient; @@ -69,7 +69,7 @@ typedef struct _virAdmClient virAdmClient; * this is the type used to reference a connection to the daemon * in the API. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef virAdmConnect *virAdmConnectPtr; @@ -80,7 +80,7 @@ typedef virAdmConnect *virAdmConnectPtr; * this is the type used to reference client-side representation of a * remote server object throughout all the APIs. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef virAdmServer *virAdmServerPtr; @@ -91,7 +91,7 @@ typedef virAdmServer *virAdmServerPtr; * this is the type used to reference client-side representation of a * client object throughout all the APIs. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef virAdmClient *virAdmClientPtr; @@ -121,7 +121,7 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * * A callback to be registered, in case a connection was closed. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn, int reason, @@ -147,7 +147,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * Macro for the threadpool minWorkers limit: represents the bottom limit to * number of active workers in threadpool, as VIR_TYPED_PARAM_UINT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_WORKERS_MIN "minWorkers" @@ -159,7 +159,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * The value of this limit has to be greater than VIR_THREADPOOL_WORKERS_MIN * at all times. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_WORKERS_MAX "maxWorkers" @@ -169,7 +169,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * Macro for the threadpool nPrioWorkers attribute: represents the current number * of active priority workers in threadpool, as VIR_TYPED_PARAM_UINT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers" @@ -182,7 +182,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_WORKERS_FREE "freeWorkers" @@ -195,7 +195,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers" @@ -208,7 +208,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_THREADPOOL_JOB_QUEUE_DEPTH "jobQueueDepth" @@ -233,15 +233,15 @@ int virAdmClientFree(virAdmClientPtr client); /** * virClientTransport: * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef enum { - VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */ - VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v2.0.0) */ - VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: v2.0.0) */ + VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: 2.0.0) */ + VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: 2.0.0) */ + VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: 2.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_CLIENT_TRANS_LAST /* (Since: v2.0.0) */ + VIR_CLIENT_TRANS_LAST /* (Since: 2.0.0) */ # endif } virClientTransport; @@ -265,7 +265,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_READONLY "readonly" @@ -278,7 +278,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_SOCKET_ADDR "sock_addr" @@ -291,7 +291,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_SASL_USER_NAME "sasl_user_name" @@ -305,7 +305,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME "tls_x509_dname" @@ -319,7 +319,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_UNIX_USER_ID "unix_user_id" @@ -333,7 +333,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_UNIX_USER_NAME "unix_user_name" @@ -347,7 +347,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_UNIX_GROUP_ID "unix_group_id" @@ -361,7 +361,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_UNIX_GROUP_NAME "unix_group_name" @@ -375,7 +375,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_UNIX_PROCESS_ID "unix_process_id" @@ -389,7 +389,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_CLIENT_INFO_SELINUX_CONTEXT "selinux_context" @@ -408,7 +408,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * Macro for per-server nclients_max limit: represents the upper limit to * number of clients connected to the server, as uint. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_SERVER_CLIENTS_MAX "nclients_max" @@ -421,7 +421,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_SERVER_CLIENTS_CURRENT "nclients" @@ -432,7 +432,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * to number of clients connected to the server, but not authenticated yet, * as VIR_TYPED_PARAM_UINT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_SERVER_CLIENTS_UNAUTH_MAX "nclients_unauth_max" @@ -446,7 +446,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth" diff --git a/include/libvirt/libvirt-common.h.in b/include/libvirt/libvirt-common.h.in index 78751cea7c..ccdbb2a100 100644 --- a/include/libvirt/libvirt-common.h.in +++ b/include/libvirt/libvirt-common.h.in @@ -71,7 +71,7 @@ extern "C" { * Macro providing the version of the library as * version * 1,000,000 + minor * 1000 + micro * - * Since: v0.0.1 + * Since: 0.0.1 */ # define LIBVIR_VERSION_NUMBER @LIBVIRT_VERSION_NUMBER@ @@ -88,7 +88,7 @@ extern "C" { * // some code that only works in 1.1.3 and newer * #endif * - * Since: v1.2.0 + * Since: 1.2.0 */ # define LIBVIR_CHECK_VERSION(major, minor, micro) \ ((major) * 1000000 + (minor) * 1000 + (micro) <= LIBVIR_VERSION_NUMBER) @@ -108,23 +108,23 @@ extern "C" { * abide by this requirement may lead to application deadlocks * or crashes. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef void (*virFreeCallback)(void *opaque); /** * virConnectCloseReason: * - * Since: v0.10.0 + * Since: 0.10.0 */ typedef enum { - VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: v0.10.0) */ - VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: v0.10.0) */ - VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: v0.10.0) */ - VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: v0.10.0) */ + VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: 0.10.0) */ + VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: 0.10.0) */ + VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: 0.10.0) */ + VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: 0.10.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_CLOSE_REASON_LAST /* (Since: v0.10.0) */ + VIR_CONNECT_CLOSE_REASON_LAST /* (Since: 0.10.0) */ # endif } virConnectCloseReason; @@ -133,19 +133,19 @@ typedef enum { * * Express the type of a virTypedParameter * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_TYPED_PARAM_INT = 1, /* integer case (Since: v0.9.2) */ - VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: v0.9.2) */ - VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: v0.9.2) */ - VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: v0.9.2) */ - VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: v0.9.2) */ - VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: v0.9.2) */ - VIR_TYPED_PARAM_STRING = 7, /* string case (Since: v0.9.8) */ + VIR_TYPED_PARAM_INT = 1, /* integer case (Since: 0.9.2) */ + VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: 0.9.2) */ + VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: 0.9.2) */ + VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: 0.9.2) */ + VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: 0.9.2) */ + VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: 0.9.2) */ + VIR_TYPED_PARAM_STRING = 7, /* string case (Since: 0.9.8) */ # ifdef VIR_ENUM_SENTINELS - VIR_TYPED_PARAM_LAST /* (Since: v0.9.10) */ + VIR_TYPED_PARAM_LAST /* (Since: 0.9.10) */ # endif } virTypedParameterType; @@ -156,7 +156,7 @@ typedef enum { * * These enums should not conflict with those of virDomainModificationImpact. * - * Since: v0.9.8 + * Since: 0.9.8 */ typedef enum { /* 1 << 0 is reserved for virDomainModificationImpact */ @@ -172,7 +172,7 @@ typedef enum { * setting the flag can be used to reject servers that cannot * return typed strings, even if no strings would be returned. * - * Since: v0.9.8 + * Since: 0.9.8 */ VIR_TYPED_PARAM_STRING_OKAY = 1 << 2, @@ -183,7 +183,7 @@ typedef enum { * * Macro providing the field length of virTypedParameter name * - * Since: v0.9.2 + * Since: 0.9.2 */ # define VIR_TYPED_PARAM_FIELD_LENGTH 80 @@ -196,7 +196,7 @@ typedef enum { * virMemoryParameter are aliases of this type, for use when * targeting libvirt earlier than 0.9.2. * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef struct _virTypedParameter virTypedParameter; @@ -219,7 +219,7 @@ struct _virTypedParameter { * * a pointer to a virTypedParameter structure. * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef virTypedParameter *virTypedParameterPtr; diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/libvirt-domain-checkpoint.h index 5476325503..c2f946b805 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -35,7 +35,7 @@ * domain disks have been altered since a point in time, but by itself does * not allow reverting back to that point in time. * - * Since: v5.2.0 + * Since: 5.2.0 */ typedef struct _virDomainCheckpoint virDomainCheckpoint; @@ -46,7 +46,7 @@ typedef struct _virDomainCheckpoint virDomainCheckpoint; * private structure, and is the type used to reference a domain * checkpoint in the API. * - * Since: v5.2.0 + * Since: 5.2.0 */ typedef virDomainCheckpoint *virDomainCheckpointPtr; @@ -57,17 +57,17 @@ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint); /** * virDomainCheckpointCreateFlags: * - * Since: v5.6.0 + * Since: 5.6.0 */ typedef enum { VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE = (1 << 0), /* Restore or alter - metadata (Since: v5.6.0) */ + metadata (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_QUIESCE = (1 << 1), /* use guest agent to quiesce all mounted file systems within - the domain (Since: v5.6.0) */ + the domain (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE_VALIDATE = (1 << 2), /* validate disk data state - when redefining a checkpoint (Since: v6.10.0) */ + when redefining a checkpoint (Since: 6.10.0) */ } virDomainCheckpointCreateFlags; /* Create a checkpoint using the current VM state. */ @@ -77,14 +77,14 @@ virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, /** * virDomainCheckpointXMLFlags: * - * Since: v5.6.0 + * Since: 5.6.0 */ typedef enum { - VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: v5.6.0) */ + VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN = (1 << 1), /* Suppress <domain> - subelement (Since: v5.6.0) */ + subelement (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_SIZE = (1 << 2), /* Include dynamic - per-<disk> size (Since: v5.6.0) */ + per-<disk> size (Since: 5.6.0) */ } virDomainCheckpointXMLFlags; /* Dump the XML of a checkpoint */ @@ -101,23 +101,23 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, * recursive. Remaining bits come in groups; if all bits from a group * are 0, then that group is not used to filter results. * - * Since: v5.6.0 + * Since: 5.6.0 */ typedef enum { VIR_DOMAIN_CHECKPOINT_LIST_ROOTS = (1 << 0), /* Filter by checkpoints with no parents, when - listing a domain (Since: v5.6.0) */ + listing a domain (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_DESCENDANTS = (1 << 0), /* List all descendants, not just children, when - listing a checkpoint (Since: v5.6.0) */ + listing a checkpoint (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL = (1 << 1), /* Ensure parents occur before children in - the resulting list (Since: v5.6.0) */ + the resulting list (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_LEAVES = (1 << 2), /* Filter by checkpoints - with no children (Since: v5.6.0) */ + with no children (Since: 5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES = (1 << 3), /* Filter by checkpoints - that have children (Since: v5.6.0) */ + that have children (Since: 5.6.0) */ } virDomainCheckpointListFlags; /* Get all checkpoint objects for this domain */ @@ -144,12 +144,12 @@ virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr check * * Delete a checkpoint * - * Since: v5.6.0 + * Since: 5.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) */ - VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v5.6.0) */ + VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 5.6.0) */ + VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 5.6.0) */ + VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 5.6.0) */ } virDomainCheckpointDeleteFlags; int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/libvirt-domain-snapshot.h index fc7aaba747..a11cd3f823 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -35,7 +35,7 @@ * time, with the intent that the guest can be reverted back to that * state at a later time. * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef struct _virDomainSnapshot virDomainSnapshot; @@ -45,7 +45,7 @@ typedef struct _virDomainSnapshot virDomainSnapshot; * A virDomainSnapshotPtr is pointer to a virDomainSnapshot private structure, * and is the type used to reference a domain snapshot in the API. * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef virDomainSnapshot *virDomainSnapshotPtr; @@ -56,32 +56,32 @@ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot); /** * virDomainSnapshotCreateFlags: * - * Since: v0.9.5 + * Since: 0.9.5 */ typedef enum { VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE = (1 << 0), /* Restore or alter - metadata (Since: v0.9.5) */ + metadata (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT = (1 << 1), /* With redefine, make - snapshot current (Since: v0.9.5) */ + snapshot current (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA = (1 << 2), /* Make snapshot without - remembering it (Since: v0.9.5) */ + remembering it (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_HALT = (1 << 3), /* Stop running guest - after snapshot (Since: v0.9.5) */ + after snapshot (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY = (1 << 4), /* disk snapshot, not - full system (Since: v0.9.5) */ + full system (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT = (1 << 5), /* reuse any existing - external files (Since: v0.9.10) */ + external files (Since: 0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE = (1 << 6), /* use guest agent to quiesce all mounted file systems within - the domain (Since: v0.9.10) */ + the domain (Since: 0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC = (1 << 7), /* atomically avoid - partial changes (Since: v0.9.11) */ + partial changes (Since: 0.9.11) */ VIR_DOMAIN_SNAPSHOT_CREATE_LIVE = (1 << 8), /* create the snapshot while the guest is - running (Since: v1.0.1) */ + running (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_CREATE_VALIDATE = (1 << 9), /* validate the XML - against the schema (Since: v5.6.0) */ + against the schema (Since: 5.6.0) */ } virDomainSnapshotCreateFlags; /* Take a snapshot of the current VM state */ @@ -91,10 +91,10 @@ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, /** * virDomainSnapshotXMLFlags: * - * Since: v5.1.0 + * Since: 5.1.0 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */ + VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: 5.1.0) */ } virDomainSnapshotXMLFlags; /* Dump the XML of a snapshot */ @@ -113,48 +113,48 @@ char *virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, * recursive. Remaining bits come in groups; if all bits from a group are * 0, then that group is not used to filter results. * - * Since: v0.9.5 + * Since: 0.9.5 */ typedef enum { VIR_DOMAIN_SNAPSHOT_LIST_ROOTS = (1 << 0), /* Filter by snapshots with no parents, when - listing a domain (Since: v0.9.5) */ + listing a domain (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS = (1 << 0), /* List all descendants, not just children, when - listing a snapshot (Since: v0.9.7) */ + listing a snapshot (Since: 0.9.7) */ VIR_DOMAIN_SNAPSHOT_LIST_LEAVES = (1 << 2), /* Filter by snapshots - with no children (Since: v0.9.7) */ + with no children (Since: 0.9.7) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_LEAVES = (1 << 3), /* Filter by snapshots - that have children (Since: v0.9.13) */ + that have children (Since: 0.9.13) */ VIR_DOMAIN_SNAPSHOT_LIST_METADATA = (1 << 1), /* Filter by snapshots - which have metadata (Since: v0.9.5) */ + which have metadata (Since: 0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_METADATA = (1 << 4), /* Filter by snapshots - with no metadata (Since: v0.9.13) */ + with no metadata (Since: 0.9.13) */ VIR_DOMAIN_SNAPSHOT_LIST_INACTIVE = (1 << 5), /* Filter by snapshots taken while guest was - shut off (Since: v1.0.1) */ + shut off (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_ACTIVE = (1 << 6), /* Filter by snapshots taken while guest was active, and with - memory state (Since: v1.0.1) */ + memory state (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_DISK_ONLY = (1 << 7), /* Filter by snapshots taken while guest was active, but without - memory state (Since: v1.0.1) */ + memory state (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_INTERNAL = (1 << 8), /* Filter by snapshots stored internal to - disk images (Since: v1.0.1) */ + disk images (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_EXTERNAL = (1 << 9), /* Filter by snapshots that use files external - to disk images (Since: v1.0.1) */ + to disk images (Since: 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_TOPOLOGICAL = (1 << 10), /* Ensure parents occur before children in - the resulting list (Since: v5.2.0) */ + the resulting list (Since: 5.2.0) */ } virDomainSnapshotListFlags; /* Return the number of snapshots for this domain */ @@ -211,13 +211,13 @@ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, /** * virDomainSnapshotRevertFlags: * - * Since: v0.9.5 + * Since: 0.9.5 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: v0.9.5) */ - VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: v0.9.5) */ - VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: v0.9.7) */ - VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */ + VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: 0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: 0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: 0.9.7) */ + VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: 8.1.0) */ } virDomainSnapshotRevertFlags; /* Revert the domain to a point-in-time snapshot. The @@ -232,12 +232,12 @@ int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, * * Delete a snapshot * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v0.8.0) */ - VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v0.9.5) */ - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 0.8.0) */ + VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 0.9.5) */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 0.9.5) */ } virDomainSnapshotDeleteFlags; int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 9386f5189c..2edef9c4e1 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -33,7 +33,7 @@ * * a virDomain is a private structure representing a domain. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef struct _virDomain virDomain; @@ -43,7 +43,7 @@ typedef struct _virDomain virDomain; * a virDomainPtr is pointer to a virDomain private structure, this is the * type used to reference a domain in the API. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef virDomain *virDomainPtr; @@ -52,18 +52,18 @@ typedef virDomain *virDomainPtr; * * A domain may be in different states at a given point in time * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef enum { - VIR_DOMAIN_NOSTATE = 0, /* no state (Since: v0.0.1) */ - VIR_DOMAIN_RUNNING = 1, /* the domain is running (Since: v0.0.1) */ - VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource (Since: v0.0.1) */ - VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user (Since: v0.0.1) */ - VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down (Since: v0.0.1) */ - VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off (Since: v0.0.1) */ - VIR_DOMAIN_CRASHED = 6, /* the domain is crashed (Since: v0.0.2) */ + VIR_DOMAIN_NOSTATE = 0, /* no state (Since: 0.0.1) */ + VIR_DOMAIN_RUNNING = 1, /* the domain is running (Since: 0.0.1) */ + VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource (Since: 0.0.1) */ + VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user (Since: 0.0.1) */ + VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down (Since: 0.0.1) */ + VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off (Since: 0.0.1) */ + VIR_DOMAIN_CRASHED = 6, /* the domain is crashed (Since: 0.0.2) */ VIR_DOMAIN_PMSUSPENDED = 7, /* the domain is suspended by guest - power management (Since: v0.9.11) */ + power management (Since: 0.9.11) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_LAST @@ -72,7 +72,7 @@ typedef enum { * added to the libvirt API. It reflects the last state supported * by this version of the libvirt API. * - * Since: v0.9.5 + * Since: 0.9.5 */ # endif } virDomainState; @@ -80,152 +80,152 @@ typedef enum { /** * virDomainNostateReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_NOSTATE_UNKNOWN = 0, /* (Since: v0.9.2) */ + VIR_DOMAIN_NOSTATE_UNKNOWN = 0, /* (Since: 0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_NOSTATE_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_NOSTATE_LAST /* (Since: 0.9.10) */ # endif } virDomainNostateReason; /** * virDomainRunningReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_RUNNING_UNKNOWN = 0, /* (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration (Since: v0.9.2) */ - VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_UNKNOWN = 0, /* (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration (Since: 0.9.2) */ + VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process (Since: 0.9.2) */ VIR_DOMAIN_RUNNING_WAKEUP = 8, /* returned from pmsuspended due to - wakeup event (Since: v0.9.11) */ - VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed (Since: v1.1.1) */ - VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode (Since: v1.3.3) */ + wakeup event (Since: 0.9.11) */ + VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed (Since: 1.1.1) */ + VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode (Since: 1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_RUNNING_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_RUNNING_LAST /* (Since: 0.9.10) */ # endif } virDomainRunningReason; /** * virDomainBlockedReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ + VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCKED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_BLOCKED_LAST /* (Since: 0.9.10) */ # endif } virDomainBlockedReason; /** * virDomainPausedReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot (Since: v0.9.2) */ - VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process (Since: v0.9.5) */ - VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot (Since: v1.0.1) */ - VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash (Since: v1.1.1) */ - VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started (Since: v1.2.14) */ - VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration (Since: v1.3.3) */ - VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy (Since: v1.3.3) */ + VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot (Since: 0.9.2) */ + VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process (Since: 0.9.5) */ + VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot (Since: 1.0.1) */ + VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash (Since: 1.1.1) */ + VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started (Since: 1.2.14) */ + VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration (Since: 1.3.3) */ + VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy (Since: 1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PAUSED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_PAUSED_LAST /* (Since: 0.9.10) */ # endif } virDomainPausedReason; /** * virDomainShutdownReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ - VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: v0.9.2) */ + VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */ + VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: 0.9.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_SHUTDOWN_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_LAST /* (Since: 0.9.10) */ # endif } virDomainShutdownReason; /** * virDomainShutoffReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file (Since: v0.9.2) */ - VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start (Since: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file (Since: 0.9.2) */ + VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start (Since: 0.9.2) */ VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT = 7, /* restored from a snapshot which was - * taken while domain was shutoff (Since: v0.9.2) */ + * taken while domain was shutoff (Since: 0.9.2) */ VIR_DOMAIN_SHUTOFF_DAEMON = 8, /* daemon decides to kill domain - during reconnection processing (Since: v4.10.0) */ + during reconnection processing (Since: 4.10.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_SHUTOFF_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_SHUTOFF_LAST /* (Since: 0.9.10) */ # endif } virDomainShutoffReason; /** * virDomainCrashedReason: * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: v0.9.2) */ - VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: v1.1.1) */ + VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: 0.9.2) */ + VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: 1.1.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CRASHED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_CRASHED_LAST /* (Since: 0.9.10) */ # endif } virDomainCrashedReason; /** * virDomainPMSuspendedReason: * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef enum { - VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, /* (Since: v0.9.11) */ + VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, /* (Since: 0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: v0.9.11) */ + VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: 0.9.11) */ # endif } virDomainPMSuspendedReason; /** * virDomainPMSuspendedDiskReason: * - * Since: v1.0.0 + * Since: 1.0.0 */ typedef enum { - VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, /* (Since: v1.0.0) */ + VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, /* (Since: 1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: v1.0.0) */ + VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: 1.0.0) */ # endif } virDomainPMSuspendedDiskReason; @@ -234,20 +234,20 @@ typedef enum { * * Current state of a control interface to the domain. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef enum { - VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: v0.9.3) */ + VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: 0.9.3) */ VIR_DOMAIN_CONTROL_JOB = 1, /* background job is running (can be monitored by virDomainGetJobInfo); only - limited set of commands may be allowed (Since: v0.9.3) */ - VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command (Since: v0.9.3) */ + limited set of commands may be allowed (Since: 0.9.3) */ + VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command (Since: 0.9.3) */ VIR_DOMAIN_CONTROL_ERROR = 3, /* unusable, domain cannot be fully operated, possible reason is provided - in the details field (Since: v0.9.3) */ + in the details field (Since: 0.9.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CONTROL_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_CONTROL_LAST /* (Since: 0.9.10) */ # endif } virDomainControlState; @@ -256,20 +256,20 @@ typedef enum { * * Reason for the error state. * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef enum { VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0, /* server didn't provide a - reason (Since: v1.2.14) */ + reason (Since: 1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_UNKNOWN = 1, /* unknown reason for the - error (Since: v1.2.14) */ + error (Since: 1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_MONITOR = 2, /* monitor connection is - broken (Since: v1.2.14) */ + broken (Since: 1.2.14) */ VIR_DOMAIN_CONTROL_ERROR_REASON_INTERNAL = 3, /* error caused due to - internal failure in libvirt (Since: v1.2.14) + internal failure in libvirt (Since: 1.2.14) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CONTROL_ERROR_REASON_LAST /* (Since: v1.2.14) */ + VIR_DOMAIN_CONTROL_ERROR_REASON_LAST /* (Since: 1.2.14) */ # endif } virDomainControlErrorReason; @@ -279,7 +279,7 @@ typedef enum { * Structure filled in by virDomainGetControlInfo and providing details about * current state of control interface to a domain. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef struct _virDomainControlInfo virDomainControlInfo; struct _virDomainControlInfo { @@ -296,7 +296,7 @@ struct _virDomainControlInfo { * * Pointer to virDomainControlInfo structure. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef virDomainControlInfo *virDomainControlInfoPtr; @@ -318,12 +318,12 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * * These enums should not conflict with those of virTypedParameterFlags. * - * Since: v0.9.2 + * Since: 0.9.2 */ typedef enum { - VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: v0.9.2) */ - VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. (Since: v0.9.2) */ - VIR_DOMAIN_AFFECT_CONFIG = 1 << 1, /* Affect persistent domain state. (Since: v0.9.2) */ + VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: 0.9.2) */ + VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. (Since: 0.9.2) */ + VIR_DOMAIN_AFFECT_CONFIG = 1 << 1, /* Affect persistent domain state. (Since: 0.9.2) */ /* 1 << 2 is reserved for virTypedParameterFlags */ } virDomainModificationImpact; @@ -333,7 +333,7 @@ typedef enum { * a virDomainInfo is a structure filled by virDomainGetInfo() and extracting * runtime information for a given active Domain * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef struct _virDomainInfo virDomainInfo; @@ -350,7 +350,7 @@ struct _virDomainInfo { * * a virDomainInfoPtr is a pointer to a virDomainInfo structure. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef virDomainInfo *virDomainInfoPtr; @@ -360,16 +360,16 @@ typedef virDomainInfo *virDomainInfoPtr; * Flags OR'ed together to provide specific behaviour when creating a * Domain. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef enum { - VIR_DOMAIN_NONE = 0, /* Default behavior (Since: v0.0.1) */ - VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state (Since: v0.8.2) */ - VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed (Since: v0.9.3) */ - VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution (Since: v0.9.4) */ - VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save (Since: v0.9.5) */ - VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema (Since: v1.2.12) */ - VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template (Since: v8.1.0) */ + VIR_DOMAIN_NONE = 0, /* Default behavior (Since: 0.0.1) */ + VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state (Since: 0.8.2) */ + VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed (Since: 0.9.3) */ + VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution (Since: 0.9.4) */ + VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save (Since: 0.9.5) */ + VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema (Since: 1.2.12) */ + VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template (Since: 8.1.0) */ } virDomainCreateFlags; @@ -381,7 +381,7 @@ typedef enum { * Macro represents proportional weight of the scheduler used on the * host cpu, when using the posix scheduler, as a ullong. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_CPU_SHARES "cpu_shares" @@ -391,7 +391,7 @@ typedef enum { * Macro represents the enforcement period for a quota, in microseconds, * for whole domain, when using the posix scheduler, as a ullong. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_DOMAIN_SCHEDULER_GLOBAL_PERIOD "global_period" @@ -401,7 +401,7 @@ typedef enum { * Macro represents the maximum bandwidth to be used within a period for * whole domain, when using the posix scheduler, as an llong. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA "global_quota" @@ -411,7 +411,7 @@ typedef enum { * Macro represents the enforcement period for a quota, in microseconds, * for vcpus only, when using the posix scheduler, as a ullong. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD "vcpu_period" @@ -421,7 +421,7 @@ typedef enum { * Macro represents the maximum bandwidth to be used within a period for * vcpus only, when using the posix scheduler, as an llong. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA "vcpu_quota" @@ -432,7 +432,7 @@ typedef enum { * when using the posix scheduler, for all emulator activity not tied to * vcpus, as a ullong. * - * Since: v0.10.0 + * Since: 0.10.0 */ # define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD "emulator_period" @@ -443,7 +443,7 @@ typedef enum { * all emulator activity not tied to vcpus, when using the posix scheduler, * as an llong. * - * Since: v0.10.0 + * Since: 0.10.0 */ # define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA "emulator_quota" @@ -453,7 +453,7 @@ typedef enum { * Macro represents the enforcement period for a quota, in microseconds, * for IOThreads only, when using the posix scheduler, as a ullong. * - * Since: v2.2.0 + * Since: 2.2.0 */ # define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD "iothread_period" @@ -463,7 +463,7 @@ typedef enum { * Macro represents the maximum bandwidth to be used within a period for * IOThreads only, when using the posix scheduler, as an llong. * - * Since: v2.2.0 + * Since: 2.2.0 */ # define VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA "iothread_quota" @@ -473,7 +473,7 @@ typedef enum { * Macro represents the relative weight, when using the credit * scheduler, as a uint. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_WEIGHT "weight" @@ -483,7 +483,7 @@ typedef enum { * Macro represents the maximum scheduler cap, when using the credit * scheduler, as a uint. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_CAP "cap" @@ -493,7 +493,7 @@ typedef enum { * Macro represents the scheduler reservation value, when using the * allocation scheduler, as an llong. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_RESERVATION "reservation" @@ -503,7 +503,7 @@ typedef enum { * Macro represents the scheduler limit value, when using the * allocation scheduler, as an llong. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_LIMIT "limit" @@ -513,7 +513,7 @@ typedef enum { * Macro represents the scheduler shares value, when using the * allocation scheduler, as an int. * - * Since: v0.9.7 + * Since: 0.9.7 */ # define VIR_DOMAIN_SCHEDULER_SHARES "shares" @@ -549,7 +549,7 @@ int virDomainSetSchedulerParametersFlags (virDomainPtr domain, * * NB. Here 'long long' means 64 bit integer. * - * Since: v0.3.3 + * Since: 0.3.3 */ typedef struct _virDomainBlockStats virDomainBlockStatsStruct; @@ -566,7 +566,7 @@ struct _virDomainBlockStats { * * A pointer to a virDomainBlockStats structure * - * Since: v0.3.2 + * Since: 0.3.2 */ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; @@ -577,7 +577,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro providing the field length of parameter names when using * virDomainBlockStatsFlags(). * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH @@ -587,7 +587,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total number of read bytes of the * block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_READ_BYTES "rd_bytes" @@ -597,7 +597,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total read requests of the * block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_READ_REQ "rd_operations" @@ -607,7 +607,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total time spend on cache reads in * nano-seconds of the block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES "rd_total_times" @@ -617,7 +617,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total number of write bytes of the * block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES "wr_bytes" @@ -627,7 +627,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total write requests of the * block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ "wr_operations" @@ -637,7 +637,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total time spend on cache writes in * nano-seconds of the block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES "wr_total_times" @@ -647,7 +647,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total flush requests of the * block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ "flush_operations" @@ -657,7 +657,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * Macro represents the total time spend on cache flushing in * nano-seconds of the block device, as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES "flush_total_times" @@ -666,7 +666,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * * In Xen this returns the mysterious 'oo_req', as an llong. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_DOMAIN_BLOCK_STATS_ERRS "errs" @@ -680,7 +680,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * * NB. Here 'long long' means 64 bit integer. * - * Since: v0.3.3 + * Since: 0.3.3 */ typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct; @@ -700,7 +700,7 @@ struct _virDomainInterfaceStats { * * A pointer to a virDomainInterfaceStats structure * - * Since: v0.3.2 + * Since: 0.3.2 */ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr; @@ -709,12 +709,12 @@ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr; * * Memory Statistics Tags: * - * Since: v0.7.5 + * Since: 0.7.5 */ typedef enum { - /* The total amount of data read from swap space (in kB). (Since: v0.7.5) */ + /* The total amount of data read from swap space (in kB). (Since: 0.7.5) */ VIR_DOMAIN_MEMORY_STAT_SWAP_IN = 0, - /* The total amount of memory written out to swap space (in kB). (Since: v0.7.5) */ + /* The total amount of memory written out to swap space (in kB). (Since: 0.7.5) */ VIR_DOMAIN_MEMORY_STAT_SWAP_OUT = 1, /* @@ -723,12 +723,12 @@ typedef enum { * required, it is considered a major fault. If not, it is a minor fault. * These are expressed as the number of faults that have occurred. * - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT = 2, /* - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT = 3, @@ -737,7 +737,7 @@ typedef enum { * is available but used for reclaimable caches should NOT be reported as * free. This value is expressed in kB. * - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_DOMAIN_MEMORY_STAT_UNUSED = 4, @@ -747,21 +747,21 @@ typedef enum { * balloon driver is in use or if the guest OS does not initialize all * assigned pages. This value is expressed in kB. * - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_DOMAIN_MEMORY_STAT_AVAILABLE = 5, /* * Current balloon value (in KB). * - * Since: v0.9.3 + * Since: 0.9.3 */ VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON = 6, /* Resident Set Size of the process running the domain. This value * is in kB * - * Since: v0.9.10 + * Since: 0.9.10 */ VIR_DOMAIN_MEMORY_STAT_RSS = 7, @@ -769,14 +769,14 @@ typedef enum { * How much the balloon can be inflated without pushing the guest system * to swap, corresponds to 'Available' in /proc/meminfo * - * Since: v2.1.0 + * Since: 2.1.0 */ VIR_DOMAIN_MEMORY_STAT_USABLE = 8, /* * Timestamp of the last update of statistics, in seconds. * - * Since: v2.1.0 + * Since: 2.1.0 */ VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE = 9, @@ -785,7 +785,7 @@ typedef enum { * additional I/O (in kB). Typically these pages are used for caching files * from disk. * - * Since: v4.6.0 + * Since: 4.6.0 */ VIR_DOMAIN_MEMORY_STAT_DISK_CACHES = 10, @@ -793,7 +793,7 @@ typedef enum { * The number of successful huge page allocations from inside the domain via * virtio balloon. * - * Since: v5.4.0 + * Since: 5.4.0 */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGALLOC = 11, @@ -801,7 +801,7 @@ typedef enum { * The number of failed huge page allocations from inside the domain via * virtio balloon. * - * Since: v5.4.0 + * Since: 5.4.0 */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGFAIL = 12, @@ -809,19 +809,19 @@ typedef enum { * The number of statistics supported by this version of the interface. * To add new statistics, add them to the enum and increase this value. * - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_DOMAIN_MEMORY_STAT_NR = 13, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR /* (Since: v0.9.10) */ + VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR /* (Since: 0.9.10) */ # endif } virDomainMemoryStatTags; /** * virDomainMemoryStatStruct: * - * Since: v0.7.5 + * Since: 0.7.5 */ typedef struct _virDomainMemoryStat virDomainMemoryStatStruct; @@ -833,7 +833,7 @@ struct _virDomainMemoryStat { /** * virDomainMemoryStatPtr: * - * Since: v0.7.5 + * Since: 0.7.5 */ typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; @@ -843,14 +843,14 @@ typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; * * Domain core dump flags. * - * Since: v0.7.5 + * Since: 0.7.5 */ typedef enum { - VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: v0.7.5) */ - VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: v0.7.5) */ - VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution (Since: v0.9.4) */ - VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes (Since: v0.9.7) */ - VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory (Since: v0.9.13) */ + VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: 0.7.5) */ + VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: 0.7.5) */ + VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution (Since: 0.9.4) */ + VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes (Since: 0.9.7) */ + VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory (Since: 0.9.13) */ } virDomainCoreDumpFlags; /** @@ -858,17 +858,17 @@ typedef enum { * * Values for specifying different formats of domain core dumps. * - * Since: v1.2.3 + * Since: 1.2.3 */ typedef enum { - VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: v1.2.3) */ + VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: 1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB, /* kdump-compressed format, with - * zlib compression (Since: v1.2.3) */ + * zlib compression (Since: 1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_LZO, /* kdump-compressed format, with - * lzo compression (Since: v1.2.3) */ + * lzo compression (Since: 1.2.3) */ VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_SNAPPY, /* kdump-compressed format, with - * snappy compression (Since: v1.2.3) */ - VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format (Since: v7.4.0) */ + * snappy compression (Since: 1.2.3) */ + VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format (Since: 7.4.0) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_CORE_DUMP_FORMAT_LAST /* @@ -876,7 +876,7 @@ typedef enum { * added to the libvirt API. It reflects the last format supported * by this version of the libvirt API. * - * Since: v1.2.3 + * Since: 1.2.3 */ # endif } virDomainCoreDumpFormat; @@ -886,7 +886,7 @@ typedef enum { * * Domain migration flags. * - * Since: v0.3.2 + * Since: 0.3.2 */ typedef enum { /* Do not pause the domain during migration. The domain's memory will @@ -895,7 +895,7 @@ typedef enum { * faster then it can be transferred. The domain can be manually paused * anytime during migration using virDomainSuspend. * - * Since: v0.3.2 + * Since: 0.3.2 */ VIR_MIGRATE_LIVE = (1 << 0), @@ -905,7 +905,7 @@ typedef enum { * libvirtd controls the migration by calling the destination daemon * directly. * - * Since: v0.7.2 + * Since: 0.7.2 */ VIR_MIGRATE_PEER2PEER = (1 << 1), @@ -917,7 +917,7 @@ typedef enum { * Note the less-common spelling that we're stuck with: * VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED. * - * Since: v0.7.2 + * Since: 0.7.2 */ VIR_MIGRATE_TUNNELLED = (1 << 2), @@ -926,14 +926,14 @@ typedef enum { * VIR_MIGRATE_UNDEFINE_SOURCE is not used, it will end up persistent on * both hosts. * - * Since: v0.7.3 + * Since: 0.7.3 */ VIR_MIGRATE_PERSIST_DEST = (1 << 3), /* Undefine the domain on the source host once migration successfully * finishes. * - * Since: v0.7.3 + * Since: 0.7.3 */ VIR_MIGRATE_UNDEFINE_SOURCE = (1 << 4), @@ -941,7 +941,7 @@ typedef enum { * the virDomainPtr returned by the migration API) has to be called * explicitly to resume domain's virtual CPUs. * - * Since: v0.7.5 + * Since: 0.7.5 */ VIR_MIGRATE_PAUSED = (1 << 5), @@ -952,7 +952,7 @@ typedef enum { * * This flag and VIR_MIGRATE_NON_SHARED_INC are mutually exclusive. * - * Since: v0.8.2 + * Since: 0.8.2 */ VIR_MIGRATE_NON_SHARED_DISK = (1 << 6), @@ -964,7 +964,7 @@ typedef enum { * * This flag and VIR_MIGRATE_NON_SHARED_DISK are mutually exclusive. * - * Since: v0.8.2 + * Since: 0.8.2 */ VIR_MIGRATE_NON_SHARED_INC = (1 << 7), @@ -973,7 +973,7 @@ typedef enum { * Explicitly setting this flag will cause migration to fail if either the * source or the destination does not support it. * - * Since: v0.9.4 + * Since: 0.9.4 */ VIR_MIGRATE_CHANGE_PROTECTION = (1 << 8), @@ -985,7 +985,7 @@ typedef enum { * is unsafe unless the disk images are stored on coherent clustered * filesystem, such as GFS2 or GPFS. * - * Since: v0.9.11 + * Since: 0.9.11 */ VIR_MIGRATE_UNSAFE = (1 << 9), @@ -996,7 +996,7 @@ typedef enum { * Offline migration may not copy disk storage or any other file based * storage (such as UEFI variables). * - * Since: v1.0.1 + * Since: 1.0.1 */ VIR_MIGRATE_OFFLINE = (1 << 10), @@ -1005,14 +1005,14 @@ typedef enum { * if this parameter is omitted. Individual compression methods can be * tuned via their specific VIR_MIGRATE_PARAM_COMPRESSION_* parameters. * - * Since: v1.0.3 + * Since: 1.0.3 */ VIR_MIGRATE_COMPRESSED = (1 << 11), /* Cancel migration if a soft error (such as I/O error) happens during * migration. * - * Since: v1.1.0 + * Since: 1.1.0 */ VIR_MIGRATE_ABORT_ON_ERROR = (1 << 12), @@ -1022,7 +1022,7 @@ typedef enum { * memory to the destination host. VIR_MIGRATE_PARAM_AUTO_CONVERGE_* * parameters can be used to tune the algorithm. * - * Since: v1.2.3 + * Since: 1.2.3 */ VIR_MIGRATE_AUTO_CONVERGE = (1 << 13), @@ -1041,7 +1041,7 @@ typedef enum { * domain and the host itself since the host's kernel may run out of * memory. * - * Since: v1.2.9 + * Since: 1.2.9 */ VIR_MIGRATE_RDMA_PIN_ALL = (1 << 14), @@ -1050,7 +1050,7 @@ typedef enum { * virDomainMigrateStartPostCopy needs to be called to switch it into the * post-copy mode. See virDomainMigrateStartPostCopy for more details. * - * Since: v1.3.3 + * Since: 1.3.3 */ VIR_MIGRATE_POSTCOPY = (1 << 15), @@ -1059,7 +1059,7 @@ typedef enum { * perform the migration. If incorrectly configured on either source or * destination, the migration will fail. * - * Since: v3.2.0 + * Since: 3.2.0 */ VIR_MIGRATE_TLS = (1 << 16), @@ -1067,7 +1067,7 @@ typedef enum { * connections. See VIR_MIGRATE_PARAM_PARALLEL_* parameters for * configuring the parallel migration. * - * Since: v5.2.0 + * Since: 5.2.0 */ VIR_MIGRATE_PARALLEL = (1 << 17), @@ -1079,7 +1079,7 @@ typedef enum { * Requires one of VIR_MIGRATE_NON_SHARED_DISK, VIR_MIGRATE_NON_SHARED_INC * to be present as well. * - * Since: v8.0.0 + * Since: 8.0.0 */ VIR_MIGRATE_NON_SHARED_SYNCHRONOUS_WRITES = (1 << 18), @@ -1099,7 +1099,7 @@ typedef enum { * * This field may not be used when VIR_MIGRATE_TUNNELLED flag is set. * - * Since: v1.1.0 + * Since: 1.1.0 */ # define VIR_MIGRATE_PARAM_URI "migrate_uri" @@ -1111,7 +1111,7 @@ typedef enum { * the domain name the same. This field is only allowed to be used with * hypervisors that support domain renaming during migration. * - * Since: v1.1.0 + * Since: 1.1.0 */ # define VIR_MIGRATE_PARAM_DEST_NAME "destination_name" @@ -1132,7 +1132,7 @@ typedef enum { * field with hypervisors that do not support changing domain configuration * during migration will result in a failure. * - * Since: v1.1.0 + * Since: 1.1.0 */ # define VIR_MIGRATE_PARAM_DEST_XML "destination_xml" @@ -1149,7 +1149,7 @@ typedef enum { * Using this field with hypervisors that do not support changing domain * configuration during migration will result in a failure. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_PERSIST_XML "persistent_xml" @@ -1161,7 +1161,7 @@ typedef enum { * libvirt will choose a suitable default. Some hypervisors do not support this * feature and will return an error if this field is used and is not 0. * - * Since: v1.1.0 + * Since: 1.1.0 */ # define VIR_MIGRATE_PARAM_BANDWIDTH "bandwidth" @@ -1172,7 +1172,7 @@ typedef enum { * be used for post-copy phase of a migration as VIR_TYPED_PARAM_ULLONG. If set * to 0 or omitted, post-copy migration speed will not be limited. * - * Since: v5.1.0 + * Since: 5.1.0 */ # define VIR_MIGRATE_PARAM_BANDWIDTH_POSTCOPY "bandwidth.postcopy" @@ -1195,7 +1195,7 @@ typedef enum { * * spice://target.host.com:1234/?tlsPort=4567 * - * Since: v1.1.0 + * Since: 1.1.0 */ # define VIR_MIGRATE_PARAM_GRAPHICS_URI "graphics_uri" @@ -1208,7 +1208,7 @@ typedef enum { * destination). Some hypervisors do not support this feature and will return * an error if this field is used. * - * Since: v1.1.4 + * Since: 1.1.4 */ # define VIR_MIGRATE_PARAM_LISTEN_ADDRESS "listen_address" @@ -1219,7 +1219,7 @@ typedef enum { * the block devices to be migrated. At the moment this is only supported * by the QEMU driver but not for the tunnelled migration. * - * Since: v1.2.17 + * Since: 1.2.17 */ # define VIR_MIGRATE_PARAM_MIGRATE_DISKS "migrate_disks" @@ -1231,7 +1231,7 @@ typedef enum { * omitted, libvirt will choose a suitable default. At the moment this is only * supported by the QEMU driver. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_MIGRATE_PARAM_DISKS_PORT "disks_port" @@ -1246,7 +1246,7 @@ typedef enum { * management application makes sure that socket created with this name on the * destination will be reachable from the source under the same exact path. * - * Since: v6.8.0 + * Since: 6.8.0 */ # define VIR_MIGRATE_PARAM_DISKS_URI "disks_uri" @@ -1258,7 +1258,7 @@ typedef enum { * The parameter may be specified multiple times if more than one method * should be used. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_COMPRESSION "compression" @@ -1269,7 +1269,7 @@ typedef enum { * compression as VIR_TYPED_PARAM_INT. Accepted values are in range 0-9. * 0 is no compression, 1 is maximum speed and 9 is maximum compression. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL "compression.mt.level" @@ -1279,7 +1279,7 @@ typedef enum { * virDomainMigrate* params field: the number of compression threads for * multithread compression as VIR_TYPED_PARAM_INT. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS "compression.mt.threads" @@ -1289,7 +1289,7 @@ typedef enum { * virDomainMigrate* params field: the number of decompression threads for * multithread compression as VIR_TYPED_PARAM_INT. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS "compression.mt.dthreads" @@ -1299,7 +1299,7 @@ typedef enum { * virDomainMigrate* params field: the size of page cache for xbzrle * compression as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.3.4 + * Since: 1.3.4 */ # define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE "compression.xbzrle.cache" @@ -1310,7 +1310,7 @@ typedef enum { * throttled to when auto-convergence decides migration is not converging. * As VIR_TYPED_PARAM_INT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL "auto_converge.initial" @@ -1322,7 +1322,7 @@ typedef enum { * the current rate is not enough to ensure convergence of the migration. * As VIR_TYPED_PARAM_INT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT "auto_converge.increment" @@ -1332,7 +1332,7 @@ typedef enum { * virDomainMigrate* params field: number of connections used during parallel * migration. As VIR_TYPED_PARAM_INT. * - * Since: v5.2.0 + * Since: 5.2.0 */ # define VIR_MIGRATE_PARAM_PARALLEL_CONNECTIONS "parallel.connections" @@ -1348,7 +1348,7 @@ typedef enum { * this parameter can be used to pass this expected hostname when starting * the migration. * - * Since: v6.0.0 + * Since: 6.0.0 */ # define VIR_MIGRATE_PARAM_TLS_DESTINATION "tls.destination" @@ -1403,10 +1403,10 @@ int virDomainMigrateSetCompressionCache(virDomainPtr domain, * * Domain migration speed flags. * - * Since: v5.1.0 + * Since: 5.1.0 */ typedef enum { - /* Set or get maximum speed of post-copy migration. (Since: v5.1.0) */ + /* Set or get maximum speed of post-copy migration. (Since: 5.1.0) */ VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY = (1 << 0), } virDomainMigrateMaxSpeedFlags; @@ -1470,15 +1470,15 @@ virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn, /** * virDomainShutdownFlagValues: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */ - VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */ - VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */ - VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */ - VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */ - VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */ + VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: 0.9.10) */ + VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: 0.9.10) */ + VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: 0.9.10) */ + VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl (Since: 1.0.1) */ + VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal (Since: 1.0.1) */ + VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: 1.2.5) */ } virDomainShutdownFlagValues; int virDomainShutdown (virDomainPtr domain); @@ -1488,15 +1488,15 @@ int virDomainShutdownFlags (virDomainPtr domain, /** * virDomainRebootFlagValues: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */ - VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */ - VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */ - VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */ - VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */ - VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */ + VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: 0.9.10) */ + VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: 0.9.10) */ + VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: 0.9.10) */ + VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl (Since: 1.0.1) */ + VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal (Since: 1.0.1) */ + VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: 1.2.5) */ } virDomainRebootFlagValues; int virDomainReboot (virDomainPtr domain, @@ -1512,12 +1512,12 @@ int virDomainDestroy (virDomainPtr domain); * Flags used to provide specific behaviour to the * virDomainDestroyFlags() function * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef enum { - VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: v0.9.10) */ - VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL (Since: v0.9.10) */ - VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy (Since: v8.3.0) */ + VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: 0.9.10) */ + VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL (Since: 0.9.10) */ + VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy (Since: 8.3.0) */ } virDomainDestroyFlagsValues; int virDomainDestroyFlags (virDomainPtr domain, @@ -1547,13 +1547,13 @@ int virDomainPMWakeup (virDomainPtr domain, * virDomainRestoreFlags(), and virDomainSaveImageDefineXML(). Not all * flags apply to all these functions. * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef enum { - VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: v0.9.4) */ - VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused (Since: v0.9.5) */ - VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running (Since: v0.9.5) */ - VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */ + VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: 0.9.4) */ + VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused (Since: 0.9.5) */ + VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running (Since: 0.9.5) */ + VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: 8.1.0) */ } virDomainSaveRestoreFlags; int virDomainSave (virDomainPtr domain, @@ -1633,7 +1633,7 @@ int virDomainGetState (virDomainPtr domain, * cpu usage (sum of both vcpu and hypervisor usage) in nanoseconds, * as a ullong * - * Since: v0.9.10 + * Since: 0.9.10 */ # define VIR_DOMAIN_CPU_STATS_CPUTIME "cpu_time" @@ -1641,7 +1641,7 @@ int virDomainGetState (virDomainPtr domain, * VIR_DOMAIN_CPU_STATS_USERTIME: * cpu time charged to user instructions in nanoseconds, as a ullong * - * Since: v0.9.11 + * Since: 0.9.11 */ # define VIR_DOMAIN_CPU_STATS_USERTIME "user_time" @@ -1649,7 +1649,7 @@ int virDomainGetState (virDomainPtr domain, * VIR_DOMAIN_CPU_STATS_SYSTEMTIME: * cpu time charged to system instructions in nanoseconds, as a ullong * - * Since: v0.9.11 + * Since: 0.9.11 */ # define VIR_DOMAIN_CPU_STATS_SYSTEMTIME "system_time" @@ -1658,7 +1658,7 @@ int virDomainGetState (virDomainPtr domain, * vcpu usage in nanoseconds (cpu_time excluding hypervisor time), * as a ullong * - * Since: v0.9.13 + * Since: 0.9.13 */ # define VIR_DOMAIN_CPU_STATS_VCPUTIME "vcpu_time" @@ -1688,7 +1688,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * Macro for the Blkio tunable weight: it represents the io weight * the guest can use, as a uint. * - * Since: v0.9.0 + * Since: 0.9.0 */ # define VIR_DOMAIN_BLKIO_WEIGHT "weight" @@ -1699,7 +1699,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * per-device weight, as a string. The string is parsed as a * series of /path/to/device,weight elements, separated by ','. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT "device_weight" @@ -1711,7 +1711,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * string is parsed as a series of /path/to/device, read_iops elements, * separated by ','. * - * Since: v1.2.2 + * Since: 1.2.2 */ # define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS "device_read_iops_sec" @@ -1724,7 +1724,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * string is parsed as a series of /path/to/device, write_iops elements, * separated by ','. * - * Since: v1.2.2 + * Since: 1.2.2 */ # define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS "device_write_iops_sec" @@ -1737,7 +1737,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * string is parsed as a series of /path/to/device, read_bps elements, * separated by ','. * - * Since: v1.2.2 + * Since: 1.2.2 */ # define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS "device_read_bytes_sec" @@ -1750,7 +1750,7 @@ char * virDomainGetSchedulerType(virDomainPtr domain, * string is parsed as a series of /path/to/device, write_bps elements, * separated by ','. * - * Since: v1.2.2 + * Since: 1.2.2 */ # define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS "device_write_bytes_sec" @@ -1770,7 +1770,7 @@ int virDomainGetBlkioParameters(virDomainPtr domain, * * Macro providing the virMemoryParameter value that indicates "unlimited" * - * Since: v0.8.8 + * Since: 0.8.8 */ # define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED 9007199254740991LL /* = INT64_MAX >> 10 */ @@ -1780,7 +1780,7 @@ int virDomainGetBlkioParameters(virDomainPtr domain, * Macro for the memory tunable hard_limit: it represents the maximum memory * the guest can use, as a ullong. * - * Since: v0.8.5 + * Since: 0.8.5 */ # define VIR_DOMAIN_MEMORY_HARD_LIMIT "hard_limit" @@ -1790,7 +1790,7 @@ int virDomainGetBlkioParameters(virDomainPtr domain, * Macro for the memory tunable soft_limit: it represents the memory upper * limit enforced during memory contention, as a ullong. * - * Since: v0.8.5 + * Since: 0.8.5 */ # define VIR_DOMAIN_MEMORY_SOFT_LIMIT "soft_limit" @@ -1800,7 +1800,7 @@ int virDomainGetBlkioParameters(virDomainPtr domain, * Macro for the memory tunable min_guarantee: it represents the minimum * memory guaranteed to be reserved for the guest, as a ullong. * - * Since: v0.8.5 + * Since: 0.8.5 */ # define VIR_DOMAIN_MEMORY_MIN_GUARANTEE "min_guarantee" @@ -1811,7 +1811,7 @@ int virDomainGetBlkioParameters(virDomainPtr domain, * plus memory the guest can use, as a ullong. This limit has to be more than * VIR_DOMAIN_MEMORY_HARD_LIMIT. * - * Since: v0.8.5 + * Since: 0.8.5 */ # define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT "swap_hard_limit" @@ -1828,14 +1828,14 @@ int virDomainGetMemoryParameters(virDomainPtr domain, * * Memory size modification flags. * - * Since: v0.9.0 + * Since: 0.9.0 */ typedef enum { - VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.1) */ - VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.9.0) */ - VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.9.0) */ + VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.9.1) */ + VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.9.0) */ + VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.9.0) */ - VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: v0.9.1) */ + VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: 0.9.1) */ } virDomainMemoryModFlags; @@ -1846,16 +1846,16 @@ typedef enum { * Representation of the various modes in the <numatune> element of * a domain. * - * Since: v0.9.9 + * Since: 0.9.9 */ typedef enum { - VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, /* (Since: v0.9.9) */ - VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, /* (Since: v0.9.9) */ - VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, /* (Since: v0.9.9) */ - VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, /* (Since: v7.3.0) */ + VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, /* (Since: 0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, /* (Since: 0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, /* (Since: 0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, /* (Since: 7.3.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change (Since: 0.9.9) */ # endif } virDomainNumatuneMemMode; @@ -1865,7 +1865,7 @@ typedef enum { * Macro for typed parameter name that lists the numa nodeset of a * domain, as a string. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_NUMA_NODESET "numa_nodeset" @@ -1875,7 +1875,7 @@ typedef enum { * Macro for typed parameter name that lists the numa mode of a domain, * as an int containing a virDomainNumatuneMemMode value. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_NUMA_MODE "numa_mode" @@ -1913,11 +1913,11 @@ int virDomainGetSecurityLabel (virDomainPtr domain, /** * virDomainGetHostnameFlags: * - * Since: v6.1.0 + * Since: 6.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) */ + VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file (Since: 6.1.0) */ + VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent (Since: 6.1.0) */ } virDomainGetHostnameFlags; char * virDomainGetHostname (virDomainPtr domain, @@ -1928,15 +1928,15 @@ int virDomainGetSecurityLabelList (virDomainPtr domain, /** * virDomainMetadataType: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: v0.9.10) */ - VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: v0.9.10) */ - VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> (Since: v0.9.10) */ + VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: 0.9.10) */ + VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: 0.9.10) */ + VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> (Since: 0.9.10) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_METADATA_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_METADATA_LAST /* (Since: 0.9.10) */ # endif } virDomainMetadataType; @@ -1963,22 +1963,22 @@ virDomainGetMetadata(virDomainPtr domain, * * Flags available for virDomainGetXMLDesc * - * Since: v0.3.3 + * Since: 0.3.3 */ typedef enum { - VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: v0.3.3) */ - VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: v0.3.3) */ - VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU (Since: v0.8.0) */ - VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: v1.0.0) */ + VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: 0.3.3) */ + VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: 0.3.3) */ + VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU (Since: 0.8.0) */ + VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: 1.0.0) */ } virDomainXMLFlags; /** * virDomainSaveImageXMLFlags: * - * Since: v5.1.0 + * Since: 5.1.0 */ typedef enum { - VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */ + VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: 5.1.0) */ } virDomainSaveImageXMLFlags; char * virDomainGetXMLDesc (virDomainPtr domain, @@ -2015,7 +2015,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the inbound average of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE "inbound.average" @@ -2024,7 +2024,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the inbound peak of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_IN_PEAK "inbound.peak" @@ -2033,7 +2033,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the inbound burst of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_IN_BURST "inbound.burst" @@ -2042,7 +2042,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the inbound floor of NIC bandwidth, as a uint. * - * Since: v1.2.19 + * Since: 1.2.19 */ # define VIR_DOMAIN_BANDWIDTH_IN_FLOOR "inbound.floor" @@ -2051,7 +2051,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the outbound average of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE "outbound.average" @@ -2060,7 +2060,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the outbound peak of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_OUT_PEAK "outbound.peak" @@ -2069,7 +2069,7 @@ int virDomainInterfaceStats (virDomainPtr dom, * * Macro represents the outbound burst of NIC bandwidth, as a uint. * - * Since: v0.9.9 + * Since: 0.9.9 */ # define VIR_DOMAIN_BANDWIDTH_OUT_BURST "outbound.burst" @@ -2096,10 +2096,10 @@ int virDomainBlockPeek (virDomainPtr dom, * * Flags available for virDomainBlockResize(). * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef enum { - VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: v0.9.11) */ + VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: 0.9.11) */ } virDomainBlockResizeFlags; int virDomainBlockResize (virDomainPtr dom, @@ -2131,14 +2131,14 @@ int virDomainBlockResize (virDomainPtr dom, * * allocation: highest qcow extent written for an active domain * * physical: size of the block device container * - * Since: v0.8.1 + * Since: 0.8.1 */ typedef struct _virDomainBlockInfo virDomainBlockInfo; /** * virDomainBlockInfoPtr: * - * Since: v0.8.1 + * Since: 0.8.1 */ typedef virDomainBlockInfo *virDomainBlockInfoPtr; struct _virDomainBlockInfo { @@ -2171,11 +2171,11 @@ int virDomainMemoryStats (virDomainPtr dom, * * Memory peeking flags. * - * Since: v0.4.4 + * Since: 0.4.4 */ typedef enum { - VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses (Since: v0.4.4) */ - VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses (Since: v0.7.0) */ + VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses (Since: 0.4.4) */ + VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses (Since: 0.7.0) */ } virDomainMemoryFlags; int virDomainMemoryPeek (virDomainPtr dom, @@ -2187,10 +2187,10 @@ int virDomainMemoryPeek (virDomainPtr dom, /** * virDomainDefineFlags: * - * Since: v1.2.12 + * Since: 1.2.12 */ typedef enum { - VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema (Since: v1.2.12) */ + VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema (Since: 1.2.12) */ } virDomainDefineFlags; /* @@ -2207,20 +2207,20 @@ int virDomainUndefine (virDomainPtr domain); /** * virDomainUndefineFlagsValues: * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef enum { VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = (1 << 0), /* Also remove any - managed save (Since: v0.9.4) */ + managed save (Since: 0.9.4) */ VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA = (1 << 1), /* If last use of domain, then also remove any - snapshot metadata (Since: v0.9.5) */ + snapshot metadata (Since: 0.9.5) */ VIR_DOMAIN_UNDEFINE_NVRAM = (1 << 2), /* Also remove any - nvram file (Since: v1.2.9) */ - VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file (Since: v2.3.0) */ + nvram file (Since: 1.2.9) */ + VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file (Since: 2.3.0) */ VIR_DOMAIN_UNDEFINE_CHECKPOINTS_METADATA = (1 << 4), /* If last use of domain, then also remove any - checkpoint metadata (Since: v5.6.0) */ + checkpoint metadata (Since: 5.6.0) */ } virDomainUndefineFlagsValues; @@ -2237,31 +2237,31 @@ int virConnectListDefinedDomains (virConnectPtr conn, * Note that these flags come in groups; if all bits from a group are 0, * then that group is not used to filter results. * - * Since: v0.9.13 + * Since: 0.9.13 */ typedef enum { - VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, /* (Since: v0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, /* (Since: v0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, /* (Since: 0.9.13) */ + VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, /* (Since: 0.9.13) */ - VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, /* (Since: v5.6.0) */ - VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, /* (Since: v5.6.0) */ + VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, /* (Since: 5.6.0) */ + VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, /* (Since: 5.6.0) */ } virConnectListAllDomainsFlags; int virConnectListAllDomains (virConnectPtr conn, @@ -2286,32 +2286,32 @@ int virDomainSetAutostart (virDomainPtr domain, * * structure for information about a virtual CPU in a domain. * - * Since: v0.1.4 + * Since: 0.1.4 */ typedef enum { - VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: v0.1.4) */ - VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: v0.1.4) */ - VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource (Since: v0.1.4) */ + VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: 0.1.4) */ + VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: 0.1.4) */ + VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource (Since: 0.1.4) */ # ifdef VIR_ENUM_SENTINELS - VIR_VCPU_LAST /* (Since: v0.9.10) */ + VIR_VCPU_LAST /* (Since: 0.9.10) */ # endif } virVcpuState; /** * virVcpuHostCpuState: * - * Since: v6.10.0 + * Since: 6.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) */ + VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline (Since: 6.10.0) */ + VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information (Since: 6.10.0) */ } virVcpuHostCpuState; /** * virVcpuInfo: * - * Since: v0.1.4 + * Since: 0.1.4 */ typedef struct _virVcpuInfo virVcpuInfo; struct _virVcpuInfo { @@ -2324,7 +2324,7 @@ struct _virVcpuInfo { /** * virVcpuInfoPtr: * - * Since: v0.1.4 + * Since: 0.1.4 */ typedef virVcpuInfo *virVcpuInfoPtr; @@ -2333,16 +2333,16 @@ typedef virVcpuInfo *virVcpuInfoPtr; * * Flags for controlling virtual CPU hot-plugging. * - * Since: v0.8.5 + * Since: 0.8.5 */ typedef enum { - VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.4) */ - VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.8.5) */ - VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.8.5) */ + VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.9.4) */ + VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.8.5) */ + VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.8.5) */ - VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count (Since: v0.8.5) */ - VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest (Since: v1.1.0) */ - VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable (Since: v2.4.0) */ + VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count (Since: 0.8.5) */ + VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest (Since: 1.1.0) */ + VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable (Since: 2.4.0) */ } virDomainVcpuFlags; int virDomainSetVcpus (virDomainPtr domain, @@ -2384,7 +2384,7 @@ int virDomainGetEmulatorPinInfo (virDomainPtr domain, * * The data structure for information about all IOThreads in a domain * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo; @@ -2392,7 +2392,7 @@ typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo; /** * virDomainIOThreadInfoPtr: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr; struct _virDomainIOThreadInfo { @@ -2433,7 +2433,7 @@ int virDomainDelIOThread(virDomainPtr domain, * small will not provide enough cycles for the guest to process data. * The polling interval is not available for statistical purposes. * - * Since: v4.10.0 + * Since: 4.10.0 */ # define VIR_DOMAIN_IOTHREAD_POLL_MAX_NS "poll_max_ns" @@ -2445,7 +2445,7 @@ int virDomainDelIOThread(virDomainPtr domain, * of 0 (zero) allows the hypervisor to choose its own value. The algorithm * to use for adjustment is hypervisor specific. * - * Since: v4.10.0 + * Since: 4.10.0 */ # define VIR_DOMAIN_IOTHREAD_POLL_GROW "poll_grow" @@ -2458,7 +2458,7 @@ int virDomainDelIOThread(virDomainPtr domain, * choose its own value. The algorithm to use for adjustment is hypervisor * specific. * - * Since: v4.10.0 + * Since: 4.10.0 */ # define VIR_DOMAIN_IOTHREAD_POLL_SHRINK "poll_shrink" @@ -2477,7 +2477,7 @@ int virDomainSetIOThreadParams(virDomainPtr domain, * This macro is to be used in conjunction with virDomainPinVcpu() API. * It sets the bit (CPU usable) of the related cpu in cpumap. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_USE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] |= (1 << ((cpu) % 8))) @@ -2489,7 +2489,7 @@ int virDomainSetIOThreadParams(virDomainPtr domain, * This macro is to be used in conjunction with virDomainPinVcpu() API. * It resets the bit (CPU not usable) of the related cpu in cpumap. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_UNUSE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] &= ~(1 << ((cpu) % 8))) @@ -2501,7 +2501,7 @@ int virDomainSetIOThreadParams(virDomainPtr domain, * This macro can be used in conjunction with virNodeGetCPUMap() API. * It returns non-zero if the bit of the related CPU is set. * - * Since: v1.0.0 + * Since: 1.0.0 */ # define VIR_CPU_USED(cpumap, cpu) ((cpumap)[(cpu) / 8] & (1 << ((cpu) % 8))) @@ -2513,7 +2513,7 @@ int virDomainSetIOThreadParams(virDomainPtr domain, * It returns the length (in bytes) required to store the complete * CPU map between a single virtual & all physical CPUs of a domain. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_CPU_MAPLEN(cpu) (((cpu) + 7) / 8) @@ -2535,7 +2535,7 @@ int virDomainGetVcpus (virDomainPtr domain, * VIR_CPU_USABLE macro returns a non-zero value (true) if the cpu * is usable by the vcpu, and 0 otherwise. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu) \ VIR_CPU_USED(VIR_GET_CPUMAP(cpumaps, maplen, vcpu), cpu) @@ -2554,7 +2554,7 @@ int virDomainGetVcpus (virDomainPtr domain, * the specified vcpu from cpumaps array and copies it into cpumap to be used * later by virDomainPinVcpu() API. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap) \ memcpy(cpumap, VIR_GET_CPUMAP(cpumaps, maplen, vcpu), maplen) @@ -2570,7 +2570,7 @@ int virDomainGetVcpus (virDomainPtr domain, * virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the * cpumap of the specified vcpu from cpumaps array. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (maplen)])) @@ -2578,14 +2578,14 @@ int virDomainGetVcpus (virDomainPtr domain, /** * virDomainDeviceModifyFlags: * - * Since: v0.7.7 + * Since: 0.7.7 */ typedef enum { - VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.7.7) */ - VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.7.7) */ - VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.7.7) */ - VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) (Since: v0.8.6) */ + VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) (Since: 0.8.6) */ } virDomainDeviceModifyFlags; int virDomainAttachDevice(virDomainPtr domain, const char *xml); @@ -2604,14 +2604,14 @@ int virDomainDetachDeviceAlias(virDomainPtr domain, /** * virDomainStatsRecord: * - * Since: v1.2.8 + * Since: 1.2.8 */ typedef struct _virDomainStatsRecord virDomainStatsRecord; /** * virDomainStatsRecordPtr: * - * Since: v1.2.8 + * Since: 1.2.8 */ typedef virDomainStatsRecord *virDomainStatsRecordPtr; struct _virDomainStatsRecord { @@ -2623,42 +2623,42 @@ struct _virDomainStatsRecord { /** * virDomainStatsTypes: * - * Since: v1.2.8 + * Since: 1.2.8 */ typedef enum { - VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state (Since: v1.2.8) */ - VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info (Since: v1.2.9) */ - VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info (Since: v1.2.9) */ - VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info (Since: v1.2.9) */ - VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info (Since: v1.2.9) */ - VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info (Since: v1.2.9) */ - VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info (Since: v1.3.3) */ - VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info (Since: v4.10.0) */ - VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info (Since: v6.0.0) */ - VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since: v7.2.0) */ + VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state (Since: 1.2.8) */ + VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info (Since: 1.2.9) */ + VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info (Since: 1.2.9) */ + VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info (Since: 1.2.9) */ + VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info (Since: 1.2.9) */ + VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info (Since: 1.2.9) */ + VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info (Since: 1.3.3) */ + VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info (Since: 4.10.0) */ + VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info (Since: 6.0.0) */ + VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since: 7.2.0) */ } virDomainStatsTypes; /** * virConnectGetAllDomainStatsFlags: * - * Since: v1.2.8 + * Since: 1.2.8 */ typedef enum { - VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE, /* (Since: 1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE, /* (Since: 1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, /* (Since: 1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, /* (Since: 1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, /* (Since: v1.2.8) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, /* (Since: 1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, /* (Since: 1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, /* (Since: 1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, /* (Since: 1.2.8) */ VIR_CONNECT_GET_ALL_DOMAINS_STATS_NOWAIT = 1 << 29, /* report statistics that can be obtained - immediately without any blocking (Since: v4.5.0) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats (Since: v1.2.12) */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats (Since: v1.2.8) */ + immediately without any blocking (Since: 4.5.0) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats (Since: 1.2.12) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats (Since: 1.2.8) */ } virConnectGetAllDomainStatsFlags; int virConnectGetAllDomainStats(virConnectPtr conn, @@ -2685,7 +2685,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * applications running on the platform. It corresponds to the * "perf.cmt" field in the *Stats APIs. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_PERF_PARAM_CMT "cmt" @@ -2697,7 +2697,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * from one level of cache to another. It corresponds to the * "perf.mbmt" field in the *Stats APIs. * - * Since: v1.3.5 + * Since: 1.3.5 */ # define VIR_PERF_PARAM_MBMT "mbmt" @@ -2709,7 +2709,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * through the memory controller on the socket. It corresponds to * the "perf.mbml" field in the *Stats APIs. * - * Since: v1.3.5 + * Since: 1.3.5 */ # define VIR_PERF_PARAM_MBML "mbml" @@ -2721,7 +2721,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * applications running on the platform. It corresponds to the * "perf.cache_misses" field in the *Stats APIs. * - * Since: v2.3.0 + * Since: 2.3.0 */ # define VIR_PERF_PARAM_CACHE_MISSES "cache_misses" @@ -2733,7 +2733,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * by applications running on the platform. It corresponds to the * "perf.cache_references" field in the *Stats APIs. * - * Since: v2.3.0 + * Since: 2.3.0 */ # define VIR_PERF_PARAM_CACHE_REFERENCES "cache_references" @@ -2745,7 +2745,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * by applications running on the platform. It corresponds to the * "perf.instructions" field in the *Stats APIs. * - * Since: v2.3.0 + * Since: 2.3.0 */ # define VIR_PERF_PARAM_INSTRUCTIONS "instructions" @@ -2757,7 +2757,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * how many cpu cycles one instruction needs. * It corresponds to the "perf.cpu_cycles" field in the *Stats APIs. * - * Since: v2.3.0 + * Since: 2.3.0 */ # define VIR_PERF_PARAM_CPU_CYCLES "cpu_cycles" @@ -2769,7 +2769,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * by applications running on the platform. It corresponds to the * "perf.branch_instructions" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS "branch_instructions" @@ -2781,7 +2781,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * by applications running on the platform. It corresponds to the * "perf.branch_misses" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_BRANCH_MISSES "branch_misses" @@ -2793,7 +2793,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * by applications running on the platform. It corresponds to the * "perf.bus_cycles" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_BUS_CYCLES "bus_cycles" @@ -2806,7 +2806,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * running on the platform. It corresponds to the * "perf.stalled_cycles_frontend" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND "stalled_cycles_frontend" @@ -2819,7 +2819,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * running on the platform. It corresponds to the * "perf.stalled_cycles_backend" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND "stalled_cycles_backend" @@ -2832,7 +2832,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * running on the platform. It corresponds to the * "perf.ref_cpu_cycles" field in the *Stats APIs. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_PERF_PARAM_REF_CPU_CYCLES "ref_cpu_cycles" @@ -2845,7 +2845,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * corresponds to the "perf.cpu_clock" field in the *Stats * APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock" @@ -2858,7 +2858,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * corresponds to the "perf.task_clock" field in the *Stats * APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_TASK_CLOCK "task_clock" @@ -2870,7 +2870,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * faults by applications running on the platform. It corresponds * to the "perf.page_faults" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_PAGE_FAULTS "page_faults" @@ -2882,7 +2882,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * switches by applications running on the platform. It corresponds * to the "perf.context_switches" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_CONTEXT_SWITCHES "context_switches" @@ -2894,7 +2894,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * migrations by applications running on the platform. It corresponds * to the "perf.cpu_migrations" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_CPU_MIGRATIONS "cpu_migrations" @@ -2906,7 +2906,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * faults by applications running on the platform. It corresponds * to the "perf.page_faults_min" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_PAGE_FAULTS_MIN "page_faults_min" @@ -2918,7 +2918,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * faults by applications running on the platform. It corresponds * to the "perf.page_faults_maj" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_PAGE_FAULTS_MAJ "page_faults_maj" @@ -2930,7 +2930,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * faults by applications running on the platform. It corresponds * to the "perf.alignment_faults" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_ALIGNMENT_FAULTS "alignment_faults" @@ -2942,7 +2942,7 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); * faults by applications running on the platform. It corresponds * to the "perf.emulation_faults" field in the *Stats APIs. * - * Since: v3.2.0 + * Since: 3.2.0 */ # define VIR_PERF_PARAM_EMULATION_FAULTS "emulation_faults" @@ -2964,48 +2964,48 @@ int virDomainSetPerfEvents(virDomainPtr dom, * * Describes various possible block jobs. * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef enum { - /* Placeholder (Since: v0.9.4) */ + /* Placeholder (Since: 0.9.4) */ VIR_DOMAIN_BLOCK_JOB_TYPE_UNKNOWN = 0, /* Block Pull (virDomainBlockPull, or virDomainBlockRebase without * flags), job ends on completion * - * Since: v0.9.4 + * Since: 0.9.4 */ VIR_DOMAIN_BLOCK_JOB_TYPE_PULL = 1, /* Block Copy (virDomainBlockCopy, or virDomainBlockRebase with * flags), job exists as long as mirroring is active * - * Since: v0.9.12 + * Since: 0.9.12 */ VIR_DOMAIN_BLOCK_JOB_TYPE_COPY = 2, /* Block Commit (virDomainBlockCommit without flags), job ends on * completion * - * Since: v0.10.2 + * Since: 0.10.2 */ VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT = 3, /* Active Block Commit (virDomainBlockCommit with flags), job * exists as long as sync is active * - * Since: v1.2.6 + * Since: 1.2.6 */ VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT = 4, /* Backup (virDomainBackupBegin) * - * Since: v6.0.0 + * Since: 6.0.0 */ VIR_DOMAIN_BLOCK_JOB_TYPE_BACKUP = 5, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: 0.9.10) */ # endif } virDomainBlockJobType; @@ -3016,11 +3016,11 @@ typedef enum { * VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT: Pivot to new file when ending a copy or * active commit job * - * Since: v0.9.12 + * Since: 0.9.12 */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, /* (Since: v0.9.12) */ - VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, /* (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, /* (Since: 0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, /* (Since: 0.9.12) */ } virDomainBlockJobAbortFlags; int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, @@ -3031,11 +3031,11 @@ int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, * * Flags for use with virDomainGetBlockJobInfo * - * Since: v1.2.9 + * Since: 1.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) */ + instead of MiB/s (Since: 1.2.9) */ } virDomainBlockJobInfoFlags; /** @@ -3043,14 +3043,14 @@ typedef enum { * * An iterator for monitoring block job operations * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef unsigned long long virDomainBlockJobCursor; /** * virDomainBlockJobInfo: * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo; struct _virDomainBlockJobInfo { @@ -3070,7 +3070,7 @@ struct _virDomainBlockJobInfo { /** * virDomainBlockJobInfoPtr: * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef virDomainBlockJobInfo *virDomainBlockJobInfoPtr; @@ -3083,11 +3083,11 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, * * Flags for use with virDomainBlockJobSetSpeed * - * Since: v1.2.9 + * Since: 1.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) */ + instead of MiB/s (Since: 1.2.9) */ } virDomainBlockJobSetSpeedFlags; int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, @@ -3099,11 +3099,11 @@ int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, * Flags for use with virDomainBlockPull (values chosen to be a subset of the * flags for virDomainBlockRebase) * - * Since: v1.2.9 + * Since: 1.2.9 */ typedef enum { VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s - instead of MiB/s (Since: v1.2.9) */ + instead of MiB/s (Since: 1.2.9) */ } virDomainBlockPullFlags; int virDomainBlockPull(virDomainPtr dom, const char *disk, @@ -3114,22 +3114,22 @@ int virDomainBlockPull(virDomainPtr dom, const char *disk, * * Flags available for virDomainBlockRebase(). * - * Since: v0.9.12 + * Since: 0.9.12 */ typedef enum { VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1 << 0, /* Limit copy to top of source - backing chain (Since: v0.9.12) */ + backing chain (Since: 0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT = 1 << 1, /* Reuse existing external - file for a copy (Since: v0.9.12) */ - VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw (Since: v0.9.12) */ - VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job (Since: v0.9.12) */ + file for a copy (Since: 0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw (Since: 0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job (Since: 0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_RELATIVE = 1 << 4, /* Keep backing chain referenced using relative - names (Since: v1.2.7) */ + names (Since: 1.2.7) */ VIR_DOMAIN_BLOCK_REBASE_COPY_DEV = 1 << 5, /* Treat destination as block - device instead of file (Since: v1.2.9) */ + device instead of file (Since: 1.2.9) */ VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s - instead of MiB/s (Since: v1.2.9) */ + instead of MiB/s (Since: 1.2.9) */ } virDomainBlockRebaseFlags; int virDomainBlockRebase(virDomainPtr dom, const char *disk, @@ -3141,22 +3141,22 @@ int virDomainBlockRebase(virDomainPtr dom, const char *disk, * * Flags available for virDomainBlockCopy(). * - * Since: v1.2.8 + * Since: 1.2.8 */ typedef enum { - /* Limit copy to top of source backing chain (Since: v1.2.8) */ + /* Limit copy to top of source backing chain (Since: 1.2.8) */ VIR_DOMAIN_BLOCK_COPY_SHALLOW = 1 << 0, - /* Reuse existing external file for a copy (Since: v1.2.8) */ + /* Reuse existing external file for a copy (Since: 1.2.8) */ VIR_DOMAIN_BLOCK_COPY_REUSE_EXT = 1 << 1, - /* Don't force usage of recoverable job for the copy operation (Since: v3.5.0) */ + /* Don't force usage of recoverable job for the copy operation (Since: 3.5.0) */ VIR_DOMAIN_BLOCK_COPY_TRANSIENT_JOB = 1 << 2, /* Force the copy job to synchronously propagate guest writes into * the destination image, so that the copy is guaranteed to converge * - * Since: v8.0.0 + * Since: 8.0.0 */ VIR_DOMAIN_BLOCK_COPY_SYNCHRONOUS_WRITES = 1 << 3, } virDomainBlockCopyFlags; @@ -3178,7 +3178,7 @@ typedef enum { * virDomainBlockJobSetSpeed(). The actual speed can be determined * with virDomainGetBlockJobInfo(). * - * Since: v1.2.8 + * Since: 1.2.8 */ # define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH "bandwidth" @@ -3191,7 +3191,7 @@ typedef enum { * range. Specifying 0 is the same as omitting this parameter, to * request the hypervisor default. * - * Since: v1.2.8 + * Since: 1.2.8 */ # define VIR_DOMAIN_BLOCK_COPY_GRANULARITY "granularity" @@ -3202,7 +3202,7 @@ typedef enum { * as an unsigned long long. Specifying 0 is the same as omitting this * parameter, to request the hypervisor default. * - * Since: v1.2.8 + * Since: 1.2.8 */ # define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE "buf-size" @@ -3217,21 +3217,21 @@ int virDomainBlockCopy(virDomainPtr dom, const char *disk, * * Flags available for virDomainBlockCommit(). * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1 << 0, /* NULL base means next backing - file, not whole chain (Since: v0.10.2) */ + file, not whole chain (Since: 0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_DELETE = 1 << 1, /* Delete any files that are now invalid after their contents - have been committed (Since: v0.10.2) */ + have been committed (Since: 0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_ACTIVE = 1 << 2, /* Allow a two-phase commit when - top is the active layer (Since: v1.2.6) */ + top is the active layer (Since: 1.2.6) */ VIR_DOMAIN_BLOCK_COMMIT_RELATIVE = 1 << 3, /* keep the backing chain referenced using relative - names (Since: v1.2.7) */ + names (Since: 1.2.7) */ VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES = 1 << 4, /* bandwidth in bytes/s - instead of MiB/s (Since: v1.2.9) */ + instead of MiB/s (Since: 1.2.9) */ } virDomainBlockCommitFlags; int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, @@ -3247,7 +3247,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the total * bytes per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC "total_bytes_sec" @@ -3257,7 +3257,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the read * bytes per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC "read_bytes_sec" @@ -3267,7 +3267,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the write * bytes per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC "write_bytes_sec" @@ -3277,7 +3277,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the total * I/O operations per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC "total_iops_sec" @@ -3287,7 +3287,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the read * I/O operations per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC "read_iops_sec" @@ -3296,7 +3296,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the write * I/O operations per second permitted through a block device, as a ullong. * - * Since: v0.9.8 + * Since: 0.9.8 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC "write_iops_sec" @@ -3306,7 +3306,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum total * bytes per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX "total_bytes_sec_max" @@ -3316,7 +3316,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum read * bytes per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX "read_bytes_sec_max" @@ -3326,7 +3326,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum write * bytes per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX "write_bytes_sec_max" @@ -3336,7 +3336,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum * I/O operations per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX "total_iops_sec_max" @@ -3346,7 +3346,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum read * I/O operations per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX "read_iops_sec_max" @@ -3355,7 +3355,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the maximum write * I/O operations per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX "write_iops_sec_max" @@ -3365,7 +3365,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by total_bytes_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH "total_bytes_sec_max_length" @@ -3375,7 +3375,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by read_bytes_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH "read_bytes_sec_max_length" @@ -3385,7 +3385,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by write_bytes_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH "write_bytes_sec_max_length" @@ -3395,7 +3395,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by total_iops_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH "total_iops_sec_max_length" @@ -3405,7 +3405,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by read_iops_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH "read_iops_sec_max_length" @@ -3415,7 +3415,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the duration in * seconds for the burst allowed by write_iops_sec_max, as a ullong. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH "write_iops_sec_max_length" @@ -3424,7 +3424,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents the size * I/O operations per second permitted through a block device, as a ullong. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC "size_iops_sec" @@ -3433,7 +3433,7 @@ int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base, * Macro for the BlockIoTune tunable weight: it represents a group name to * allow sharing of I/O throttling quota between multiple drives, as a string. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME "group_name" @@ -3455,29 +3455,29 @@ virDomainGetBlockIoTune(virDomainPtr dom, * * Disk I/O error. * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: v0.9.10) */ - VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error (Since: v0.9.10) */ - VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device (Since: v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: 0.9.10) */ + VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error (Since: 0.9.10) */ + VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device (Since: 0.9.10) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DISK_ERROR_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_LAST /* (Since: 0.9.10) */ # endif } virDomainDiskErrorCode; /** * virDomainDiskError: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef struct _virDomainDiskError virDomainDiskError; /** * virDomainDiskErrorPtr: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef virDomainDiskError *virDomainDiskErrorPtr; @@ -3498,19 +3498,19 @@ int virDomainGetDiskErrors(virDomainPtr dom, * * Enum to specify which keycode mapping is in use for virDomainSendKey(). * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef enum { - VIR_KEYCODE_SET_LINUX = 0, /* (Since: v0.9.3) */ - VIR_KEYCODE_SET_XT = 1, /* (Since: v0.9.3) */ - VIR_KEYCODE_SET_ATSET1 = 2, /* (Since: v0.9.3) */ - VIR_KEYCODE_SET_ATSET2 = 3, /* (Since: v0.9.3) */ - VIR_KEYCODE_SET_ATSET3 = 4, /* (Since: v0.9.3) */ - VIR_KEYCODE_SET_OSX = 5, /* (Since: v0.9.4) */ - VIR_KEYCODE_SET_XT_KBD = 6, /* (Since: v0.9.4) */ - VIR_KEYCODE_SET_USB = 7, /* (Since: v0.9.4) */ - VIR_KEYCODE_SET_WIN32 = 8, /* (Since: v0.9.4) */ - VIR_KEYCODE_SET_QNUM = 9, /* (Since: v4.2.0) */ + VIR_KEYCODE_SET_LINUX = 0, /* (Since: 0.9.3) */ + VIR_KEYCODE_SET_XT = 1, /* (Since: 0.9.3) */ + VIR_KEYCODE_SET_ATSET1 = 2, /* (Since: 0.9.3) */ + VIR_KEYCODE_SET_ATSET2 = 3, /* (Since: 0.9.3) */ + VIR_KEYCODE_SET_ATSET3 = 4, /* (Since: 0.9.3) */ + VIR_KEYCODE_SET_OSX = 5, /* (Since: 0.9.4) */ + VIR_KEYCODE_SET_XT_KBD = 6, /* (Since: 0.9.4) */ + VIR_KEYCODE_SET_USB = 7, /* (Since: 0.9.4) */ + VIR_KEYCODE_SET_WIN32 = 8, /* (Since: 0.9.4) */ + VIR_KEYCODE_SET_QNUM = 9, /* (Since: 4.2.0) */ # ifdef VIR_ENUM_SENTINELS VIR_KEYCODE_SET_LAST @@ -3519,7 +3519,7 @@ typedef enum { * added to the libvirt API. It reflects the last keycode set supported * by this version of the libvirt API. * - * Since: v0.9.4 + * Since: 0.9.4 */ # endif } virKeycodeSet; @@ -3529,7 +3529,7 @@ typedef enum { * * Compatibility alias for VIR_KEYCODE_SET_QNUM, which replaced it since 4.2.0. * - * Since: v0.9.5 + * Since: 0.9.5 */ # define VIR_KEYCODE_SET_RFB VIR_KEYCODE_SET_QNUM @@ -3538,7 +3538,7 @@ typedef enum { * * Maximum number of keycodes that can be sent in one virDomainSendKey() call. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_DOMAIN_SEND_KEY_MAX_KEYS 16 @@ -3561,83 +3561,83 @@ int virDomainSendKey(virDomainPtr domain, * this enum might be extended with new signals which have no * mapping in Linux. * - * Since: v1.0.1 + * Since: 1.0.1 */ typedef enum { - VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux (Since: v1.0.1) )*/ - VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 (Since: v1.0.1) */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 (Since: v1.0.1) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux (Since: 1.0.1) )*/ + VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 (Since: 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 (Since: 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX (Since: 1.0.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: 1.0.1) */ # endif } virDomainProcessSignal; @@ -3663,21 +3663,21 @@ virDomainPtr virDomainCreateLinux (virConnectPtr conn, * * a virDomainEventType is emitted during domain lifecycle events * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED = 0, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_UNDEFINED = 1, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STARTED = 2, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_SUSPENDED = 3, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_RESUMED = 4, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED = 5, /* (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_SHUTDOWN = 6, /* (Since: v0.9.8) */ - VIR_DOMAIN_EVENT_PMSUSPENDED = 7, /* (Since: v0.10.2) */ - VIR_DOMAIN_EVENT_CRASHED = 8, /* (Since: v1.1.1) */ + VIR_DOMAIN_EVENT_DEFINED = 0, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED = 1, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STARTED = 2, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED = 3, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED = 4, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED = 5, /* (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_SHUTDOWN = 6, /* (Since: 0.9.8) */ + VIR_DOMAIN_EVENT_PMSUSPENDED = 7, /* (Since: 0.10.2) */ + VIR_DOMAIN_EVENT_CRASHED = 8, /* (Since: 1.1.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_LAST /* (Since: 0.9.10) */ # endif } virDomainEventType; @@ -3686,16 +3686,16 @@ typedef enum { * * Details on the cause of a 'defined' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed (Since: v1.2.19) */ - VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed (Since: 1.2.19) */ + VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot (Since: 1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventDefinedDetailType; @@ -3704,14 +3704,14 @@ typedef enum { * * Details on the cause of an 'undefined' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed (Since: v1.2.19) */ + VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed (Since: 1.2.19) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventUndefinedDetailType; @@ -3720,17 +3720,17 @@ typedef enum { * * Details on the cause of a 'started' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event (Since: 0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventStartedDetailType; @@ -3739,21 +3739,21 @@ typedef enum { * * Details on the cause of a 'suspended' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file (Since: v0.9.5) */ - VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot (Since: v0.9.5) */ - VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call (Since: v1.0.1) */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration (Since: v1.3.3) */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file (Since: 0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot (Since: 0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call (Since: 1.0.1) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration (Since: 1.3.3) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy (Since: 1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventSuspendedDetailType; @@ -3762,17 +3762,17 @@ typedef enum { * * Details on the cause of a 'resumed' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot (Since: v0.9.5) */ + VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot (Since: 0.9.5) */ VIR_DOMAIN_EVENT_RESUMED_POSTCOPY = 3, /* Resumed, but migration is still - running in post-copy mode (Since: v1.3.3) */ + running in post-copy mode (Since: 1.3.3) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventResumedDetailType; @@ -3781,19 +3781,19 @@ typedef enum { * * Details on the cause of a 'stopped' lifecycle event * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed (Since: v0.5.0) */ - VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed (Since: 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded (Since: 0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: 0.9.10) */ # endif } virDomainEventStoppedDetailType; @@ -3803,25 +3803,25 @@ typedef enum { * * Details on the cause of a 'shutdown' lifecycle event * - * Since: v0.9.8 + * Since: 0.9.8 */ typedef enum { - /* Guest finished shutdown sequence (Since: v0.9.8) */ + /* Guest finished shutdown sequence (Since: 0.9.8) */ VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED = 0, /* Domain finished shutting down after request from the guest itself - * (e.g. hardware-specific action) (Since: v3.4.0) */ + * (e.g. hardware-specific action) (Since: 3.4.0) */ VIR_DOMAIN_EVENT_SHUTDOWN_GUEST = 1, /* Domain finished shutting down after request from the host (e.g. killed by * a signal) * - * Since: v3.4.0 + * Since: 3.4.0 */ VIR_DOMAIN_EVENT_SHUTDOWN_HOST = 2, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: 0.9.10) */ # endif } virDomainEventShutdownDetailType; @@ -3830,14 +3830,14 @@ typedef enum { * * Details on the cause of a 'pmsuspended' lifecycle event * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: v0.10.2) */ - VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk (Since: v1.0.0) */ + VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: 0.10.2) */ + VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk (Since: 1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: v0.10.2) */ + VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: 0.10.2) */ # endif } virDomainEventPMSuspendedDetailType; @@ -3846,14 +3846,14 @@ typedef enum { * * Details on the cause of a 'crashed' lifecycle event * - * Since: v1.1.1 + * Since: 1.1.1 */ typedef enum { - VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: v1.1.1) */ - VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded (Since: v6.1.0) */ + VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: 1.1.1) */ + VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded (Since: 6.1.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: v1.1.1) */ + VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: 1.1.1) */ # endif } virDomainEventCrashedDetailType; @@ -3862,17 +3862,17 @@ typedef enum { * * Recipient of a memory failure event. * - * Since: v6.9.0 + * Since: 6.9.0 */ typedef enum { - /* memory failure at hypersivor memory address space (Since: v6.9.0) */ + /* memory failure at hypersivor memory address space (Since: 6.9.0) */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_HYPERVISOR = 0, - /* memory failure at guest memory address space (Since: v6.9.0) */ + /* memory failure at guest memory address space (Since: 6.9.0) */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_GUEST = 1, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: v6.9.0) */ + VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: 6.9.0) */ # endif } virDomainMemoryFailureRecipientType; @@ -3882,13 +3882,13 @@ typedef enum { * * Action of a memory failure event. * - * Since: v6.9.0 + * Since: 6.9.0 */ typedef enum { /* the memory failure could be ignored. This will only be the case for * action-optional failures. * - * Since: v6.9.0 + * Since: 6.9.0 */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_IGNORE = 0, @@ -3896,26 +3896,26 @@ typedef enum { * mechanism, and hypervisor could inject the MCE into the guest * successfully. * - * Since: v6.9.0 + * Since: 6.9.0 */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_INJECT = 1, /* the failure is unrecoverable. This occurs for action-required failures * if the recipient is the hypervisor; hypervisor will exit. * - * Since: v6.9.0 + * Since: 6.9.0 */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_FATAL = 2, /* the failure is unrecoverable but confined to the guest. This occurs if * the recipient is a guest which is not ready to handle memory failures. * - * Since: v6.9.0 + * Since: 6.9.0 */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_RESET = 3, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: v6.9.0) */ + VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: 6.9.0) */ # endif } virDomainMemoryFailureActionType; @@ -3923,17 +3923,17 @@ typedef enum { /** * virDomainMemoryFailureFlags: * - * Since: v6.9.0 + * Since: 6.9.0 */ typedef enum { /* whether a memory failure event is action-required or action-optional - * (e.g. a failure during memory scrub). (Since: v6.9.0) */ + * (e.g. a failure during memory scrub). (Since: 6.9.0) */ VIR_DOMAIN_MEMORY_FAILURE_ACTION_REQUIRED = (1 << 0), /* whether the failure occurred while the previous failure was still in * progress. * - * Since: v6.9.0 + * Since: 6.9.0 */ VIR_DOMAIN_MEMORY_FAILURE_RECURSIVE = (1 << 1), } virDomainMemoryFailureFlags; @@ -3951,7 +3951,7 @@ typedef enum { * * Returns 0 (the return value is currently ignored) * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef int (*virConnectDomainEventCallback)(virConnectPtr conn, virDomainPtr dom, @@ -3975,32 +3975,32 @@ int virDomainIsUpdated(virDomainPtr dom); /** * virDomainJobType: * - * Since: v0.7.7 + * Since: 0.7.7 */ typedef enum { - VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: v0.7.7) */ - VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: v0.7.7) */ - VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time (Since: v0.7.7) */ - VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up (Since: v0.7.7) */ - VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up (Since: v0.7.7) */ - VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up (Since: v0.7.7) */ + VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: 0.7.7) */ + VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: 0.7.7) */ + VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time (Since: 0.7.7) */ + VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up (Since: 0.7.7) */ + VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up (Since: 0.7.7) */ + VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up (Since: 0.7.7) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_JOB_LAST /* (Since: 0.9.10) */ # endif } virDomainJobType; /** * virDomainJobInfo: * - * Since: v0.7.7 + * Since: 0.7.7 */ typedef struct _virDomainJobInfo virDomainJobInfo; /** * virDomainJobInfoPtr: * - * Since: v0.7.7 + * Since: 0.7.7 */ typedef virDomainJobInfo *virDomainJobInfoPtr; struct _virDomainJobInfo { @@ -4043,13 +4043,13 @@ struct _virDomainJobInfo { * Flags OR'ed together to provide specific behavior when querying domain * job statistics. * - * Since: v1.2.9 + * Since: 1.2.9 */ typedef enum { VIR_DOMAIN_JOB_STATS_COMPLETED = 1 << 0, /* return stats of a recently - * completed job (Since: v1.2.9) */ + * completed job (Since: 1.2.9) */ VIR_DOMAIN_JOB_STATS_KEEP_COMPLETED = 1 << 1, /* don't remove completed - stats when reading them (Since: v6.0.0) */ + stats when reading them (Since: 6.0.0) */ } virDomainGetJobStatsFlags; int virDomainGetJobInfo(virDomainPtr dom, @@ -4064,22 +4064,22 @@ int virDomainAbortJob(virDomainPtr dom); /** * virDomainJobOperation: * - * Since: v3.3.0 + * Since: 3.3.0 */ typedef enum { - VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_START = 1, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_SAVE = 2, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_DUMP = 8, /* (Since: v3.3.0) */ - VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, /* (Since: v6.0.0) */ + VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_START = 1, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SAVE = 2, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_DUMP = 8, /* (Since: 3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, /* (Since: 6.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: 3.3.0) */ # endif } virDomainJobOperation; @@ -4090,7 +4090,7 @@ typedef enum { * VIR_TYPED_PARAM_INT. The values correspond to the items in * virDomainJobOperation enum. * - * Since: v3.3.0 + * Since: 3.3.0 */ # define VIR_DOMAIN_JOB_OPERATION "operation" @@ -4102,7 +4102,7 @@ typedef enum { * * This field corresponds to timeElapsed field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_TIME_ELAPSED "time_elapsed" @@ -4114,7 +4114,7 @@ typedef enum { * flow from the source host to the destination host, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.15 + * Since: 1.2.15 */ # define VIR_DOMAIN_JOB_TIME_ELAPSED_NET "time_elapsed_net" @@ -4126,7 +4126,7 @@ typedef enum { * * This field corresponds to timeRemaining field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_TIME_REMAINING "time_remaining" @@ -4138,7 +4138,7 @@ typedef enum { * between the time guest CPUs were paused and the time they were resumed * is reported for completed migration. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DOWNTIME "downtime" @@ -4149,7 +4149,7 @@ typedef enum { * the time required to transfer control flow from the source host to the * destination host, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.15 + * Since: 1.2.15 */ # define VIR_DOMAIN_JOB_DOWNTIME_NET "downtime_net" @@ -4160,7 +4160,7 @@ typedef enum { * the migration in the 'setup' phase before the iterations begin, as * VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_JOB_SETUP_TIME "setup_time" @@ -4177,7 +4177,7 @@ typedef enum { * * This field corresponds to dataTotal field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DATA_TOTAL "data_total" @@ -4189,7 +4189,7 @@ typedef enum { * * This field corresponds to dataProcessed field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DATA_PROCESSED "data_processed" @@ -4201,7 +4201,7 @@ typedef enum { * * This field corresponds to dataRemaining field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DATA_REMAINING "data_remaining" @@ -4213,7 +4213,7 @@ typedef enum { * * This field corresponds to memTotal field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_TOTAL "memory_total" @@ -4225,7 +4225,7 @@ typedef enum { * * This field corresponds to memProcessed field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_PROCESSED "memory_processed" @@ -4237,7 +4237,7 @@ typedef enum { * * This field corresponds to memRemaining field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_REMAINING "memory_remaining" @@ -4251,7 +4251,7 @@ typedef enum { * The most common example of such pages are zero pages, i.e., pages filled * with zero bytes. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_CONSTANT "memory_constant" @@ -4263,7 +4263,7 @@ typedef enum { * byte and which could not be compressed) transferred since the beginning * of the migration job, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_NORMAL "memory_normal" @@ -4275,7 +4275,7 @@ typedef enum { * * See VIR_DOMAIN_JOB_MEMORY_NORMAL for more details. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES "memory_normal_bytes" @@ -4285,7 +4285,7 @@ typedef enum { * virDomainGetJobStats field: network throughput used while migrating * memory in Bytes per second, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_JOB_MEMORY_BPS "memory_bps" @@ -4295,7 +4295,7 @@ typedef enum { * per second, as VIR_TYPED_PARAM_ULLONG. This statistics makes sense only * when live migration is running. * - * Since: v1.3.1 + * Since: 1.3.1 */ # define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE "memory_dirty_rate" @@ -4308,7 +4308,7 @@ typedef enum { * VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE or VIR_DOMAIN_JOB_COMPRESSION_PAGES * to bytes. * - * Since: v3.9.0 + * Since: 3.9.0 */ # define VIR_DOMAIN_JOB_MEMORY_PAGE_SIZE "memory_page_size" @@ -4321,7 +4321,7 @@ typedef enum { * every time a new iteration is started to transfer memory pages dirtied * since the last iteration. * - * Since: v1.3.1 + * Since: 1.3.1 */ # define VIR_DOMAIN_JOB_MEMORY_ITERATION "memory_iteration" @@ -4333,7 +4333,7 @@ typedef enum { * This counter is incremented whenever the migrated domain tries to access * a memory page which has not been transferred from the source host yet. * - * Since: v5.0.0 + * Since: 5.0.0 */ # define VIR_DOMAIN_JOB_MEMORY_POSTCOPY_REQS "memory_postcopy_requests" @@ -4345,7 +4345,7 @@ typedef enum { * * This field corresponds to fileTotal field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DISK_TOTAL "disk_total" @@ -4357,7 +4357,7 @@ typedef enum { * * This field corresponds to fileProcessed field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DISK_PROCESSED "disk_processed" @@ -4369,7 +4369,7 @@ typedef enum { * * This field corresponds to fileRemaining field in virDomainJobInfo. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_DISK_REMAINING "disk_remaining" @@ -4379,7 +4379,7 @@ typedef enum { * virDomainGetJobStats field: network throughput used while migrating * disks in Bytes per second, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_JOB_DISK_BPS "disk_bps" @@ -4390,7 +4390,7 @@ typedef enum { * compressing repeatedly transferred memory pages during live migration, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_COMPRESSION_CACHE "compression_cache" @@ -4400,7 +4400,7 @@ typedef enum { * virDomainGetJobStats field: number of compressed bytes transferred * since the beginning of migration, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_COMPRESSION_BYTES "compression_bytes" @@ -4410,7 +4410,7 @@ typedef enum { * virDomainGetJobStats field: number of compressed pages transferred * since the beginning of migration, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_COMPRESSION_PAGES "compression_pages" @@ -4421,7 +4421,7 @@ typedef enum { * were not found in compression cache and thus could not be compressed, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES "compression_cache_misses" @@ -4433,7 +4433,7 @@ typedef enum { * the result of compression was larger than the original page as a whole, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.0.3 + * Since: 1.0.3 */ # define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW "compression_overflow" @@ -4444,7 +4444,7 @@ typedef enum { * to when auto-convergence decided migration was not converging, as * VIR_TYPED_PARAM_INT. * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE "auto_converge_throttle" @@ -4454,7 +4454,7 @@ typedef enum { * virDomainGetJobStats field: Present only in statistics for a completed job. * Successful completion of the job as VIR_TYPED_PARAM_BOOLEAN. * - * Since: v6.0.0 + * Since: 6.0.0 */ # define VIR_DOMAIN_JOB_SUCCESS "success" @@ -4464,7 +4464,7 @@ typedef enum { * virDomainGetJobStats field: Present only in statistics for a completed job. * Optional error message for a failed job. * - * Since: v6.3.0 + * Since: 6.3.0 */ # define VIR_DOMAIN_JOB_ERRMSG "errmsg" @@ -4474,7 +4474,7 @@ typedef enum { * virDomainGetJobStats field: current usage of temporary disk space for the * job in bytes as VIR_TYPED_PARAM_ULLONG. * - * Since: v6.0.0 + * Since: 6.0.0 */ # define VIR_DOMAIN_JOB_DISK_TEMP_USED "disk_temp_used" @@ -4483,7 +4483,7 @@ typedef enum { * virDomainGetJobStats field: possible total temporary disk space for the * job in bytes as VIR_TYPED_PARAM_ULLONG. * - * Since: v6.0.0 + * Since: 6.0.0 */ # define VIR_DOMAIN_JOB_DISK_TEMP_TOTAL "disk_temp_total" @@ -4499,7 +4499,7 @@ typedef enum { * passed in a different parameter position; use VIR_DOMAIN_EVENT_CALLBACK() * when registering an appropriate handler. * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef void (*virConnectDomainEventGenericCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4515,7 +4515,7 @@ typedef void (*virConnectDomainEventGenericCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_RTC_CHANGE with virConnectDomainEventRegisterAny() * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4527,19 +4527,19 @@ typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn, * * The action that is to be taken due to the watchdog device firing * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest (Since: v1.2.17) */ + VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest (Since: 1.2.17) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: 0.9.10) */ # endif } virDomainEventWatchdogAction; @@ -4553,7 +4553,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_WATCHDOG with virConnectDomainEventRegisterAny() * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4565,15 +4565,15 @@ typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn, * * The action that is to be taken due to an IO error occurring * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS (Since: 0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: 0.9.10) */ # endif } virDomainEventIOErrorAction; @@ -4590,7 +4590,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_IO_ERROR with virConnectDomainEventRegisterAny() * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4618,7 +4618,7 @@ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn, * Otherwise, @reason will be "", although future strings may be added * if determination of other error types becomes possible. * - * Since: v0.8.1 + * Since: 0.8.1 */ typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4633,15 +4633,15 @@ typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr conn, * * The phase of the graphics client connection * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection (Since: 0.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: 0.9.10) */ # endif } virDomainEventGraphicsPhase; @@ -4650,15 +4650,15 @@ typedef enum { * * The type of address for the connection * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path (Since: v0.9.7) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path (Since: 0.9.7) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: 0.9.10) */ # endif } virDomainEventGraphicsAddressType; @@ -4668,7 +4668,7 @@ typedef enum { * * The data structure containing connection address details * - * Since: v1.0.0 + * Since: 1.0.0 */ struct _virDomainEventGraphicsAddress { int family; /* Address family, virDomainEventGraphicsAddressType */ @@ -4679,14 +4679,14 @@ struct _virDomainEventGraphicsAddress { /** * virDomainEventGraphicsAddress: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddress; /** * virDomainEventGraphicsAddressPtr: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef virDomainEventGraphicsAddress *virDomainEventGraphicsAddressPtr; @@ -4707,14 +4707,14 @@ struct _virDomainEventGraphicsSubjectIdentity { /** * virDomainEventGraphicsSubjectIdentity: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphicsSubjectIdentity; /** * virDomainEventGraphicsSubjectIdentityPtr: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubjectIdentityPtr; @@ -4727,7 +4727,7 @@ typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubjectIden * A subject will have zero or more identities. The types of * identity differ according to the authentication scheme * - * Since: v0.8.0 + * Since: 0.8.0 */ struct _virDomainEventGraphicsSubject { int nidentity; /* Number of identities in array*/ @@ -4737,14 +4737,14 @@ struct _virDomainEventGraphicsSubject { /** * virDomainEventGraphicsSubject: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubject; /** * virDomainEventGraphicsSubjectPtr: * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr; @@ -4763,7 +4763,7 @@ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr; * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_GRAPHICS with virConnectDomainEventRegisterAny() * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4780,16 +4780,16 @@ typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn, * Tracks status of a virDomainBlockPull(), virDomainBlockRebase(), * virDomainBlockCopy(), or virDomainBlockCommit() operation * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, /* (Since: v0.9.4) */ - VIR_DOMAIN_BLOCK_JOB_FAILED = 1, /* (Since: v0.9.4) */ - VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, /* (Since: v0.9.12) */ - VIR_DOMAIN_BLOCK_JOB_READY = 3, /* (Since: v1.0.0) */ + VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, /* (Since: 0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_FAILED = 1, /* (Since: 0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, /* (Since: 0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_READY = 3, /* (Since: 1.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: 0.9.10) */ # endif } virConnectDomainEventBlockJobStatus; @@ -4817,7 +4817,7 @@ typedef enum { * then @disk will contain the device target shorthand (the <target * dev='...'/> sub-element, such as "vda"). * - * Since: v0.9.4 + * Since: 0.9.4 */ typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4831,25 +4831,25 @@ typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn, * * The reason describing why this callback is called * - * Since: v0.9.7 + * Since: 0.9.7 */ typedef enum { /* Removable media changed to empty according to startup policy as source * was missing. oldSrcPath is set, newSrcPath is NULL * - * Since: v0.9.7 + * Since: 0.9.7 * */ VIR_DOMAIN_EVENT_DISK_CHANGE_MISSING_ON_START = 0, /* Disk was dropped from domain as source file was missing. * oldSrcPath is set, newSrcPath is NULL * - * Since: v1.1.2 + * Since: 1.1.2 * */ VIR_DOMAIN_EVENT_DISK_DROP_MISSING_ON_START = 1, # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: v0.9.10) */ + VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: 0.9.10) */ # endif } virConnectDomainEventDiskChangeReason; @@ -4872,7 +4872,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_DISK_CHANGE with virConnectDomainEventRegisterAny() * - * Since: v0.9.7 + * Since: 0.9.7 */ typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4887,14 +4887,14 @@ typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn, * * The reason describing why the callback was called * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef enum { - VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, /* (Since: v0.9.11) */ - VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, /* (Since: 0.9.11) */ + VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: 0.9.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: 0.9.11) */ # endif } virDomainEventTrayChangeReason; @@ -4911,7 +4911,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_TRAY_CHANGE with virConnectDomainEventRegisterAny() * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef void (*virConnectDomainEventTrayChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4932,7 +4932,7 @@ typedef void (*virConnectDomainEventTrayChangeCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_PMWAKEUP with virConnectDomainEventRegisterAny() * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef void (*virConnectDomainEventPMWakeupCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4952,7 +4952,7 @@ typedef void (*virConnectDomainEventPMWakeupCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_PMSUSPEND with virConnectDomainEventRegisterAny() * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef void (*virConnectDomainEventPMSuspendCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4970,7 +4970,7 @@ typedef void (*virConnectDomainEventPMSuspendCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE with virConnectDomainEventRegisterAny() * - * Since: v0.10.0 + * Since: 0.10.0 */ typedef void (*virConnectDomainEventBalloonChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4990,7 +4990,7 @@ typedef void (*virConnectDomainEventBalloonChangeCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK with virConnectDomainEventRegisterAny() * - * Since: v1.0.0 + * Since: 1.0.0 */ typedef void (*virConnectDomainEventPMSuspendDiskCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5009,7 +5009,7 @@ typedef void (*virConnectDomainEventPMSuspendDiskCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED with virConnectDomainEventRegisterAny() * - * Since: v1.1.1 + * Since: 1.1.1 */ typedef void (*virConnectDomainEventDeviceRemovedCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5028,7 +5028,7 @@ typedef void (*virConnectDomainEventDeviceRemovedCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_DEVICE_ADDED with virConnectDomainEventRegisterAny() * - * Since: v1.2.15 + * Since: 1.2.15 */ typedef void (*virConnectDomainEventDeviceAddedCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5049,7 +5049,7 @@ typedef void (*virConnectDomainEventDeviceAddedCallback)(virConnectPtr conn, * VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED with * virConnectDomainEventRegisterAny(). * - * Since: v1.3.4 + * Since: 1.3.4 */ typedef void (*virConnectDomainEventDeviceRemovalFailedCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5069,7 +5069,7 @@ typedef void (*virConnectDomainEventDeviceRemovalFailedCallback)(virConnectPtr c * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_METADATA_CHANGE with virConnectDomainEventRegisterAny(). * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef void (*virConnectDomainEventMetadataChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5094,7 +5094,7 @@ typedef void (*virConnectDomainEventMetadataChangeCallback)(virConnectPtr conn, * VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION with * virConnectDomainEventRegisterAny(). * - * Since: v1.3.2 + * Since: 1.3.2 */ typedef void (*virConnectDomainEventMigrationIterationCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5120,7 +5120,7 @@ typedef void (*virConnectDomainEventMigrationIterationCallback)(virConnectPtr co * VIR_DOMAIN_EVENT_ID_JOB_COMPLETED with * virConnectDomainEventRegisterAny(). * - * Since: v1.3.3 + * Since: 1.3.3 */ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5135,7 +5135,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * appended to the parameter name, for example "cputune.vcpupin1", * as VIR_TYPED_PARAM_STRING. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN "cputune.vcpupin%u" @@ -5145,7 +5145,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents formatted pinning for emulator process, * as VIR_TYPED_PARAM_STRING. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN "cputune.emulatorpin" @@ -5156,7 +5156,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * appended to the parameter name, for example "cputune.iothreadpin1", * as VIR_TYPED_PARAM_STRING. * - * Since: v1.2.14 + * Since: 1.2.14 */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN "cputune.iothreadpin%u" @@ -5166,7 +5166,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents proportional weight of the scheduler used on the * host cpu, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES "cputune.cpu_shares" @@ -5176,7 +5176,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the enforcement period for a quota, in microseconds, * for whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_PERIOD "cputune.global_period" @@ -5186,7 +5186,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the maximum bandwidth to be used within a period for * whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG. * - * Since: v1.3.3 + * Since: 1.3.3 */ # define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA "cputune.global_quota" @@ -5196,7 +5196,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the enforcement period for a quota, in microseconds, * for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD "cputune.vcpu_period" @@ -5206,7 +5206,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the maximum bandwidth to be used within a period for * vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA "cputune.vcpu_quota" @@ -5217,7 +5217,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * when using the posix scheduler, for all emulator activity not tied to * vcpus, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD "cputune.emulator_period" @@ -5228,7 +5228,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * all emulator activity not tied to vcpus, when using the posix scheduler, * as an VIR_TYPED_PARAM_LLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA "cputune.emulator_quota" @@ -5238,7 +5238,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the enforcement period for a quota, in microseconds, for * iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.2.0 + * Since: 2.2.0 */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD "cputune.iothread_period" @@ -5248,7 +5248,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the maximum bandwidth to be used within a period for * iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG. * - * Since: v2.2.0 + * Since: 2.2.0 */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA "cputune.iothread_quota" @@ -5258,7 +5258,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the name of guest disk for which the values are updated, * as VIR_TYPED_PARAM_STRING. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_DISK "blkdeviotune.disk" @@ -5268,7 +5268,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the total throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC "blkdeviotune.total_bytes_sec" @@ -5278,7 +5278,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the read throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC "blkdeviotune.read_bytes_sec" @@ -5288,7 +5288,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the write throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC "blkdeviotune.write_bytes_sec" @@ -5298,7 +5298,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the total I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC "blkdeviotune.total_iops_sec" @@ -5308,7 +5308,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the read I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC "blkdeviotune.read_iops_sec" @@ -5318,7 +5318,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the write I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.9 + * Since: 1.2.9 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC "blkdeviotune.write_iops_sec" @@ -5328,7 +5328,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the total throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX "blkdeviotune.total_bytes_sec_max" @@ -5338,7 +5338,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the read throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX "blkdeviotune.read_bytes_sec_max" @@ -5348,7 +5348,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the write throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX "blkdeviotune.write_bytes_sec_max" @@ -5358,7 +5358,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the total maximum I/O operations per second during bursts, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX "blkdeviotune.total_iops_sec_max" @@ -5368,7 +5368,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the read maximum I/O operations per second during bursts, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX "blkdeviotune.read_iops_sec_max" @@ -5378,7 +5378,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the write maximum I/O operations per second during bursts, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX "blkdeviotune.write_iops_sec_max" @@ -5388,7 +5388,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the size maximum I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v1.2.11 + * Since: 1.2.11 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC "blkdeviotune.size_iops_sec" @@ -5398,7 +5398,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * Macro represents the group name to be used, * as VIR_TYPED_PARAM_STRING. * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_GROUP_NAME "blkdeviotune.group_name" @@ -5409,7 +5409,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.total_bytes_sec_max, * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH "blkdeviotune.total_bytes_sec_max_length" @@ -5420,7 +5420,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.read_bytes_sec_max * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH "blkdeviotune.read_bytes_sec_max_length" @@ -5431,7 +5431,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.write_bytes_sec_max * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH "blkdeviotune.write_bytes_sec_max_length" @@ -5442,7 +5442,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.total_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH "blkdeviotune.total_iops_sec_max_length" @@ -5453,7 +5453,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.read_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH "blkdeviotune.read_iops_sec_max_length" @@ -5464,7 +5464,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * for the blkdeviotune.write_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. * - * Since: v2.4.0 + * Since: 2.4.0 */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH "blkdeviotune.write_iops_sec_max_length" @@ -5487,7 +5487,7 @@ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_TUNABLE with virConnectDomainEventRegisterAny() * - * Since: v1.2.9 + * Since: 1.2.9 */ typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5499,29 +5499,29 @@ typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn, /** * virConnectDomainEventAgentLifecycleState: * - * Since: v1.2.11 + * Since: 1.2.11 */ typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected (Since: v1.2.11) */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected (Since: 1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected (Since: 1.2.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST /* (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST /* (Since: 1.2.11) */ # endif } virConnectDomainEventAgentLifecycleState; /** * virConnectDomainEventAgentLifecycleReason: * - * Since: v1.2.11 + * Since: 1.2.11 */ typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason (Since: v1.2.11) */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start (Since: v1.2.11) */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason (Since: 1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start (Since: 1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed (Since: 1.2.11) */ # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: 1.2.11) */ # endif } virConnectDomainEventAgentLifecycleReason; @@ -5539,7 +5539,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE with virConnectDomainEventRegisterAny() * - * Since: v1.2.11 + * Since: 1.2.11 */ typedef void (*virConnectDomainEventAgentLifecycleCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5570,7 +5570,7 @@ typedef void (*virConnectDomainEventAgentLifecycleCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD with virConnectDomainEventRegisterAny() * - * Since: v3.2.0 + * Since: 3.2.0 */ typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5597,7 +5597,7 @@ typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE with virConnectDomainEventRegisterAny() * - * Since: v6.9.0 + * Since: 6.9.0 */ typedef void (*virConnectDomainEventMemoryFailureCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5623,7 +5623,7 @@ typedef void (*virConnectDomainEventMemoryFailureCallback)(virConnectPtr conn, * VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE with * virConnectDomainEventRegisterAny(). * - * Since: v7.9.0 + * Since: 7.9.0 */ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5638,7 +5638,7 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPt * Used to cast the event specific callback into the generic one * for use for virConnectDomainEventRegisterAny() * - * Since: v0.8.0 + * Since: 0.8.0 */ # define VIR_DOMAIN_EVENT_CALLBACK(cb) ((virConnectDomainEventGenericCallback)(cb)) @@ -5650,36 +5650,36 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPt * virConnectDomainEventRegisterAny(). Each event id determines which * signature of callback function will be used. * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef enum { - VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback (Since: v0.8.0) */ - VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback (Since: v0.8.1) */ - VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback (Since: v0.9.2) */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback (Since: v0.9.4) */ - VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback (Since: v0.9.7) */ - VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback (Since: v0.9.11) */ - VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback (Since: v0.9.11) */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback (Since: v0.9.11) */ - VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback (Since: v0.10.0) */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback (Since: v1.0.0) */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback (Since: v1.1.1) */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback (Since: v1.2.6) */ - VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback (Since: v1.2.9) */ - VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback (Since: v1.2.11) */ - VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback (Since: v1.2.15) */ - VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback (Since: v1.3.2) */ - VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback (Since: v1.3.3) */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback (Since: v1.3.4) */ - VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback (Since: v3.0.0) */ - VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback (Since: v3.2.0) */ - VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback (Since: v6.9.0) */ - VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback (Since: v7.9.0) */ + VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback (Since: 0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback (Since: 0.8.1) */ + VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback (Since: 0.9.2) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback (Since: 0.9.4) */ + VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback (Since: 0.9.7) */ + VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback (Since: 0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback (Since: 0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback (Since: 0.9.11) */ + VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback (Since: 0.10.0) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback (Since: 1.0.0) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback (Since: 1.1.1) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback (Since: 1.2.6) */ + VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback (Since: 1.2.9) */ + VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback (Since: 1.2.11) */ + VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback (Since: 1.2.15) */ + VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback (Since: 1.3.2) */ + VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback (Since: 1.3.3) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback (Since: 1.3.4) */ + VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback (Since: 3.0.0) */ + VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback (Since: 3.2.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback (Since: 6.9.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback (Since: 7.9.0) */ # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_EVENT_ID_LAST @@ -5688,7 +5688,7 @@ typedef enum { * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. * - * Since: v0.8.0 + * Since: 0.8.0 */ # endif } virDomainEventID; @@ -5709,15 +5709,15 @@ int virConnectDomainEventDeregisterAny(virConnectPtr conn, /** * virDomainConsoleFlags: * - * Since: v0.9.11 + * Since: 0.9.11 */ typedef enum { VIR_DOMAIN_CONSOLE_FORCE = (1 << 0), /* abort a (possibly) active console connection to force a new - connection (Since: v0.9.11) */ + connection (Since: 0.9.11) */ VIR_DOMAIN_CONSOLE_SAFE = (1 << 1), /* check if the console driver supports - safe console operations (Since: v0.9.11) */ + safe console operations (Since: 0.9.11) */ } virDomainConsoleFlags; int virDomainOpenConsole(virDomainPtr dom, @@ -5728,12 +5728,12 @@ int virDomainOpenConsole(virDomainPtr dom, /** * virDomainChannelFlags: * - * Since: v1.0.2 + * Since: 1.0.2 */ typedef enum { VIR_DOMAIN_CHANNEL_FORCE = (1 << 0), /* abort a (possibly) active channel connection to force a new - connection (Since: v1.0.2) */ + connection (Since: 1.0.2) */ } virDomainChannelFlags; int virDomainOpenChannel(virDomainPtr dom, @@ -5744,10 +5744,10 @@ int virDomainOpenChannel(virDomainPtr dom, /** * virDomainOpenGraphicsFlags: * - * Since: v0.9.7 + * Since: 0.9.7 */ typedef enum { - VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), /* (Since: v0.9.7) */ + VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), /* (Since: 0.9.7) */ } virDomainOpenGraphicsFlags; int virDomainOpenGraphics(virDomainPtr dom, @@ -5781,14 +5781,14 @@ int virDomainFSThaw(virDomainPtr dom, * * The data structure containing mounted file systems within a guset * - * Since: v1.2.11 + * Since: 1.2.11 */ typedef struct _virDomainFSInfo virDomainFSInfo; /** * virDomainFSInfoPtr: * - * Since: v1.2.11 + * Since: 1.2.11 */ typedef virDomainFSInfo *virDomainFSInfoPtr; @@ -5813,10 +5813,10 @@ int virDomainGetTime(virDomainPtr dom, /** * virDomainSetTimeFlags: * - * Since: v1.2.5 + * Since: 1.2.5 */ typedef enum { - VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC (Since: v1.2.5) */ + VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC (Since: 1.2.5) */ } virDomainSetTimeFlags; int virDomainSetTime(virDomainPtr dom, @@ -5830,15 +5830,15 @@ int virDomainSetTime(virDomainPtr dom, * A scheduler parameter field type. Provided for backwards * compatibility; virTypedParameterType is the preferred enum * - * Since: v0.2.3 + * Since: 0.2.3 */ typedef enum { - VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.2.3) */ - VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.2.3) */ - VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.2.3) */ - VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.2.3) */ - VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.2.3) */ - VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.2.3) */ } virSchedParameterType; /** @@ -5848,14 +5848,14 @@ typedef enum { * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the * preferred value * - * Since: v0.2.3 + * Since: 0.2.3 */ # define VIR_DOMAIN_SCHED_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH /** * _virSchedParameter: * - * Since: v0.2.3 + * Since: 0.2.3 */ # define _virSchedParameter _virTypedParameter @@ -5866,7 +5866,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.2.3 + * Since: 0.2.3 */ typedef struct _virTypedParameter virSchedParameter; @@ -5877,7 +5877,7 @@ typedef struct _virTypedParameter virSchedParameter; * Provided for backwards compatibility; virTypedParameterPtr is the * preferred alias since 0.9.2. * - * Since: v0.2.3 + * Since: 0.2.3 */ typedef virSchedParameter *virSchedParameterPtr; @@ -5887,15 +5887,15 @@ typedef virSchedParameter *virSchedParameterPtr; * A blkio parameter field type. Provided for backwards * compatibility; virTypedParameterType is the preferred enum * - * Since: v0.9.0 + * Since: 0.9.0 */ typedef enum { - VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.9.0) */ - VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.9.0) */ - VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.9.0) */ - VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.9.0) */ - VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.9.0) */ - VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.9.0) */ } virBlkioParameterType; /** @@ -5905,14 +5905,14 @@ typedef enum { * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the * preferred value. * - * Since: v0.9.0 + * Since: 0.9.0 */ # define VIR_DOMAIN_BLKIO_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH /** * _virBlkioParameter: * - * Since: v0.9.0 + * Since: 0.9.0 */ # define _virBlkioParameter _virTypedParameter @@ -5923,7 +5923,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.9.0 + * Since: 0.9.0 */ typedef struct _virTypedParameter virBlkioParameter; @@ -5934,7 +5934,7 @@ typedef struct _virTypedParameter virBlkioParameter; * Provided for backwards compatibility; virTypedParameterPtr is the * preferred alias. * - * Since: v0.9.0 + * Since: 0.9.0 */ typedef virBlkioParameter *virBlkioParameterPtr; @@ -5944,15 +5944,15 @@ typedef virBlkioParameter *virBlkioParameterPtr; * A memory parameter field type. Provided for backwards * compatibility; virTypedParameterType is the preferred enum * - * Since: v0.8.5 + * Since: 0.8.5 */ typedef enum { - VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.8.5) */ - VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.8.5) */ - VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.8.5) */ - VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.8.5) */ - VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.8.5) */ - VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.8.5) */ } virMemoryParameterType; /** @@ -5962,14 +5962,14 @@ typedef enum { * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the * preferred value. * - * Since: v0.8.5 + * Since: 0.8.5 */ # define VIR_DOMAIN_MEMORY_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH /** * _virMemoryParameter: * - * Since: v0.8.5 + * Since: 0.8.5 */ # define _virMemoryParameter _virTypedParameter @@ -5980,7 +5980,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.8.5 + * Since: 0.8.5 */ typedef struct _virTypedParameter virMemoryParameter; @@ -5991,36 +5991,36 @@ typedef struct _virTypedParameter virMemoryParameter; * Provided for backwards compatibility; virTypedParameterPtr is the * preferred alias. * - * Since: v0.8.5 + * Since: 0.8.5 */ typedef virMemoryParameter *virMemoryParameterPtr; /** * virDomainInterfaceAddressesSource: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef enum { - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file (Since: v1.2.14) */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent (Since: v1.2.14) */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables (Since: v4.2.0) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file (Since: 1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent (Since: 1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables (Since: 4.2.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: v1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: 1.2.14) */ # endif } virDomainInterfaceAddressesSource; /** * virDomainIPAddress: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef struct _virDomainInterfaceIPAddress virDomainIPAddress; /** * virDomainIPAddressPtr: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef virDomainIPAddress *virDomainIPAddressPtr; struct _virDomainInterfaceIPAddress { @@ -6032,14 +6032,14 @@ struct _virDomainInterfaceIPAddress { /** * virDomainInterface: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef struct _virDomainInterface virDomainInterface; /** * virDomainInterfacePtr: * - * Since: v1.2.14 + * Since: 1.2.14 */ typedef virDomainInterface *virDomainInterfacePtr; struct _virDomainInterface { @@ -6059,10 +6059,10 @@ void virDomainInterfaceFree(virDomainInterfacePtr iface); /** * virDomainSetUserPasswordFlags: * - * Since: v1.2.16 + * Since: 1.2.16 */ typedef enum { - VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted (Since: v1.2.16) */ + VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted (Since: 1.2.16) */ } virDomainSetUserPasswordFlags; int virDomainSetUserPassword(virDomainPtr dom, @@ -6097,33 +6097,33 @@ int virDomainSetBlockThreshold(virDomainPtr domain, /** * virDomainLifecycle: * - * Since: v3.9.0 + * Since: 3.9.0 */ typedef enum { - VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_REBOOT = 1, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_CRASH = 2, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_REBOOT = 1, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_CRASH = 2, /* (Since: 3.9.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_LAST /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_LAST /* (Since: 3.9.0) */ # endif } virDomainLifecycle; /** * virDomainLifecycleAction: * - * Since: v3.9.0 + * Since: 3.9.0 */ typedef enum { - VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, /* (Since: v3.9.0) */ - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, /* (Since: 3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, /* (Since: 3.9.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: 3.9.0) */ # endif } virDomainLifecycleAction; @@ -6142,7 +6142,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * Macro represents the launch measurement of the SEV guest, * as VIR_TYPED_PARAM_STRING. * - * Since: v4.5.0 + * Since: 4.5.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_MEASUREMENT "sev-measurement" @@ -6153,7 +6153,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * Macro represents the API major version of the SEV host, * as VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MAJOR "sev-api-major" @@ -6163,7 +6163,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * Macro represents the API minor version of the SEV guest, * as VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MINOR "sev-api-minor" @@ -6173,7 +6173,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * Macro represents the build ID of the SEV host, * as VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_BUILD_ID "sev-build-id" @@ -6183,7 +6183,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * Macro represents the policy of the SEV guest, * as VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_POLICY "sev-policy" @@ -6196,7 +6196,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * section "6.6 LAUNCH_SECRET" in the SEV API specification for a detailed * description of the secret header. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_HEADER "sev-secret-header" @@ -6208,7 +6208,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * secret. The secret is created by the domain owner after the SEV launch * measurement is retrieved and verified. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET "sev-secret" @@ -6219,7 +6219,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * where the secret will be set, as VIR_TYPED_PARAM_ULLONG. If not specified, * the address will be determined by the hypervisor. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_SET_ADDRESS "sev-secret-set-address" @@ -6236,16 +6236,16 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain, /** * virDomainGuestInfoTypes: * - * Since: v5.7.0 + * Since: 5.7.0 */ typedef enum { - VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users (Since: v5.7.0) */ - VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information (Since: v5.7.0) */ - VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information (Since: v5.7.0) */ - VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information (Since: v5.7.0) */ - VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information (Since: v5.7.0) */ - VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information (Since: v7.0.0) */ - VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information (Since: v7.10.0) */ + VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users (Since: 5.7.0) */ + VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information (Since: 5.7.0) */ + VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information (Since: 5.7.0) */ + VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information (Since: 5.7.0) */ + VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information (Since: 5.7.0) */ + VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information (Since: 7.0.0) */ + VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information (Since: 7.10.0) */ } virDomainGuestInfoTypes; int virDomainGetGuestInfo(virDomainPtr domain, @@ -6257,12 +6257,12 @@ int virDomainGetGuestInfo(virDomainPtr domain, /** * virDomainAgentResponseTimeoutValues: * - * Since: v5.10.0 + * Since: 5.10.0 */ typedef enum { - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, /* (Since: v5.10.0) */ - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, /* (Since: v5.10.0) */ - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, /* (Since: v5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, /* (Since: 5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, /* (Since: 5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, /* (Since: 5.10.0) */ } virDomainAgentResponseTimeoutValues; int virDomainAgentSetResponseTimeout(virDomainPtr domain, @@ -6272,11 +6272,11 @@ int virDomainAgentSetResponseTimeout(virDomainPtr domain, /** * virDomainBackupBeginFlags: * - * Since: v6.0.0 + * Since: 6.0.0 */ typedef enum { VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL = (1 << 0), /* reuse separately - provided images (Since: v6.0.0) */ + provided images (Since: 6.0.0) */ } virDomainBackupBeginFlags; int virDomainBackupBegin(virDomainPtr domain, @@ -6295,11 +6295,11 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, /** * virDomainAuthorizedSSHKeysSetFlags: * - * Since: v6.10.0 + * Since: 6.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) */ + VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate file, just append (Since: 6.10.0) */ + VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead of adding them (Since: 6.10.0) */ } virDomainAuthorizedSSHKeysSetFlags; @@ -6312,11 +6312,11 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, /** * virDomainMessageType: * - * Since: v7.1.0 + * Since: 7.1.0 */ typedef enum { - VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), /* (Since: v7.1.0) */ - VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), /* (Since: v7.1.0) */ + VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), /* (Since: 7.1.0) */ + VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), /* (Since: 7.1.0) */ } virDomainMessageType; int virDomainGetMessages(virDomainPtr domain, @@ -6328,18 +6328,18 @@ int virDomainGetMessages(virDomainPtr domain, * * Details on the cause of a dirty rate calculation status. * - * Since: v7.2.0 + * Since: 7.2.0 */ typedef enum { VIR_DOMAIN_DIRTYRATE_UNSTARTED = 0, /* the dirtyrate calculation has - not been started (Since: v7.2.0) */ + not been started (Since: 7.2.0) */ VIR_DOMAIN_DIRTYRATE_MEASURING = 1, /* the dirtyrate calculation is - measuring (Since: v7.2.0) */ + measuring (Since: 7.2.0) */ VIR_DOMAIN_DIRTYRATE_MEASURED = 2, /* the dirtyrate calculation is - completed (Since: v7.2.0) */ + completed (Since: 7.2.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DIRTYRATE_LAST /* (Since: v7.2.0) */ + VIR_DOMAIN_DIRTYRATE_LAST /* (Since: 7.2.0) */ # endif } virDomainDirtyRateStatus; @@ -6350,12 +6350,12 @@ typedef enum { * rate for a Domain * * - * Since: v8.1.0 + * Since: 8.1.0 */ typedef enum { - VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: v8.1.0) */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode (Since: v8.1.0) */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode (Since: v8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: 8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode (Since: 8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode (Since: 8.1.0) */ } virDomainDirtyRateCalcFlags; int virDomainStartDirtyRateCalc(virDomainPtr domain, diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-event.h index cc517044c6..41e662a237 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -35,13 +35,13 @@ * to libvirt. A client app must translate to, and from POLL events when using * this construct. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef enum { - VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: v0.5.0) */ - VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: v0.5.0) */ - VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: v0.5.0) */ - VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: 0.5.0) */ + VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: 0.5.0) */ + VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: 0.5.0) */ + VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: 0.5.0) */ } virEventHandleType; /** @@ -55,7 +55,7 @@ typedef enum { * Callback for receiving file handle events. The callback will * be invoked once for each event which is pending. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaque); @@ -84,7 +84,7 @@ typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaq * Returns -1 if the file handle cannot be registered, otherwise a handle * watch number to be used for updating and unregistering for events * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef int (*virEventAddHandleFunc)(int fd, int event, virEventHandleCallback cb, @@ -99,7 +99,7 @@ typedef int (*virEventAddHandleFunc)(int fd, int event, * Part of the EventImpl, this user-provided callback is notified when * events to listen on change * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef void (*virEventUpdateHandleFunc)(int watch, int event); @@ -116,7 +116,7 @@ typedef void (*virEventUpdateHandleFunc)(int watch, int event); * * Returns -1 if the file handle was not registered, 0 upon success * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef int (*virEventRemoveHandleFunc)(int watch); @@ -128,7 +128,7 @@ typedef int (*virEventRemoveHandleFunc)(int watch); * * callback for receiving timer events * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef void (*virEventTimeoutCallback)(int timer, void *opaque); @@ -148,7 +148,7 @@ typedef void (*virEventTimeoutCallback)(int timer, void *opaque); * * Returns a timer value * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef int (*virEventAddTimeoutFunc)(int timeout, virEventTimeoutCallback cb, @@ -163,7 +163,7 @@ typedef int (*virEventAddTimeoutFunc)(int timeout, * Part of the EventImpl, this user-defined callback updates an * event timeout. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout); @@ -179,7 +179,7 @@ typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout); * * Returns 0 on success, -1 on failure * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef int (*virEventRemoveTimeoutFunc)(int timer); diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index b5cf8a4a4a..e115f7b998 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -34,7 +34,7 @@ * a virConnect is a private structure representing a connection to * the Hypervisor. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef struct _virConnect virConnect; @@ -44,7 +44,7 @@ typedef struct _virConnect virConnect; * a virConnectPtr is pointer to a virConnect private structure, this is the * type used to reference a connection to the Hypervisor in the API. * - * Since: v0.0.1 + * Since: 0.0.1 */ typedef virConnect *virConnectPtr; @@ -54,15 +54,15 @@ typedef virConnect *virConnectPtr; * Flags to indicate which system-wide sleep state the host must be * transitioned to. * - * Since: v0.9.8 + * Since: 0.9.8 */ typedef enum { - VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: v0.9.8) */ - VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: v0.9.8) */ - VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: 0.9.8) */ + VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: 0.9.8) */ + VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: 0.9.8) */ # ifdef VIR_ENUM_SENTINELS - VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: 0.9.8) */ # endif } virNodeSuspendTarget; @@ -71,7 +71,7 @@ typedef enum { * * a virStream is a private structure representing a data stream. * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef struct _virStream virStream; @@ -81,7 +81,7 @@ typedef struct _virStream virStream; * a virStreamPtr is pointer to a virStream private structure, this is the * type used to reference a data stream in the API. * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef virStream *virStreamPtr; @@ -91,7 +91,7 @@ typedef virStream *virStreamPtr; * Macro providing the maximum length of the virSecurityLabel label string. * Note that this value is based on that used by Labeled NFS. * - * Since: v0.6.1 + * Since: 0.6.1 */ # define VIR_SECURITY_LABEL_BUFLEN (4096 + 1) @@ -102,7 +102,7 @@ typedef virStream *virStreamPtr; * providing the security label and associated attributes for the specified * domain. * - * Since: v0.6.1 + * Since: 0.6.1 */ typedef struct _virSecurityLabel virSecurityLabel; @@ -116,7 +116,7 @@ struct _virSecurityLabel { * * a virSecurityLabelPtr is a pointer to a virSecurityLabel. * - * Since: v0.6.1 + * Since: 0.6.1 */ typedef virSecurityLabel *virSecurityLabelPtr; @@ -125,7 +125,7 @@ typedef virSecurityLabel *virSecurityLabelPtr; * * Macro providing the maximum length of the virSecurityModel model string. * - * Since: v0.6.1 + * Since: 0.6.1 */ # define VIR_SECURITY_MODEL_BUFLEN (256 + 1) @@ -134,7 +134,7 @@ typedef virSecurityLabel *virSecurityLabelPtr; * * Macro providing the maximum length of the virSecurityModel doi string. * - * Since: v0.6.1 + * Since: 0.6.1 */ # define VIR_SECURITY_DOI_BUFLEN (256 + 1) @@ -145,7 +145,7 @@ typedef virSecurityLabel *virSecurityLabelPtr; * providing the per-hypervisor security model and DOI attributes for the * specified domain. * - * Since: v0.6.1 + * Since: 0.6.1 */ typedef struct _virSecurityModel virSecurityModel; @@ -159,7 +159,7 @@ struct _virSecurityModel { * * a virSecurityModelPtr is a pointer to a virSecurityModel. * - * Since: v0.6.1 + * Since: 0.6.1 */ typedef virSecurityModel *virSecurityModelPtr; @@ -176,7 +176,7 @@ typedef virSecurityModel *virSecurityModelPtr; * accurate relection of the system hardware. See the virNodeGetInfo() * API documentation for further guidance. * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef struct _virNodeInfo virNodeInfo; @@ -202,7 +202,7 @@ struct _virNodeInfo { * * Macro providing the field length of virNodeCPUStats * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_FIELD_LENGTH 80 @@ -211,10 +211,10 @@ struct _virNodeInfo { * * Value for specifying request for the total CPU time/utilization * - * Since: v0.9.8 + * Since: 0.9.8 */ typedef enum { - VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: v0.9.3) */ + VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: 0.9.3) */ } virNodeGetCPUStatsAllCPUs; /** @@ -223,7 +223,7 @@ typedef enum { * Macro for the cumulative CPU time which was spent by the kernel, * since the node booting up (in nanoseconds). * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_KERNEL "kernel" @@ -233,7 +233,7 @@ typedef enum { * The cumulative CPU time which was spent by user processes, * since the node booting up (in nanoseconds). * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_USER "user" @@ -243,7 +243,7 @@ typedef enum { * The cumulative idle CPU time, * since the node booting up (in nanoseconds). * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_IDLE "idle" @@ -253,7 +253,7 @@ typedef enum { * The cumulative I/O wait CPU time, * since the node booting up (in nanoseconds). * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_IOWAIT "iowait" @@ -263,7 +263,7 @@ typedef enum { * The cumulative interrupt CPU time, * since the node booting up (in nanoseconds). * - * Since: v1.2.2 + * Since: 1.2.2 */ # define VIR_NODE_CPU_STATS_INTR "intr" @@ -274,7 +274,7 @@ typedef enum { * The usage value is in percent and 100% represents all CPUs of * the node. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_CPU_STATS_UTILIZATION "utilization" @@ -284,7 +284,7 @@ typedef enum { * a virNodeCPUStats is a structure filled by virNodeGetCPUStats() * providing information about the CPU stats of the node. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef struct _virNodeCPUStats virNodeCPUStats; @@ -298,7 +298,7 @@ struct _virNodeCPUStats { * * Macro providing the field length of virNodeMemoryStats * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80 @@ -307,10 +307,10 @@ struct _virNodeCPUStats { * * Value for specifying request for the total memory of all cells. * - * Since: v0.9.8 + * Since: 0.9.8 */ typedef enum { - VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: v0.9.3) */ + VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: 0.9.3) */ } virNodeGetMemoryStatsAllCells; /** @@ -319,7 +319,7 @@ typedef enum { * Macro for the total memory of specified cell: * it represents the maximum memory. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_MEMORY_STATS_TOTAL "total" @@ -330,7 +330,7 @@ typedef enum { * On Linux, it includes buffer and cached memory, in case of * VIR_NODE_MEMORY_STATS_ALL_CELLS. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_MEMORY_STATS_FREE "free" @@ -340,7 +340,7 @@ typedef enum { * Macro for the buffer memory: On Linux, it is only returned in case of * VIR_NODE_MEMORY_STATS_ALL_CELLS. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_MEMORY_STATS_BUFFERS "buffers" @@ -350,7 +350,7 @@ typedef enum { * Macro for the cached memory: On Linux, it is only returned in case of * VIR_NODE_MEMORY_STATS_ALL_CELLS. * - * Since: v0.9.3 + * Since: 0.9.3 */ # define VIR_NODE_MEMORY_STATS_CACHED "cached" @@ -360,7 +360,7 @@ typedef enum { * a virNodeMemoryStats is a structure filled by virNodeGetMemoryStats() * providing information about the memory of the node. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef struct _virNodeMemoryStats virNodeMemoryStats; @@ -375,7 +375,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many present pages * to scan before the shared memory service goes to sleep. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_PAGES_TO_SCAN "shm_pages_to_scan" @@ -385,7 +385,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many milliseconds * the shared memory service should sleep before next scan. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_SLEEP_MILLISECS "shm_sleep_millisecs" @@ -395,7 +395,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many the shared * memory pages are being used. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_PAGES_SHARED "shm_pages_shared" @@ -405,7 +405,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many sites are * sharing the pages i.e. how much saved. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_PAGES_SHARING "shm_pages_sharing" @@ -415,7 +415,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many pages unique * but repeatedly checked for merging. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_PAGES_UNSHARED "shm_pages_unshared" @@ -425,7 +425,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many pages changing * too fast to be placed in a tree. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_PAGES_VOLATILE "shm_pages_volatile" @@ -435,7 +435,7 @@ struct _virNodeMemoryStats { * Macro for typed parameter that represents how many times all * mergeable areas have been scanned. * - * Since: v0.10.2 + * Since: 0.10.2 */ # define VIR_NODE_MEMORY_SHARED_FULL_SCANS "shm_full_scans" @@ -449,7 +449,7 @@ struct _virNodeMemoryStats { * pages from all nodes can be merged. Other values are reserved * for future use. * - * Since: v1.0.0 + * Since: 1.0.0 */ # define VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES "shm_merge_across_nodes" @@ -480,7 +480,7 @@ int virNodeGetCPUMap(virConnectPtr conn, * This macro is to calculate the total number of CPUs supported * but not necessary active in the host. * - * Since: v0.1.4 + * Since: 0.1.4 */ # define VIR_NODEINFO_MAXCPUS(nodeinfo) ((nodeinfo).nodes*(nodeinfo).sockets*(nodeinfo).cores*(nodeinfo).threads) @@ -489,7 +489,7 @@ int virNodeGetCPUMap(virConnectPtr conn, * * a virNodeInfoPtr is a pointer to a virNodeInfo structure. * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef virNodeInfo *virNodeInfoPtr; @@ -498,7 +498,7 @@ typedef virNodeInfo *virNodeInfoPtr; * * a virNodeCPUStatsPtr is a pointer to a virNodeCPUStats structure. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef virNodeCPUStats *virNodeCPUStatsPtr; @@ -507,7 +507,7 @@ typedef virNodeCPUStats *virNodeCPUStatsPtr; * * a virNodeMemoryStatsPtr is a pointer to a virNodeMemoryStats structure. * - * Since: v0.9.3 + * Since: 0.9.3 */ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; @@ -522,7 +522,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * * Macro represents the Platform Diffie-Hellman key, as VIR_TYPED_PARAMS_STRING. * - * Since: v4.5.0 + * Since: 4.5.0 */ # define VIR_NODE_SEV_PDH "pdh" @@ -533,7 +533,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * endorsement key (PEK), owner certificate authority (OCD) and chip * endorsement key (CEK), as VIR_TYPED_PARAMS_STRING. * - * Since: v4.5.0 + * Since: 4.5.0 */ # define VIR_NODE_SEV_CERT_CHAIN "cert-chain" @@ -542,7 +542,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * * Macro represents the CBit Position used by hypervisor when SEV is enabled. * - * Since: v4.5.0 + * Since: 4.5.0 */ # define VIR_NODE_SEV_CBITPOS "cbitpos" @@ -552,7 +552,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * Macro represents the number of bits we lose in physical address space * when SEV is enabled in the guest. * - * Since: v4.5.0 + * Since: 4.5.0 */ # define VIR_NODE_SEV_REDUCED_PHYS_BITS "reduced-phys-bits" @@ -562,7 +562,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * Macro represents the number of SEV guests that can * be run on the host, as a VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_NODE_SEV_MAX_GUESTS "max-guests" @@ -572,7 +572,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * Macro represents the number of SEV-ES guests that can * be run on the host, as a VIR_TYPED_PARAM_UINT. * - * Since: v8.0.0 + * Since: 8.0.0 */ # define VIR_NODE_SEV_MAX_ES_GUESTS "max-es-guests" @@ -586,31 +586,31 @@ int virNodeGetSEVInfo (virConnectPtr conn, * * Flags when opening a connection to a hypervisor * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: v0.4.1) */ - VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: v0.9.7) */ + VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: 0.4.1) */ + VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: 0.9.7) */ } virConnectFlags; /** * virConnectCredentialType: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_CRED_USERNAME = 1, /* Identity to act as (Since: v0.4.1) */ - VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: v0.4.1) */ - VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: v0.4.1) */ - VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: v0.4.1) */ - VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: v0.4.1) */ - VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: v0.4.1) */ - VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: v0.4.1) */ - VIR_CRED_REALM = 8, /* Authentication realm (Since: v0.4.1) */ - VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: v0.4.1) */ + VIR_CRED_USERNAME = 1, /* Identity to act as (Since: 0.4.1) */ + VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: 0.4.1) */ + VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: 0.4.1) */ + VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: 0.4.1) */ + VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: 0.4.1) */ + VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: 0.4.1) */ + VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: 0.4.1) */ + VIR_CRED_REALM = 8, /* Authentication realm (Since: 0.4.1) */ + VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: 0.4.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_CRED_LAST /* More may be added - expect the unexpected (Since: v0.9.10) */ + VIR_CRED_LAST /* More may be added - expect the unexpected (Since: 0.9.10) */ # endif } virConnectCredentialType; @@ -626,14 +626,14 @@ struct _virConnectCredential { /** * virConnectCredential: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virConnectCredential virConnectCredential; /** * virConnectCredentialPtr: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virConnectCredential *virConnectCredentialPtr; @@ -651,7 +651,7 @@ typedef virConnectCredential *virConnectCredentialPtr; * * Returns 0 if all interactions were filled, or -1 upon error * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef int (*virConnectAuthCallbackPtr)(virConnectCredentialPtr cred, unsigned int ncred, @@ -668,14 +668,14 @@ struct _virConnectAuth { /** * virConnectAuth: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virConnectAuth virConnectAuth; /** * virConnectAuthPtr: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virConnectAuth *virConnectAuthPtr; @@ -689,7 +689,7 @@ typedef virConnectAuth *virConnectAuthPtr; * suitable for the application's needs an alternative implementation * should be provided. * - * Since: v0.4.1 + * Since: 0.4.1 */ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault; @@ -699,7 +699,7 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault; * This macro provides the length of the buffer required * for virDomainGetUUID() * - * Since: v0.2.0 + * Since: 0.2.0 */ # define VIR_UUID_BUFLEN (16) @@ -709,7 +709,7 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault; * This macro provides the length of the buffer required * for virDomainGetUUIDString() * - * Since: v0.2.0 + * Since: 0.2.0 */ # define VIR_UUID_STRING_BUFLEN (36+1) @@ -736,7 +736,7 @@ int virConnectClose (virConnectPtr conn); * * The operating system user name as VIR_TYPED_PARAM_STRING. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_USER_NAME "user-name" @@ -745,7 +745,7 @@ int virConnectClose (virConnectPtr conn); * * The UNIX user ID as VIR_TYPED_PARAM_ULLONG. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_UNIX_USER_ID "unix-user-id" @@ -754,7 +754,7 @@ int virConnectClose (virConnectPtr conn); * * The operating system group name as VIR_TYPED_PARAM_STRING. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_GROUP_NAME "group-name" @@ -763,7 +763,7 @@ int virConnectClose (virConnectPtr conn); * * The UNIX group ID as VIR_TYPED_PARAM_ULLONG. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_UNIX_GROUP_ID "unix-group-id" @@ -772,7 +772,7 @@ int virConnectClose (virConnectPtr conn); * * The operating system process ID as VIR_TYPED_PARAM_LLONG. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_PROCESS_ID "process-id" @@ -785,7 +785,7 @@ int virConnectClose (virConnectPtr conn); * host operating system. On Linux this is usually clock * ticks (as reported in /proc/$PID/stat field 22). * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_PROCESS_TIME "process-time" @@ -794,7 +794,7 @@ int virConnectClose (virConnectPtr conn); * * The SASL authenticated username as VIR_TYPED_PARAM_STRING * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_SASL_USER_NAME "sasl-user-name" @@ -803,7 +803,7 @@ int virConnectClose (virConnectPtr conn); * * The TLS x509 certificate distinguished named as VIR_TYPED_PARAM_STRING * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_X509_DISTINGUISHED_NAME "x509-distinguished-name" @@ -812,7 +812,7 @@ int virConnectClose (virConnectPtr conn); * * The application's SELinux context as VIR_TYPED_PARAM_STRING. * - * Since: v5.8.0 + * Since: 5.8.0 */ # define VIR_CONNECT_IDENTITY_SELINUX_CONTEXT "selinux-context" @@ -844,7 +844,7 @@ int virConnectSetKeepAlive(virConnectPtr conn, * A callback function to be registered, and called when the connection * is closed. * - * Since: v0.10.0 + * Since: 0.10.0 */ typedef void (*virConnectCloseFunc)(virConnectPtr conn, int reason, @@ -910,29 +910,29 @@ int virConnectIsAlive(virConnectPtr conn); /** * virCPUCompareResult: * - * Since: v0.7.5 + * Since: 0.7.5 */ typedef enum { - VIR_CPU_COMPARE_ERROR = -1, /* (Since: v0.7.5) */ - VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: v0.7.5) */ - VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: v0.7.5) */ - VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_ERROR = -1, /* (Since: 0.7.5) */ + VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: 0.7.5) */ + VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: 0.7.5) */ + VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: 0.7.5) */ # ifdef VIR_ENUM_SENTINELS - VIR_CPU_COMPARE_LAST /* (Since: v0.9.10) */ + VIR_CPU_COMPARE_LAST /* (Since: 0.9.10) */ # endif } virCPUCompareResult; /** * virConnectCompareCPUFlags: * - * Since: v1.2.6 + * Since: 1.2.6 */ typedef enum { VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = (1 << 0), /* treat incompatible - CPUs as failure (Since: v1.2.6) */ + CPUs as failure (Since: 1.2.6) */ VIR_CONNECT_COMPARE_CPU_VALIDATE_XML = (1 << 1), /* validate the xml - document (Since: v6.9.0) */ + document (Since: 6.9.0) */ } virConnectCompareCPUFlags; int virConnectCompareCPU(virConnectPtr conn, @@ -956,11 +956,11 @@ int virConnectGetCPUModelNames(virConnectPtr conn, * * Flags when getting XML description of a computed CPU * - * Since: v1.1.2 + * Since: 1.1.2 */ typedef enum { - VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: v1.1.2) */ - VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: v1.2.14) */ + VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: 1.1.2) */ + VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: 1.2.14) */ } virConnectBaselineCPUFlags; char *virConnectBaselineCPU(virConnectPtr conn, @@ -987,14 +987,14 @@ int virNodeGetFreePages(virConnectPtr conn, /** * virNodeAllocPagesFlags: * - * Since: v1.2.9 + * Since: 1.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) */ + can be used only to size up the pool. (Since: 1.2.9) */ VIR_NODE_ALLOC_PAGES_SET = (1 << 0), /* Don't add @pageCounts, instead set passed number of pages. This can be - used to free allocated pages. (Since: v1.2.9) */ + used to free allocated pages. (Since: 1.2.9) */ } virNodeAllocPagesFlags; int virNodeAllocPages(virConnectPtr conn, diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-interface.h index 66ede43f43..fcbec115c5 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -32,7 +32,7 @@ * * a virInterface is a private structure representing a virtual interface. * - * Since: v0.6.4 + * Since: 0.6.4 */ typedef struct _virInterface virInterface; @@ -42,7 +42,7 @@ typedef struct _virInterface virInterface; * a virInterfacePtr is pointer to a virInterface private structure, this is the * type used to reference a virtual interface in the API. * - * Since: v0.6.4 + * Since: 0.6.4 */ typedef virInterface *virInterfacePtr; @@ -62,11 +62,11 @@ int virConnectListDefinedInterfaces (virConnectPtr conn, * * Flags used to filter the returned interfaces. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: 0.10.2) */ } virConnectListAllInterfacesFlags; int virConnectListAllInterfaces (virConnectPtr conn, @@ -84,19 +84,19 @@ const char* virInterfaceGetMACString (virInterfacePtr iface); /** * virInterfaceXMLFlags: * - * Since: v0.7.3 + * Since: 0.7.3 */ typedef enum { - VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: v0.7.3) */ + VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: 0.7.3) */ } virInterfaceXMLFlags; /** * virInterfaceDefineFlags: * - * Since: v7.7.0 + * Since: 7.7.0 */ typedef enum { - VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ + VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */ } virInterfaceDefineFlags; char * virInterfaceGetXMLDesc (virInterfacePtr iface, diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-network.h index 0a9f0ecb0d..d3e3fdeecf 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -30,10 +30,10 @@ /** * virNetworkXMLFlags: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: v0.9.10) */ + VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: 0.9.10) */ } virNetworkXMLFlags; /** @@ -41,7 +41,7 @@ typedef enum { * * a virNetwork is a private structure representing a virtual network. * - * Since: v0.2.0 + * Since: 0.2.0 */ typedef struct _virNetwork virNetwork; @@ -51,7 +51,7 @@ typedef struct _virNetwork virNetwork; * a virNetworkPtr is pointer to a virNetwork private structure, this is the * type used to reference a virtual network in the API. * - * Since: v0.2.0 + * Since: 0.2.0 */ typedef virNetwork *virNetworkPtr; @@ -61,7 +61,7 @@ typedef virNetwork *virNetworkPtr; * a virNetworkPort is a private structure representing a virtual network * port * - * Since: v5.5.0 + * Since: 5.5.0 */ typedef struct _virNetworkPort virNetworkPort; @@ -71,7 +71,7 @@ typedef struct _virNetworkPort virNetworkPort; * a virNetworkPortPtr is pointer to a virNetworkPort private structure, * this is the type used to reference a virtual network port in the API. * - * Since: v5.5.0 + * Since: 5.5.0 */ typedef virNetworkPort *virNetworkPortPtr; @@ -101,17 +101,17 @@ int virConnectListDefinedNetworks (virConnectPtr conn, * Flags used to filter the returned networks. Flags in each group * are exclusive attributes of a network. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */ } virConnectListAllNetworksFlags; int virConnectListAllNetworks (virConnectPtr conn, @@ -130,10 +130,10 @@ virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn, /** * virNetworkCreateFlags: * - * Since: v7.8.0 + * Since: 7.8.0 */ typedef enum { - VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */ + VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */ } virNetworkCreateFlags; /* @@ -147,10 +147,10 @@ virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, /** * virNetworkDefineFlags: * - * Since: v7.7.0 + * Since: 7.7.0 */ typedef enum { - VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ + VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */ } virNetworkDefineFlags; /* @@ -173,16 +173,16 @@ int virNetworkUndefine (virNetworkPtr network); * describes which type of update to perform on a <network> * definition. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: 0.10.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: 0.10.2) */ # endif } virNetworkUpdateCommand; @@ -192,24 +192,24 @@ typedef enum { * describes which section of a <network> definition the provided * xml should be applied to. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: v0.10.2) */ - VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: v0.10.2) */ - VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: v0.10.2) */ + VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: 0.10.2) */ + VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: 0.10.2) */ + VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: 0.10.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_SECTION_LAST /* (Since: v0.10.2) */ + VIR_NETWORK_SECTION_LAST /* (Since: 0.10.2) */ # endif } virNetworkUpdateSection; @@ -218,13 +218,13 @@ typedef enum { * * Flags to control options for virNetworkUpdate() * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { VIR_NETWORK_UPDATE_AFFECT_CURRENT = 0, /* affect live if network is active, - config if it's not active (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: v0.10.2) */ - VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: v0.10.2) */ + config if it's not active (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: 0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: 0.10.2) */ } virNetworkUpdateFlags; /* @@ -274,16 +274,16 @@ int virNetworkIsPersistent(virNetworkPtr net); * * a virNetworkEventLifecycleType is emitted during network lifecycle events * - * Since: v1.2.1 + * Since: 1.2.1 */ typedef enum { - VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: v1.2.1) */ - VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: v1.2.1) */ - VIR_NETWORK_EVENT_STARTED = 2, /* (Since: v1.2.1) */ - VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: 1.2.1) */ + VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: 1.2.1) */ + VIR_NETWORK_EVENT_STARTED = 2, /* (Since: 1.2.1) */ + VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: 1.2.1) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_EVENT_LAST /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_LAST /* (Since: 1.2.1) */ # endif } virNetworkEventLifecycleType; @@ -301,7 +301,7 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_NETWORK_EVENT_ID_LIFECYCLE with virConnectNetworkEventRegisterAny() * - * Since: v1.2.1 + * Since: 1.2.1 */ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, virNetworkPtr net, @@ -315,7 +315,7 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, * Used to cast the event specific callback into the generic one * for use for virConnectNetworkEventRegisterAny() * - * Since: v1.2.1 + * Since: 1.2.1 */ # define VIR_NETWORK_EVENT_CALLBACK(cb) ((virConnectNetworkEventGenericCallback)(cb)) @@ -326,10 +326,10 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, * virConnectNetworkEventRegisterAny(). Each event id determines which * signature of callback function will be used. * - * Since: v1.2.1 + * Since: 1.2.1 */ typedef enum { - VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: v1.2.1) */ + VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: 1.2.1) */ # ifdef VIR_ENUM_SENTINELS VIR_NETWORK_EVENT_ID_LAST @@ -338,7 +338,7 @@ typedef enum { * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. * - * Since: v1.2.1 + * Since: 1.2.1 */ # endif } virNetworkEventID; @@ -346,28 +346,28 @@ typedef enum { /** * virIPAddrType: * - * Since: v1.2.6 + * Since: 1.2.6 */ typedef enum { - VIR_IP_ADDR_TYPE_IPV4, /* (Since: v1.2.6) */ - VIR_IP_ADDR_TYPE_IPV6, /* (Since: v1.2.6) */ + VIR_IP_ADDR_TYPE_IPV4, /* (Since: 1.2.6) */ + VIR_IP_ADDR_TYPE_IPV6, /* (Since: 1.2.6) */ # ifdef VIR_ENUM_SENTINELS - VIR_IP_ADDR_TYPE_LAST /* (Since: v1.2.6) */ + VIR_IP_ADDR_TYPE_LAST /* (Since: 1.2.6) */ # endif } virIPAddrType; /** * virNetworkDHCPLease: * - * Since: v1.2.6 + * Since: 1.2.6 */ typedef struct _virNetworkDHCPLease virNetworkDHCPLease; /** * virNetworkDHCPLeasePtr: * - * Since: v1.2.6 + * Since: 1.2.6 */ typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr; struct _virNetworkDHCPLease { @@ -401,7 +401,7 @@ int virNetworkGetDHCPLeases(virNetworkPtr network, * passed in a different parameter position; use VIR_NETWORK_EVENT_CALLBACK() * when registering an appropriate handler. * - * Since: v1.2.1 + * Since: 1.2.1 */ typedef void (*virConnectNetworkEventGenericCallback)(virConnectPtr conn, virNetworkPtr net, @@ -430,11 +430,11 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, /** * virNetworkPortCreateFlags: * - * Since: v5.5.0 + * Since: 5.5.0 */ typedef enum { - VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: v5.5.0) */ - VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: v7.8.0) */ + VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: 5.5.0) */ + VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: 7.8.0) */ } virNetworkPortCreateFlags; virNetworkPortPtr @@ -463,7 +463,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the inbound average of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE "inbound.average" @@ -472,7 +472,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the inbound peak of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK "inbound.peak" @@ -481,7 +481,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the inbound burst of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_BURST "inbound.burst" @@ -490,7 +490,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the inbound floor of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR "inbound.floor" @@ -499,7 +499,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the outbound average of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE "outbound.average" @@ -508,7 +508,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the outbound peak of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK "outbound.peak" @@ -517,7 +517,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Macro represents the outbound burst of NIC bandwidth, as a uint. * - * Since: v5.5.0 + * Since: 5.5.0 */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST "outbound.burst" diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-nodedev.h index 455bc2ce57..4fccd3f614 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -33,7 +33,7 @@ * * A virNodeDevice contains a node (host) device details. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef struct _virNodeDevice virNodeDevice; @@ -45,7 +45,7 @@ typedef struct _virNodeDevice virNodeDevice; * to call virNodeDeviceFree when done using a virNodeDevicePtr obtained * from any of the above functions to avoid leaking memory. * - * Since: v0.5.0 + * Since: 0.5.0 */ typedef virNodeDevice *virNodeDevicePtr; @@ -65,34 +65,34 @@ int virNodeListDevices (virConnectPtr conn, * Flags used to filter either by capability or active state, the * returned node devices. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: v0.10.2) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: v1.0.4) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: v1.0.4) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: v1.1.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: v3.1.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: v3.4.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: v3.4.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: v3.4.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: v6.8.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: v6.9.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: v7.0.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: v7.0.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: v7.0.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: v7.9.0) */ - - VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: v7.3.0) */ - VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: v7.3.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: 0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: 1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: 1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: 1.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: 3.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: 3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: 3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: 3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: 6.8.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: 6.9.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: 7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: 7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: 7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: 7.9.0) */ + + VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: 7.3.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: 7.3.0) */ } virConnectListAllNodeDeviceFlags; int virConnectListAllNodeDevices (virConnectPtr conn, @@ -162,7 +162,7 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * Used to cast the event specific callback into the generic one * for use for virConnectNodeDeviceEventRegisterAny() * - * Since: v2.2.0 + * Since: 2.2.0 */ # define VIR_NODE_DEVICE_EVENT_CALLBACK(cb)((virConnectNodeDeviceEventGenericCallback)(cb)) @@ -173,11 +173,11 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * virConnectNodeDeviceEventRegisterAny(). Each event id determines which * signature of callback function will be used. * - * Since: v2.2.0 + * Since: 2.2.0 */ typedef enum { - VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: v2.2.0) */ - VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: 2.2.0) */ + VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: 2.2.0) */ # ifdef VIR_ENUM_SENTINELS VIR_NODE_DEVICE_EVENT_ID_LAST @@ -186,7 +186,7 @@ typedef enum { * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. * - * Since: v2.2.0 + * Since: 2.2.0 */ # endif } virNodeDeviceEventID; @@ -203,7 +203,7 @@ typedef enum { * passed in a different parameter position; use * VIR_NODE_DEVICE_EVENT_CALLBACK() when registering an appropriate handler. * - * Since: v2.2.0 + * Since: 2.2.0 */ typedef void (*virConnectNodeDeviceEventGenericCallback)(virConnectPtr conn, virNodeDevicePtr dev, @@ -226,16 +226,16 @@ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, * a virNodeDeviceEventLifecycleType is emitted during node device * lifecycle events * - * Since: v2.2.0 + * Since: 2.2.0 */ typedef enum { - VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: v2.2.0) */ - VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: v2.2.0) */ - VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: v7.3.0) */ - VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: v7.3.0) */ + VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: 2.2.0) */ + VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: 2.2.0) */ + VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: 7.3.0) */ + VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: 7.3.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_NODE_DEVICE_EVENT_LAST /* (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_LAST /* (Since: 2.2.0) */ # endif } virNodeDeviceEventLifecycleType; @@ -254,7 +254,7 @@ typedef enum { * VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE with * virConnectNodeDeviceEventRegisterAny() * - * Since: v2.2.0 + * Since: 2.2.0 */ typedef void (*virConnectNodeDeviceEventLifecycleCallback)(virConnectPtr conn, virNodeDevicePtr dev, diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-nwfilter.h index 279cc3740e..33b842b464 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -32,7 +32,7 @@ * * a virNWFilter is a private structure representing a network filter * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef struct _virNWFilter virNWFilter; @@ -42,7 +42,7 @@ typedef struct _virNWFilter virNWFilter; * a virNWFilterPtr is pointer to a virNWFilter private structure, * this is the type used to reference a network filter in the API. * - * Since: v0.8.0 + * Since: 0.8.0 */ typedef virNWFilter *virNWFilterPtr; @@ -52,7 +52,7 @@ typedef virNWFilter *virNWFilterPtr; * a virNWFilterBinding is a private structure representing a network * filter binding to a port * - * Since: v4.5.0 + * Since: 4.5.0 */ typedef struct _virNWFilterBinding virNWFilterBinding; @@ -63,7 +63,7 @@ typedef struct _virNWFilterBinding virNWFilterBinding; * structure, this is the type used to reference a network filter * port binding in the API. * - * Since: v4.5.0 + * Since: 4.5.0 */ typedef virNWFilterBinding *virNWFilterBindingPtr; @@ -90,10 +90,10 @@ virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn, /** * virNWFilterDefineFlags: * - * Since: v7.7.0 + * Since: 7.7.0 */ typedef enum { - VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ + VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */ } virNWFilterDefineFlags; /* @@ -123,10 +123,10 @@ int virNWFilterFree (virNWFilterPtr nwfilter); /** * virNWFilterBindingCreateFlags: * - * Since: v7.8.0 + * Since: 7.8.0 */ typedef enum { - VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */ + VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */ } virNWFilterBindingCreateFlags; const char* virNWFilterGetName (virNWFilterPtr nwfilter); diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index 7aff5a1c96..a26498ab89 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -33,11 +33,11 @@ extern "C" { /** * virDomainQemuMonitorCommandFlags: * - * Since: v0.8.8 + * Since: 0.8.8 */ typedef enum { - VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: v0.8.8) */ - VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: v0.8.8) */ + VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: 0.8.8) */ + VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: 0.8.8) */ } virDomainQemuMonitorCommandFlags; int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, @@ -58,14 +58,14 @@ virDomainPtr virDomainQemuAttach(virConnectPtr domain, /** * virDomainQemuAgentCommandTimeoutValues: * - * Since: v0.10.0 + * Since: 0.10.0 */ typedef enum { - VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */ - VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */ - VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: v0.10.0) */ - VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: v0.10.0) */ - VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: v1.2.15) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: 0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: 0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: 1.2.15) */ } virDomainQemuAgentCommandTimeoutValues; char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd, @@ -85,7 +85,7 @@ char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd, * The callback signature to use when registering for a qemu monitor * event with virConnectDomainQemuMonitorEventRegister(). * - * Since: v1.2.3 + * Since: 1.2.3 */ typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn, virDomainPtr dom, @@ -99,13 +99,13 @@ typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn, /** * virConnectDomainQemuMonitorEventRegisterFlags: * - * Since: v1.2.3 + * Since: 1.2.3 */ typedef enum { - /* Event filter is a regex rather than a literal string (Since: v1.2.3) */ + /* Event filter is a regex rather than a literal string (Since: 1.2.3) */ VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX = (1 << 0), - /* Event filter is case insensitive (Since: v1.2.3) */ + /* Event filter is case insensitive (Since: 1.2.3) */ VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE = (1 << 1), } virConnectDomainQemuMonitorEventRegisterFlags; diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h index a71c3e7eba..761437d4ad 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -34,29 +34,29 @@ * A virSecret stores a secret value (e.g. a passphrase or encryption key) * and associated metadata. * - * Since: v0.7.1 + * Since: 0.7.1 */ typedef struct _virSecret virSecret; /** * virSecretPtr: * - * Since: v0.7.1 + * Since: 0.7.1 */ typedef virSecret *virSecretPtr; /** * virSecretUsageType: * - * Since: v0.7.1 + * Since: 0.7.1 */ typedef enum { - VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: v0.7.1) */ - VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: v0.7.1) */ - VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: v0.9.7) */ - VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: v1.0.4) */ - VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: v2.3.0) */ - VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: v5.6.0) */ + VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: 0.7.1) */ + VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: 0.7.1) */ + VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: 0.9.7) */ + VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: 1.0.4) */ + VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: 2.3.0) */ + VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: 5.6.0) */ # ifdef VIR_ENUM_SENTINELS VIR_SECRET_USAGE_TYPE_LAST @@ -65,7 +65,7 @@ typedef enum { * added to the libvirt API. It reflects the last usage type supported * by this version of the libvirt API. * - * Since: v0.9.7 + * Since: 0.9.7 */ # endif } virSecretUsageType; @@ -82,17 +82,17 @@ int virConnectListSecrets (virConnectPtr conn, * Flags used to filter the returned secrets. Flags in each group * are exclusive attributes of a secret. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never - stored persistently (Since: v0.10.2) */ - VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: v0.10.2) */ + stored persistently (Since: 0.10.2) */ + VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: 0.10.2) */ VIR_CONNECT_LIST_SECRETS_PRIVATE = 1 << 2, /* not revealed to any caller of libvirt, nor to any other - node (Since: v0.10.2) */ - VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: v0.10.2) */ + node (Since: 0.10.2) */ + VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: 0.10.2) */ } virConnectListAllSecretsFlags; int virConnectListAllSecrets(virConnectPtr conn, @@ -108,10 +108,10 @@ virSecretPtr virSecretLookupByUsage(virConnectPtr conn, /** * virSecretDefineFlags: * - * Since: v7.7.0 + * Since: 7.7.0 */ typedef enum { - VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ + VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */ } virSecretDefineFlags; virSecretPtr virSecretDefineXML (virConnectPtr conn, @@ -142,7 +142,7 @@ int virSecretFree (virSecretPtr secret); * Used to cast the event specific callback into the generic one * for use for virConnectSecretEventRegisterAny() * - * Since: v3.0.0 + * Since: 3.0.0 */ # define VIR_SECRET_EVENT_CALLBACK(cb)((virConnectSecretEventGenericCallback)(cb)) @@ -153,11 +153,11 @@ int virSecretFree (virSecretPtr secret); * virConnectSecretEventRegisterAny(). Each event id determines which * signature of callback function will be used. * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef enum { - VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: v3.0.0) */ - VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: v3.0.0) */ + VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: 3.0.0) */ + VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: 3.0.0) */ # ifdef VIR_ENUM_SENTINELS VIR_SECRET_EVENT_ID_LAST @@ -166,7 +166,7 @@ typedef enum { * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. * - * Since: v3.0.0 + * Since: 3.0.0 */ # endif } virSecretEventID; @@ -183,7 +183,7 @@ typedef enum { * passed in a different parameter position; use * VIR_SECRET_EVENT_CALLBACK() when registering an appropriate handler. * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef void (*virConnectSecretEventGenericCallback)(virConnectPtr conn, virSecretPtr secret, @@ -206,14 +206,14 @@ int virConnectSecretEventDeregisterAny(virConnectPtr conn, * a virSecretEventLifecycleType is emitted during secret * lifecycle events * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef enum { - VIR_SECRET_EVENT_DEFINED = 0, /* (Since: v3.0.0) */ - VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: v3.0.0) */ + VIR_SECRET_EVENT_DEFINED = 0, /* (Since: 3.0.0) */ + VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: 3.0.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_SECRET_EVENT_LAST /* (Since: v3.0.0) */ + VIR_SECRET_EVENT_LAST /* (Since: 3.0.0) */ # endif } virSecretEventLifecycleType; @@ -232,7 +232,7 @@ typedef enum { * VIR_SECRET_EVENT_ID_LIFECYCLE with * virConnectSecretEventRegisterAny() * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef void (*virConnectSecretEventLifecycleCallback)(virConnectPtr conn, virSecretPtr secret, diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index 30e3dc25c5..af1c50b9f1 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -33,7 +33,7 @@ * * a virStoragePool is a private structure representing a storage pool * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virStoragePool virStoragePool; @@ -43,7 +43,7 @@ typedef struct _virStoragePool virStoragePool; * a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the * type used to reference a storage pool in the API. * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virStoragePool *virStoragePoolPtr; @@ -51,60 +51,60 @@ typedef virStoragePool *virStoragePoolPtr; /** * virStoragePoolState: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: v0.4.1) */ - VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: v0.4.1) */ - VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: v0.4.1) */ - VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: v0.4.1) */ - VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: v0.8.2) */ + VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: 0.4.1) */ + VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: 0.4.1) */ + VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: 0.4.1) */ + VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: 0.4.1) */ + VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: 0.8.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_STATE_LAST /* (Since: v0.9.10) */ + VIR_STORAGE_POOL_STATE_LAST /* (Since: 0.9.10) */ # endif } virStoragePoolState; /** * virStoragePoolBuildFlags: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: v0.4.1) */ - VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: v0.4.1) */ - VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: v0.4.1) */ - VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: v0.9.5) */ - VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: v0.9.5) */ + VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: 0.4.1) */ + VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: 0.4.1) */ + VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: 0.4.1) */ + VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: 0.9.5) */ + VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: 0.9.5) */ } virStoragePoolBuildFlags; /** * virStoragePoolDeleteFlags: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */ - VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */ + VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */ + VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */ } virStoragePoolDeleteFlags; /** * virStoragePoolCreateFlags: * - * Since: v1.3.1 + * Since: 1.3.1 */ typedef enum { - /* Create the pool but do not perform pool build (Since: v1.3.1) */ + /* Create the pool but do not perform pool build (Since: 1.3.1) */ VIR_STORAGE_POOL_CREATE_NORMAL = 0, - /* Create the pool and perform pool build without any flags (Since: v1.3.1) */ + /* Create the pool and perform pool build without any flags (Since: 1.3.1) */ VIR_STORAGE_POOL_CREATE_WITH_BUILD = 1 << 0, /* Create the pool and perform pool build using the * VIR_STORAGE_POOL_BUILD_OVERWRITE flag. This is mutually * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE * - * Since: v1.3.1 + * Since: 1.3.1 */ VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE = 1 << 1, @@ -112,7 +112,7 @@ typedef enum { * VIR_STORAGE_POOL_BUILD_NO_OVERWRITE flag. This is mutually * exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE * - * Since: v1.3.1 + * Since: 1.3.1 */ VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE = 1 << 2, } virStoragePoolCreateFlags; @@ -120,7 +120,7 @@ typedef enum { /** * virStoragePoolInfo: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virStoragePoolInfo virStoragePoolInfo; @@ -134,7 +134,7 @@ struct _virStoragePoolInfo { /** * virStoragePoolInfoPtr: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virStoragePoolInfo *virStoragePoolInfoPtr; @@ -144,7 +144,7 @@ typedef virStoragePoolInfo *virStoragePoolInfoPtr; * * a virStorageVol is a private structure representing a storage volume * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virStorageVol virStorageVol; @@ -154,7 +154,7 @@ typedef struct _virStorageVol virStorageVol; * a virStorageVolPtr is pointer to a virStorageVol private structure, this is the * type used to reference a storage volume in the API. * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virStorageVol *virStorageVolPtr; @@ -162,59 +162,59 @@ typedef virStorageVol *virStorageVolPtr; /** * virStorageVolType: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: v0.4.1) */ - VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: v0.4.1) */ - VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: v0.9.5) */ - VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: v0.9.13) */ + VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: 0.4.1) */ + VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: 0.4.1) */ + VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: 0.9.5) */ + VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: 0.9.13) */ VIR_STORAGE_VOL_NETDIR = 4, /* Network accessible directory that can - * contain other network volumes (Since: v1.2.0) */ - VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: v1.3.4) */ + * contain other network volumes (Since: 1.2.0) */ + VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: 1.3.4) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_VOL_LAST /* (Since: v0.9.10) */ + VIR_STORAGE_VOL_LAST /* (Since: 0.9.10) */ # endif } virStorageVolType; /** * virStorageVolDeleteFlags: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef enum { - VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */ - VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */ - VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: v1.2.21) */ + VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */ + VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */ + VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: 1.2.21) */ } virStorageVolDeleteFlags; /** * virStorageVolWipeAlgorithm: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: 0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_NNSA = 1, /* 4-pass NNSA Policy Letter - NAP-14.1-C (XVI-8) (Since: v0.9.10) */ + NAP-14.1-C (XVI-8) (Since: 0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_DOD = 2, /* 4-pass DoD 5220.22-M section - 8-306 procedure (Since: v0.9.10) */ + 8-306 procedure (Since: 0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_BSI = 3, /* 9-pass method recommended by the German Center of Security in - Information Technologies (Since: v0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: v0.9.10) */ + Information Technologies (Since: 0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: 0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_SCHNEIER = 5, /* 7-pass method described by Bruce Schneier in "Applied - Cryptography" (1996) (Since: v0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: v0.9.10) */ + Cryptography" (1996) (Since: 0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: 0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: 0.9.10) */ - VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: 0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_TRIM = 9, /* 1-pass, trim all data on the - volume by using TRIM or DISCARD (Since: v1.3.2) */ + volume by using TRIM or DISCARD (Since: 1.3.2) */ # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_VOL_WIPE_ALG_LAST @@ -223,7 +223,7 @@ typedef enum { * added to the libvirt API. It reflects the last algorithm supported * by this version of the libvirt API. * - * Since: v0.9.10 + * Since: 0.9.10 */ # endif } virStorageVolWipeAlgorithm; @@ -231,17 +231,17 @@ typedef enum { /** * virStorageVolInfoFlags: * - * Since: v3.0.0 + * Since: 3.0.0 */ typedef enum { - VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: v3.0.0) */ - VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: v3.0.0) */ + VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: 3.0.0) */ + VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: 3.0.0) */ } virStorageVolInfoFlags; /** * virStorageVolInfo: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef struct _virStorageVolInfo virStorageVolInfo; @@ -255,17 +255,17 @@ struct _virStorageVolInfo { /** * virStorageVolInfoPtr: * - * Since: v0.4.1 + * Since: 0.4.1 */ typedef virStorageVolInfo *virStorageVolInfoPtr; /** * virStorageXMLFlags: * - * Since: v0.9.13 + * Since: 0.9.13 */ typedef enum { - VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: v0.9.13) */ + VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: 0.9.13) */ } virStorageXMLFlags; /* @@ -300,32 +300,32 @@ int virConnectListDefinedStoragePools(virConnectPtr conn, * Note that these flags come in groups; if all bits from a group are 0, * then that group is not used to filter results. * - * Since: v0.10.2 + * Since: 0.10.2 */ typedef enum { - VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */ - - VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */ - - VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */ - - VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: v0.10.2) */ - VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: v1.2.1) */ - VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: v1.2.8) */ - VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: v3.1.0) */ - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: v5.6.0) */ + VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: 1.2.1) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: 1.2.8) */ + VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: 3.1.0) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: 5.6.0) */ } virConnectListAllStoragePoolsFlags; int virConnectListAllStoragePools(virConnectPtr conn, @@ -354,10 +354,10 @@ virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn, /** * virStoragePoolDefineFlags: * - * Since: v7.7.0 + * Since: 7.7.0 */ typedef enum { - VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */ + VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */ } virStoragePoolDefineFlags; /* @@ -432,11 +432,11 @@ const char* virStorageVolGetKey (virStorageVolPtr vol); /** * virStorageVolCreateFlags: * - * Since: v1.0.1 + * Since: 1.0.1 */ typedef enum { - VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: v1.0.1) */ - VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: v1.2.13) */ + VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: 1.0.1) */ + VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: 1.2.13) */ } virStorageVolCreateFlags; virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool, @@ -449,10 +449,10 @@ virStorageVolPtr virStorageVolCreateXMLFrom (virStoragePoolPtr pool, /** * virStorageVolDownloadFlags: * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef enum { - VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */ + VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */ } virStorageVolDownloadFlags; int virStorageVolDownload (virStorageVolPtr vol, @@ -464,10 +464,10 @@ int virStorageVolDownload (virStorageVolPtr vol, /** * virStorageVolUploadFlags: * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef enum { - VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */ + VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */ } virStorageVolUploadFlags; int virStorageVolUpload (virStorageVolPtr vol, @@ -498,12 +498,12 @@ char * virStorageVolGetPath (virStorageVolPtr vol); /** * virStorageVolResizeFlags: * - * Since: v0.9.10 + * Since: 0.9.10 */ typedef enum { - VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: v0.9.10) */ - VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: v0.9.10) */ - VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: v0.9.10) */ + VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: 0.9.10) */ + VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: 0.9.10) */ + VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: 0.9.10) */ } virStorageVolResizeFlags; int virStorageVolResize (virStorageVolPtr vol, @@ -519,7 +519,7 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * Used to cast the event specific callback into the generic one * for use for virConnectStoragePoolEventRegisterAny() * - * Since: v2.0.0 + * Since: 2.0.0 */ # define VIR_STORAGE_POOL_EVENT_CALLBACK(cb)((virConnectStoragePoolEventGenericCallback)(cb)) @@ -530,11 +530,11 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * virConnectStoragePoolEventRegisterAny(). Each event id determines which * signature of callback function will be used. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef enum { - VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: v2.0.0) */ - VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: 2.0.0) */ + VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: 2.0.0) */ # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_POOL_EVENT_ID_LAST @@ -543,7 +543,7 @@ typedef enum { * added to the libvirt API. It reflects the last event ID supported * by this version of the libvirt API. * - * Since: v2.0.0 + * Since: 2.0.0 */ # endif } virStoragePoolEventID; @@ -560,7 +560,7 @@ typedef enum { * passed in a different parameter position; use * VIR_STORAGE_POOL_EVENT_CALLBACK() when registering an appropriate handler. * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef void (*virConnectStoragePoolEventGenericCallback)(virConnectPtr conn, virStoragePoolPtr pool, @@ -583,18 +583,18 @@ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, * a virStoragePoolEventLifecycleType is emitted during storage pool * lifecycle events * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef enum { - VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: v2.0.0) */ - VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: v2.0.0) */ - VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: v2.0.0) */ - VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: v2.0.0) */ - VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: v3.8.0) */ - VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: v3.8.0) */ + VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: 2.0.0) */ + VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: 2.0.0) */ + VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: 2.0.0) */ + VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: 2.0.0) */ + VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: 3.8.0) */ + VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: 3.8.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_EVENT_LAST /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_LAST /* (Since: 2.0.0) */ # endif } virStoragePoolEventLifecycleType; @@ -613,7 +613,7 @@ typedef enum { * VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE with * virConnectStoragePoolEventRegisterAny() * - * Since: v2.0.0 + * Since: 2.0.0 */ typedef void (*virConnectStoragePoolEventLifecycleCallback)(virConnectPtr conn, virStoragePoolPtr pool, diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-stream.h index 6b82711244..e3bdc8923a 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -31,10 +31,10 @@ /** * virStreamFlags: * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef enum { - VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: v0.7.2) */ + VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: 0.7.2) */ } virStreamFlags; virStreamPtr virStreamNew(virConnectPtr conn, @@ -52,10 +52,10 @@ int virStreamRecv(virStreamPtr st, /** * virStreamRecvFlagsValues: * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef enum { - VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: v3.4.0) */ + VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: 3.4.0) */ } virStreamRecvFlagsValues; int virStreamRecvFlags(virStreamPtr st, @@ -99,7 +99,7 @@ int virStreamRecvHole(virStreamPtr, * Returns the number of bytes filled, 0 upon end * of file, or -1 upon error * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef int (*virStreamSourceFunc)(virStreamPtr st, char *data, @@ -139,7 +139,7 @@ int virStreamSendAll(virStreamPtr st, * Returns 0 on success, * -1 upon error * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, int *inData, @@ -167,7 +167,7 @@ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, * Returns 0 on success, * -1 upon error. * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef int (*virStreamSourceSkipFunc)(virStreamPtr st, long long length, @@ -206,7 +206,7 @@ int virStreamSparseSendAll(virStreamPtr st, * Returns the number of bytes consumed or -1 upon * error * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef int (*virStreamSinkFunc)(virStreamPtr st, const char *data, @@ -238,7 +238,7 @@ int virStreamRecvAll(virStreamPtr st, * Returns 0 on success, * -1 upon error * - * Since: v3.4.0 + * Since: 3.4.0 */ typedef int (*virStreamSinkHoleFunc)(virStreamPtr st, long long length, @@ -252,13 +252,13 @@ int virStreamSparseRecvAll(virStreamPtr stream, /** * virStreamEventType: * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef enum { - VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: v0.7.2) */ - VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: v0.7.2) */ - VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: v0.7.2) */ - VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: 0.7.2) */ + VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: 0.7.2) */ + VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: 0.7.2) */ + VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: 0.7.2) */ } virStreamEventType; @@ -272,7 +272,7 @@ typedef enum { * Callback for receiving stream events. The callback will * be invoked once for each event which is pending. * - * Since: v0.7.2 + * Since: 0.7.2 */ typedef void (*virStreamEventCallback)(virStreamPtr stream, int events, void *opaque); diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 4e6dfaa3f4..df13e4f11e 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -35,12 +35,12 @@ extern "C" { * * Indicates the level of an error * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef enum { - VIR_ERR_NONE = 0, /* (Since: v0.1.0) */ - VIR_ERR_WARNING = 1, /* A simple warning (Since: v0.1.0) */ - VIR_ERR_ERROR = 2 /* An error (Since: v0.1.0) */ + VIR_ERR_NONE = 0, /* (Since: 0.1.0) */ + VIR_ERR_WARNING = 1, /* A simple warning (Since: 0.1.0) */ + VIR_ERR_ERROR = 2 /* An error (Since: 0.1.0) */ } virErrorLevel; /** @@ -49,101 +49,101 @@ typedef enum { * Indicates where an error may have come from. This should remain * stable, with all additions placed at the end since libvirt 0.1.0. * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef enum { - VIR_FROM_NONE = 0, /* (Since: v0.1.0) */ - VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: v0.1.0) */ - VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: v0.1.0) */ - VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: v0.1.0) */ - VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: v0.1.0) */ - - VIR_FROM_XML = 5, /* Error in the XML code (Since: v0.1.0) */ - VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: v0.1.0) */ - VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: v0.1.1) */ + VIR_FROM_NONE = 0, /* (Since: 0.1.0) */ + VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: 0.1.0) */ + VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: 0.1.0) */ + VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: 0.1.0) */ + VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: 0.1.0) */ + + VIR_FROM_XML = 5, /* Error in the XML code (Since: 0.1.0) */ + VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: 0.1.0) */ + VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: 0.1.1) */ VIR_FROM_PROXY = 8, /* Error in the proxy code; unused since - 0.8.6 (Since: v0.1.3) */ - VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: v0.1.6) */ - - VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: v0.2.0) */ - VIR_FROM_NET = 11, /* Error when operating on a network (Since: v0.2.0) */ - VIR_FROM_TEST = 12, /* Error from test driver (Since: v0.2.3) */ - VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: v0.2.3) */ - VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: v0.3.1) */ - - VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: v0.4.1) */ - VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: v0.4.1) */ - VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: v0.4.2) */ - VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: v0.4.1) */ - VIR_FROM_NETWORK = 19, /* Error from network config (Since: v0.4.6) */ - - VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: v0.4.6) */ - VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: v0.5.0) */ - VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: v0.5.0) */ - VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: v0.5.0) */ - VIR_FROM_SECURITY = 24, /* Error from security framework (Since: v0.6.1) */ - - VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: v0.6.3) */ - VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: v0.6.4) */ + 0.8.6 (Since: 0.1.3) */ + VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: 0.1.6) */ + + VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: 0.2.0) */ + VIR_FROM_NET = 11, /* Error when operating on a network (Since: 0.2.0) */ + VIR_FROM_TEST = 12, /* Error from test driver (Since: 0.2.3) */ + VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: 0.2.3) */ + VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: 0.3.1) */ + + VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: 0.4.1) */ + VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: 0.4.1) */ + VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: 0.4.2) */ + VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: 0.4.1) */ + VIR_FROM_NETWORK = 19, /* Error from network config (Since: 0.4.6) */ + + VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: 0.4.6) */ + VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: 0.5.0) */ + VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: 0.5.0) */ + VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: 0.5.0) */ + VIR_FROM_SECURITY = 24, /* Error from security framework (Since: 0.6.1) */ + + VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: 0.6.3) */ + VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: 0.6.4) */ VIR_FROM_ONE = 27, /* The OpenNebula driver no longer exists. - Retained for ABI/API compat only (Since: v0.6.4) */ - VIR_FROM_ESX = 28, /* Error from ESX driver (Since: v0.7.0) */ - VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: v0.7.0) */ - - VIR_FROM_SECRET = 30, /* Error from secret storage (Since: v0.7.1) */ - VIR_FROM_CPU = 31, /* Error from CPU driver (Since: v0.7.5) */ - VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: v0.8.0) */ - VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: v0.8.0) */ - VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: v0.8.0) */ - - VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: v0.8.0) */ - VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: v0.8.5) */ - VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: v0.8.6) */ - VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: v0.8.6) */ - VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: v0.8.7) */ - - VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: v0.9.0) */ - VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: v0.9.0) */ - VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: v0.9.2) */ - VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: v0.9.5) */ - VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: v0.9.8) */ - - VIR_FROM_URI = 45, /* Error from URI handling (Since: v0.9.11) */ - VIR_FROM_AUTH = 46, /* Error from auth handling (Since: v0.9.11) */ - VIR_FROM_DBUS = 47, /* Error from DBus (Since: v0.9.12) */ - VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: v0.10.0) */ - VIR_FROM_DEVICE = 49, /* Error from Device (Since: v0.10.0) */ - - VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: v0.10.0) */ - VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: v1.0.0) */ - VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: v1.0.1) */ - VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: v1.0.4) */ - VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: v1.0.5) */ - - VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: v1.1.0) */ - VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: v1.1.1) */ - VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: v1.2.2) */ - VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: v1.2.3) */ - VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: v1.2.4) */ - - VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: v1.2.9) */ - VIR_FROM_THREAD = 61, /* Error from thread utils (Since: v1.2.14) */ - VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: v1.2.17) */ - VIR_FROM_LOGGING = 63, /* Error from log manager (Since: v1.3.0) */ - VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: v1.3.2) */ - - VIR_FROM_PERF = 65, /* Error from perf (Since: v1.3.3) */ - VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: v2.5.0) */ - VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: v3.7.0) */ - VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: v5.1.0) */ - VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: v5.2.0) */ - - VIR_FROM_TPM = 70, /* Error from TPM (Since: v5.6.0) */ - VIR_FROM_BPF = 71, /* Error from BPF code (Since: v5.10.0) */ - VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: v7.5.0) */ + Retained for ABI/API compat only (Since: 0.6.4) */ + VIR_FROM_ESX = 28, /* Error from ESX driver (Since: 0.7.0) */ + VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: 0.7.0) */ + + VIR_FROM_SECRET = 30, /* Error from secret storage (Since: 0.7.1) */ + VIR_FROM_CPU = 31, /* Error from CPU driver (Since: 0.7.5) */ + VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: 0.8.0) */ + VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: 0.8.0) */ + VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: 0.8.0) */ + + VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: 0.8.0) */ + VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: 0.8.5) */ + VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: 0.8.6) */ + VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: 0.8.6) */ + VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: 0.8.7) */ + + VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: 0.9.0) */ + VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: 0.9.0) */ + VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: 0.9.2) */ + VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: 0.9.5) */ + VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: 0.9.8) */ + + VIR_FROM_URI = 45, /* Error from URI handling (Since: 0.9.11) */ + VIR_FROM_AUTH = 46, /* Error from auth handling (Since: 0.9.11) */ + VIR_FROM_DBUS = 47, /* Error from DBus (Since: 0.9.12) */ + VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: 0.10.0) */ + VIR_FROM_DEVICE = 49, /* Error from Device (Since: 0.10.0) */ + + VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: 0.10.0) */ + VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: 1.0.0) */ + VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: 1.0.1) */ + VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: 1.0.4) */ + VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: 1.0.5) */ + + VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: 1.1.0) */ + VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: 1.1.1) */ + VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: 1.2.2) */ + VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: 1.2.3) */ + VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: 1.2.4) */ + + VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: 1.2.9) */ + VIR_FROM_THREAD = 61, /* Error from thread utils (Since: 1.2.14) */ + VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: 1.2.17) */ + VIR_FROM_LOGGING = 63, /* Error from log manager (Since: 1.3.0) */ + VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: 1.3.2) */ + + VIR_FROM_PERF = 65, /* Error from perf (Since: 1.3.3) */ + VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: 2.5.0) */ + VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: 3.7.0) */ + VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: 5.1.0) */ + VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: 5.2.0) */ + + VIR_FROM_TPM = 70, /* Error from TPM (Since: 5.6.0) */ + VIR_FROM_BPF = 71, /* Error from BPF code (Since: 5.10.0) */ + VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: 7.5.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_ERR_DOMAIN_LAST /* (Since: v0.9.13) */ + VIR_ERR_DOMAIN_LAST /* (Since: 0.9.13) */ # endif } virErrorDomain; @@ -157,14 +157,14 @@ typedef enum { * Reference counts are not incremented so the underlying objects * may be deleted without notice after the error has been delivered. * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef struct _virError virError; /** * virErrorPtr: * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef virError *virErrorPtr; struct _virError { @@ -217,140 +217,140 @@ struct _virError { * default: * } * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef enum { - VIR_ERR_OK = 0, /* (Since: v0.1.0) */ - VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: v0.1.0) */ - VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: v0.1.0) */ - VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: v0.1.0) */ - VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: v0.1.0) */ - VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: v0.1.0) */ - VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: v0.1.0) */ - VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: v0.1.0) */ - VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: v0.1.0) */ - VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: v0.1.0) */ - VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: v0.1.0) */ - VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: v0.1.0) */ - VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: v0.1.0) */ - VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: v0.1.0) */ + VIR_ERR_OK = 0, /* (Since: 0.1.0) */ + VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: 0.1.0) */ + VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: 0.1.0) */ + VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: 0.1.0) */ + VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: 0.1.0) */ + VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: 0.1.0) */ + VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: 0.1.0) */ + VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: 0.1.0) */ + VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: 0.1.0) */ + VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: 0.1.0) */ + VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: 0.1.0) */ + VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: 0.1.0) */ + VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: 0.1.0) */ + VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: 0.1.0) */ VIR_ERR_NO_XEN = 14, /* could not open Xen hypervisor - control (Since: v0.1.0) */ - VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: v0.1.0) */ - VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: v0.1.0) */ - VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: v0.1.0) */ - VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: v0.1.0) */ - VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: v0.1.0) */ - VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: v0.1.0) */ - VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: v0.1.0) */ - VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: v0.1.0) */ - VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: v0.1.0) */ - VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: v0.1.0) */ - VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: v0.1.0) */ + control (Since: 0.1.0) */ + VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: 0.1.0) */ + VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: 0.1.0) */ + VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: 0.1.0) */ + VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: 0.1.0) */ + VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: 0.1.0) */ + VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: 0.1.0) */ + VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: 0.1.0) */ + VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: 0.1.0) */ + VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: 0.1.0) */ + VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: 0.1.0) */ + VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: 0.1.0) */ VIR_ERR_CALL_FAILED = 26, /* not supported by the drivers - (DEPRECATED) (Since: v0.1.0) */ + (DEPRECATED) (Since: 0.1.0) */ VIR_ERR_XML_ERROR = 27, /* an XML description is not well - formed or broken (Since: v0.1.1) */ - VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: v0.1.1) */ + formed or broken (Since: 0.1.1) */ + VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: 0.1.1) */ VIR_ERR_OPERATION_DENIED = 29, /* operation forbidden on read-only - connections (Since: v0.1.4) */ - VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: v0.1.6) */ - VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: v0.1.6) */ - VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: v0.1.6) */ + connections (Since: 0.1.4) */ + VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: 0.1.6) */ + VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: 0.1.6) */ + VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: 0.1.6) */ VIR_ERR_CONF_SYNTAX = 33, /* failed to parse the syntax of a - conf file (Since: v0.1.6) */ - VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: v0.1.6) */ - VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: v0.1.9) */ - VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: v0.2.0) */ - VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: v0.2.0) */ - VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: v0.2.1) */ - VIR_ERR_RPC = 39, /* some sort of RPC error (Since: v0.2.3) */ - VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: v0.2.3) */ - VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: v0.2.3) */ + conf file (Since: 0.1.6) */ + VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: 0.1.6) */ + VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: 0.1.9) */ + VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: 0.2.0) */ + VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: 0.2.0) */ + VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: 0.2.1) */ + VIR_ERR_RPC = 39, /* some sort of RPC error (Since: 0.2.3) */ + VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: 0.2.3) */ + VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: 0.2.3) */ VIR_ERR_NO_DOMAIN = 42, /* domain not found or unexpectedly - disappeared (Since: v0.3.0) */ - VIR_ERR_NO_NETWORK = 43, /* network not found (Since: v0.3.0) */ - VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: v0.3.1) */ - VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: v0.4.1) */ - VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: v0.4.1) */ - VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: v0.4.1) */ - VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: v0.4.1) */ - VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: v0.4.1) */ - VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: v0.4.1) */ - VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: v0.5.0) */ - VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: v0.5.0) */ - VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: v0.5.0) */ - VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: v0.6.1) */ + disappeared (Since: 0.3.0) */ + VIR_ERR_NO_NETWORK = 43, /* network not found (Since: 0.3.0) */ + VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: 0.3.1) */ + VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: 0.4.1) */ + VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: 0.4.1) */ + VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: 0.4.1) */ + VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: 0.4.1) */ + VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: 0.4.1) */ + VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: 0.4.1) */ + VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: 0.5.0) */ + VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: 0.5.0) */ + VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: 0.5.0) */ + VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: 0.6.1) */ VIR_ERR_OPERATION_INVALID = 55, /* operation is not applicable at this - time (Since: v0.6.4) */ - VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: v0.6.4) */ - VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: v0.6.4) */ - VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: v0.6.4) */ + time (Since: 0.6.4) */ + VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: 0.6.4) */ + VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: 0.6.4) */ + VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: 0.6.4) */ VIR_ERR_MULTIPLE_INTERFACES = 59, /* more than one matching interface - found (Since: v0.7.0) */ - VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: v0.8.0) */ - VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: v0.8.0) */ - VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: v0.8.0) */ - VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: v0.8.0) */ - VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: v0.7.1) */ - VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: v0.7.1) */ - VIR_ERR_NO_SECRET = 66, /* secret not found (Since: v0.7.1) */ + found (Since: 0.7.0) */ + VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: 0.8.0) */ + VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: 0.8.0) */ + VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: 0.8.0) */ + VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: 0.8.0) */ + VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: 0.7.1) */ + VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: 0.7.1) */ + VIR_ERR_NO_SECRET = 66, /* secret not found (Since: 0.7.1) */ VIR_ERR_CONFIG_UNSUPPORTED = 67, /* unsupported configuration - construct (Since: v0.7.3) */ - VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: v0.7.3) */ + construct (Since: 0.7.3) */ + VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: 0.7.3) */ VIR_ERR_MIGRATE_PERSIST_FAILED = 69,/* a migration worked, but making the - VM persist on the dest host failed (Since: v0.7.3) */ - VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: v0.8.0) */ - VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: v0.8.0) */ - VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: v0.8.0) */ - VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: v0.9.0) */ + VM persist on the dest host failed (Since: 0.7.3) */ + VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: 0.8.0) */ + VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: 0.8.0) */ + VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: 0.8.0) */ + VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: 0.9.0) */ VIR_ERR_ARGUMENT_UNSUPPORTED = 74, /* valid API use but unsupported by - the given driver (Since: v0.9.4) */ - VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: v0.9.5) */ - VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: v0.9.5) */ + the given driver (Since: 0.9.4) */ + VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: 0.9.5) */ + VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: 0.9.5) */ VIR_ERR_SNAPSHOT_REVERT_RISKY = 77, /* force was not requested for a - risky domain snapshot revert (Since: v0.9.7) */ + risky domain snapshot revert (Since: 0.9.7) */ VIR_ERR_OPERATION_ABORTED = 78, /* operation on a domain was - canceled/aborted by user (Since: v0.9.9) */ - VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: v0.9.10) */ - VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: v0.9.10) */ - VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: v0.9.11) */ - VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: v0.9.11) */ - VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: v0.9.12) */ + canceled/aborted by user (Since: 0.9.9) */ + VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: 0.9.10) */ + VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: 0.9.10) */ + VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: 0.9.11) */ + VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: 0.9.11) */ + VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: 0.9.12) */ VIR_ERR_OPERATION_UNSUPPORTED = 84, /* The requested operation is not - supported (Since: v0.10.0) */ - VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: v0.10.0) */ + supported (Since: 0.10.0) */ + VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: 0.10.0) */ VIR_ERR_AGENT_UNRESPONSIVE = 86, /* guest agent is unresponsive, - not running or not usable (Since: v0.10.0) */ - VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: v1.0.0) */ + not running or not usable (Since: 0.10.0) */ + VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: 1.0.0) */ VIR_ERR_ACCESS_DENIED = 88, /* operation on the object/resource - was denied (Since: v1.1.0) */ - VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: v1.1.1) */ - VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: v1.1.4) */ - VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: v1.2.6) */ - VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: v1.2.12) */ - VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: v1.2.18) */ - VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: v1.3.3) */ - VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: v1.3.3) */ - VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: v1.3.5) */ + was denied (Since: 1.1.0) */ + VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: 1.1.1) */ + VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: 1.1.4) */ + VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: 1.2.6) */ + VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: 1.2.12) */ + VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: 1.2.18) */ + VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: 1.3.3) */ + VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: 1.3.3) */ + VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: 1.3.5) */ VIR_ERR_AGENT_UNSYNCED = 97, /* guest agent replies with wrong id - to guest-sync command (DEPRECATED) (Since: v2.3.0) */ - VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: v2.5.0) */ - VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: v4.1.0) */ - VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: v4.5.0) */ - VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: v4.5.0) */ - VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: v5.2.0) */ - VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: v5.2.0) */ - VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: v5.2.0) */ - VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: v5.5.0) */ - VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: v5.5.0) */ - VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: v5.5.0) */ - VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: v6.1.0) */ - VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: v6.10.0) */ - VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: v7.1.0) */ + to guest-sync command (DEPRECATED) (Since: 2.3.0) */ + VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: 2.5.0) */ + VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: 4.1.0) */ + VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: 4.5.0) */ + VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: 4.5.0) */ + VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: 5.2.0) */ + VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: 5.2.0) */ + VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: 5.2.0) */ + VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: 5.5.0) */ + VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: 5.5.0) */ + VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: 5.5.0) */ + VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: 6.1.0) */ + VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: 6.10.0) */ + VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: 7.1.0) */ # ifdef VIR_ENUM_SENTINELS - VIR_ERR_NUMBER_LAST /* (Since: v5.0.0) */ + VIR_ERR_NUMBER_LAST /* (Since: 5.0.0) */ # endif } virErrorNumber; @@ -361,7 +361,7 @@ typedef enum { * * Signature of a function to use when there is an error raised by the library. * - * Since: v0.1.0 + * Since: 0.1.0 */ typedef void (*virErrorFunc) (void *userData, virErrorPtr error); diff --git a/src/admin/libvirt-admin.c b/src/admin/libvirt-admin.c index 3cdaaf1de2..5f64784a13 100644 --- a/src/admin/libvirt-admin.c +++ b/src/admin/libvirt-admin.c @@ -85,7 +85,7 @@ virAdmGlobalInit(void) * * Returns 0 in case of success, -1 in case of error * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmInitialize(void) @@ -203,7 +203,7 @@ virAdmGetDefaultURI(virConf *conf, char **uristr) * * Returns @virAdmConnectPtr object or NULL on error * - * Since: v2.0.0 + * Since: 2.0.0 */ virAdmConnectPtr virAdmConnectOpen(const char *name, unsigned int flags) @@ -289,7 +289,7 @@ virAdmConnectOpen(const char *name, unsigned int flags) * application should not try to further use a connection after the * virAdmConnectClose that matches the initial open. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectClose(virAdmConnectPtr conn) @@ -326,7 +326,7 @@ virAdmConnectClose(virAdmConnectPtr conn) * * Returns 0 in case of success, -1 in case of failure * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectRef(virAdmConnectPtr conn) @@ -355,7 +355,7 @@ virAdmConnectRef(virAdmConnectPtr conn) * * Returns 0 on success, -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmGetVersion(unsigned long long *libVer) @@ -388,7 +388,7 @@ virAdmGetVersion(unsigned long long *libVer) * Returns 1, if the connection is alive, 0 if there isn't an existing * connection at all or the channel has already been closed, or -1 on error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectIsAlive(virAdmConnectPtr conn) @@ -424,7 +424,7 @@ virAdmConnectIsAlive(virAdmConnectPtr conn) * Returns an URI string related to the connection or NULL in case of an error. * Caller is responsible for freeing the string. * - * Since: v2.0.0 + * Since: 2.0.0 */ char * virAdmConnectGetURI(virAdmConnectPtr conn) @@ -460,7 +460,7 @@ virAdmConnectGetURI(virAdmConnectPtr conn) * * Returns 0 on success, -1 on error * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb, @@ -515,7 +515,7 @@ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, * * Returns 0 on success, -1 on error * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb) @@ -547,7 +547,7 @@ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, * * Returns 0 on success, -1 on failure and @libVer follows this format: * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, unsigned long long *libVer) @@ -577,7 +577,7 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * Returns a pointer to the name or NULL. The string doesn't need to be * deallocated since its lifetime will be the same as the server object. * - * Since: v2.0.0 + * Since: 2.0.0 */ const char * virAdmServerGetName(virAdmServerPtr srv) @@ -599,7 +599,7 @@ virAdmServerGetName(virAdmServerPtr srv) * * Returns 0 on success, -1 on failure. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerFree(virAdmServerPtr srv) { @@ -624,7 +624,7 @@ int virAdmServerFree(virAdmServerPtr srv) * * Returns numeric value used for client's ID or -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ unsigned long long virAdmClientGetID(virAdmClientPtr client) @@ -649,7 +649,7 @@ virAdmClientGetID(virAdmClientPtr client) * (epoch time) if libvirt doesn't have any information about client's * connection time, or -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ long long virAdmClientGetTimestamp(virAdmClientPtr client) @@ -676,7 +676,7 @@ virAdmClientGetTimestamp(virAdmClientPtr client) * Returns integer representation of the connection transport used by @client * (this will be one of virClientTransport) or -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmClientGetTransport(virAdmClientPtr client) @@ -697,7 +697,7 @@ virAdmClientGetTransport(virAdmClientPtr client) * * Returns 0 in success, -1 on failure. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmClientFree(virAdmClientPtr client) { @@ -730,7 +730,7 @@ int virAdmClientFree(virAdmClientPtr client) * Caller is responsible to call virAdmServerFree() on each list element, * followed by freeing @servers. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmConnectListServers(virAdmConnectPtr conn, @@ -770,7 +770,7 @@ virAdmConnectListServers(virAdmConnectPtr conn, * Returns the requested server or NULL in case of failure. If the * server cannot be found, then VIR_ERR_NO_SERVER error is raised. * - * Since: v2.0.0 + * Since: 2.0.0 */ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, @@ -813,7 +813,7 @@ virAdmConnectLookupServer(virAdmConnectPtr conn, * * Returns 0 on success, -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, @@ -854,7 +854,7 @@ virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, * * Returns 0 on success, -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, @@ -897,7 +897,7 @@ virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, * Caller is responsible to call virAdmClientFree() on each list element, * followed by freeing @clients. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerListClients(virAdmServerPtr srv, @@ -937,7 +937,7 @@ virAdmServerListClients(virAdmServerPtr srv, * Returns the requested client or NULL in case of failure. If the * client could not be found, then VIR_ERR_NO_CLIENT error is raised. * - * Since: v2.0.0 + * Since: 2.0.0 */ virAdmClientPtr virAdmServerLookupClient(virAdmServerPtr srv, @@ -985,7 +985,7 @@ virAdmServerLookupClient(virAdmServerPtr srv, * Returns 0 if the information has been successfully retrieved or -1 in case * of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmClientGetInfo(virAdmClientPtr client, @@ -1021,7 +1021,7 @@ virAdmClientGetInfo(virAdmClientPtr client, * Returns 0 if the daemon's connection with @client was closed successfully * or -1 in case of an error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmClientClose(virAdmClientPtr client, unsigned int flags) @@ -1060,7 +1060,7 @@ int virAdmClientClose(virAdmClientPtr client, * Returns 0 on success, allocating @params to size returned in @nparams, or * -1 in case of an error. Caller is responsible for deallocating @params. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerGetClientLimits(virAdmServerPtr srv, @@ -1102,7 +1102,7 @@ virAdmServerGetClientLimits(virAdmServerPtr srv, * Returns 0 if the limits have been changed successfully or -1 in case of an * error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virAdmServerSetClientLimits(virAdmServerPtr srv, @@ -1142,7 +1142,7 @@ virAdmServerSetClientLimits(virAdmServerPtr srv, * Returns 0 if the TLS files have been updated successfully or -1 in case of an * error. * - * Since: v6.2.0 + * Since: 6.2.0 */ int virAdmServerUpdateTlsFiles(virAdmServerPtr srv, @@ -1182,7 +1182,7 @@ virAdmServerUpdateTlsFiles(virAdmServerPtr srv, * * Returns the count of outputs in @outputs, or -1 in case of an error. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, @@ -1225,7 +1225,7 @@ virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, * Returns the number of filters returned in @filters, or -1 in case of * an error. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, @@ -1267,7 +1267,7 @@ virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, * Returns 0 if the new output or the set of outputs has been defined * successfully, or -1 in case of an error. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, @@ -1307,7 +1307,7 @@ virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, * Returns 0 if the new filter or the set of filters has been defined * successfully, or -1 in case of an error. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virAdmConnectSetLoggingFilters(virAdmConnectPtr conn, diff --git a/src/libvirt-domain-checkpoint.c b/src/libvirt-domain-checkpoint.c index a92404a56f..f58f1b4f8f 100644 --- a/src/libvirt-domain-checkpoint.c +++ b/src/libvirt-domain-checkpoint.c @@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.domain-checkpoint"); * Returns a pointer to the name or NULL, the string need not be deallocated * as its lifetime will be the same as the checkpoint object. * - * Since: v5.6.0 + * Since: 5.6.0 */ const char * virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint) @@ -61,7 +61,7 @@ virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint) * * Returns the domain or NULL. * - * Since: v5.6.0 + * Since: 5.6.0 */ virDomainPtr virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint) @@ -86,7 +86,7 @@ virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint) * * Returns the connection or NULL. * - * Since: v5.6.0 + * Since: 5.6.0 */ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint) @@ -145,7 +145,7 @@ virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint) * Returns an (opaque) new virDomainCheckpointPtr on success or NULL * on failure. * - * Since: v5.6.0 + * Since: 5.6.0 */ virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, @@ -216,7 +216,7 @@ virDomainCheckpointCreateXML(virDomainPtr domain, * Returns a 0 terminated UTF-8 encoded XML instance or NULL in case * of error. The caller must free() the returned value. * - * Since: v5.6.0 + * Since: 5.6.0 */ char * virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, @@ -292,7 +292,7 @@ virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, * responsible for calling virDomainCheckpointFree() on each array element, * then calling free() on @checkpoints. * - * Since: v5.6.0 + * Since: 5.6.0 */ int virDomainListAllCheckpoints(virDomainPtr domain, @@ -361,7 +361,7 @@ virDomainListAllCheckpoints(virDomainPtr domain, * for calling virDomainCheckpointFree() on each array element, then calling * free() on @children. * - * Since: v5.6.0 + * Since: 5.6.0 */ int virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint, @@ -409,7 +409,7 @@ virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint, * domain checkpoint cannot be found, then the VIR_ERR_NO_DOMAIN_CHECKPOINT * error is raised. * - * Since: v5.6.0 + * Since: 5.6.0 */ virDomainCheckpointPtr virDomainCheckpointLookupByName(virDomainPtr domain, @@ -457,7 +457,7 @@ virDomainCheckpointLookupByName(virDomainPtr domain, * given checkpoint is a root (no parent), then the VIR_ERR_NO_DOMAIN_CHECKPOINT * error is raised. * - * Since: v5.6.0 + * Since: 5.6.0 */ virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint, @@ -512,7 +512,7 @@ virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint, * * Returns 0 on success, -1 on error. * - * Since: v5.6.0 + * Since: 5.6.0 */ int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, @@ -564,7 +564,7 @@ virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v5.6.0 + * Since: 5.6.0 */ int virDomainCheckpointRef(virDomainCheckpointPtr checkpoint) @@ -589,7 +589,7 @@ virDomainCheckpointRef(virDomainCheckpointPtr checkpoint) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v5.6.0 + * Since: 5.6.0 */ int virDomainCheckpointFree(virDomainCheckpointPtr checkpoint) diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c index 021f6f599d..2917b8bd90 100644 --- a/src/libvirt-domain-snapshot.c +++ b/src/libvirt-domain-snapshot.c @@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.domain-snapshot"); * Returns a pointer to the name or NULL, the string need not be deallocated * as its lifetime will be the same as the snapshot object. * - * Since: v0.9.5 + * Since: 0.9.5 */ const char * virDomainSnapshotGetName(virDomainSnapshotPtr snapshot) @@ -61,7 +61,7 @@ virDomainSnapshotGetName(virDomainSnapshotPtr snapshot) * * Returns the domain or NULL. * - * Since: v0.9.5 + * Since: 0.9.5 */ virDomainPtr virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) @@ -86,7 +86,7 @@ virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) * * Returns the connection or NULL. * - * Since: v0.9.5 + * Since: 0.9.5 */ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot) @@ -220,7 +220,7 @@ virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot) * Returns an (opaque) new virDomainSnapshotPtr on success or NULL on * failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, @@ -280,7 +280,7 @@ virDomainSnapshotCreateXML(virDomainPtr domain, * Returns a 0 terminated UTF-8 encoded XML instance or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.8.0 + * Since: 0.8.0 */ char * virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, @@ -335,7 +335,7 @@ virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, * * Returns the number of domain snapshots found or -1 in case of error. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainSnapshotNum(virDomainPtr domain, unsigned int flags) @@ -401,7 +401,7 @@ virDomainSnapshotNum(virDomainPtr domain, unsigned int flags) * Returns the number of domain snapshots found or -1 in case of error. * The caller is responsible to call free() for each member of the array. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen, @@ -491,7 +491,7 @@ virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen, * for calling virDomainSnapshotFree() on each array element, then calling * free() on @snaps. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snaps, @@ -542,7 +542,7 @@ virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snaps, * * Returns the number of domain snapshots found or -1 in case of error. * - * Since: v0.9.7 + * Since: 0.9.7 */ int virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags) @@ -610,7 +610,7 @@ virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags) * Returns the number of domain snapshots found or -1 in case of error. * The caller is responsible to call free() for each member of the array. * - * Since: v0.9.7 + * Since: 0.9.7 */ int virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot, @@ -683,7 +683,7 @@ virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot, * for calling virDomainSnapshotFree() on each array element, then calling * free() on @snaps. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot, @@ -729,7 +729,7 @@ virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot, * domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT * error is raised. * - * Since: v0.8.0 + * Since: 0.8.0 */ virDomainSnapshotPtr virDomainSnapshotLookupByName(virDomainPtr domain, @@ -771,7 +771,7 @@ virDomainSnapshotLookupByName(virDomainPtr domain, * * Returns 1 if such snapshot exists, 0 if it doesn't, -1 on error. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags) @@ -813,7 +813,7 @@ virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags) * current domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT * error is raised. * - * Since: v0.8.0 + * Since: 0.8.0 */ virDomainSnapshotPtr virDomainSnapshotCurrent(virDomainPtr domain, @@ -857,7 +857,7 @@ virDomainSnapshotCurrent(virDomainPtr domain, * given snapshot is a root (no parent), then the VIR_ERR_NO_DOMAIN_SNAPSHOT * error is raised. * - * Since: v0.9.7 + * Since: 0.9.7 */ virDomainSnapshotPtr virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot, @@ -897,7 +897,7 @@ virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot, * * Returns 1 if current, 0 if not current, or -1 on error. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot, @@ -938,7 +938,7 @@ virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot, * Returns 1 if the snapshot has metadata, 0 if the snapshot exists without * help from libvirt, or -1 on error. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, @@ -1019,7 +1019,7 @@ virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, * * Returns 0 if the creation is successful, -1 on error. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, @@ -1078,7 +1078,7 @@ virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, * Returns 0 if the selected snapshot(s) were successfully deleted, * -1 on error. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, @@ -1130,7 +1130,7 @@ virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virDomainSnapshotRef(virDomainSnapshotPtr snapshot) @@ -1155,7 +1155,7 @@ virDomainSnapshotRef(virDomainSnapshotPtr snapshot) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainSnapshotFree(virDomainSnapshotPtr snapshot) diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index e27d611882..27993829a0 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -50,7 +50,7 @@ VIR_LOG_INIT("libvirt.domain"); * that all currently active domains were listed if the return is less * than @maxids. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virConnectListDomains(virConnectPtr conn, int *ids, int maxids) @@ -85,7 +85,7 @@ virConnectListDomains(virConnectPtr conn, int *ids, int maxids) * * Returns the number of domain found or -1 in case of error * - * Since: v0.0.3 + * Since: 0.0.3 */ int virConnectNumOfDomains(virConnectPtr conn) @@ -120,7 +120,7 @@ virConnectNumOfDomains(virConnectPtr conn) * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.3.0 + * Since: 0.3.0 */ virConnectPtr virDomainGetConnect(virDomainPtr dom) @@ -169,7 +169,7 @@ virDomainGetConnect(virDomainPtr dom) * * Returns a new domain object or NULL in case of failure * - * Since: v0.5.0 + * Since: 0.5.0 */ virDomainPtr virDomainCreateXML(virConnectPtr conn, const char *xmlDesc, @@ -237,7 +237,7 @@ virDomainCreateXML(virConnectPtr conn, const char *xmlDesc, * * Returns a new domain object or NULL in case of failure * - * Since: v1.1.1 + * Since: 1.1.1 */ virDomainPtr virDomainCreateXMLWithFiles(virConnectPtr conn, const char *xmlDesc, @@ -295,7 +295,7 @@ virDomainCreateXMLWithFiles(virConnectPtr conn, const char *xmlDesc, * * Returns a new domain object or NULL in case of failure * - * Since: v0.0.3 + * Since: 0.0.3 */ virDomainPtr virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc, @@ -320,7 +320,7 @@ virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc, * Returns a new domain object or NULL in case of failure. If the * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised. * - * Since: v0.0.3 + * Since: 0.0.3 */ virDomainPtr virDomainLookupByID(virConnectPtr conn, int id) @@ -361,7 +361,7 @@ virDomainLookupByID(virConnectPtr conn, int id) * Returns a new domain object or NULL in case of failure. If the * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised. * - * Since: v0.0.5 + * Since: 0.0.5 */ virDomainPtr virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -402,7 +402,7 @@ virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid) * Returns a new domain object or NULL in case of failure. If the * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised. * - * Since: v0.1.1 + * Since: 0.1.1 */ virDomainPtr virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -441,7 +441,7 @@ virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr) * Returns a new domain object or NULL in case of failure. If the * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised. * - * Since: v0.0.3 + * Since: 0.0.3 */ virDomainPtr virDomainLookupByName(virConnectPtr conn, const char *name) @@ -493,7 +493,7 @@ virDomainLookupByName(virConnectPtr conn, const char *name) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainDestroy(virDomainPtr domain) @@ -560,7 +560,7 @@ virDomainDestroy(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainDestroyFlags(virDomainPtr domain, @@ -602,7 +602,7 @@ virDomainDestroyFlags(virDomainPtr domain, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainFree(virDomainPtr domain) @@ -635,7 +635,7 @@ virDomainFree(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.6.0 + * Since: 0.6.0 */ int virDomainRef(virDomainPtr domain) @@ -665,7 +665,7 @@ virDomainRef(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainSuspend(virDomainPtr domain) @@ -709,7 +709,7 @@ virDomainSuspend(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainResume(virDomainPtr domain) @@ -767,7 +767,7 @@ virDomainResume(virDomainPtr domain) * Returns: 0 on success, * -1 on failure. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainPMSuspendForDuration(virDomainPtr dom, @@ -816,7 +816,7 @@ virDomainPMSuspendForDuration(virDomainPtr dom, * Returns: 0 on success, * -1 on failure. * - * Since: v0.9.11 + * Since: 0.9.11 */ int virDomainPMWakeup(virDomainPtr dom, @@ -865,7 +865,7 @@ virDomainPMWakeup(virDomainPtr dom, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainSave(virDomainPtr domain, const char *to) @@ -949,7 +949,7 @@ virDomainSave(virDomainPtr domain, const char *to) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainSaveFlags(virDomainPtr domain, const char *to, @@ -1011,7 +1011,7 @@ virDomainSaveFlags(virDomainPtr domain, const char *to, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainRestore(virConnectPtr conn, const char *from) @@ -1085,7 +1085,7 @@ virDomainRestore(virConnectPtr conn, const char *from) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainRestoreFlags(virConnectPtr conn, const char *from, const char *dxml, @@ -1149,7 +1149,7 @@ virDomainRestoreFlags(virConnectPtr conn, const char *from, const char *dxml, * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of * error. The caller must free() the returned value. * - * Since: v0.9.4 + * Since: 0.9.4 */ char * virDomainSaveImageGetXMLDesc(virConnectPtr conn, const char *file, @@ -1219,7 +1219,7 @@ virDomainSaveImageGetXMLDesc(virConnectPtr conn, const char *file, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainSaveImageDefineXML(virConnectPtr conn, const char *file, @@ -1295,7 +1295,7 @@ virDomainSaveImageDefineXML(virConnectPtr conn, const char *file, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.1.9 + * Since: 0.1.9 */ int virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags) @@ -1373,7 +1373,7 @@ virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v1.2.3 + * Since: 1.2.3 */ int virDomainCoreDumpWithFormat(virDomainPtr domain, const char *to, @@ -1454,7 +1454,7 @@ virDomainCoreDumpWithFormat(virDomainPtr domain, const char *to, * Returns a string representing the mime-type of the image format, or * NULL upon error. The caller must free() the returned value. * - * Since: v0.9.2 + * Since: 0.9.2 */ char * virDomainScreenshot(virDomainPtr domain, @@ -1515,7 +1515,7 @@ virDomainScreenshot(virDomainPtr domain, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainShutdown(virDomainPtr domain) @@ -1577,7 +1577,7 @@ virDomainShutdown(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainShutdownFlags(virDomainPtr domain, unsigned int flags) @@ -1637,7 +1637,7 @@ virDomainShutdownFlags(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.1.0 + * Since: 0.1.0 */ int virDomainReboot(virDomainPtr domain, unsigned int flags) @@ -1683,7 +1683,7 @@ virDomainReboot(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.7 + * Since: 0.9.7 */ int virDomainReset(virDomainPtr domain, unsigned int flags) @@ -1724,7 +1724,7 @@ virDomainReset(virDomainPtr domain, unsigned int flags) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the domain object. * - * Since: v0.0.3 + * Since: 0.0.3 */ const char * virDomainGetName(virDomainPtr domain) @@ -1748,7 +1748,7 @@ virDomainGetName(virDomainPtr domain) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.0.5 + * Since: 0.0.5 */ int virDomainGetUUID(virDomainPtr domain, unsigned char *uuid) @@ -1780,7 +1780,7 @@ virDomainGetUUID(virDomainPtr domain, unsigned char *uuid) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.1.1 + * Since: 0.1.1 */ int virDomainGetUUIDString(virDomainPtr domain, char *buf) @@ -1809,7 +1809,7 @@ virDomainGetUUIDString(virDomainPtr domain, char *buf) * * Returns the domain ID number or (unsigned int) -1 in case of error * - * Since: v0.0.3 + * Since: 0.0.3 */ unsigned int virDomainGetID(virDomainPtr domain) @@ -1833,7 +1833,7 @@ virDomainGetID(virDomainPtr domain) * Returns the new string or NULL in case of error, the string must be * freed by the caller. * - * Since: v0.0.3 + * Since: 0.0.3 */ char * virDomainGetOSType(virDomainPtr domain) @@ -1874,7 +1874,7 @@ virDomainGetOSType(virDomainPtr domain) * Returns the memory size in kibibytes (blocks of 1024 bytes), or 0 in * case of error. * - * Since: v0.0.3 + * Since: 0.0.3 */ unsigned long virDomainGetMaxMemory(virDomainPtr domain) @@ -1925,7 +1925,7 @@ virDomainGetMaxMemory(virDomainPtr domain) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory) @@ -1980,7 +1980,7 @@ virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.1.1 + * Since: 0.1.1 */ int virDomainSetMemory(virDomainPtr domain, unsigned long memory) @@ -2044,7 +2044,7 @@ virDomainSetMemory(virDomainPtr domain, unsigned long memory) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virDomainSetMemoryFlags(virDomainPtr domain, unsigned long memory, @@ -2106,7 +2106,7 @@ virDomainSetMemoryFlags(virDomainPtr domain, unsigned long memory, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.1.1 + * Since: 1.1.1 */ int virDomainSetMemoryStatsPeriod(virDomainPtr domain, int period, @@ -2158,7 +2158,7 @@ virDomainSetMemoryStatsPeriod(virDomainPtr domain, int period, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.8.5 + * Since: 0.8.5 */ int virDomainSetMemoryParameters(virDomainPtr domain, @@ -2234,7 +2234,7 @@ virDomainSetMemoryParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.8.5 + * Since: 0.8.5 */ int virDomainGetMemoryParameters(virDomainPtr domain, @@ -2303,7 +2303,7 @@ virDomainGetMemoryParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.9 + * Since: 0.9.9 */ int virDomainSetNumaParameters(virDomainPtr domain, @@ -2370,7 +2370,7 @@ virDomainSetNumaParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.9 + * Since: 0.9.9 */ int virDomainGetNumaParameters(virDomainPtr domain, @@ -2429,7 +2429,7 @@ virDomainGetNumaParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virDomainSetBlkioParameters(virDomainPtr domain, @@ -2496,7 +2496,7 @@ virDomainSetBlkioParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virDomainGetBlkioParameters(virDomainPtr domain, @@ -2556,7 +2556,7 @@ virDomainGetBlkioParameters(virDomainPtr domain, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info) @@ -2604,7 +2604,7 @@ virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virDomainGetState(virDomainPtr domain, @@ -2649,7 +2649,7 @@ virDomainGetState(virDomainPtr domain, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virDomainGetControlInfo(virDomainPtr domain, @@ -2712,7 +2712,7 @@ virDomainGetControlInfo(virDomainPtr domain, * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.0.3 + * Since: 0.0.3 */ char * virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags) @@ -2763,7 +2763,7 @@ virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.6.4 + * Since: 0.6.4 */ char * virConnectDomainXMLFromNative(virConnectPtr conn, @@ -2815,7 +2815,7 @@ virConnectDomainXMLFromNative(virConnectPtr conn, * Returns a 0 terminated UTF-8 encoded native config datafile, or * NULL in case of error. The caller must free() the returned value. * - * Since: v0.6.4 + * Since: 0.6.4 */ char * virConnectDomainXMLToNative(virConnectPtr conn, @@ -3670,7 +3670,7 @@ virDomainMigrateUnmanaged(virDomainPtr domain, * or NULL in case of error. Note that the new domain object * exists in the scope of the destination connection (dconn). * - * Since: v0.3.2 + * Since: 0.3.2 */ virDomainPtr virDomainMigrate(virDomainPtr domain, @@ -3868,7 +3868,7 @@ virDomainMigrate(virDomainPtr domain, * or NULL in case of error. Note that the new domain object * exists in the scope of the destination connection (dconn). * - * Since: v0.9.2 + * Since: 0.9.2 */ virDomainPtr virDomainMigrate2(virDomainPtr domain, @@ -4079,7 +4079,7 @@ virDomainMigrate2(virDomainPtr domain, * or NULL in case of error. Note that the new domain object * exists in the scope of the destination connection (dconn). * - * Since: v1.1.0 + * Since: 1.1.0 */ virDomainPtr virDomainMigrate3(virDomainPtr domain, @@ -4369,7 +4369,7 @@ int virDomainMigrateUnmanagedCheckCompat(virDomainPtr domain, * * Returns 0 if the migration succeeded, -1 upon error. * - * Since: v0.7.2 + * Since: 0.7.2 */ int virDomainMigrateToURI(virDomainPtr domain, @@ -4447,7 +4447,7 @@ virDomainMigrateToURI(virDomainPtr domain, * * Returns 0 if the migration succeeded, -1 upon error. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virDomainMigrateToURI2(virDomainPtr domain, @@ -4529,7 +4529,7 @@ virDomainMigrateToURI2(virDomainPtr domain, * * Returns 0 if the migration succeeded, -1 upon error. * - * Since: v1.1.0 + * Since: 1.1.0 */ int virDomainMigrateToURI3(virDomainPtr domain, @@ -5400,7 +5400,7 @@ virDomainMigrateConfirm3Params(virDomainPtr domain, * * Returns NULL in case of error. The caller must free the returned string. * - * Since: v0.2.3 + * Since: 0.2.3 */ char * virDomainGetSchedulerType(virDomainPtr domain, int *nparams) @@ -5450,7 +5450,7 @@ virDomainGetSchedulerType(virDomainPtr domain, int *nparams) * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.2.3 + * Since: 0.2.3 */ int virDomainGetSchedulerParameters(virDomainPtr domain, @@ -5517,7 +5517,7 @@ virDomainGetSchedulerParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virDomainGetSchedulerParametersFlags(virDomainPtr domain, @@ -5583,7 +5583,7 @@ virDomainGetSchedulerParametersFlags(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.2.3 + * Since: 0.2.3 */ int virDomainSetSchedulerParameters(virDomainPtr domain, @@ -5639,7 +5639,7 @@ virDomainSetSchedulerParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virDomainSetSchedulerParametersFlags(virDomainPtr domain, @@ -5712,7 +5712,7 @@ virDomainSetSchedulerParametersFlags(virDomainPtr domain, * * Returns: 0 in case of success or -1 in case of failure. * - * Since: v0.3.2 + * Since: 0.3.2 */ int virDomainBlockStats(virDomainPtr dom, const char *disk, @@ -5791,7 +5791,7 @@ virDomainBlockStats(virDomainPtr dom, const char *disk, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.5 + * Since: 0.9.5 */ int virDomainBlockStatsFlags(virDomainPtr dom, @@ -5862,7 +5862,7 @@ virDomainBlockStatsFlags(virDomainPtr dom, * * Returns: 0 in case of success or -1 in case of failure. * - * Since: v0.3.2 + * Since: 0.3.2 */ int virDomainInterfaceStats(virDomainPtr dom, const char *device, @@ -5924,7 +5924,7 @@ virDomainInterfaceStats(virDomainPtr dom, const char *device, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.9 + * Since: 0.9.9 */ int virDomainSetInterfaceParameters(virDomainPtr domain, @@ -5994,7 +5994,7 @@ virDomainSetInterfaceParameters(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.9 + * Since: 0.9.9 */ int virDomainGetInterfaceParameters(virDomainPtr domain, @@ -6086,7 +6086,7 @@ virDomainGetInterfaceParameters(virDomainPtr domain, * * Returns: The number of stats provided or -1 in case of failure. * - * Since: v0.7.5 + * Since: 0.7.5 */ int virDomainMemoryStats(virDomainPtr dom, virDomainMemoryStatPtr stats, @@ -6167,7 +6167,7 @@ virDomainMemoryStats(virDomainPtr dom, virDomainMemoryStatPtr stats, * * Returns: 0 in case of success or -1 in case of failure. * - * Since: v0.4.3 + * Since: 0.4.3 */ int virDomainBlockPeek(virDomainPtr dom, @@ -6238,7 +6238,7 @@ virDomainBlockPeek(virDomainPtr dom, * * Returns: 0 in case of success or -1 in case of failure. * - * Since: v0.9.8 + * Since: 0.9.8 */ int virDomainBlockResize(virDomainPtr dom, @@ -6308,7 +6308,7 @@ virDomainBlockResize(virDomainPtr dom, * * Returns: 0 in case of success or -1 in case of failure. * - * Since: v0.4.3 + * Since: 0.4.3 */ int virDomainMemoryPeek(virDomainPtr dom, @@ -6446,7 +6446,7 @@ virDomainMemoryPeek(virDomainPtr dom, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.8.1 + * Since: 0.8.1 */ int virDomainGetBlockInfo(virDomainPtr domain, const char *disk, @@ -6498,7 +6498,7 @@ virDomainGetBlockInfo(virDomainPtr domain, const char *disk, * * Returns NULL in case of error, a pointer to the domain otherwise * - * Since: v0.1.1 + * Since: 0.1.1 */ virDomainPtr virDomainDefineXML(virConnectPtr conn, const char *xml) @@ -6543,7 +6543,7 @@ virDomainDefineXML(virConnectPtr conn, const char *xml) * * Returns NULL in case of error, a pointer to the domain otherwise * - * Since: v1.2.12 + * Since: 1.2.12 */ virDomainPtr virDomainDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags) @@ -6588,7 +6588,7 @@ virDomainDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.1.1 + * Since: 0.1.1 */ int virDomainUndefine(virDomainPtr domain) @@ -6659,7 +6659,7 @@ virDomainUndefine(virDomainPtr domain) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainUndefineFlags(virDomainPtr domain, @@ -6700,7 +6700,7 @@ virDomainUndefineFlags(virDomainPtr domain, * * Returns the number of domain found or -1 in case of error * - * Since: v0.1.5 + * Since: 0.1.5 */ int virConnectNumOfDefinedDomains(virConnectPtr conn) @@ -6745,7 +6745,7 @@ virConnectNumOfDefinedDomains(virConnectPtr conn) * guaranteed that all currently defined domains were listed if the return * is less than @maxids. The client must call free() on each returned name. * - * Since: v0.1.1 + * Since: 0.1.1 */ int virConnectListDefinedDomains(virConnectPtr conn, char **const names, @@ -6846,7 +6846,7 @@ virConnectListDefinedDomains(virConnectPtr conn, char **const names, * make iteration easier. The caller is responsible for calling virDomainFree() * on each array element, then calling free() on @domains. * - * Since: v0.9.13 + * Since: 0.9.13 */ int virConnectListAllDomains(virConnectPtr conn, @@ -6889,7 +6889,7 @@ virConnectListAllDomains(virConnectPtr conn, * * Returns 0 in case of success, -1 in case of error * - * Since: v0.1.1 + * Since: 0.1.1 */ int virDomainCreate(virDomainPtr domain) @@ -6959,7 +6959,7 @@ virDomainCreate(virDomainPtr domain) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.8.2 + * Since: 0.8.2 */ int virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) @@ -7037,7 +7037,7 @@ virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success, -1 in case of error * - * Since: v1.1.1 + * Since: 1.1.1 */ int virDomainCreateWithFiles(virDomainPtr domain, unsigned int nfiles, @@ -7096,7 +7096,7 @@ virDomainCreateWithFiles(virDomainPtr domain, unsigned int nfiles, * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.1 + * Since: 0.2.1 */ int virDomainGetAutostart(virDomainPtr domain, @@ -7139,7 +7139,7 @@ virDomainGetAutostart(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.1 + * Since: 0.2.1 */ int virDomainSetAutostart(virDomainPtr domain, @@ -7181,7 +7181,7 @@ virDomainSetAutostart(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virDomainInjectNMI(virDomainPtr domain, unsigned int flags) @@ -7225,7 +7225,7 @@ virDomainInjectNMI(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virDomainSendKey(virDomainPtr domain, @@ -7312,7 +7312,7 @@ virDomainSendKey(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.0.1 + * Since: 1.0.1 */ int virDomainSendProcessSignal(virDomainPtr domain, @@ -7371,7 +7371,7 @@ virDomainSendProcessSignal(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.1.4 + * Since: 0.1.4 */ int virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus) @@ -7444,7 +7444,7 @@ virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.8.5 + * Since: 0.8.5 */ int virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus, @@ -7515,7 +7515,7 @@ virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus, * * Returns the number of vCPUs in case of success, -1 in case of failure. * - * Since: v0.8.5 + * Since: 0.8.5 */ int virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags) @@ -7573,7 +7573,7 @@ virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.1.4 + * Since: 0.1.4 */ int virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu, @@ -7641,7 +7641,7 @@ virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virDomainPinVcpuFlags(virDomainPtr domain, unsigned int vcpu, @@ -7701,7 +7701,7 @@ virDomainPinVcpuFlags(virDomainPtr domain, unsigned int vcpu, * Returns the number of virtual CPUs in case of success, * -1 in case of failure. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpumaps, @@ -7779,7 +7779,7 @@ virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpumaps, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.10.0 + * Since: 0.10.0 */ int virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap, @@ -7836,7 +7836,7 @@ virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap, * 0 in case of no emulator threads are pined to pcpus, * -1 in case of failure. * - * Since: v0.10.0 + * Since: 0.10.0 */ int virDomainGetEmulatorPinInfo(virDomainPtr domain, unsigned char *cpumap, @@ -7903,7 +7903,7 @@ virDomainGetEmulatorPinInfo(virDomainPtr domain, unsigned char *cpumap, * * Returns the number of info filled in case of success, -1 in case of failure. * - * Since: v0.1.4 + * Since: 0.1.4 */ int virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo, @@ -7964,7 +7964,7 @@ virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo, * * Returns the maximum of virtual CPU or -1 in case of error. * - * Since: v0.2.1 + * Since: 0.2.1 */ int virDomainGetMaxVcpus(virDomainPtr domain) @@ -8010,7 +8010,7 @@ virDomainGetMaxVcpus(virDomainPtr domain) * responsible for calling virDomainIOThreadInfoFree() on each array element, * then calling free() on @info. On error, @info is set to NULL. * - * Since: v1.2.14 + * Since: 1.2.14 */ int virDomainGetIOThreadInfo(virDomainPtr dom, @@ -8051,7 +8051,7 @@ virDomainGetIOThreadInfo(virDomainPtr dom, * * Frees the memory used by @info. * - * Since: v1.2.14 + * Since: 1.2.14 */ void virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr info) @@ -8096,7 +8096,7 @@ virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr info) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.2.14 + * Since: 1.2.14 */ int virDomainPinIOThread(virDomainPtr domain, @@ -8162,7 +8162,7 @@ virDomainPinIOThread(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.2.15 + * Since: 1.2.15 */ int virDomainAddIOThread(virDomainPtr domain, @@ -8223,7 +8223,7 @@ virDomainAddIOThread(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.2.15 + * Since: 1.2.15 */ int virDomainDelIOThread(virDomainPtr domain, @@ -8286,7 +8286,7 @@ virDomainDelIOThread(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v4.10.0 + * Since: 4.10.0 */ int virDomainSetIOThreadParams(virDomainPtr domain, @@ -8341,7 +8341,7 @@ virDomainSetIOThreadParams(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure * - * Since: v0.6.1 + * Since: 0.6.1 */ int virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel) @@ -8385,7 +8385,7 @@ virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel) * * Returns number of elements in @seclabels on success, -1 in case of failure. * - * Since: v0.10.0 + * Since: 0.10.0 */ int virDomainGetSecurityLabelList(virDomainPtr domain, @@ -8449,7 +8449,7 @@ virDomainGetSecurityLabelList(virDomainPtr domain, * * Returns 0 on success, -1 in case of failure. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainSetMetadata(virDomainPtr domain, @@ -8536,7 +8536,7 @@ virDomainSetMetadata(virDomainPtr domain, * Returns the metadata string on success (caller must free), * or NULL in case of failure. * - * Since: v0.9.10 + * Since: 0.9.10 */ char * virDomainGetMetadata(virDomainPtr domain, @@ -8605,7 +8605,7 @@ virDomainGetMetadata(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.1.9 + * Since: 0.1.9 */ int virDomainAttachDevice(virDomainPtr domain, const char *xml) @@ -8666,7 +8666,7 @@ virDomainAttachDevice(virDomainPtr domain, const char *xml) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.7.7 + * Since: 0.7.7 */ int virDomainAttachDeviceFlags(virDomainPtr domain, @@ -8712,7 +8712,7 @@ virDomainAttachDeviceFlags(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.1.9 + * Since: 0.1.9 */ int virDomainDetachDevice(virDomainPtr domain, const char *xml) @@ -8796,7 +8796,7 @@ virDomainDetachDevice(virDomainPtr domain, const char *xml) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.7.7 + * Since: 0.7.7 */ int virDomainDetachDeviceFlags(virDomainPtr domain, @@ -8862,7 +8862,7 @@ virDomainDetachDeviceFlags(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainUpdateDeviceFlags(virDomainPtr domain, @@ -8918,7 +8918,7 @@ virDomainUpdateDeviceFlags(virDomainPtr domain, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v4.4.0 + * Since: 4.4.0 */ int virDomainDetachDeviceAlias(virDomainPtr domain, @@ -8980,7 +8980,7 @@ virDomainDetachDeviceAlias(virDomainPtr domain, * sometimes returned a positive number on success, but without any reliable * semantics on what that number represents. * - * Since: v0.5.0 + * Since: 0.5.0 */ int virConnectDomainEventRegister(virConnectPtr conn, @@ -9025,7 +9025,7 @@ virConnectDomainEventRegister(virConnectPtr conn, * sometimes returned a positive number on success, but without any reliable * semantics on what that number represents. * - * Since: v0.5.0 + * Since: 0.5.0 */ int virConnectDomainEventDeregister(virConnectPtr conn, @@ -9061,7 +9061,7 @@ virConnectDomainEventDeregister(virConnectPtr conn, * * Returns 1 if running, 0 if inactive, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virDomainIsActive(virDomainPtr dom) @@ -9096,7 +9096,7 @@ virDomainIsActive(virDomainPtr dom) * * Returns 1 if persistent, 0 if transient, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virDomainIsPersistent(virDomainPtr dom) @@ -9138,7 +9138,7 @@ virDomainIsPersistent(virDomainPtr dom) * * Returns 0 if successfully renamed, -1 on error * - * Since: v1.2.19 + * Since: 1.2.19 */ int virDomainRename(virDomainPtr dom, @@ -9173,7 +9173,7 @@ virDomainRename(virDomainPtr dom, * * Returns 1 if updated, 0 if not, -1 on error * - * Since: v0.8.6 + * Since: 0.8.6 */ int virDomainIsUpdated(virDomainPtr dom) @@ -9212,7 +9212,7 @@ virDomainIsUpdated(virDomainPtr dom) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.7.7 + * Since: 0.7.7 */ int virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info) @@ -9278,7 +9278,7 @@ virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v1.0.3 + * Since: 1.0.3 */ int virDomainGetJobStats(virDomainPtr domain, @@ -9332,7 +9332,7 @@ virDomainGetJobStats(virDomainPtr domain, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.7.7 + * Since: 0.7.7 */ int virDomainAbortJob(virDomainPtr domain) @@ -9376,7 +9376,7 @@ virDomainAbortJob(virDomainPtr domain) * * Returns 0 in case of success, -1 otherwise. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainMigrateSetMaxDowntime(virDomainPtr domain, @@ -9419,7 +9419,7 @@ virDomainMigrateSetMaxDowntime(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v3.7.0 + * Since: 3.7.0 */ int virDomainMigrateGetMaxDowntime(virDomainPtr domain, @@ -9461,7 +9461,7 @@ virDomainMigrateGetMaxDowntime(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v1.0.3 + * Since: 1.0.3 */ int virDomainMigrateGetCompressionCache(virDomainPtr domain, @@ -9507,7 +9507,7 @@ virDomainMigrateGetCompressionCache(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v1.0.3 + * Since: 1.0.3 */ int virDomainMigrateSetCompressionCache(virDomainPtr domain, @@ -9553,7 +9553,7 @@ virDomainMigrateSetCompressionCache(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virDomainMigrateSetMaxSpeed(virDomainPtr domain, @@ -9598,7 +9598,7 @@ virDomainMigrateSetMaxSpeed(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v0.9.5 + * Since: 0.9.5 */ int virDomainMigrateGetMaxSpeed(virDomainPtr domain, @@ -9693,7 +9693,7 @@ virDomainMigrateGetMaxSpeed(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v1.3.3 + * Since: 1.3.3 */ int virDomainMigrateStartPostCopy(virDomainPtr domain, @@ -9758,7 +9758,7 @@ virDomainMigrateStartPostCopy(virDomainPtr domain, * * Returns a callback identifier on success, -1 on failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virConnectDomainEventRegisterAny(virConnectPtr conn, @@ -9819,7 +9819,7 @@ virConnectDomainEventRegisterAny(virConnectPtr conn, * sometimes returned a positive number on success, but without any reliable * semantics on what that number represents. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virConnectDomainEventDeregisterAny(virConnectPtr conn, @@ -9876,7 +9876,7 @@ virConnectDomainEventDeregisterAny(virConnectPtr conn, * * Returns 0 in case of success or -1 in case of failure * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainManagedSave(virDomainPtr dom, unsigned int flags) @@ -9925,7 +9925,7 @@ virDomainManagedSave(virDomainPtr dom, unsigned int flags) * Returns 0 if no image is present, 1 if an image is present, and * -1 in case of error * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainHasManagedSaveImage(virDomainPtr dom, unsigned int flags) @@ -9965,7 +9965,7 @@ virDomainHasManagedSaveImage(virDomainPtr dom, unsigned int flags) * * Returns 0 in case of success, and -1 in case of error * - * Since: v0.8.0 + * Since: 0.8.0 */ int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags) @@ -10013,7 +10013,7 @@ virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of * error. The caller must free() the returned value. * - * Since: v3.7.0 + * Since: 3.7.0 */ char * virDomainManagedSaveGetXMLDesc(virDomainPtr domain, unsigned int flags) @@ -10073,7 +10073,7 @@ virDomainManagedSaveGetXMLDesc(virDomainPtr domain, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v3.7.0 + * Since: 3.7.0 */ int virDomainManagedSaveDefineXML(virDomainPtr domain, const char *dxml, @@ -10140,7 +10140,7 @@ virDomainManagedSaveDefineXML(virDomainPtr domain, const char *dxml, * * Returns 0 if the console was opened, -1 on error * - * Since: v0.8.6 + * Since: 0.8.6 */ int virDomainOpenConsole(virDomainPtr dom, @@ -10206,7 +10206,7 @@ virDomainOpenConsole(virDomainPtr dom, * * Returns 0 if the channel was opened, -1 on error * - * Since: v1.0.2 + * Since: 1.0.2 */ int virDomainOpenChannel(virDomainPtr dom, @@ -10265,7 +10265,7 @@ virDomainOpenChannel(virDomainPtr dom, * * Returns -1 in case of failure, 0 in case of success. * - * Since: v1.3.3 + * Since: 1.3.3 */ int virDomainGetPerfEvents(virDomainPtr domain, virTypedParameterPtr *params, @@ -10317,7 +10317,7 @@ int virDomainGetPerfEvents(virDomainPtr domain, * * Returns -1 in case of error, 0 in case of success. * - * Since: v1.3.3 + * Since: 1.3.3 */ int virDomainSetPerfEvents(virDomainPtr domain, virTypedParameterPtr params, @@ -10402,7 +10402,7 @@ int virDomainSetPerfEvents(virDomainPtr domain, * * Returns -1 in case of failure, 0 when successful. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, @@ -10481,7 +10481,7 @@ virDomainBlockJobAbort(virDomainPtr dom, const char *disk, * * Returns -1 in case of failure, 0 when nothing found, 1 when info was found. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, @@ -10546,7 +10546,7 @@ virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, * * Returns -1 in case of failure, 0 when successful. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, @@ -10622,7 +10622,7 @@ virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, * * Returns 0 if the operation has started, -1 on failure. * - * Since: v0.9.4 + * Since: 0.9.4 */ int virDomainBlockPull(virDomainPtr dom, const char *disk, @@ -10768,7 +10768,7 @@ virDomainBlockPull(virDomainPtr dom, const char *disk, * * Returns 0 if the operation has started, -1 on failure. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainBlockRebase(virDomainPtr dom, const char *disk, @@ -10900,7 +10900,7 @@ virDomainBlockRebase(virDomainPtr dom, const char *disk, * * Returns 0 if the operation has started, -1 on failure. * - * Since: v1.2.8 + * Since: 1.2.8 */ int virDomainBlockCopy(virDomainPtr dom, const char *disk, @@ -11048,7 +11048,7 @@ virDomainBlockCopy(virDomainPtr dom, const char *disk, * * Returns 0 if the operation has started, -1 on failure. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virDomainBlockCommit(virDomainPtr dom, const char *disk, @@ -11109,7 +11109,7 @@ virDomainBlockCommit(virDomainPtr dom, const char *disk, * * Returns 0 on success, -1 on failure * - * Since: v0.9.7 + * Since: 0.9.7 */ int virDomainOpenGraphics(virDomainPtr dom, @@ -11191,7 +11191,7 @@ virDomainOpenGraphics(virDomainPtr dom, * * Returns an fd on success, -1 on failure * - * Since: v1.2.8 + * Since: 1.2.8 */ int virDomainOpenGraphicsFD(virDomainPtr dom, @@ -11254,7 +11254,7 @@ virDomainOpenGraphicsFD(virDomainPtr dom, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.8 + * Since: 0.9.8 */ int virDomainSetBlockIoTune(virDomainPtr dom, @@ -11331,7 +11331,7 @@ virDomainSetBlockIoTune(virDomainPtr dom, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.8 + * Since: 0.9.8 */ int virDomainGetBlockIoTune(virDomainPtr dom, @@ -11462,7 +11462,7 @@ virDomainGetBlockIoTune(virDomainPtr dom, * @ncpus is too large). The caller is responsible for freeing any * returned string parameters. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainGetCPUStats(virDomainPtr domain, @@ -11564,7 +11564,7 @@ virDomainGetCPUStats(virDomainPtr domain, * Returns number of disks with errors filled in the @errors array or -1 on * error. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virDomainGetDiskErrors(virDomainPtr dom, @@ -11611,7 +11611,7 @@ virDomainGetDiskErrors(virDomainPtr dom, * Returns the hostname which must be freed by the caller, or * NULL if there was an error. * - * Since: v0.10.0 + * Since: 0.10.0 */ char * virDomainGetHostname(virDomainPtr domain, unsigned int flags) @@ -11662,7 +11662,7 @@ virDomainGetHostname(virDomainPtr domain, unsigned int flags) * * Returns 0 on success, -1 otherwise. * - * Since: v1.0.1 + * Since: 1.0.1 */ int virDomainFSTrim(virDomainPtr dom, @@ -11708,7 +11708,7 @@ virDomainFSTrim(virDomainPtr dom, * * Returns the number of frozen filesystems on success, -1 otherwise. * - * Since: v1.2.5 + * Since: 1.2.5 */ int virDomainFSFreeze(virDomainPtr dom, @@ -11753,7 +11753,7 @@ virDomainFSFreeze(virDomainPtr dom, * * Returns the number of thawed filesystems on success, -1 otherwise. * - * Since: v1.2.5 + * Since: 1.2.5 */ int virDomainFSThaw(virDomainPtr dom, @@ -11800,7 +11800,7 @@ virDomainFSThaw(virDomainPtr dom, * * Returns 0 on success, -1 otherwise. * - * Since: v1.2.5 + * Since: 1.2.5 */ int virDomainGetTime(virDomainPtr dom, @@ -11852,7 +11852,7 @@ virDomainGetTime(virDomainPtr dom, * * Returns 0 on success, -1 otherwise. * - * Since: v1.2.5 + * Since: 1.2.5 */ int virDomainSetTime(virDomainPtr dom, @@ -11900,7 +11900,7 @@ virDomainSetTime(virDomainPtr dom, * * Returns 0 on success, -1 otherwise. * - * Since: v1.2.16 + * Since: 1.2.16 */ int virDomainSetUserPassword(virDomainPtr dom, @@ -11952,7 +11952,7 @@ virDomainSetUserPassword(virDomainPtr dom, * Returns NULL in case of error or an XML string * defining the capabilities. * - * Since: v1.2.7 + * Since: 1.2.7 */ char * virConnectGetDomainCapabilities(virConnectPtr conn, @@ -12360,7 +12360,7 @@ virConnectGetDomainCapabilities(virConnectPtr conn, * The requested data are returned in the @retStats parameter. The returned * array should be freed by the caller. See virDomainStatsRecordListFree. * - * Since: v1.2.8 + * Since: 1.2.8 */ int virConnectGetAllDomainStats(virConnectPtr conn, @@ -12441,7 +12441,7 @@ virConnectGetAllDomainStats(virConnectPtr conn, * Note that the count of returned stats may be less than the domain count * provided via @doms. * - * Since: v1.2.8 + * Since: 1.2.8 */ int virDomainListGetStats(virDomainPtr *doms, @@ -12510,7 +12510,7 @@ virDomainListGetStats(virDomainPtr *doms, * Convenience function to free a list of domain stats returned by * virDomainListGetStats and virConnectGetAllDomainStats. * - * Since: v1.2.8 + * Since: 1.2.8 */ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats) @@ -12544,7 +12544,7 @@ virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats) * responsible for calling virDomainFSInfoFree() on each array element, then * calling free() on @info. On error, @info is set to NULL. * - * Since: v1.2.11 + * Since: 1.2.11 */ int virDomainGetFSInfo(virDomainPtr dom, @@ -12581,7 +12581,7 @@ virDomainGetFSInfo(virDomainPtr dom, * * Frees all the memory occupied by @info. * - * Since: v1.2.11 + * Since: 1.2.11 */ void virDomainFSInfoFree(virDomainFSInfoPtr info) @@ -12675,7 +12675,7 @@ virDomainFSInfoFree(virDomainFSInfoPtr info) * * Returns the number of interfaces on success, -1 in case of error. * - * Since: v1.2.14 + * Since: 1.2.14 */ int virDomainInterfaceAddresses(virDomainPtr dom, @@ -12718,7 +12718,7 @@ virDomainInterfaceAddresses(virDomainPtr dom, * freed and should not be used thereafter. If @iface * is NULL, then this method has no effect. * - * Since: v1.2.14 + * Since: 1.2.14 */ void virDomainInterfaceFree(virDomainInterfacePtr iface) @@ -12763,7 +12763,7 @@ virDomainInterfaceFree(virDomainInterfacePtr iface) * * Returns 0 on success, -1 on error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virDomainGetGuestVcpus(virDomainPtr domain, @@ -12823,7 +12823,7 @@ virDomainGetGuestVcpus(virDomainPtr domain, * * Returns 0 on success, -1 on error. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virDomainSetGuestVcpus(virDomainPtr domain, @@ -12874,7 +12874,7 @@ virDomainSetGuestVcpus(virDomainPtr domain, * * Returns 0 on success, -1 on error. * - * Since: v3.1.0 + * Since: 3.1.0 */ int virDomainSetVcpu(virDomainPtr domain, @@ -13028,7 +13028,7 @@ virDomainSetVcpu(virDomainPtr domain, * * Returns 0 on success, -1 on error. * - * Since: v5.7.0 + * Since: 5.7.0 */ int virDomainGetGuestInfo(virDomainPtr domain, unsigned int types, @@ -13104,7 +13104,7 @@ int virDomainGetGuestInfo(virDomainPtr domain, * * Returns 0 if the operation has started, -1 on failure. * - * Since: v3.2.0 + * Since: 3.2.0 */ int virDomainSetBlockThreshold(virDomainPtr domain, @@ -13155,7 +13155,7 @@ virDomainSetBlockThreshold(virDomainPtr domain, * * Returns 0 on success, -1 on failure. * - * Since: v3.9.0 + * Since: 3.9.0 */ int virDomainSetLifecycleAction(virDomainPtr domain, unsigned int type, @@ -13212,7 +13212,7 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Returns -1 in case of failure, 0 in case of success. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virDomainGetLaunchSecurityInfo(virDomainPtr domain, virTypedParameterPtr *params, @@ -13280,7 +13280,7 @@ int virDomainGetLaunchSecurityInfo(virDomainPtr domain, * * Returns -1 in case of failure, 0 in case of success. * - * Since: v8.0.0 + * Since: 8.0.0 */ int virDomainSetLaunchSecurityState(virDomainPtr domain, virTypedParameterPtr params, @@ -13339,7 +13339,7 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain, * * Returns 0 on success, -1 on failure * - * Since: v5.10.0 + * Since: 5.10.0 */ int virDomainAgentSetResponseTimeout(virDomainPtr domain, @@ -13437,7 +13437,7 @@ virDomainAgentSetResponseTimeout(virDomainPtr domain, * * Returns 0 on success or -1 on failure. * - * Since: v6.0.0 + * Since: 6.0.0 */ int virDomainBackupBegin(virDomainPtr domain, @@ -13489,7 +13489,7 @@ virDomainBackupBegin(virDomainPtr domain, * Returns a NUL-terminated UTF-8 encoded XML instance or NULL in * case of error. The caller must free() the returned value. * - * Since: v6.0.0 + * Since: 6.0.0 */ char * virDomainBackupGetXMLDesc(virDomainPtr domain, @@ -13540,7 +13540,7 @@ virDomainBackupGetXMLDesc(virDomainPtr domain, * Returns: number of keys stored in @keys, * -1 otherwise. * - * Since: v6.10.0 + * Since: 6.10.0 */ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, @@ -13610,7 +13610,7 @@ virDomainAuthorizedSSHKeysGet(virDomainPtr domain, * Returns: 0 on success, * -1 otherwise. * - * Since: v6.10.0 + * Since: 6.10.0 */ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, @@ -13680,7 +13680,7 @@ virDomainAuthorizedSSHKeysSet(virDomainPtr domain, * Returns: number of messages stored in @msgs, * -1 otherwise. * - * Since: v7.1.0 + * Since: 7.1.0 */ int virDomainGetMessages(virDomainPtr domain, @@ -13724,7 +13724,7 @@ virDomainGetMessages(virDomainPtr domain, * * Returns 0 in case of success, -1 otherwise. * - * Since: v7.2.0 + * Since: 7.2.0 */ int virDomainStartDirtyRateCalc(virDomainPtr domain, diff --git a/src/libvirt-host.c b/src/libvirt-host.c index 7e7545d447..2ee6370bce 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -48,7 +48,7 @@ VIR_LOG_INIT("libvirt.host"); * * Returns 0 in case of success, -1 in case of failure * - * Since: v0.6.0 + * Since: 0.6.0 */ int virConnectRef(virConnectPtr conn) @@ -88,7 +88,7 @@ virConnectRef(virConnectPtr conn) * * Returns: 0 if the identity change was accepted, -1 on error * - * Since: v5.8.0 + * Since: 5.8.0 */ int virConnectSetIdentity(virConnectPtr conn, @@ -154,7 +154,7 @@ virConnectSupportsFeature(virConnectPtr conn, int feature) * * Returns NULL in case of error, a static zero terminated string otherwise. * - * Since: v0.0.3 + * Since: 0.0.3 */ const char * virConnectGetType(virConnectPtr conn) @@ -187,7 +187,7 @@ virConnectGetType(virConnectPtr conn) * extracted by lack of capacities returns 0 and @hvVer is 0, otherwise * @hvVer value is major * 1,000,000 + minor * 1,000 + release * - * Since: v0.0.3 + * Since: 0.0.3 */ int virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer) @@ -225,7 +225,7 @@ virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer) * Returns -1 in case of failure, 0 otherwise, and values for @libVer have * the format major * 1,000,000 + minor * 1,000 + release. * - * Since: v0.7.3 + * Since: 0.7.3 */ int virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer) @@ -267,7 +267,7 @@ virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer) * Returns the hostname which must be freed by the caller, or * NULL if there was an error. * - * Since: v0.3.0 + * Since: 0.3.0 */ char * virConnectGetHostname(virConnectPtr conn) @@ -308,7 +308,7 @@ virConnectGetHostname(virConnectPtr conn) * Returns the URI string which must be freed by the caller, or * NULL if there was an error. * - * Since: v0.3.0 + * Since: 0.3.0 */ char * virConnectGetURI(virConnectPtr conn) @@ -344,7 +344,7 @@ virConnectGetURI(virConnectPtr conn) * Returns the XML string which must be freed by the caller, or * NULL if there was an error. * - * Since: v0.8.8 + * Since: 0.8.8 */ char * virConnectGetSysinfo(virConnectPtr conn, unsigned int flags) @@ -384,7 +384,7 @@ virConnectGetSysinfo(virConnectPtr conn, unsigned int flags) * * Returns the maximum of virtual CPU or -1 in case of error. * - * Since: v0.2.1 + * Since: 0.2.1 */ int virConnectGetMaxVcpus(virConnectPtr conn, @@ -435,7 +435,7 @@ virConnectGetMaxVcpus(virConnectPtr conn, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.1.0 + * Since: 0.1.0 */ int virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info) @@ -473,7 +473,7 @@ virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info) * defining the capabilities. * The client must free the returned string after use. * - * Since: v0.2.1 + * Since: 0.2.1 */ char * virConnectGetCapabilities(virConnectPtr conn) @@ -555,7 +555,7 @@ virConnectGetCapabilities(virConnectPtr conn) * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virNodeGetCPUStats(virConnectPtr conn, @@ -644,7 +644,7 @@ virNodeGetCPUStats(virConnectPtr conn, * * Returns -1 in case of error, 0 in case of success. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virNodeGetMemoryStats(virConnectPtr conn, @@ -693,7 +693,7 @@ virNodeGetMemoryStats(virConnectPtr conn, * * Returns the available free memory in bytes or 0 in case of error * - * Since: v0.3.3 + * Since: 0.3.3 */ unsigned long long virNodeGetFreeMemory(virConnectPtr conn) @@ -741,7 +741,7 @@ virNodeGetFreeMemory(virConnectPtr conn) * delay), -1 on failure (the operation is not supported, or an attempted * suspend is already underway). * - * Since: v0.9.8 + * Since: 0.9.8 */ int virNodeSuspendForDuration(virConnectPtr conn, @@ -796,7 +796,7 @@ virNodeSuspendForDuration(virConnectPtr conn, * * Returns 0 in case of success, and -1 in case of failure. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virNodeGetMemoryParameters(virConnectPtr conn, @@ -862,7 +862,7 @@ virNodeGetMemoryParameters(virConnectPtr conn, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virNodeSetMemoryParameters(virConnectPtr conn, @@ -912,7 +912,7 @@ virNodeSetMemoryParameters(virConnectPtr conn, * * Returns 0 in case of success, -1 in case of failure * - * Since: v0.6.1 + * Since: 0.6.1 */ int virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel) @@ -957,7 +957,7 @@ virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel) * * Returns the number of entries filled in freeMems, or -1 in case of error. * - * Since: v0.3.3 + * Since: 0.3.3 */ int virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems, @@ -997,7 +997,7 @@ virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems, * * Returns 1 if encrypted, 0 if not encrypted, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virConnectIsEncrypted(virConnectPtr conn) @@ -1034,7 +1034,7 @@ virConnectIsEncrypted(virConnectPtr conn) * * Returns 1 if secure, 0 if not secure, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virConnectIsSecure(virConnectPtr conn) @@ -1078,7 +1078,7 @@ virConnectIsSecure(virConnectPtr conn) * VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about * the incompatibility. * - * Since: v0.7.5 + * Since: 0.7.5 */ int virConnectCompareCPU(virConnectPtr conn, @@ -1136,7 +1136,7 @@ virConnectCompareCPU(virConnectPtr conn, * VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about * the incompatibility. * - * Since: v4.4.0 + * Since: 4.4.0 */ int virConnectCompareHypervisorCPU(virConnectPtr conn, @@ -1200,7 +1200,7 @@ virConnectCompareHypervisorCPU(virConnectPtr conn, * Returns -1 on error, number of elements in @models on success (0 means * libvirt accepts any CPU model). * - * Since: v1.1.3 + * Since: 1.1.3 */ int virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***models, @@ -1258,7 +1258,7 @@ virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***models, * * Returns XML description of the computed CPU (caller frees) or NULL on error. * - * Since: v0.7.7 + * Since: 0.7.7 */ char * virConnectBaselineCPU(virConnectPtr conn, @@ -1329,7 +1329,7 @@ virConnectBaselineCPU(virConnectPtr conn, * * Returns XML description of the computed CPU (caller frees) or NULL on error. * - * Since: v4.4.0 + * Since: 4.4.0 */ char * virConnectBaselineHypervisorCPU(virConnectPtr conn, @@ -1404,7 +1404,7 @@ virConnectBaselineHypervisorCPU(virConnectPtr conn, * Returns -1 on error, 0 on success, 1 when remote party doesn't support * keepalive messages. * - * Since: v0.9.8 + * Since: 0.9.8 */ int virConnectSetKeepAlive(virConnectPtr conn, @@ -1443,7 +1443,7 @@ virConnectSetKeepAlive(virConnectPtr conn, * * Returns 1 if alive, 0 if dead, -1 on error * - * Since: v0.9.8 + * Since: 0.9.8 */ int virConnectIsAlive(virConnectPtr conn) @@ -1491,7 +1491,7 @@ virConnectIsAlive(virConnectPtr conn) * * Returns 0 on success, -1 on error * - * Since: v0.10.0 + * Since: 0.10.0 */ int virConnectRegisterCloseCallback(virConnectPtr conn, @@ -1530,7 +1530,7 @@ virConnectRegisterCloseCallback(virConnectPtr conn, * * Returns 0 on success, -1 on error * - * Since: v0.10.0 + * Since: 0.10.0 */ int virConnectUnregisterCloseCallback(virConnectPtr conn, @@ -1574,7 +1574,7 @@ virConnectUnregisterCloseCallback(virConnectPtr conn, * Returns number of CPUs present on the host node, * or -1 if there was an error. * - * Since: v1.0.0 + * Since: 1.0.0 */ int virNodeGetCPUMap(virConnectPtr conn, @@ -1662,7 +1662,7 @@ virNodeGetCPUMap(virConnectPtr conn, * * Returns: the number of entries filled in @counts or -1 in case of error. * - * Since: v1.2.6 + * Since: 1.2.6 */ int virNodeGetFreePages(virConnectPtr conn, @@ -1734,7 +1734,7 @@ virNodeGetFreePages(virConnectPtr conn, * Returns: the number of nodes successfully adjusted or -1 in * case of an error. * - * Since: v1.2.9 + * Since: 1.2.9 */ int virNodeAllocPages(virConnectPtr conn, @@ -1789,7 +1789,7 @@ virNodeAllocPages(virConnectPtr conn, * * Returns 0 in case of success, and -1 in case of failure. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virNodeGetSEVInfo(virConnectPtr conn, diff --git a/src/libvirt-interface.c b/src/libvirt-interface.c index b1194fd803..7affe03470 100644 --- a/src/libvirt-interface.c +++ b/src/libvirt-interface.c @@ -37,7 +37,7 @@ VIR_LOG_INIT("libvirt.interface"); * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.6.4 + * Since: 0.6.4 */ virConnectPtr virInterfaceGetConnect(virInterfacePtr iface) @@ -79,7 +79,7 @@ virInterfaceGetConnect(virInterfacePtr iface) * to make iteration easier. The caller is responsible for calling * virStorageInterfaceFree() on each array element, then calling free() on @ifaces. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllInterfaces(virConnectPtr conn, @@ -120,7 +120,7 @@ virConnectListAllInterfaces(virConnectPtr conn, * * Returns the number of active interfaces found or -1 in case of error * - * Since: v0.6.4 + * Since: 0.6.4 */ int virConnectNumOfInterfaces(virConnectPtr conn) @@ -165,7 +165,7 @@ virConnectNumOfInterfaces(virConnectPtr conn) * all currently active interfaces were listed if the return is less than * @maxnames. The client must call free() on each returned name. * - * Since: v0.6.4 + * Since: 0.6.4 */ int virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames) @@ -202,7 +202,7 @@ virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames) * * Returns the number of defined interface found or -1 in case of error * - * Since: v0.7.0 + * Since: 0.7.0 */ int virConnectNumOfDefinedInterfaces(virConnectPtr conn) @@ -247,7 +247,7 @@ virConnectNumOfDefinedInterfaces(virConnectPtr conn) * guaranteed that all currently defined interfaces were listed if the return * is less than @maxnames. The client must call free() on each returned name. * - * Since: v0.7.0 + * Since: 0.7.0 */ int virConnectListDefinedInterfaces(virConnectPtr conn, @@ -291,7 +291,7 @@ virConnectListDefinedInterfaces(virConnectPtr conn, * Returns a new interface object or NULL in case of failure. If the * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised. * - * Since: v0.6.4 + * Since: 0.6.4 */ virInterfacePtr virInterfaceLookupByName(virConnectPtr conn, const char *name) @@ -332,7 +332,7 @@ virInterfaceLookupByName(virConnectPtr conn, const char *name) * Returns a new interface object or NULL in case of failure. If the * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised. * - * Since: v0.6.4 + * Since: 0.6.4 */ virInterfacePtr virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr) @@ -369,7 +369,7 @@ virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the interface object. * - * Since: v0.6.4 + * Since: 0.6.4 */ const char * virInterfaceGetName(virInterfacePtr iface) @@ -395,7 +395,7 @@ virInterfaceGetName(virInterfacePtr iface) * format) or NULL, the string need not be deallocated its lifetime * will be the same as the interface object. * - * Since: v0.6.4 + * Since: 0.6.4 */ const char * virInterfaceGetMACString(virInterfacePtr iface) @@ -428,7 +428,7 @@ virInterfaceGetMACString(virInterfacePtr iface) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.6.4 + * Since: 0.6.4 */ char * virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags) @@ -481,7 +481,7 @@ virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags) * * Returns NULL in case of error, a pointer to the interface otherwise * - * Since: v0.6.4 + * Since: 0.6.4 */ virInterfacePtr virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags) @@ -529,7 +529,7 @@ virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.6.4 + * Since: 0.6.4 */ int virInterfaceUndefine(virInterfacePtr iface) @@ -574,7 +574,7 @@ virInterfaceUndefine(virInterfacePtr iface) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.6.4 + * Since: 0.6.4 */ int virInterfaceCreate(virInterfacePtr iface, unsigned int flags) @@ -623,7 +623,7 @@ virInterfaceCreate(virInterfacePtr iface, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.6.4 + * Since: 0.6.4 */ int virInterfaceDestroy(virInterfacePtr iface, unsigned int flags) @@ -671,7 +671,7 @@ virInterfaceDestroy(virInterfacePtr iface, unsigned int flags) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.4 + * Since: 0.6.4 */ int virInterfaceRef(virInterfacePtr iface) @@ -696,7 +696,7 @@ virInterfaceRef(virInterfacePtr iface) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.6.4 + * Since: 0.6.4 */ int virInterfaceFree(virInterfacePtr iface) @@ -729,7 +729,7 @@ virInterfaceFree(virInterfacePtr iface) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags) @@ -771,7 +771,7 @@ virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags) @@ -813,7 +813,7 @@ virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.9.2 + * Since: 0.9.2 */ int virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags) @@ -850,7 +850,7 @@ virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags) * * Returns 1 if running, 0 if inactive, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virInterfaceIsActive(virInterfacePtr iface) diff --git a/src/libvirt-lxc.c b/src/libvirt-lxc.c index ea72e15569..ab7e88c1c5 100644 --- a/src/libvirt-lxc.c +++ b/src/libvirt-lxc.c @@ -60,7 +60,7 @@ VIR_LOG_INIT("libvirt-lxc"); * * Returns the number of opened file descriptors, or -1 on error * - * Since: v1.0.2 + * Since: 1.0.2 */ int virDomainLxcOpenNamespace(virDomainPtr domain, @@ -118,7 +118,7 @@ virDomainLxcOpenNamespace(virDomainPtr domain, * * Returns 0 on success, -1 on error * - * Since: v1.0.2 + * Since: 1.0.2 */ int virDomainLxcEnterNamespace(virDomainPtr domain, @@ -187,7 +187,7 @@ virDomainLxcEnterNamespace(virDomainPtr domain, * * Returns 0 on success, -1 on error * - * Since: v1.0.4 + * Since: 1.0.4 */ int virDomainLxcEnterSecurityLabel(virSecurityModelPtr model, @@ -290,7 +290,7 @@ virDomainLxcEnterSecurityLabel(virSecurityModelPtr model, * * Returns 0 on success, -1 on error * - * Since: v2.0.0 + * Since: 2.0.0 */ int virDomainLxcEnterCGroup(virDomainPtr domain, unsigned int flags) diff --git a/src/libvirt-network.c b/src/libvirt-network.c index 0d1524ce34..50c4108641 100644 --- a/src/libvirt-network.c +++ b/src/libvirt-network.c @@ -39,7 +39,7 @@ VIR_LOG_INIT("libvirt.network"); * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.3.0 + * Since: 0.3.0 */ virConnectPtr virNetworkGetConnect(virNetworkPtr net) @@ -89,7 +89,7 @@ virNetworkGetConnect(virNetworkPtr net) * to make iteration easier. The caller is responsible for calling * virNetworkFree() on each array element, then calling free() on @nets. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllNetworks(virConnectPtr conn, @@ -130,7 +130,7 @@ virConnectListAllNetworks(virConnectPtr conn, * * Returns the number of network found or -1 in case of error * - * Since: v0.2.0 + * Since: 0.2.0 */ int virConnectNumOfNetworks(virConnectPtr conn) @@ -174,7 +174,7 @@ virConnectNumOfNetworks(virConnectPtr conn) * all currently active networks were listed if the return is less than * @maxnames. The client must call free() on each returned name. * - * Since: v0.2.0 + * Since: 0.2.0 */ int virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames) @@ -211,7 +211,7 @@ virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames) * * Returns the number of networks found or -1 in case of error * - * Since: v0.2.0 + * Since: 0.2.0 */ int virConnectNumOfDefinedNetworks(virConnectPtr conn) @@ -255,7 +255,7 @@ virConnectNumOfDefinedNetworks(virConnectPtr conn) * guaranteed that all currently defined networks were listed if the return * is less than @maxnames. The client must call free() on each returned name. * - * Since: v0.2.0 + * Since: 0.2.0 */ int virConnectListDefinedNetworks(virConnectPtr conn, char **const names, @@ -298,7 +298,7 @@ virConnectListDefinedNetworks(virConnectPtr conn, char **const names, * Returns a new network object or NULL in case of failure. If the * network cannot be found, then VIR_ERR_NO_NETWORK error is raised. * - * Since: v0.2.0 + * Since: 0.2.0 */ virNetworkPtr virNetworkLookupByName(virConnectPtr conn, const char *name) @@ -339,7 +339,7 @@ virNetworkLookupByName(virConnectPtr conn, const char *name) * Returns a new network object or NULL in case of failure. If the * network cannot be found, then VIR_ERR_NO_NETWORK error is raised. * - * Since: v0.2.0 + * Since: 0.2.0 */ virNetworkPtr virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -377,7 +377,7 @@ virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid) * Returns a new network object or NULL in case of failure. If the * network cannot be found, then VIR_ERR_NO_NETWORK error is raised. * - * Since: v0.2.0 + * Since: 0.2.0 */ virNetworkPtr virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -418,7 +418,7 @@ virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr) * * Returns a new network object or NULL in case of failure * - * Since: v0.2.0 + * Since: 0.2.0 */ virNetworkPtr virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc) @@ -461,7 +461,7 @@ virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc) * * Returns a new network object or NULL in case of failure * - * Since: v7.8.0 + * Since: 7.8.0 */ virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags) @@ -503,7 +503,7 @@ virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int f * * Returns NULL in case of error, a pointer to the network otherwise * - * Since: v0.2.0 + * Since: 0.2.0 */ virNetworkPtr virNetworkDefineXML(virConnectPtr conn, const char *xml) @@ -546,7 +546,7 @@ virNetworkDefineXML(virConnectPtr conn, const char *xml) * * Returns NULL in case of error, a pointer to the network otherwise * - * Since: v7.7.0 + * Since: 7.7.0 */ virNetworkPtr virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags) @@ -583,7 +583,7 @@ virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags * * Returns 0 in case of success, -1 in case of error * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkUndefine(virNetworkPtr network) @@ -633,7 +633,7 @@ virNetworkUndefine(virNetworkPtr network) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.10.2 + * Since: 0.10.2 */ int virNetworkUpdate(virNetworkPtr network, @@ -701,7 +701,7 @@ virNetworkUpdate(virNetworkPtr network, * * Returns 0 in case of success, -1 in case of error * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkCreate(virNetworkPtr network) @@ -743,7 +743,7 @@ virNetworkCreate(virNetworkPtr network) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkDestroy(virNetworkPtr network) @@ -783,7 +783,7 @@ virNetworkDestroy(virNetworkPtr network) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkFree(virNetworkPtr network) @@ -816,7 +816,7 @@ virNetworkFree(virNetworkPtr network) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.0 + * Since: 0.6.0 */ int virNetworkRef(virNetworkPtr network) @@ -841,7 +841,7 @@ virNetworkRef(virNetworkPtr network) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the network object. * - * Since: v0.2.0 + * Since: 0.2.0 */ const char * virNetworkGetName(virNetworkPtr network) @@ -865,7 +865,7 @@ virNetworkGetName(virNetworkPtr network) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid) @@ -897,7 +897,7 @@ virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.0 + * Since: 0.2.0 */ int virNetworkGetUUIDString(virNetworkPtr network, char *buf) @@ -934,7 +934,7 @@ virNetworkGetUUIDString(virNetworkPtr network, char *buf) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.2.0 + * Since: 0.2.0 */ char * virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags) @@ -973,7 +973,7 @@ virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags) * Returns a 0 terminated interface name, or NULL in case of * error. The caller must free() the returned value. * - * Since: v0.2.0 + * Since: 0.2.0 */ char * virNetworkGetBridgeName(virNetworkPtr network) @@ -1013,7 +1013,7 @@ virNetworkGetBridgeName(virNetworkPtr network) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.1 + * Since: 0.2.1 */ int virNetworkGetAutostart(virNetworkPtr network, @@ -1055,7 +1055,7 @@ virNetworkGetAutostart(virNetworkPtr network, * * Returns -1 in case of error, 0 in case of success * - * Since: v0.2.1 + * Since: 0.2.1 */ int virNetworkSetAutostart(virNetworkPtr network, @@ -1095,7 +1095,7 @@ virNetworkSetAutostart(virNetworkPtr network, * * Returns 1 if running, 0 if inactive, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virNetworkIsActive(virNetworkPtr net) @@ -1130,7 +1130,7 @@ virNetworkIsActive(virNetworkPtr net) * * Returns 1 if persistent, 0 if transient, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virNetworkIsPersistent(virNetworkPtr net) @@ -1191,7 +1191,7 @@ virNetworkIsPersistent(virNetworkPtr net) * * Returns a callback identifier on success, -1 on failure. * - * Since: v1.2.1 + * Since: 1.2.1 */ int virConnectNetworkEventRegisterAny(virConnectPtr conn, @@ -1254,7 +1254,7 @@ virConnectNetworkEventRegisterAny(virConnectPtr conn, * * Returns 0 on success, -1 on failure * - * Since: v1.2.1 + * Since: 1.2.1 */ int virConnectNetworkEventDeregisterAny(virConnectPtr conn, @@ -1357,7 +1357,7 @@ virConnectNetworkEventDeregisterAny(virConnectPtr conn, * Returns the number of leases found or -1 and sets @leases to NULL in * case of error. * - * Since: v1.2.6 + * Since: 1.2.6 */ int virNetworkGetDHCPLeases(virNetworkPtr network, @@ -1400,7 +1400,7 @@ virNetworkGetDHCPLeases(virNetworkPtr network, * * Frees all the memory occupied by @lease. * - * Since: v1.2.6 + * Since: 1.2.6 */ void virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease) @@ -1430,7 +1430,7 @@ virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease) * Returns a new network port object or NULL in case of failure. If the * network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised. * - * Since: v5.5.0 + * Since: 5.5.0 */ virNetworkPortPtr virNetworkPortLookupByUUID(virNetworkPtr net, @@ -1469,7 +1469,7 @@ virNetworkPortLookupByUUID(virNetworkPtr net, * Returns a new network port object or NULL in case of failure. If the * network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised. * - * Since: v5.5.0 + * Since: 5.5.0 */ virNetworkPortPtr virNetworkPortLookupByUUIDString(virNetworkPtr net, @@ -1511,7 +1511,7 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, * * Returns -1 in case of error, 0 in case of success. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortSetParameters(virNetworkPortPtr port, @@ -1561,7 +1561,7 @@ virNetworkPortSetParameters(virNetworkPortPtr port, * * Returns -1 in case of error, 0 in case of success. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortGetParameters(virNetworkPortPtr port, @@ -1607,7 +1607,7 @@ virNetworkPortGetParameters(virNetworkPortPtr port, * * Returns a new network port object or NULL in case of failure * - * Since: v5.5.0 + * Since: 5.5.0 */ virNetworkPortPtr virNetworkPortCreateXML(virNetworkPtr net, @@ -1647,7 +1647,7 @@ virNetworkPortCreateXML(virNetworkPtr net, * * Returns the virNetworkPtr or NULL in case of failure. * - * Since: v5.5.0 + * Since: 5.5.0 */ virNetworkPtr virNetworkPortGetNetwork(virNetworkPortPtr port) @@ -1673,7 +1673,7 @@ virNetworkPortGetNetwork(virNetworkPortPtr port) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. * the caller must free() the returned value. * - * Since: v5.5.0 + * Since: 5.5.0 */ char * virNetworkPortGetXMLDesc(virNetworkPortPtr port, @@ -1712,7 +1712,7 @@ virNetworkPortGetXMLDesc(virNetworkPortPtr port, * * Returns -1 in case of error, 0 in case of success * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortGetUUID(virNetworkPortPtr port, @@ -1745,7 +1745,7 @@ virNetworkPortGetUUID(virNetworkPortPtr port, * * Returns -1 in case of error, 0 in case of success * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortGetUUIDString(virNetworkPortPtr port, @@ -1779,7 +1779,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortDelete(virNetworkPortPtr port, @@ -1829,7 +1829,7 @@ virNetworkPortDelete(virNetworkPortPtr port, * for calling virNetworkPortFree() on each array element, then calling * free() on @ports. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkListAllPorts(virNetworkPtr network, @@ -1868,7 +1868,7 @@ virNetworkListAllPorts(virNetworkPtr network, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortFree(virNetworkPortPtr port) @@ -1901,7 +1901,7 @@ virNetworkPortFree(virNetworkPortPtr port) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v5.5.0 + * Since: 5.5.0 */ int virNetworkPortRef(virNetworkPortPtr port) diff --git a/src/libvirt-nodedev.c b/src/libvirt-nodedev.c index 1caf3c8479..d5a24ea2ef 100644 --- a/src/libvirt-nodedev.c +++ b/src/libvirt-nodedev.c @@ -41,7 +41,7 @@ VIR_LOG_INIT("libvirt.nodedev"); * * Returns the number of node devices or -1 in case of error * - * Since: v0.5.0 + * Since: 0.5.0 */ int virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags) @@ -89,7 +89,7 @@ virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags) * virNodeDeviceFree() on each array element, then calling free() on * @devices. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllNodeDevices(virConnectPtr conn, @@ -140,7 +140,7 @@ virConnectListAllNodeDevices(virConnectPtr conn, * * Returns the number of node devices found or -1 in case of error * - * Since: v0.5.0 + * Since: 0.5.0 */ int virNodeListDevices(virConnectPtr conn, @@ -185,7 +185,7 @@ virNodeListDevices(virConnectPtr conn, * * Returns a virNodeDevicePtr if found, NULL otherwise. * - * Since: v0.5.0 + * Since: 0.5.0 */ virNodeDevicePtr virNodeDeviceLookupByName(virConnectPtr conn, const char *name) @@ -227,7 +227,7 @@ virNodeDeviceLookupByName(virConnectPtr conn, const char *name) * * Returns a virNodeDevicePtr if found, NULL otherwise. * - * Since: v1.0.3 + * Since: 1.0.3 */ virNodeDevicePtr virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn, @@ -271,7 +271,7 @@ virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn, * * Returns the XML document, or NULL on error * - * Since: v0.5.0 + * Since: 0.5.0 */ char * virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags) @@ -306,7 +306,7 @@ virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags) * * Returns the device name or NULL in case of error * - * Since: v0.5.0 + * Since: 0.5.0 */ const char * virNodeDeviceGetName(virNodeDevicePtr dev) @@ -330,7 +330,7 @@ virNodeDeviceGetName(virNodeDevicePtr dev) * Returns the name of the device's parent, or NULL if an * error occurred or when the device has no parent. * - * Since: v0.5.0 + * Since: 0.5.0 */ const char * virNodeDeviceGetParent(virNodeDevicePtr dev) @@ -363,7 +363,7 @@ virNodeDeviceGetParent(virNodeDevicePtr dev) * Returns the number of capabilities supported by the device or -1 * in case of error. * - * Since: v0.5.0 + * Since: 0.5.0 */ int virNodeDeviceNumOfCaps(virNodeDevicePtr dev) @@ -401,7 +401,7 @@ virNodeDeviceNumOfCaps(virNodeDevicePtr dev) * Returns the number of capability names listed in @names or -1 * in case of error. * - * Since: v0.5.0 + * Since: 0.5.0 */ int virNodeDeviceListCaps(virNodeDevicePtr dev, @@ -442,7 +442,7 @@ virNodeDeviceListCaps(virNodeDevicePtr dev, * * Returns the 0 for success, -1 for error. * - * Since: v0.5.0 + * Since: 0.5.0 */ int virNodeDeviceFree(virNodeDevicePtr dev) @@ -475,7 +475,7 @@ virNodeDeviceFree(virNodeDevicePtr dev) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.0 + * Since: 0.6.0 */ int virNodeDeviceRef(virNodeDevicePtr dev) @@ -515,7 +515,7 @@ virNodeDeviceRef(virNodeDevicePtr dev) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.1 + * Since: 0.6.1 */ int virNodeDeviceDettach(virNodeDevicePtr dev) @@ -570,7 +570,7 @@ virNodeDeviceDettach(virNodeDevicePtr dev) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v1.0.5 + * Since: 1.0.5 */ int virNodeDeviceDetachFlags(virNodeDevicePtr dev, @@ -617,7 +617,7 @@ virNodeDeviceDetachFlags(virNodeDevicePtr dev, * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.1 + * Since: 0.6.1 */ int virNodeDeviceReAttach(virNodeDevicePtr dev) @@ -662,7 +662,7 @@ virNodeDeviceReAttach(virNodeDevicePtr dev) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.1 + * Since: 0.6.1 */ int virNodeDeviceReset(virNodeDevicePtr dev) @@ -704,7 +704,7 @@ virNodeDeviceReset(virNodeDevicePtr dev) * * Returns a node device object if successful, NULL in case of failure * - * Since: v0.6.3 + * Since: 0.6.3 */ virNodeDevicePtr virNodeDeviceCreateXML(virConnectPtr conn, @@ -745,7 +745,7 @@ virNodeDeviceCreateXML(virConnectPtr conn, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.6.3 + * Since: 0.6.3 */ int virNodeDeviceDestroy(virNodeDevicePtr dev) @@ -787,7 +787,7 @@ virNodeDeviceDestroy(virNodeDevicePtr dev) * * Returns a node device object if successful, NULL in case of failure * - * Since: v7.3.0 + * Since: 7.3.0 */ virNodeDevicePtr virNodeDeviceDefineXML(virConnectPtr conn, @@ -828,7 +828,7 @@ virNodeDeviceDefineXML(virConnectPtr conn, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v7.3.0 + * Since: 7.3.0 */ int virNodeDeviceUndefine(virNodeDevicePtr dev, @@ -867,7 +867,7 @@ virNodeDeviceUndefine(virNodeDevicePtr dev, * * Returns 0 in case of success and -1 in case of failure. * - * Since: v7.3.0 + * Since: 7.3.0 */ int virNodeDeviceCreate(virNodeDevicePtr dev, @@ -932,7 +932,7 @@ virNodeDeviceCreate(virNodeDevicePtr dev, * * Returns a callback identifier on success, -1 on failure. * - * Since: v2.2.0 + * Since: 2.2.0 */ int virConnectNodeDeviceEventRegisterAny(virConnectPtr conn, @@ -998,7 +998,7 @@ virConnectNodeDeviceEventRegisterAny(virConnectPtr conn, * * Returns 0 on success, -1 on failure. * - * Since: v2.2.0 + * Since: 2.2.0 */ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, @@ -1037,7 +1037,7 @@ virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, * * Returns -1 in case of error, 0 in case of success * - * Since: v7.8.0 + * Since: 7.8.0 */ int virNodeDeviceSetAutostart(virNodeDevicePtr dev, @@ -1078,7 +1078,7 @@ virNodeDeviceSetAutostart(virNodeDevicePtr dev, * * Returns -1 in case of error, 0 in case of success * - * Since: v7.8.0 + * Since: 7.8.0 */ int virNodeDeviceGetAutostart(virNodeDevicePtr dev, @@ -1116,7 +1116,7 @@ virNodeDeviceGetAutostart(virNodeDevicePtr dev, * * Returns 1 if persistent, 0 if transient, -1 on error * - * Since: v7.8.0 + * Since: 7.8.0 */ int virNodeDeviceIsPersistent(virNodeDevicePtr dev) @@ -1151,7 +1151,7 @@ virNodeDeviceIsPersistent(virNodeDevicePtr dev) * * Returns 1 if active, 0 if inactive, -1 on error * - * Since: v7.8.0 + * Since: 7.8.0 */ int virNodeDeviceIsActive(virNodeDevicePtr dev) { diff --git a/src/libvirt-nwfilter.c b/src/libvirt-nwfilter.c index bac50e89a3..b0b53cb132 100644 --- a/src/libvirt-nwfilter.c +++ b/src/libvirt-nwfilter.c @@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.nwfilter"); * * Returns the number of nwfilters found or -1 in case of error * - * Since: v0.8.0 + * Since: 0.8.0 */ int virConnectNumOfNWFilters(virConnectPtr conn) @@ -80,7 +80,7 @@ virConnectNumOfNWFilters(virConnectPtr conn) * to make iteration easier. The caller is responsible for calling * virNWFilterFree() on each array element, then calling free() on @filters. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllNWFilters(virConnectPtr conn, @@ -126,7 +126,7 @@ virConnectListAllNWFilters(virConnectPtr conn, * * Returns the number of network filters found or -1 in case of error * - * Since: v0.8.0 + * Since: 0.8.0 */ int virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames) @@ -168,7 +168,7 @@ virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames) * Returns a new nwfilter object or NULL in case of failure. If the * network filter cannot be found, then VIR_ERR_NO_NWFILTER error is raised. * - * Since: v0.8.0 + * Since: 0.8.0 */ virNWFilterPtr virNWFilterLookupByName(virConnectPtr conn, const char *name) @@ -209,7 +209,7 @@ virNWFilterLookupByName(virConnectPtr conn, const char *name) * Returns a new nwfilter object or NULL in case of failure. If the * nwfdilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised. * - * Since: v0.8.0 + * Since: 0.8.0 */ virNWFilterPtr virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -250,7 +250,7 @@ virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid) * Returns a new nwfilter object or NULL in case of failure. If the * nwfilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised. * - * Since: v0.8.0 + * Since: 0.8.0 */ virNWFilterPtr virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -287,7 +287,7 @@ virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virNWFilterFree(virNWFilterPtr nwfilter) @@ -312,7 +312,7 @@ virNWFilterFree(virNWFilterPtr nwfilter) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the nwfilter object. * - * Since: v0.8.0 + * Since: 0.8.0 */ const char * virNWFilterGetName(virNWFilterPtr nwfilter) @@ -336,7 +336,7 @@ virNWFilterGetName(virNWFilterPtr nwfilter) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.8.0 + * Since: 0.8.0 */ int virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid) @@ -368,7 +368,7 @@ virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.8.0 + * Since: 0.8.0 */ int virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf) @@ -402,7 +402,7 @@ virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf) * * Returns a new nwfilter object or NULL in case of failure * - * Since: v0.8.0 + * Since: 0.8.0 */ virNWFilterPtr virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc) @@ -445,7 +445,7 @@ virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc) * * Returns a new nwfilter object or NULL in case of failure * - * Since: v7.7.0 + * Since: 7.7.0 */ virNWFilterPtr virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags) @@ -484,7 +484,7 @@ virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int * * Returns 0 in case of success and -1 in case of failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virNWFilterUndefine(virNWFilterPtr nwfilter) @@ -526,7 +526,7 @@ virNWFilterUndefine(virNWFilterPtr nwfilter) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v0.8.0 + * Since: 0.8.0 */ char * virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags) @@ -572,7 +572,7 @@ virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.8.0 + * Since: 0.8.0 */ int virNWFilterRef(virNWFilterPtr nwfilter) @@ -605,7 +605,7 @@ virNWFilterRef(virNWFilterPtr nwfilter) * to make iteration easier. The caller is responsible for calling * virNWFilterFree() on each array element, then calling free() on @filters. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virConnectListAllNWFilterBindings(virConnectPtr conn, @@ -653,7 +653,7 @@ virConnectListAllNWFilterBindings(virConnectPtr conn, * network filter cannot be found, then VIR_ERR_NO_NWFILTER_BINDING * error is raised. * - * Since: v4.5.0 + * Since: 4.5.0 */ virNWFilterBindingPtr virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev) @@ -690,7 +690,7 @@ virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev) * * Returns 0 in case of success and -1 in case of failure. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virNWFilterBindingFree(virNWFilterBindingPtr binding) @@ -715,7 +715,7 @@ virNWFilterBindingFree(virNWFilterBindingPtr binding) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the binding object. * - * Since: v4.5.0 + * Since: 4.5.0 */ const char * virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding) @@ -739,7 +739,7 @@ virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding) * Returns a pointer to the name or NULL, the string need not be deallocated * its lifetime will be the same as the binding object. * - * Since: v4.5.0 + * Since: 4.5.0 */ const char * virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding) @@ -775,7 +775,7 @@ virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding) * * Returns a new binding object or NULL in case of failure * - * Since: v4.5.0 + * Since: 4.5.0 */ virNWFilterBindingPtr virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned int flags) @@ -818,7 +818,7 @@ virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned int fl * * Returns 0 in case of success and -1 in case of failure. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virNWFilterBindingDelete(virNWFilterBindingPtr binding) @@ -860,7 +860,7 @@ virNWFilterBindingDelete(virNWFilterBindingPtr binding) * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case * of error. The caller must free() the returned value. * - * Since: v4.5.0 + * Since: 4.5.0 */ char * virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags) @@ -906,7 +906,7 @@ virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virNWFilterBindingRef(virNWFilterBindingPtr binding) diff --git a/src/libvirt-qemu.c b/src/libvirt-qemu.c index d4ddbed059..3cd8c8f745 100644 --- a/src/libvirt-qemu.c +++ b/src/libvirt-qemu.c @@ -61,7 +61,7 @@ VIR_LOG_INIT("libvirt-qemu"); * * Returns 0 in case of success, -1 in case of failure * - * Since: v0.8.3 + * Since: 0.8.3 */ int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, @@ -133,7 +133,7 @@ virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, * * Returns 0 in case of success, -1 in case of failure * - * Since: v8.2.0 + * Since: 8.2.0 */ int virDomainQemuMonitorCommandWithFiles(virDomainPtr domain, @@ -220,7 +220,7 @@ virDomainQemuMonitorCommandWithFiles(virDomainPtr domain, * * Returns a new domain object on success, NULL otherwise * - * Since: v0.9.4 + * Since: 0.9.4 */ virDomainPtr virDomainQemuAttach(virConnectPtr conn, @@ -278,7 +278,7 @@ virDomainQemuAttach(virConnectPtr conn, * * Returns strings if success, NULL in failure. * - * Since: v0.10.0 + * Since: 0.10.0 */ char * virDomainQemuAgentCommand(virDomainPtr domain, @@ -358,7 +358,7 @@ virDomainQemuAgentCommand(virDomainPtr domain, * * Returns a callback identifier on success, -1 on failure * - * Since: v1.2.3 + * Since: 1.2.3 */ int virConnectDomainQemuMonitorEventRegister(virConnectPtr conn, @@ -414,7 +414,7 @@ virConnectDomainQemuMonitorEventRegister(virConnectPtr conn, * * Returns 0 on success, -1 on failure * - * Since: v1.2.3 + * Since: 1.2.3 */ int virConnectDomainQemuMonitorEventDeregister(virConnectPtr conn, diff --git a/src/libvirt-secret.c b/src/libvirt-secret.c index ccf47a8f07..fa00570043 100644 --- a/src/libvirt-secret.c +++ b/src/libvirt-secret.c @@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.secret"); * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ virConnectPtr virSecretGetConnect(virSecretPtr secret) @@ -59,7 +59,7 @@ virSecretGetConnect(virSecretPtr secret) * * Returns the number currently defined secrets. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virConnectNumOfSecrets(virConnectPtr conn) @@ -121,7 +121,7 @@ virConnectNumOfSecrets(virConnectPtr conn) * to make iteration easier. The caller is responsible for calling * virSecretFree() on each array element, then calling free() on @secrets. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllSecrets(virConnectPtr conn, @@ -167,7 +167,7 @@ virConnectListAllSecrets(virConnectPtr conn, * * Returns the number of UUIDs provided in the array, or -1 on failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids) @@ -211,7 +211,7 @@ virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids) * Returns a new secret object or NULL in case of failure. If the * secret cannot be found, then VIR_ERR_NO_SECRET error is raised. * - * Since: v0.7.1 + * Since: 0.7.1 */ virSecretPtr virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -254,7 +254,7 @@ virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid) * Returns a new secret object or NULL in case of failure. If the * secret cannot be found, then VIR_ERR_NO_SECRET error is raised. * - * Since: v0.7.1 + * Since: 0.7.1 */ virSecretPtr virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -298,7 +298,7 @@ virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr) * Returns a new secret object or NULL in case of failure. If the * secret cannot be found, then VIR_ERR_NO_SECRET error is raised. * - * Since: v0.7.1 + * Since: 0.7.1 */ virSecretPtr virSecretLookupByUsage(virConnectPtr conn, @@ -347,7 +347,7 @@ virSecretLookupByUsage(virConnectPtr conn, * * Returns a secret on success, NULL on failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ virSecretPtr virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags) @@ -387,7 +387,7 @@ virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags) * Returns 0 on success with the uuid buffer being filled, or * -1 upon failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretGetUUID(virSecretPtr secret, unsigned char *uuid) @@ -419,7 +419,7 @@ virSecretGetUUID(virSecretPtr secret, unsigned char *uuid) * * Returns -1 in case of error, 0 in case of success * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretGetUUIDString(virSecretPtr secret, char *buf) @@ -453,7 +453,7 @@ virSecretGetUUIDString(virSecretPtr secret, char *buf) * Returns a positive integer identifying the type of object, * or -1 upon error. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretGetUsageType(virSecretPtr secret) @@ -484,7 +484,7 @@ virSecretGetUsageType(virSecretPtr secret) * Returns a string identifying the object using the secret, * or NULL upon error * - * Since: v0.7.1 + * Since: 0.7.1 */ const char * virSecretGetUsageID(virSecretPtr secret) @@ -509,7 +509,7 @@ virSecretGetUsageID(virSecretPtr secret) * Returns the XML document on success, NULL on failure. The caller must * free() the XML. * - * Since: v0.7.1 + * Since: 0.7.1 */ char * virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags) @@ -551,7 +551,7 @@ virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags) * * Returns 0 on success, -1 on failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretSetValue(virSecretPtr secret, const unsigned char *value, @@ -598,7 +598,7 @@ virSecretSetValue(virSecretPtr secret, const unsigned char *value, * Returns the secret value on success, NULL on failure. The caller must * free() the secret value. * - * Since: v0.7.1 + * Since: 0.7.1 */ unsigned char * virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags) @@ -641,7 +641,7 @@ virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags) * * Returns 0 on success, -1 on failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretUndefine(virSecretPtr secret) @@ -690,7 +690,7 @@ virSecretUndefine(virSecretPtr secret) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretRef(virSecretPtr secret) @@ -714,7 +714,7 @@ virSecretRef(virSecretPtr secret) * * Returns 0 on success, or -1 on error * - * Since: v0.7.1 + * Since: 0.7.1 */ int virSecretFree(virSecretPtr secret) @@ -765,7 +765,7 @@ virSecretFree(virSecretPtr secret) * * Returns a callback identifier on success, -1 on failure. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virConnectSecretEventRegisterAny(virConnectPtr conn, @@ -833,7 +833,7 @@ virConnectSecretEventRegisterAny(virConnectPtr conn, * * Returns 0 on success, -1 on failure. * - * Since: v3.0.0 + * Since: 3.0.0 */ int virConnectSecretEventDeregisterAny(virConnectPtr conn, diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c index a31a18dbe9..84900340a7 100644 --- a/src/libvirt-storage.c +++ b/src/libvirt-storage.c @@ -38,7 +38,7 @@ VIR_LOG_INIT("libvirt.storage"); * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.4.1 + * Since: 0.4.1 */ virConnectPtr virStoragePoolGetConnect(virStoragePoolPtr pool) @@ -107,7 +107,7 @@ virStoragePoolGetConnect(virStoragePoolPtr pool) * for calling virStoragePoolFree() on each array element, then calling * free() on @pools. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virConnectListAllStoragePools(virConnectPtr conn, @@ -148,7 +148,7 @@ virConnectListAllStoragePools(virConnectPtr conn, * * Returns the number of pools found, or -1 on error * - * Since: v0.4.1 + * Since: 0.4.1 */ int virConnectNumOfStoragePools(virConnectPtr conn) @@ -194,7 +194,7 @@ virConnectNumOfStoragePools(virConnectPtr conn) * that all currently active pools were listed if the return is less than * @maxnames. The client must call free() on each returned name. * - * Since: v0.4.1 + * Since: 0.4.1 */ int virConnectListStoragePools(virConnectPtr conn, @@ -233,7 +233,7 @@ virConnectListStoragePools(virConnectPtr conn, * * Returns the number of pools found, or -1 on error * - * Since: v0.4.1 + * Since: 0.4.1 */ int virConnectNumOfDefinedStoragePools(virConnectPtr conn) @@ -279,7 +279,7 @@ virConnectNumOfDefinedStoragePools(virConnectPtr conn) * guaranteed that all currently defined pools were listed if the return * is less than @maxnames. The client must call free() on each returned name. * - * Since: v0.4.1 + * Since: 0.4.1 */ int virConnectListDefinedStoragePools(virConnectPtr conn, @@ -331,7 +331,7 @@ virConnectListDefinedStoragePools(virConnectPtr conn, * containing a source document appropriate to the given pool * type for each discovered source. * - * Since: v0.4.5 + * Since: 0.4.5 */ char * virConnectFindStoragePoolSources(virConnectPtr conn, @@ -376,7 +376,7 @@ virConnectFindStoragePoolSources(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolLookupByName(virConnectPtr conn, @@ -417,7 +417,7 @@ virStoragePoolLookupByName(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolLookupByUUID(virConnectPtr conn, @@ -458,7 +458,7 @@ virStoragePoolLookupByUUID(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolLookupByUUIDString(virConnectPtr conn, @@ -498,7 +498,7 @@ virStoragePoolLookupByUUIDString(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolLookupByVolume(virStorageVolPtr vol) @@ -539,7 +539,7 @@ virStoragePoolLookupByVolume(virStorageVolPtr vol) * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found * - * Since: v4.1.0 + * Since: 4.1.0 */ virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn, @@ -582,7 +582,7 @@ virStoragePoolLookupByTargetPath(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if creation failed * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolCreateXML(virConnectPtr conn, @@ -627,7 +627,7 @@ virStoragePoolCreateXML(virConnectPtr conn, * * Returns a virStoragePoolPtr object, or NULL if creation failed * - * Since: v0.4.1 + * Since: 0.4.1 */ virStoragePoolPtr virStoragePoolDefineXML(virConnectPtr conn, @@ -670,7 +670,7 @@ virStoragePoolDefineXML(virConnectPtr conn, * * Returns 0 on success, or -1 upon failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolBuild(virStoragePoolPtr pool, @@ -710,7 +710,7 @@ virStoragePoolBuild(virStoragePoolPtr pool, * * Returns 0 on success, -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolUndefine(virStoragePoolPtr pool) @@ -750,7 +750,7 @@ virStoragePoolUndefine(virStoragePoolPtr pool) * * Returns 0 on success, or -1 if it could not be started * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolCreate(virStoragePoolPtr pool, @@ -794,7 +794,7 @@ virStoragePoolCreate(virStoragePoolPtr pool, * * Returns 0 on success, or -1 if it could not be destroyed * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolDestroy(virStoragePoolPtr pool) @@ -836,7 +836,7 @@ virStoragePoolDestroy(virStoragePoolPtr pool) * * Returns 0 on success, or -1 if it could not be obliterate * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolDelete(virStoragePoolPtr pool, @@ -877,7 +877,7 @@ virStoragePoolDelete(virStoragePoolPtr pool, * * Returns 0 on success, or -1 if it could not be free'd. * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolFree(virStoragePoolPtr pool) @@ -911,7 +911,7 @@ virStoragePoolFree(virStoragePoolPtr pool) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.0 + * Since: 0.6.0 */ int virStoragePoolRef(virStoragePoolPtr pool) @@ -938,7 +938,7 @@ virStoragePoolRef(virStoragePoolPtr pool) * * Returns 0 if the volume list was refreshed, -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolRefresh(virStoragePoolPtr pool, @@ -978,7 +978,7 @@ virStoragePoolRefresh(virStoragePoolPtr pool, * * Returns the name of the pool, or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ const char* virStoragePoolGetName(virStoragePoolPtr pool) @@ -1002,7 +1002,7 @@ virStoragePoolGetName(virStoragePoolPtr pool) * * Returns 0 on success, or -1 on error; * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolGetUUID(virStoragePoolPtr pool, @@ -1034,7 +1034,7 @@ virStoragePoolGetUUID(virStoragePoolPtr pool, * * Returns 0 on success, or -1 on error; * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolGetUUIDString(virStoragePoolPtr pool, @@ -1066,7 +1066,7 @@ virStoragePoolGetUUIDString(virStoragePoolPtr pool, * * Returns 0 on success, or -1 on failure. * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolGetInfo(virStoragePoolPtr pool, @@ -1112,7 +1112,7 @@ virStoragePoolGetInfo(virStoragePoolPtr pool, * * Returns a XML document (caller frees), or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ char * virStoragePoolGetXMLDesc(virStoragePoolPtr pool, @@ -1152,7 +1152,7 @@ virStoragePoolGetXMLDesc(virStoragePoolPtr pool, * * Returns 0 on success, -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolGetAutostart(virStoragePoolPtr pool, @@ -1194,7 +1194,7 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool, * * Returns 0 on success, -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolSetAutostart(virStoragePoolPtr pool, @@ -1244,7 +1244,7 @@ virStoragePoolSetAutostart(virStoragePoolPtr pool, * for calling virStorageVolFree() on each array element, then calling * free() on @vols. * - * Since: v0.10.2 + * Since: 0.10.2 */ int virStoragePoolListAllVolumes(virStoragePoolPtr pool, @@ -1282,7 +1282,7 @@ virStoragePoolListAllVolumes(virStoragePoolPtr pool, * * Returns the number of storage pools, or -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolNumOfVolumes(virStoragePoolPtr pool) @@ -1323,7 +1323,7 @@ virStoragePoolNumOfVolumes(virStoragePoolPtr pool) * * Returns the number of names fetched, or -1 on error * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStoragePoolListVolumes(virStoragePoolPtr pool, @@ -1364,7 +1364,7 @@ virStoragePoolListVolumes(virStoragePoolPtr pool, * * Returns the virConnectPtr or NULL in case of failure. * - * Since: v0.4.1 + * Since: 0.4.1 */ virConnectPtr virStorageVolGetConnect(virStorageVolPtr vol) @@ -1392,7 +1392,7 @@ virStorageVolGetConnect(virStorageVolPtr vol) * * Returns a storage volume, or NULL if not found / error * - * Since: v0.4.1 + * Since: 0.4.1 */ virStorageVolPtr virStorageVolLookupByName(virStoragePoolPtr pool, @@ -1434,7 +1434,7 @@ virStorageVolLookupByName(virStoragePoolPtr pool, * * Returns a storage volume, or NULL if not found / error * - * Since: v0.4.1 + * Since: 0.4.1 */ virStorageVolPtr virStorageVolLookupByKey(virConnectPtr conn, @@ -1476,7 +1476,7 @@ virStorageVolLookupByKey(virConnectPtr conn, * * Returns a storage volume, or NULL if not found / error * - * Since: v0.4.1 + * Since: 0.4.1 */ virStorageVolPtr virStorageVolLookupByPath(virConnectPtr conn, @@ -1514,7 +1514,7 @@ virStorageVolLookupByPath(virConnectPtr conn, * * Returns the volume name, or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ const char* virStorageVolGetName(virStorageVolPtr vol) @@ -1539,7 +1539,7 @@ virStorageVolGetName(virStorageVolPtr vol) * * Returns the volume key, or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ const char* virStorageVolGetKey(virStorageVolPtr vol) @@ -1574,7 +1574,7 @@ virStorageVolGetKey(virStorageVolPtr vol) * * Returns the storage volume, or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ virStorageVolPtr virStorageVolCreateXML(virStoragePoolPtr pool, @@ -1627,7 +1627,7 @@ virStorageVolCreateXML(virStoragePoolPtr pool, * * Returns the storage volume, or NULL on error * - * Since: v0.6.4 + * Since: 0.6.4 */ virStorageVolPtr virStorageVolCreateXMLFrom(virStoragePoolPtr pool, @@ -1693,7 +1693,7 @@ virStorageVolCreateXMLFrom(virStoragePoolPtr pool, * * Returns 0, or -1 upon error. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virStorageVolDownload(virStorageVolPtr vol, @@ -1778,7 +1778,7 @@ virStorageVolDownload(virStorageVolPtr vol, * * Returns 0, or -1 upon error. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virStorageVolUpload(virStorageVolPtr vol, @@ -1833,7 +1833,7 @@ virStorageVolUpload(virStorageVolPtr vol, * * Returns 0 on success, or -1 on error * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStorageVolDelete(virStorageVolPtr vol, @@ -1884,7 +1884,7 @@ virStorageVolDelete(virStorageVolPtr vol, * * Returns 0 on success, or -1 on error * - * Since: v0.8.0 + * Since: 0.8.0 */ int virStorageVolWipe(virStorageVolPtr vol, @@ -1932,7 +1932,7 @@ virStorageVolWipe(virStorageVolPtr vol, * * Returns 0 on success, or -1 on error. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virStorageVolWipePattern(virStorageVolPtr vol, @@ -1974,7 +1974,7 @@ virStorageVolWipePattern(virStorageVolPtr vol, * * Returns 0 on success, or -1 on error * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStorageVolFree(virStorageVolPtr vol) @@ -2007,7 +2007,7 @@ virStorageVolFree(virStorageVolPtr vol) * * Returns 0 in case of success, -1 in case of failure. * - * Since: v0.6.0 + * Since: 0.6.0 */ int virStorageVolRef(virStorageVolPtr vol) @@ -2033,7 +2033,7 @@ virStorageVolRef(virStorageVolPtr vol) * * Returns 0 on success, or -1 on failure * - * Since: v0.4.1 + * Since: 0.4.1 */ int virStorageVolGetInfo(virStorageVolPtr vol, @@ -2085,7 +2085,7 @@ virStorageVolGetInfo(virStorageVolPtr vol, * * Returns 0 on success, or -1 on failure * - * Since: v3.0.0 + * Since: 3.0.0 */ int virStorageVolGetInfoFlags(virStorageVolPtr vol, @@ -2131,7 +2131,7 @@ virStorageVolGetInfoFlags(virStorageVolPtr vol, * * Returns the XML document, or NULL on error * - * Since: v0.4.1 + * Since: 0.4.1 */ char * virStorageVolGetXMLDesc(virStorageVolPtr vol, @@ -2174,7 +2174,7 @@ virStorageVolGetXMLDesc(virStorageVolPtr vol, * Returns the storage volume path, or NULL on error. The * caller must free() the returned path after use. * - * Since: v0.4.1 + * Since: 0.4.1 */ char * virStorageVolGetPath(virStorageVolPtr vol) @@ -2237,7 +2237,7 @@ virStorageVolGetPath(virStorageVolPtr vol) * * Returns 0 on success, or -1 on error. * - * Since: v0.9.10 + * Since: 0.9.10 */ int virStorageVolResize(virStorageVolPtr vol, @@ -2288,7 +2288,7 @@ virStorageVolResize(virStorageVolPtr vol, * * Returns 1 if running, 0 if inactive, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virStoragePoolIsActive(virStoragePoolPtr pool) @@ -2323,7 +2323,7 @@ virStoragePoolIsActive(virStoragePoolPtr pool) * * Returns 1 if persistent, 0 if transient, -1 on error * - * Since: v0.7.3 + * Since: 0.7.3 */ int virStoragePoolIsPersistent(virStoragePoolPtr pool) @@ -2383,7 +2383,7 @@ virStoragePoolIsPersistent(virStoragePoolPtr pool) * * Returns a callback identifier on success, -1 on failure. * - * Since: v2.0.0 + * Since: 2.0.0 */ int virConnectStoragePoolEventRegisterAny(virConnectPtr conn, @@ -2448,7 +2448,7 @@ virConnectStoragePoolEventRegisterAny(virConnectPtr conn, * * Returns 0 on success, -1 on failure * - * Since: v2.0.0 + * Since: 2.0.0 */ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, @@ -2489,7 +2489,7 @@ virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, * * Returns NULL in case of error or an XML string defining the capabilities. * - * Since: v5.2.0 + * Since: 5.2.0 */ char * virConnectGetStoragePoolCapabilities(virConnectPtr conn, diff --git a/src/libvirt-stream.c b/src/libvirt-stream.c index 2bc9535eb1..12b6333692 100644 --- a/src/libvirt-stream.c +++ b/src/libvirt-stream.c @@ -53,7 +53,7 @@ VIR_LOG_INIT("libvirt.stream"); * * Returns the new stream, or NULL upon error * - * Since: v0.7.2 + * Since: 0.7.2 */ virStreamPtr virStreamNew(virConnectPtr conn, @@ -88,7 +88,7 @@ virStreamNew(virConnectPtr conn, * * Returns 0 in case of success, -1 in case of failure * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamRef(virStreamPtr stream) @@ -168,7 +168,7 @@ virStreamRef(virStreamPtr stream) * Returns -2 if the outgoing transmit buffers are full & * the stream is marked as non-blocking. * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamSend(virStreamPtr stream, @@ -265,7 +265,7 @@ virStreamSend(virStreamPtr stream, * Returns -2 if there is no data pending to be read & the * stream is marked as non-blocking. * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamRecv(virStreamPtr stream, @@ -354,7 +354,7 @@ virStreamRecv(virStreamPtr stream, * Returns -3 if there is a hole in stream and caller requested * to stop at a hole. * - * Since: v3.4.0 + * Since: 3.4.0 */ int virStreamRecvFlags(virStreamPtr stream, @@ -423,7 +423,7 @@ virStreamRecvFlags(virStreamPtr stream, * Returns 0 on success, * -1 error * - * Since: v3.4.0 + * Since: 3.4.0 */ int virStreamSendHole(virStreamPtr stream, @@ -468,7 +468,7 @@ virStreamSendHole(virStreamPtr stream, * Returns 0 on success, * -1 on error or when there's currently no hole in the stream * - * Since: v3.4.0 + * Since: 3.4.0 */ int virStreamRecvHole(virStreamPtr stream, @@ -592,7 +592,7 @@ virStreamInData(virStreamPtr stream, * having been called, so the caller need only call * virStreamFree(). * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamSendAll(virStreamPtr stream, @@ -723,7 +723,7 @@ virStreamSendAll(virStreamPtr stream, * having been called, so the caller need only call * virStreamFree(). * - * Since: v3.4.0 + * Since: 3.4.0 */ int virStreamSparseSendAll(virStreamPtr stream, virStreamSourceFunc handler, @@ -864,7 +864,7 @@ int virStreamSparseSendAll(virStreamPtr stream, * having been called, so the caller need only call * virStreamFree() * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamRecvAll(virStreamPtr stream, @@ -979,7 +979,7 @@ virStreamRecvAll(virStreamPtr stream, * Returns -1 upon any error, with virStreamAbort() already * having been called, so the caller need only call virStreamFree(). * - * Since: v3.4.0 + * Since: 3.4.0 */ int virStreamSparseRecvAll(virStreamPtr stream, @@ -1074,7 +1074,7 @@ virStreamSparseRecvAll(virStreamPtr stream, * * Returns 0 on success, -1 upon error * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamEventAddCallback(virStreamPtr stream, @@ -1119,7 +1119,7 @@ virStreamEventAddCallback(virStreamPtr stream, * * Returns 0 on success, -1 if no callback is registered * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamEventUpdateCallback(virStreamPtr stream, @@ -1156,7 +1156,7 @@ virStreamEventUpdateCallback(virStreamPtr stream, * * Returns 0 on success, -1 on error * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamEventRemoveCallback(virStreamPtr stream) @@ -1202,7 +1202,7 @@ virStreamEventRemoveCallback(virStreamPtr stream) * * Returns 0 on success, -1 upon error * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamFinish(virStreamPtr stream) @@ -1246,7 +1246,7 @@ virStreamFinish(virStreamPtr stream) * * Returns 0 on success, -1 upon error * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamAbort(virStreamPtr stream) @@ -1292,7 +1292,7 @@ virStreamAbort(virStreamPtr stream) * * Returns 0 upon success, or -1 on error * - * Since: v0.7.2 + * Since: 0.7.2 */ int virStreamFree(virStreamPtr stream) diff --git a/src/libvirt.c b/src/libvirt.c index ec685355b1..b78b49a632 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -297,7 +297,7 @@ virGlobalInit(void) * * Returns 0 in case of success, -1 in case of error * - * Since: v0.1.0 + * Since: 0.1.0 */ int virInitialize(void) @@ -800,7 +800,7 @@ virStateStop(void) * Returns -1 in case of failure, 0 otherwise, and values for @libVer and * @typeVer have the format major * 1,000,000 + minor * 1,000 + release. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virGetVersion(unsigned long *libVer, const char *type G_GNUC_UNUSED, @@ -1190,7 +1190,7 @@ virConnectOpenInternal(const char *name, * * Returns a pointer to the hypervisor connection or NULL in case of error * - * Since: v0.0.3 + * Since: 0.0.3 */ virConnectPtr virConnectOpen(const char *name) @@ -1225,7 +1225,7 @@ virConnectOpen(const char *name) * * Returns a pointer to the hypervisor connection or NULL in case of error * - * Since: v0.0.3 + * Since: 0.0.3 */ virConnectPtr virConnectOpenReadOnly(const char *name) @@ -1261,7 +1261,7 @@ virConnectOpenReadOnly(const char *name) * * Returns a pointer to the hypervisor connection or NULL in case of error * - * Since: v0.4.0 + * Since: 0.4.0 */ virConnectPtr virConnectOpenAuth(const char *name, @@ -1311,7 +1311,7 @@ virConnectOpenAuth(const char *name, * connection, but the application should not try to further use a * connection after the virConnectClose that matches the initial open. * - * Since: v0.0.3 + * Since: 0.0.3 */ int virConnectClose(virConnectPtr conn) diff --git a/src/util/virerror.c b/src/util/virerror.c index ea320ebbf1..5c8b9ebeb5 100644 --- a/src/util/virerror.c +++ b/src/util/virerror.c @@ -255,7 +255,7 @@ virLastErrorObject(void) * * Returns a pointer to the last error or NULL if none occurred. * - * Since: v0.1.0 + * Since: 0.1.0 */ virErrorPtr virGetLastError(void) @@ -274,7 +274,7 @@ virGetLastError(void) * * Returns the most recent error code, or VIR_ERR_OK if none is set. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virGetLastErrorCode(void) @@ -294,7 +294,7 @@ virGetLastErrorCode(void) * Returns a numerical value of the most recent error's origin, or VIR_FROM_NONE * if none is set. * - * Since: v4.5.0 + * Since: 4.5.0 */ int virGetLastErrorDomain(void) @@ -314,7 +314,7 @@ virGetLastErrorDomain(void) * Returns the most recent error message string in this * thread, or a generic message if none is set * - * Since: v1.0.6 + * Since: 1.0.6 */ const char * virGetLastErrorMessage(void) @@ -370,7 +370,7 @@ virSetError(virErrorPtr newerr) * * Returns error code or -1 in case of parameter error. * - * Since: v0.1.0 + * Since: 0.1.0 */ int virCopyLastError(virErrorPtr to) @@ -403,7 +403,7 @@ virCopyLastError(virErrorPtr to) * It is the caller's responsibility to free the error with * virFreeError(). * - * Since: v0.6.1 + * Since: 0.6.1 */ virErrorPtr virSaveLastError(void) @@ -468,7 +468,7 @@ virErrorRestore(virErrorPtr *savederr) * * Reset the error being pointed to * - * Since: v0.1.0 + * Since: 0.1.0 */ void virResetError(virErrorPtr err) @@ -488,7 +488,7 @@ virResetError(virErrorPtr err) * * Resets and frees the given error. * - * Since: v0.6.1 + * Since: 0.6.1 */ void virFreeError(virErrorPtr err) @@ -506,7 +506,7 @@ virFreeError(virErrorPtr err) * threads can safely access this concurrently, only resetting * their own error object. * - * Since: v0.1.0 + * Since: 0.1.0 */ void virResetLastError(void) @@ -538,7 +538,7 @@ virResetLastError(void) * * Returns a pointer to the last error or NULL if none occurred. * - * Since: v0.1.0 + * Since: 0.1.0 */ virErrorPtr virConnGetLastError(virConnectPtr conn) @@ -574,7 +574,7 @@ virConnGetLastError(virConnectPtr conn) * Returns 0 if no error was found and the error code otherwise and -1 in case * of parameter error. * - * Since: v0.1.0 + * Since: 0.1.0 */ int virConnCopyLastError(virConnectPtr conn, virErrorPtr to) @@ -602,7 +602,7 @@ virConnCopyLastError(virConnectPtr conn, virErrorPtr to) * * Reset the last error caught on that connection * - * Since: v0.1.0 + * Since: 0.1.0 */ void virConnResetLastError(virConnectPtr conn) @@ -623,7 +623,7 @@ virConnResetLastError(virConnectPtr conn) * it will reset to default printing on stderr. The error raised there * are those for which no handler at the connection level could caught. * - * Since: v0.1.0 + * Since: 0.1.0 */ void virSetErrorFunc(void *userData, virErrorFunc handler) @@ -642,7 +642,7 @@ virSetErrorFunc(void *userData, virErrorFunc handler) * it will reset to default which is to pass error back to the global * library handler. * - * Since: v0.1.0 + * Since: 0.1.0 */ void virConnSetErrorFunc(virConnectPtr conn, void *userData, @@ -662,7 +662,7 @@ virConnSetErrorFunc(virConnectPtr conn, void *userData, * * Default routine reporting an error to stderr. * - * Since: v0.1.0 + * Since: 0.1.0 */ void virDefaultErrorFunc(virErrorPtr err) diff --git a/src/util/virevent.c b/src/util/virevent.c index 6add093216..e625183a7f 100644 --- a/src/util/virevent.c +++ b/src/util/virevent.c @@ -70,7 +70,7 @@ static virEventRemoveTimeoutFunc removeTimeoutImpl; * Returns -1 if the file handle cannot be registered, otherwise a handle * watch number to be used for updating and unregistering for events. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virEventAddHandle(int fd, @@ -97,7 +97,7 @@ virEventAddHandle(int fd, * * Will not fail if fd exists. * - * Since: v0.9.3 + * Since: 0.9.3 */ void virEventUpdateHandle(int watch, int events) @@ -117,7 +117,7 @@ virEventUpdateHandle(int watch, int events) * * Returns -1 if the file handle was not registered, 0 upon success. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virEventRemoveHandle(int watch) @@ -146,7 +146,7 @@ virEventRemoveHandle(int watch) * Returns -1 if the timer cannot be registered, a positive * integer timer id upon success. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virEventAddTimeout(int timeout, @@ -175,7 +175,7 @@ virEventAddTimeout(int timeout, * * Will not fail if timer exists. * - * Since: v0.9.3 + * Since: 0.9.3 */ void virEventUpdateTimeout(int timer, int timeout) @@ -195,7 +195,7 @@ virEventUpdateTimeout(int timer, int timeout) * * Returns -1 if the timer was not registered, 0 upon success. * - * Since: v0.9.3 + * Since: 0.9.3 */ int virEventRemoveTimeout(int timer) @@ -245,7 +245,7 @@ virEventRemoveTimeout(int timer) * to stop running the event loop immediately after closing * the connection. * - * Since: v0.5.0 + * Since: 0.5.0 */ void virEventRegisterImpl(virEventAddHandleFunc addHandle, virEventUpdateHandleFunc updateHandle, @@ -315,7 +315,7 @@ int virEventRequireImpl(void) * * Returns 0 on success, -1 on failure. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virEventRegisterDefaultImpl(void) { @@ -352,7 +352,7 @@ int virEventRegisterDefaultImpl(void) * * Returns 0 on success, -1 on failure. * - * Since: v0.9.0 + * Since: 0.9.0 */ int virEventRunDefaultImpl(void) { diff --git a/src/util/virtypedparam-public.c b/src/util/virtypedparam-public.c index 1aea13149f..5bd207d1e6 100644 --- a/src/util/virtypedparam-public.c +++ b/src/util/virtypedparam-public.c @@ -128,7 +128,7 @@ virTypedParameterAssignFromStr(virTypedParameterPtr param, * Returns pointer to the parameter or NULL if it does not exist in @params. * This function does not raise an error, even when returning NULL. * - * Since: v1.0.2 + * Since: 1.0.2 */ virTypedParameterPtr virTypedParamsGet(virTypedParameterPtr params, @@ -179,7 +179,7 @@ virTypedParamsGet(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetInt(virTypedParameterPtr params, @@ -217,7 +217,7 @@ virTypedParamsGetInt(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetUInt(virTypedParameterPtr params, @@ -255,7 +255,7 @@ virTypedParamsGetUInt(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetLLong(virTypedParameterPtr params, @@ -293,7 +293,7 @@ virTypedParamsGetLLong(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetULLong(virTypedParameterPtr params, @@ -331,7 +331,7 @@ virTypedParamsGetULLong(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetDouble(virTypedParameterPtr params, @@ -369,7 +369,7 @@ virTypedParamsGetDouble(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetBoolean(virTypedParameterPtr params, @@ -409,7 +409,7 @@ virTypedParamsGetBoolean(virTypedParameterPtr params, * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsGetString(virTypedParameterPtr params, @@ -450,7 +450,7 @@ virTypedParamsGetString(virTypedParameterPtr params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddInt(virTypedParameterPtr *params, @@ -498,7 +498,7 @@ virTypedParamsAddInt(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddUInt(virTypedParameterPtr *params, @@ -546,7 +546,7 @@ virTypedParamsAddUInt(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddLLong(virTypedParameterPtr *params, @@ -594,7 +594,7 @@ virTypedParamsAddLLong(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddULLong(virTypedParameterPtr *params, @@ -642,7 +642,7 @@ virTypedParamsAddULLong(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddDouble(virTypedParameterPtr *params, @@ -690,7 +690,7 @@ virTypedParamsAddDouble(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddBoolean(virTypedParameterPtr *params, @@ -740,7 +740,7 @@ virTypedParamsAddBoolean(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddString(virTypedParameterPtr *params, @@ -788,7 +788,7 @@ virTypedParamsAddString(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.2.17 + * Since: 1.2.17 */ int virTypedParamsAddStringList(virTypedParameterPtr *params, @@ -835,7 +835,7 @@ virTypedParamsAddStringList(virTypedParameterPtr *params, * * Returns 0 on success, -1 on error. * - * Since: v1.0.2 + * Since: 1.0.2 */ int virTypedParamsAddFromString(virTypedParameterPtr *params, @@ -875,7 +875,7 @@ virTypedParamsAddFromString(virTypedParameterPtr *params, * * Returns nothing. * - * Since: v1.0.2 + * Since: 1.0.2 */ void virTypedParamsClear(virTypedParameterPtr params, @@ -903,7 +903,7 @@ virTypedParamsClear(virTypedParameterPtr params, * * Returns nothing. * - * Since: v1.0.2 + * Since: 1.0.2 */ void virTypedParamsFree(virTypedParameterPtr params, -- 2.35.1

On Wed, May 04, 2022 at 01:11:24PM +0200, Victor Toso wrote: *mandatory Needless to say, it would be amazing if this didn't have to be changed in two separate spots... Lots of opportunities for refactoring for someone with a strong will and a stronger stomach :) Reviewed-by: Andrea Bolognani <abologna(a)redhat.com&gt; and pushed along with the previous patch. -- Andrea Bolognani / Red Hat / Virtualization