[PATCH v2 08/34] docs: generated: typedefs: libvirt: append 'Since version' metadata

There were a few style fixes introduced with this commit. With 'style fixes', I mean the docstring enforced/used by scripts/apibuild.py As most of the metadata was generated by a script, it did not seem useful to split the style fixes with those generated by the script. In the end, they are all typedef fixes that are related to appending *Since* metadata. Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-domain-checkpoint.h | 18 +- include/libvirt/libvirt-domain-snapshot.h | 24 +- include/libvirt/libvirt-domain.h | 583 +++++++++++++++++++- include/libvirt/libvirt-event.h | 3 + include/libvirt/libvirt-host.h | 100 +++- include/libvirt/libvirt-interface.h | 13 +- include/libvirt/libvirt-network.h | 50 +- include/libvirt/libvirt-nodedev.h | 22 +- include/libvirt/libvirt-nwfilter.h | 12 + include/libvirt/libvirt-secret.h | 22 +- include/libvirt/libvirt-storage.h | 81 +++ include/libvirt/libvirt-stream.h | 18 + include/libvirt/virterror.h | 12 + 13 files changed, 913 insertions(+), 45 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/libvirt-domain-checkpoint.h index a59578b857..1a1631b9cf 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -34,6 +34,9 @@ * a domain. A checkpoint is useful for tracking which portions of the * 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 + * */ typedef struct _virDomainCheckpoint virDomainCheckpoint; @@ -43,6 +46,9 @@ typedef struct _virDomainCheckpoint virDomainCheckpoint; * A virDomainCheckpointPtr is pointer to a virDomainCheckpoint * private structure, and is the type used to reference a domain * checkpoint in the API. + * + * Since: v5.2.0 + * */ typedef virDomainCheckpoint *virDomainCheckpointPtr; @@ -50,6 +56,12 @@ const char *virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint); virDomainPtr virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint); virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint); +/** + * virDomainCheckpointCreateFlags: + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE = (1 << 0), /* Restore or alter metadata (Since: v5.6.0) */ @@ -86,7 +98,11 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, * flag (1<<0) depends on which function it is passed to; but serves * to toggle the per-call default of whether the listing is shallow or * recursive. Remaining bits come in groups; if all bits from a group - * are 0, then that group is not used to filter results. */ + * are 0, then that group is not used to filter results. + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_LIST_ROOTS = (1 << 0), /* Filter by checkpoints with no parents, when diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/libvirt-domain-snapshot.h index 40f7a95441..aa7bfa903a 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -34,6 +34,9 @@ * a domain. A snapshot captures the state of the domain at a point in * time, with the intent that the guest can be reverted back to that * state at a later time. + * + * Since: v1.0.0 + * */ typedef struct _virDomainSnapshot virDomainSnapshot; @@ -42,6 +45,9 @@ 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: v1.0.0 + * */ typedef virDomainSnapshot *virDomainSnapshotPtr; @@ -49,6 +55,12 @@ const char *virDomainSnapshotGetName(virDomainSnapshotPtr snapshot); virDomainPtr virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot); virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot); +/** + * virDomainSnapshotCreateFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE = (1 << 0), /* Restore or alter metadata (Since: v1.0.0) */ @@ -98,7 +110,11 @@ char *virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, * of flag (1<<0) depends on which function it is passed to; but serves * to toggle the per-call default of whether the listing is shallow or * recursive. Remaining bits come in groups; if all bits from a group are - * 0, then that group is not used to filter results. */ + * 0, then that group is not used to filter results. + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_LIST_ROOTS = (1 << 0), /* Filter by snapshots with no parents, when @@ -194,6 +210,12 @@ int virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot, int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, unsigned int flags); +/** + * virDomainSnapshotRevertFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: v1.0.0) */ VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: v1.0.0) */ diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 4983494a0b..912ed26a56 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -32,6 +32,9 @@ * virDomain: * * a virDomain is a private structure representing a domain. + * + * Since: v1.0.0 + * */ typedef struct _virDomain virDomain; @@ -40,6 +43,9 @@ 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: v1.0.0 + * */ typedef virDomain *virDomainPtr; @@ -47,6 +53,9 @@ typedef virDomain *virDomainPtr; * virDomainState: * * A domain may be in different states at a given point in time + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_NOSTATE = 0, /* no state (Since: v1.0.0) */ @@ -69,6 +78,12 @@ typedef enum { # endif } virDomainState; +/** + * virDomainNostateReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_NOSTATE_UNKNOWN = 0, @@ -77,6 +92,12 @@ typedef enum { # endif } virDomainNostateReason; +/** + * virDomainRunningReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_RUNNING_UNKNOWN = 0, VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: v1.0.0) */ @@ -96,6 +117,12 @@ typedef enum { # endif } virDomainRunningReason; +/** + * virDomainBlockedReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: v1.0.0) */ @@ -104,6 +131,12 @@ typedef enum { # endif } virDomainBlockedReason; +/** + * virDomainPausedReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: v1.0.0) */ VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: v1.0.0) */ @@ -125,6 +158,12 @@ typedef enum { # endif } virDomainPausedReason; +/** + * virDomainShutdownReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: v1.0.0) */ VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: v1.0.0) */ @@ -134,6 +173,12 @@ typedef enum { # endif } virDomainShutdownReason; +/** + * virDomainShutoffReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: v1.0.0) */ VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: v1.0.0) */ @@ -151,6 +196,12 @@ typedef enum { # endif } virDomainShutoffReason; +/** + * virDomainCrashedReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: v1.0.0) */ VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: v1.1.1) */ @@ -160,6 +211,12 @@ typedef enum { # endif } virDomainCrashedReason; +/** + * virDomainPMSuspendedReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, @@ -168,6 +225,12 @@ typedef enum { # endif } virDomainPMSuspendedReason; +/** + * virDomainPMSuspendedDiskReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, @@ -180,6 +243,9 @@ typedef enum { * virDomainControlState: * * Current state of a control interface to the domain. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: v1.0.0) */ @@ -200,6 +266,9 @@ typedef enum { * virDomainControlErrorReason: * * Reason for the error state. + * + * Since: v1.2.14 + * */ typedef enum { VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0, /* server didn't provide a @@ -221,6 +290,9 @@ typedef enum { * * Structure filled in by virDomainGetControlInfo and providing details about * current state of control interface to a domain. + * + * Since: v1.0.0 + * */ typedef struct _virDomainControlInfo virDomainControlInfo; struct _virDomainControlInfo { @@ -236,6 +308,9 @@ struct _virDomainControlInfo { * virDomainControlInfoPtr: * * Pointer to virDomainControlInfo structure. + * + * Since: v1.0.0 + * */ typedef virDomainControlInfo *virDomainControlInfoPtr; @@ -256,6 +331,9 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * (whether or not it is running). * * These enums should not conflict with those of virTypedParameterFlags. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: v1.0.0) */ @@ -265,12 +343,14 @@ typedef enum { } virDomainModificationImpact; /** - * virDomainInfoPtr: + * virDomainInfo: * * a virDomainInfo is a structure filled by virDomainGetInfo() and extracting * runtime information for a given active Domain + * + * Since: v1.0.0 + * */ - typedef struct _virDomainInfo virDomainInfo; struct _virDomainInfo { @@ -285,6 +365,9 @@ struct _virDomainInfo { * virDomainInfoPtr: * * a virDomainInfoPtr is a pointer to a virDomainInfo structure. + * + * Since: v1.0.0 + * */ typedef virDomainInfo *virDomainInfoPtr; @@ -294,6 +377,9 @@ typedef virDomainInfo *virDomainInfoPtr; * * Flags OR'ed together to provide specific behaviour when creating a * Domain. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_NONE = 0, /* Default behavior (Since: v1.0.0) */ @@ -487,7 +573,7 @@ int virDomainSetSchedulerParametersFlags (virDomainPtr domain, unsigned int flags); /** - * virDomainBlockStats: + * virDomainBlockStatsStruct: * * Block device stats for virDomainBlockStats. * @@ -495,6 +581,9 @@ int virDomainSetSchedulerParametersFlags (virDomainPtr domain, * that the hypervisor does not support that statistic. * * NB. Here 'long long' means 64 bit integer. + * + * Since: v1.0.0 + * */ typedef struct _virDomainBlockStats virDomainBlockStatsStruct; @@ -510,6 +599,9 @@ struct _virDomainBlockStats { * virDomainBlockStatsPtr: * * A pointer to a virDomainBlockStats structure + * + * Since: v1.0.0 + * */ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; @@ -624,7 +716,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; # define VIR_DOMAIN_BLOCK_STATS_ERRS "errs" /** - * virDomainInterfaceStats: + * virDomainInterfaceStatsStruct: * * Network interface stats for virDomainInterfaceStats. * @@ -632,6 +724,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; * that the hypervisor does not support that statistic. * * NB. Here 'long long' means 64 bit integer. + * + * Since: v1.0.0 + * */ typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct; @@ -650,11 +745,19 @@ struct _virDomainInterfaceStats { * virDomainInterfaceStatsPtr: * * A pointer to a virDomainInterfaceStats structure + * + * Since: v1.0.0 + * */ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr; /** + * virDomainMemoryStatTags: + * * Memory Statistics Tags: + * + * Since: v1.0.0 + * */ typedef enum { /* The total amount of data read from swap space (in kB). (Since: v1.0.0) */ @@ -768,6 +871,12 @@ typedef enum { # endif } virDomainMemoryStatTags; +/** + * virDomainMemoryStatStruct: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainMemoryStat virDomainMemoryStatStruct; struct _virDomainMemoryStat { @@ -775,6 +884,12 @@ struct _virDomainMemoryStat { unsigned long long val; }; +/** + * *virDomainMemoryStatPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; @@ -791,6 +906,9 @@ typedef enum { * virDomainCoreDumpFormat: * * Values for specifying different formats of domain core dumps. + * + * Since: v1.2.3 + * */ typedef enum { VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: v1.2.3) */ @@ -811,7 +929,14 @@ typedef enum { # endif } virDomainCoreDumpFormat; -/* Domain migration flags. */ +/** + * virDomainMigrateFlags: + * + * Domain migration flags. + * + * Since: v1.0.0 + * + */ typedef enum { /* Do not pause the domain during migration. The domain's memory will * be transferred to the destination host while the domain is running. @@ -1361,7 +1486,14 @@ int virDomainMigrateSetCompressionCache(virDomainPtr domain, unsigned long long cacheSize, unsigned int flags); -/* Domain migration speed flags. */ +/** + * virDomainMigrateMaxSpeedFlags: + * + * Domain migration speed flags. + * + * Since: v5.1.0 + * + */ typedef enum { /* Set or get maximum speed of post-copy migration. (Since: v5.1.0) */ VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY = (1 << 0), @@ -1424,6 +1556,12 @@ virDomainPtr virDomainLookupByUUID (virConnectPtr conn, virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn, const char *uuid); +/** + * virDomainShutdownFlagValues: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: v1.0.0) */ VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v1.0.0) */ @@ -1437,6 +1575,12 @@ int virDomainShutdown (virDomainPtr domain); int virDomainShutdownFlags (virDomainPtr domain, unsigned int flags); +/** + * virDomainRebootFlagValues: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: v1.0.0) */ VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v1.0.0) */ @@ -1458,6 +1602,9 @@ int virDomainDestroy (virDomainPtr domain); * * Flags used to provide specific behaviour to the * virDomainDestroyFlags() function + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: v1.0.0) */ @@ -1487,9 +1634,13 @@ int virDomainPMWakeup (virDomainPtr domain, /** * virDomainSaveRestoreFlags: + * * Flags for use in virDomainSaveFlags(), virDomainManagedSave(), * virDomainRestoreFlags(), and virDomainSaveImageDefineXML(). Not all * flags apply to all these functions. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: v1.0.0) */ @@ -1788,7 +1939,14 @@ int virDomainGetMemoryParameters(virDomainPtr domain, virTypedParameterPtr params, int *nparams, unsigned int flags); -/* Memory size modification flags. */ +/** + * virDomainMemoryModFlags: + * + * Memory size modification flags. + * + * Since: v1.0.0 + * + */ typedef enum { /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, @@ -1806,6 +1964,9 @@ typedef enum { * virDomainNumatuneMemMode: * Representation of the various modes in the <numatune> element of * a domain. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, @@ -1882,6 +2043,12 @@ char * virDomainGetHostname (virDomainPtr domain, int virDomainGetSecurityLabelList (virDomainPtr domain, virSecurityLabelPtr* seclabels); +/** + * virDomainMetadataType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: v1.0.0) */ VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: v1.0.0) */ @@ -1909,12 +2076,15 @@ virDomainGetMetadata(virDomainPtr domain, /* * XML domain description */ + /** * virDomainXMLFlags: * * Flags available for virDomainGetXMLDesc + * + * Since: v1.0.0 + * */ - typedef enum { VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: v1.0.0) */ VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: v1.0.0) */ @@ -1922,6 +2092,12 @@ typedef enum { VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: v1.0.0) */ } virDomainXMLFlags; +/** + * virDomainSaveImageXMLFlags: + * + * Since: v5.1.0 + * + */ typedef enum { VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */ } virDomainSaveImageXMLFlags; @@ -2047,6 +2223,9 @@ int virDomainBlockPeek (virDomainPtr dom, * virDomainBlockResizeFlags: * * Flags available for virDomainBlockResize(). + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: v1.0.0) */ @@ -2080,8 +2259,18 @@ int virDomainBlockResize (virDomainPtr dom, * * capacity: logical size from qcow2 header * * allocation: highest qcow extent written for an active domain * * physical: size of the block device container + * + * Since: v1.0.0 + * */ typedef struct _virDomainBlockInfo virDomainBlockInfo; + +/** + * virDomainBlockInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainBlockInfo *virDomainBlockInfoPtr; struct _virDomainBlockInfo { unsigned long long capacity; /* logical size in bytes of the @@ -2136,6 +2325,12 @@ virDomainPtr virDomainDefineXMLFlags (virConnectPtr conn, unsigned int flags); int virDomainUndefine (virDomainPtr domain); +/** + * virDomainUndefineFlagsValues: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = (1 << 0), /* Also remove any managed save (Since: v1.0.0) */ @@ -2165,6 +2360,8 @@ int virConnectListDefinedDomains (virConnectPtr conn, * Flags used to tune which domains are listed by virConnectListAllDomains(). * 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 */ typedef enum { VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, @@ -2209,9 +2406,13 @@ int virDomainSetAutostart (virDomainPtr domain, int autostart); /** - * virVcpuInfo: structure for information about a virtual CPU in a domain. + * virVcpuState: + * + * structure for information about a virtual CPU in a domain. + * + * Since: v1.0.0 + * */ - typedef enum { VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: v1.0.0) */ VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: v1.0.0) */ @@ -2227,6 +2428,12 @@ typedef enum { VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information (Since: v6.10.0) */ } virVcpuHostCpuState; +/** + * virVcpuInfo: + * + * Since: v1.0.0 + * + */ typedef struct _virVcpuInfo virVcpuInfo; struct _virVcpuInfo { unsigned int number; /* virtual CPU number */ @@ -2234,9 +2441,23 @@ struct _virVcpuInfo { unsigned long long cpuTime; /* CPU time used, in nanoseconds */ int cpu; /* real CPU number, or one of the values from virVcpuHostCpuState */ }; + +/** + * *virVcpuInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virVcpuInfo *virVcpuInfoPtr; -/* Flags for controlling virtual CPU hot-plugging. */ +/** + * virDomainVcpuFlags: + * + * Flags for controlling virtual CPU hot-plugging. + * + * Since: v1.0.0 + * + */ typedef enum { /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, @@ -2284,9 +2505,12 @@ int virDomainGetEmulatorPinInfo (virDomainPtr domain, unsigned int flags); /** - * virIOThreadInfo: + * virDomainIOThreadInfo: * * The data structure for information about all IOThreads in a domain + * + * Since: v1.2.14 + * */ typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo; typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr; @@ -2485,6 +2709,12 @@ int virDomainGetVcpus (virDomainPtr domain, # define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (maplen)])) +/** + * virDomainDeviceModifyFlags: + * + * Since: v1.0.0 + * + */ typedef enum { /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, @@ -2509,6 +2739,12 @@ int virDomainUpdateDeviceFlags(virDomainPtr domain, int virDomainDetachDeviceAlias(virDomainPtr domain, const char *alias, unsigned int flags); +/** + * virDomainStatsRecord: + * + * Since: v1.2.8 + * + */ typedef struct _virDomainStatsRecord virDomainStatsRecord; typedef virDomainStatsRecord *virDomainStatsRecordPtr; struct _virDomainStatsRecord { @@ -2517,6 +2753,12 @@ struct _virDomainStatsRecord { int nparams; }; +/** + * virDomainStatsTypes: + * + * Since: v1.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) */ @@ -2873,6 +3115,9 @@ int virDomainSetPerfEvents(virDomainPtr dom, * virDomainBlockJobType: * * Describes various possible block jobs. + * + * Since: v1.0.0 + * */ typedef enum { /* Placeholder (Since: v1.0.0) */ @@ -2923,6 +3168,9 @@ typedef enum { * VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC: Request only, do not wait for completion * VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT: Pivot to new file when ending a copy or * active commit job + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, @@ -2941,6 +3189,12 @@ typedef enum { /* An iterator for monitoring block job operations */ typedef unsigned long long virDomainBlockJobCursor; +/** + * virDomainBlockJobInfo: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo; struct _virDomainBlockJobInfo { int type; /* virDomainBlockJobType */ @@ -2955,6 +3209,13 @@ struct _virDomainBlockJobInfo { virDomainBlockJobCursor cur; virDomainBlockJobCursor end; }; + +/** + * *virDomainBlockJobInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainBlockJobInfo *virDomainBlockJobInfoPtr; int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, @@ -2984,6 +3245,9 @@ int virDomainBlockPull(virDomainPtr dom, const char *disk, * virDomainBlockRebaseFlags: * * Flags available for virDomainBlockRebase(). + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1 << 0, /* Limit copy to top of source @@ -3009,6 +3273,9 @@ int virDomainBlockRebase(virDomainPtr dom, const char *disk, * virDomainBlockCopyFlags: * * Flags available for virDomainBlockCopy(). + * + * Since: v1.2.8 + * */ typedef enum { /* Limit copy to top of source backing chain (Since: v1.2.8) */ @@ -3086,6 +3353,9 @@ int virDomainBlockCopy(virDomainPtr dom, const char *disk, * virDomainBlockCommitFlags: * * Flags available for virDomainBlockCommit(). + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1 << 0, /* NULL base means next backing @@ -3342,6 +3612,9 @@ virDomainGetBlockIoTune(virDomainPtr dom, * virDomainDiskErrorCode: * * Disk I/O error. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: v1.0.0) */ @@ -3356,8 +3629,17 @@ typedef enum { /** * virDomainDiskError: * + * Since: v1.0.0 + * */ typedef struct _virDomainDiskError virDomainDiskError; + +/** + * *virDomainDiskErrorPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainDiskError *virDomainDiskErrorPtr; struct _virDomainDiskError { @@ -3376,6 +3658,9 @@ int virDomainGetDiskErrors(virDomainPtr dom, * virKeycodeSet: * * Enum to specify which keycode mapping is in use for virDomainSendKey(). + * + * Since: v1.0.0 + * */ typedef enum { VIR_KEYCODE_SET_LINUX = 0, @@ -3426,7 +3711,9 @@ int virDomainSendKey(virDomainPtr domain, int nkeycodes, unsigned int flags); -/* +/** + * virDomainProcessSignal: + * * These just happen to match Linux signal numbers. The numbers * will be mapped to whatever the SIGNUM is in the guest OS in * question by the agent delivering the signal. The names are @@ -3435,6 +3722,9 @@ int virDomainSendKey(virDomainPtr domain, * Do not rely on all values matching Linux though. It is possible * this enum might be extended with new signals which have no * mapping in Linux. + * + * Since: v1.0.1 + * */ typedef enum { VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: v1.0.1) */ @@ -3535,6 +3825,9 @@ virDomainPtr virDomainCreateLinux (virConnectPtr conn, * virDomainEventType: * * a virDomainEventType is emitted during domain lifecycle events + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_DEFINED = 0, @@ -3556,6 +3849,9 @@ typedef enum { * virDomainEventDefinedDetailType: * * Details on the cause of a 'defined' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: v1.0.0) */ @@ -3572,6 +3868,9 @@ typedef enum { * virDomainEventUndefinedDetailType: * * Details on the cause of an 'undefined' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: v1.0.0) */ @@ -3586,6 +3885,9 @@ typedef enum { * virDomainEventStartedDetailType: * * Details on the cause of a 'started' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: v1.0.0) */ @@ -3603,6 +3905,9 @@ typedef enum { * virDomainEventSuspendedDetailType: * * Details on the cause of a 'suspended' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: v1.0.0) */ @@ -3624,6 +3929,9 @@ typedef enum { * virDomainEventResumedDetailType: * * Details on the cause of a 'resumed' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: v1.0.0) */ @@ -3641,6 +3949,9 @@ typedef enum { * virDomainEventStoppedDetailType: * * Details on the cause of a 'stopped' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: v1.0.0) */ @@ -3661,6 +3972,9 @@ typedef enum { * virDomainEventShutdownDetailType: * * Details on the cause of a 'shutdown' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { /* Guest finished shutdown sequence (Since: v1.0.0) */ @@ -3686,6 +4000,9 @@ typedef enum { * virDomainEventPMSuspendedDetailType: * * Details on the cause of a 'pmsuspended' lifecycle event + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: v1.0.0) */ @@ -3700,6 +4017,9 @@ typedef enum { * virDomainEventCrashedDetailType: * * Details on the cause of a 'crashed' lifecycle event + * + * Since: v1.1.1 + * */ typedef enum { VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: v1.1.1) */ @@ -3714,6 +4034,9 @@ typedef enum { * virDomainMemoryFailureRecipientType: * * Recipient of a memory failure event. + * + * Since: v6.9.0 + * */ typedef enum { /* memory failure at hypersivor memory address space (Since: v6.9.0) */ @@ -3732,6 +4055,9 @@ typedef enum { * virDomainMemoryFailureActionType: * * Action of a memory failure event. + * + * Since: v6.9.0 + * */ typedef enum { /* the memory failure could be ignored. This will only be the case for @@ -3769,6 +4095,12 @@ typedef enum { } virDomainMemoryFailureActionType; +/** + * virDomainMemoryFailureFlags: + * + * Since: v6.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) */ @@ -3814,6 +4146,12 @@ int virDomainIsActive(virDomainPtr dom); int virDomainIsPersistent(virDomainPtr dom); int virDomainIsUpdated(virDomainPtr dom); +/** + * virDomainJobType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: v1.0.0) */ VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: v1.0.0) */ @@ -3827,7 +4165,20 @@ typedef enum { # endif } virDomainJobType; +/** + * virDomainJobInfo: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainJobInfo virDomainJobInfo; + +/** + * *virDomainJobInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainJobInfo *virDomainJobInfoPtr; struct _virDomainJobInfo { /* One of virDomainJobType */ @@ -3868,6 +4219,9 @@ struct _virDomainJobInfo { * * Flags OR'ed together to provide specific behavior when querying domain * job statistics. + * + * Since: v1.2.9 + * */ typedef enum { VIR_DOMAIN_JOB_STATS_COMPLETED = 1 << 0, /* return stats of a recently @@ -3885,6 +4239,12 @@ int virDomainGetJobStats(virDomainPtr domain, unsigned int flags); int virDomainAbortJob(virDomainPtr dom); +/** + * virDomainJobOperation: + * + * Since: v3.3.0 + * + */ typedef enum { VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, VIR_DOMAIN_JOB_OPERATION_START = 1, @@ -4376,6 +4736,9 @@ typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn, * virDomainEventWatchdogAction: * * The action that is to be taken due to the watchdog device firing + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: v1.0.0) */ @@ -4411,6 +4774,9 @@ typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn, * virDomainEventIOErrorAction: * * The action that is to be taken due to an IO error occurring + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: v1.0.0) */ @@ -4474,6 +4840,9 @@ typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr conn, * virDomainEventGraphicsPhase: * * The phase of the graphics client connection + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: v1.0.0) */ @@ -4489,6 +4858,9 @@ typedef enum { * virDomainEventGraphicsAddressType: * * The type of address for the connection + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: v1.0.0) */ @@ -4502,22 +4874,38 @@ typedef enum { /** - * virDomainEventGraphicsAddress: + * _virDomainEventGraphicsAddress: * * The data structure containing connection address details * + * Since: v1.0.0 + * */ struct _virDomainEventGraphicsAddress { int family; /* Address family, virDomainEventGraphicsAddressType */ char *node; /* Address of node (eg IP address, or UNIX path) */ char *service; /* Service name/number (eg TCP port, or NULL) */ }; + +/** + * virDomainEventGraphicsAddress: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddress; + +/** + * virDomainEventGraphicsAddressPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainEventGraphicsAddress *virDomainEventGraphicsAddressPtr; /** - * virDomainEventGraphicsSubjectIdentity: + * _virDomainEventGraphicsSubjectIdentity: * * The data structure representing a single identity * @@ -4528,7 +4916,21 @@ struct _virDomainEventGraphicsSubjectIdentity { char *type; /* Type of identity */ char *name; /* Identity value */ }; + +/** + * virDomainEventGraphicsSubjectIdentity: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphicsSubjectIdentity; + +/** + * virDomainEventGraphicsSubjectIdentityPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubjectIdentityPtr; @@ -4539,12 +4941,29 @@ typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubjectIden * * A subject will have zero or more identities. The types of * identity differ according to the authentication scheme + * + * Since: v1.0.0 + * */ struct _virDomainEventGraphicsSubject { int nidentity; /* Number of identities in array*/ virDomainEventGraphicsSubjectIdentityPtr identities; /* Array of identities for subject */ }; + +/** + * virDomainEventGraphicsSubject: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubject; + +/** + * virDomainEventGraphicsSubjectPtr: + * + * Since: v1.0.0 + * + */ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr; @@ -4576,6 +4995,9 @@ typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn, * * Tracks status of a virDomainBlockPull(), virDomainBlockRebase(), * virDomainBlockCopy(), or virDomainBlockCommit() operation + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, @@ -4623,6 +5045,9 @@ typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn, * virConnectDomainEventDiskChangeReason: * * The reason describing why this callback is called + * + * Since: v1.0.0 + * */ typedef enum { /* Removable media changed to empty according to startup policy as source @@ -4675,6 +5100,9 @@ typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn, * virDomainEventTrayChangeReason: * * The reason describing why the callback was called + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, @@ -5292,6 +5720,12 @@ typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn, void *opaque); +/** + * virConnectDomainEventAgentLifecycleState: + * + * Since: v1.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) */ @@ -5301,6 +5735,12 @@ typedef enum { # endif } virConnectDomainEventAgentLifecycleState; +/** + * virConnectDomainEventAgentLifecycleReason: + * + * Since: v1.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) */ @@ -5428,6 +5868,9 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPt * An enumeration of supported eventId parameters for * virConnectDomainEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v1.0.0 + * */ typedef enum { VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: v1.0.0) */ @@ -5482,9 +5925,10 @@ int virConnectDomainEventDeregisterAny(virConnectPtr conn, /** - * virDomainConsoleFlags + * virDomainConsoleFlags: + * + * Since: v0.9.10 * - * Since 0.9.10 */ typedef enum { @@ -5501,9 +5945,9 @@ int virDomainOpenConsole(virDomainPtr dom, unsigned int flags); /** - * virDomainChannelFlags + * virDomainChannelFlags: * - * Since 1.0.2 + * Since: v1.0.2 */ typedef enum { VIR_DOMAIN_CHANNEL_FORCE = (1 << 0), /* abort a (possibly) active channel @@ -5516,6 +5960,12 @@ int virDomainOpenChannel(virDomainPtr dom, virStreamPtr st, unsigned int flags); +/** + * virDomainOpenGraphicsFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), } virDomainOpenGraphicsFlags; @@ -5551,6 +6001,9 @@ int virDomainFSThaw(virDomainPtr dom, * * The data structure containing mounted file systems within a guset * + * Since: v1.2.11 + * + * */ typedef struct _virDomainFSInfo virDomainFSInfo; typedef virDomainFSInfo *virDomainFSInfoPtr; @@ -5586,8 +6039,10 @@ int virDomainSetTime(virDomainPtr dom, * virSchedParameterType: * * A scheduler parameter field type. Provided for backwards - * compatibility; virTypedParameterType is the preferred enum since - * 0.9.2. + * compatibility; virTypedParameterType is the preferred enum + * + * Since: v0.9.2 + * */ typedef enum { VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, @@ -5629,6 +6084,9 @@ typedef struct _virTypedParameter virSchedParameter; * a virSchedParameterPtr is a pointer to a virSchedParameter structure. * Provided for backwards compatibility; virTypedParameterPtr is the * preferred alias since 0.9.2. + * + * Since: v1.0.0 + * */ typedef virSchedParameter *virSchedParameterPtr; @@ -5636,8 +6094,10 @@ typedef virSchedParameter *virSchedParameterPtr; * virBlkioParameterType: * * A blkio parameter field type. Provided for backwards - * compatibility; virTypedParameterType is the preferred enum since - * 0.9.2. + * compatibility; virTypedParameterType is the preferred enum + * + * Since: v0.9.2 + * */ typedef enum { VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, @@ -5678,7 +6138,10 @@ typedef struct _virTypedParameter virBlkioParameter; * * a virBlkioParameterPtr is a pointer to a virBlkioParameter structure. * Provided for backwards compatibility; virTypedParameterPtr is the - * preferred alias since 0.9.2. + * preferred alias. + * + * Since: v0.9.2 + * */ typedef virBlkioParameter *virBlkioParameterPtr; @@ -5686,8 +6149,10 @@ typedef virBlkioParameter *virBlkioParameterPtr; * virMemoryParameterType: * * A memory parameter field type. Provided for backwards - * compatibility; virTypedParameterType is the preferred enum since - * 0.9.2. + * compatibility; virTypedParameterType is the preferred enum + * + * Since: v0.9.2 + * */ typedef enum { VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, @@ -5728,10 +6193,19 @@ typedef struct _virTypedParameter virMemoryParameter; * * a virMemoryParameterPtr is a pointer to a virMemoryParameter structure. * Provided for backwards compatibility; virTypedParameterPtr is the - * preferred alias since 0.9.2. + * preferred alias. + * + * Since: v0.9.2 + * */ typedef virMemoryParameter *virMemoryParameterPtr; +/** + * virDomainInterfaceAddressesSource: + * + * Since: v1.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) */ @@ -5742,7 +6216,20 @@ typedef enum { # endif } virDomainInterfaceAddressesSource; +/** + * virDomainIPAddress: + * + * Since: v1.2.14 + * + */ typedef struct _virDomainInterfaceIPAddress virDomainIPAddress; + +/** + * virDomainIPAddressPtr: + * + * Since: v1.2.14 + * + */ typedef virDomainIPAddress *virDomainIPAddressPtr; struct _virDomainInterfaceIPAddress { int type; /* virIPAddrType */ @@ -5750,6 +6237,12 @@ struct _virDomainInterfaceIPAddress { unsigned int prefix; /* IP address prefix */ }; +/** + * virDomainInterface: + * + * Since: v1.0.0 + * + */ typedef struct _virDomainInterface virDomainInterface; typedef virDomainInterface *virDomainInterfacePtr; struct _virDomainInterface { @@ -5799,6 +6292,12 @@ int virDomainSetBlockThreshold(virDomainPtr domain, unsigned long long threshold, unsigned int flags); +/** + * virDomainLifecycle: + * + * Since: v3.9.0 + * + */ typedef enum { VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, VIR_DOMAIN_LIFECYCLE_REBOOT = 1, @@ -5809,6 +6308,12 @@ typedef enum { # endif } virDomainLifecycle; +/** + * virDomainLifecycleAction: + * + * Since: v3.9.0 + * + */ typedef enum { VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* Since: v3.9.0 */ @@ -5936,6 +6441,12 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain, int nparams, unsigned int flags); +/** + * virDomainGuestInfoTypes: + * + * Since: v5.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) */ @@ -5952,6 +6463,12 @@ int virDomainGetGuestInfo(virDomainPtr domain, int *nparams, unsigned int flags); +/** + * virDomainAgentResponseTimeoutValues: + * + * Since: v5.10.0 + * + */ typedef enum { VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, @@ -5992,6 +6509,12 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, unsigned int nkeys, unsigned int flags); +/** + * virDomainMessageType: + * + * Since: v7.1.0 + * + */ typedef enum { VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), @@ -6005,6 +6528,9 @@ int virDomainGetMessages(virDomainPtr domain, * virDomainDirtyRateStatus: * * Details on the cause of a dirty rate calculation status. + * + * Since: v7.2.0 + * */ typedef enum { VIR_DOMAIN_DIRTYRATE_UNSTARTED = 0, /* the dirtyrate calculation has @@ -6025,6 +6551,9 @@ typedef enum { * Flags OR'ed together to provide specific behaviour when calculating dirty page * rate for a Domain * + * + * Since: v8.1.0 + * */ typedef enum { VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: v8.1.0) */ diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-event.h index facdc3a3ec..a5c73dda2a 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -34,6 +34,9 @@ * a virEventHandleType is used similar to POLLxxx FD events, but is specific * to libvirt. A client app must translate to, and from POLL events when using * this construct. + * + * Since: v1.0.0 + * */ typedef enum { VIR_EVENT_HANDLE_READABLE = (1 << 0), diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index a31fa2d9ee..a11bfb5f95 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -33,6 +33,9 @@ * * a virConnect is a private structure representing a connection to * the Hypervisor. + * + * Since: v1.0.0 + * */ typedef struct _virConnect virConnect; @@ -41,6 +44,9 @@ 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: v1.0.0 + * */ typedef virConnect *virConnectPtr; @@ -49,6 +55,9 @@ typedef virConnect *virConnectPtr; * * Flags to indicate which system-wide sleep state the host must be * transitioned to. + * + * Since: v1.0.0 + * */ typedef enum { VIR_NODE_SUSPEND_TARGET_MEM = 0, @@ -64,6 +73,9 @@ typedef enum { * virStream: * * a virStream is a private structure representing a data stream. + * + * Since: v1.0.0 + * */ typedef struct _virStream virStream; @@ -72,6 +84,9 @@ 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: v1.0.0 + * */ typedef virStream *virStreamPtr; @@ -92,6 +107,9 @@ typedef virStream *virStreamPtr; * a virSecurityLabel is a structure filled by virDomainGetSecurityLabel(), * providing the security label and associated attributes for the specified * domain. + * + * Since: v1.0.0 + * */ typedef struct _virSecurityLabel virSecurityLabel; @@ -104,6 +122,9 @@ struct _virSecurityLabel { * virSecurityLabelPtr: * * a virSecurityLabelPtr is a pointer to a virSecurityLabel. + * + * Since: v1.0.0 + * */ typedef virSecurityLabel *virSecurityLabelPtr; @@ -133,6 +154,9 @@ typedef virSecurityLabel *virSecurityLabelPtr; * a virSecurityModel is a structure filled by virNodeGetSecurityModel(), * providing the per-hypervisor security model and DOI attributes for the * specified domain. + * + * Since: v1.0.0 + * */ typedef struct _virSecurityModel virSecurityModel; @@ -145,6 +169,9 @@ struct _virSecurityModel { * virSecurityModelPtr: * * a virSecurityModelPtr is a pointer to a virSecurityModel. + * + * Since: v1.0.0 + * */ typedef virSecurityModel *virSecurityModelPtr; @@ -152,7 +179,7 @@ typedef virSecurityModel *virSecurityModelPtr; /* data types related to virNodePtr */ /** - * virNodeInfoPtr: + * virNodeInfo: * * a virNodeInfo is a structure filled by virNodeGetInfo() and providing * the information for the Node. @@ -160,8 +187,9 @@ typedef virSecurityModel *virSecurityModelPtr; * Note that the information in this struct is not guaranteed to be an * accurate relection of the system hardware. See the virNodeGetInfo() * API documentation for further guidance. + * + * Since: v1.0.0 */ - typedef struct _virNodeInfo virNodeInfo; struct _virNodeInfo { @@ -192,9 +220,12 @@ struct _virNodeInfo { # define VIR_NODE_CPU_STATS_FIELD_LENGTH 80 /** - * VIR_NODE_CPU_STATS_ALL_CPUS: + * virNodeGetCPUStatsAllCPUs: * * Value for specifying request for the total CPU time/utilization + * + * Since: v1.0.0 + * */ typedef enum { VIR_NODE_CPU_STATS_ALL_CPUS = -1, @@ -272,6 +303,9 @@ typedef enum { * * a virNodeCPUStats is a structure filled by virNodeGetCPUStats() * providing information about the CPU stats of the node. + * + * Since: v1.0.0 + * */ typedef struct _virNodeCPUStats virNodeCPUStats; @@ -291,9 +325,12 @@ struct _virNodeCPUStats { # define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80 /** - * VIR_NODE_MEMORY_STATS_ALL_CELLS: + * virNodeGetMemoryStatsAllCells: * * Value for specifying request for the total memory of all cells. + * + * Since: v1.0.0 + * */ typedef enum { VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, @@ -349,6 +386,9 @@ typedef enum { * * a virNodeMemoryStats is a structure filled by virNodeGetMemoryStats() * providing information about the memory of the node. + * + * Since: v1.0.0 + * */ typedef struct _virNodeMemoryStats virNodeMemoryStats; @@ -487,6 +527,9 @@ int virNodeGetCPUMap(virConnectPtr conn, * virNodeInfoPtr: * * a virNodeInfoPtr is a pointer to a virNodeInfo structure. + * + * Since: v1.0.0 + * */ typedef virNodeInfo *virNodeInfoPtr; @@ -495,6 +538,9 @@ typedef virNodeInfo *virNodeInfoPtr; * virNodeCPUStatsPtr: * * a virNodeCPUStatsPtr is a pointer to a virNodeCPUStats structure. + * + * Since: v1.0.0 + * */ typedef virNodeCPUStats *virNodeCPUStatsPtr; @@ -503,6 +549,9 @@ typedef virNodeCPUStats *virNodeCPUStatsPtr; * virNodeMemoryStatsPtr: * * a virNodeMemoryStatsPtr is a pointer to a virNodeMemoryStats structure. + * + * Since: v1.0.0 + * */ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; @@ -584,9 +633,12 @@ int virNodeGetSEVInfo (virConnectPtr conn, unsigned int flags); /** - * virConnectFlags + * virConnectFlags: * * Flags when opening a connection to a hypervisor + * + * Since: v1.0.0 + * */ typedef enum { VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: v1.0.0) */ @@ -619,7 +671,20 @@ struct _virConnectCredential { unsigned int resultlen; /* Length of the result */ }; +/** + * virConnectCredential: + * + * Since: v1.0.0 + * + */ typedef struct _virConnectCredential virConnectCredential; + +/** + * virConnectCredentialPtr: + * + * Since: v1.0.0 + * + */ typedef virConnectCredential *virConnectCredentialPtr; @@ -648,8 +713,14 @@ struct _virConnectAuth { void *cbdata; }; - +/** + * virConnectAuth: + * + * Since: v1.0.0 + * + */ typedef struct _virConnectAuth virConnectAuth; + typedef virConnectAuth *virConnectAuthPtr; /* @@ -892,6 +963,12 @@ int virConnectIsAlive(virConnectPtr conn); * CPU specification API */ +/** + * virCPUCompareResult: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_CPU_COMPARE_ERROR = -1, VIR_CPU_COMPARE_INCOMPATIBLE = 0, @@ -903,6 +980,12 @@ typedef enum { # endif } virCPUCompareResult; +/** + * virConnectCompareCPUFlags: + * + * Since: v1.2.6 + * + */ typedef enum { VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = (1 << 0), /* treat incompatible CPUs as failure (Since: v1.2.6) */ @@ -927,9 +1010,12 @@ int virConnectGetCPUModelNames(virConnectPtr conn, unsigned int flags); /** - * virConnectBaselineCPUFlags + * virConnectBaselineCPUFlags: * * Flags when getting XML description of a computed CPU + * + * Since: v1.1.2 + * */ typedef enum { VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: v1.1.2) */ diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-interface.h index 289c3d0b07..22a90a6452 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -31,6 +31,9 @@ * virInterface: * * a virInterface is a private structure representing a virtual interface. + * + * Since: v1.0.0 + * */ typedef struct _virInterface virInterface; @@ -39,6 +42,9 @@ 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: v1.0.0 + * */ typedef virInterface *virInterfacePtr; @@ -53,10 +59,13 @@ int virConnectNumOfDefinedInterfaces (virConnectPtr conn); int virConnectListDefinedInterfaces (virConnectPtr conn, char **const names, int maxnames); -/* - * virConnectListAllInterfaces: +/** + * virConnectListAllInterfacesFlags: * * Flags used to filter the returned interfaces. + * + * Since: v1.0.0 + * */ typedef enum { VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-network.h index 3bf6df34a7..ab8b34ae1c 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -35,6 +35,9 @@ typedef enum { * virNetwork: * * a virNetwork is a private structure representing a virtual network. + * + * Since: v1.0.0 + * */ typedef struct _virNetwork virNetwork; @@ -43,6 +46,9 @@ 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: v1.0.0 + * */ typedef virNetwork *virNetworkPtr; @@ -51,6 +57,9 @@ typedef virNetwork *virNetworkPtr; * * a virNetworkPort is a private structure representing a virtual network * port + * + * Since: v5.5.0 + * */ typedef struct _virNetworkPort virNetworkPort; @@ -59,6 +68,9 @@ 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 + * */ typedef virNetworkPort *virNetworkPortPtr; @@ -82,11 +94,14 @@ int virConnectNumOfDefinedNetworks (virConnectPtr conn); int virConnectListDefinedNetworks (virConnectPtr conn, char **const names, int maxnames); -/* - * virConnectListAllNetworks: +/** + * virConnectListAllNetworksFlags: * * Flags used to filter the returned networks. Flags in each group * are exclusive attributes of a network. + * + * Since: v1.0.0 + * */ typedef enum { VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, @@ -150,6 +165,8 @@ int virNetworkUndefine (virNetworkPtr network); * describes which type of update to perform on a <network> * definition. * + * Since: v1.0.0 + * */ typedef enum { VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: v1.0.0)) */ @@ -168,6 +185,8 @@ typedef enum { * describes which section of a <network> definition the provided * xml should be applied to. * + * Since: v1.0.0 + * */ typedef enum { VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: v1.0.0)) */ @@ -192,6 +211,9 @@ typedef enum { * virNetworkUpdateFlags: * * Flags to control options for virNetworkUpdate() + * + * Since: v1.0.0 + * */ typedef enum { VIR_NETWORK_UPDATE_AFFECT_CURRENT = 0, /* affect live if network is active, @@ -246,6 +268,9 @@ int virNetworkIsPersistent(virNetworkPtr net); * virNetworkEventLifecycleType: * * a virNetworkEventLifecycleType is emitted during network lifecycle events + * + * Since: v1.2.1 + * */ typedef enum { VIR_NETWORK_EVENT_DEFINED = 0, @@ -295,6 +320,9 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, * An enumeration of supported eventId parameters for * virConnectNetworkEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v1.2.1 + * */ typedef enum { VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: v1.2.1) */ @@ -309,6 +337,12 @@ typedef enum { # endif } virNetworkEventID; +/** + * virIPAddrType: + * + * Since: v1.2.6 + * + */ typedef enum { VIR_IP_ADDR_TYPE_IPV4, VIR_IP_ADDR_TYPE_IPV6, @@ -318,6 +352,12 @@ typedef enum { # endif } virIPAddrType; +/** + * virNetworkDHCPLease: + * + * Since: v1.2.6 + * + */ typedef struct _virNetworkDHCPLease virNetworkDHCPLease; typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr; struct _virNetworkDHCPLease { @@ -375,6 +415,12 @@ virNetworkPortPtr virNetworkPortLookupByUUIDString(virNetworkPtr net, const char *uuidstr); +/** + * virNetworkPortCreateFlags: + * + * Since: v5.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) */ diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-nodedev.h index 589495213c..a19821bb75 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -32,6 +32,9 @@ * virNodeDevice: * * A virNodeDevice contains a node (host) device details. + * + * Since: v1.0.0 + * */ typedef struct _virNodeDevice virNodeDevice; @@ -43,6 +46,9 @@ typedef struct _virNodeDevice virNodeDevice; * one via virNodeDeviceLookupByName, or virNodeDeviceCreate. Be sure * to call virNodeDeviceFree when done using a virNodeDevicePtr obtained * from any of the above functions to avoid leaking memory. + * + * Since: v1.0.0 + * */ typedef virNodeDevice *virNodeDevicePtr; @@ -57,11 +63,15 @@ int virNodeListDevices (virConnectPtr conn, char **const names, int maxnames, unsigned int flags); -/* - * virConnectListAllNodeDevices: +/** + * virConnectListAllNodeDeviceFlags: * * Flags used to filter either by capability or active state, the - * returned node devices. */ + * returned node devices. + * + * Since: v1.0.0 + * + */ typedef enum { VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: v1.0.0) */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: v1.0.0) */ @@ -168,6 +178,9 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * An enumeration of supported eventId parameters for * virConnectNodeDeviceEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v2.2.0 + * */ typedef enum { VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: v2.2.0) */ @@ -215,6 +228,9 @@ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, * * a virNodeDeviceEventLifecycleType is emitted during node device * lifecycle events + * + * Since: v2.2.0 + * */ typedef enum { VIR_NODE_DEVICE_EVENT_CREATED = 0, diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-nwfilter.h index aa8872e156..5c78ea9d8b 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -31,6 +31,9 @@ * virNWFilter: * * a virNWFilter is a private structure representing a network filter + * + * Since: v1.0.0 + * */ typedef struct _virNWFilter virNWFilter; @@ -39,6 +42,9 @@ 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: v1.0.0 + * */ typedef virNWFilter *virNWFilterPtr; @@ -47,6 +53,9 @@ typedef virNWFilter *virNWFilterPtr; * * a virNWFilterBinding is a private structure representing a network * filter binding to a port + * + * Since: v4.5.0 + * */ typedef struct _virNWFilterBinding virNWFilterBinding; @@ -56,6 +65,9 @@ typedef struct _virNWFilterBinding virNWFilterBinding; * a virNWFilterBindingPtr is pointer to a virNWFilterBinding private * structure, this is the type used to reference a network filter * port binding in the API. + * + * Since: v4.5.0 + * */ typedef virNWFilterBinding *virNWFilterBindingPtr; diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h index cd636f14be..9f4f60dcaa 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -33,10 +33,19 @@ * * A virSecret stores a secret value (e.g. a passphrase or encryption key) * and associated metadata. + * + * Since: v1.0.0 + * */ typedef struct _virSecret virSecret; typedef virSecret *virSecretPtr; +/** + * virSecretUsageType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_SECRET_USAGE_TYPE_NONE = 0, VIR_SECRET_USAGE_TYPE_VOLUME = 1, @@ -61,11 +70,14 @@ int virConnectListSecrets (virConnectPtr conn, char **uuids, int maxuuids); -/* - * virConnectListAllSecrets: +/** + * virConnectListAllSecretsFlags: * * Flags used to filter the returned secrets. Flags in each group * are exclusive attributes of a secret. + * + * Since: v1.0.0 + * */ typedef enum { VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never @@ -132,6 +144,9 @@ int virSecretFree (virSecretPtr secret); * An enumeration of supported eventId parameters for * virConnectSecretEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v3.0.0 + * */ typedef enum { VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: v3.0.0) */ @@ -179,6 +194,9 @@ int virConnectSecretEventDeregisterAny(virConnectPtr conn, * * a virSecretEventLifecycleType is emitted during secret * lifecycle events + * + * Since: v3.0.0 + * */ typedef enum { VIR_SECRET_EVENT_DEFINED = 0, diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index a0c4dab809..c86b1439b6 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -32,6 +32,9 @@ * virStoragePool: * * a virStoragePool is a private structure representing a storage pool + * + * Since: v1.0.0 + * */ typedef struct _virStoragePool virStoragePool; @@ -40,10 +43,19 @@ 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: v1.0.0 + * */ typedef virStoragePool *virStoragePoolPtr; +/** + * virStoragePoolState: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: v1.0.0) */ VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: v1.0.0) */ @@ -69,6 +81,12 @@ typedef enum { VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v1.0.0) */ } virStoragePoolDeleteFlags; +/** + * virStoragePoolCreateFlags: + * + * Since: v1.3.1 + * + */ typedef enum { /* Create the pool but do not perform pool build (Since: v1.3.1) */ VIR_STORAGE_POOL_CREATE_NORMAL = 0, @@ -93,6 +111,12 @@ typedef enum { VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE = 1 << 2, } virStoragePoolCreateFlags; +/** + * virStoragePoolInfo: + * + * Since: v1.0.0 + * + */ typedef struct _virStoragePoolInfo virStoragePoolInfo; struct _virStoragePoolInfo { @@ -102,6 +126,12 @@ struct _virStoragePoolInfo { unsigned long long available; /* Remaining free space bytes */ }; +/** + * virStoragePoolInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virStoragePoolInfo *virStoragePoolInfoPtr; @@ -109,6 +139,9 @@ typedef virStoragePoolInfo *virStoragePoolInfoPtr; * virStorageVol: * * a virStorageVol is a private structure representing a storage volume + * + * Since: v1.0.0 + * */ typedef struct _virStorageVol virStorageVol; @@ -117,10 +150,19 @@ 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: v1.0.0 + * */ typedef virStorageVol *virStorageVolPtr; +/** + * virStorageVolType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: v1.0.0) */ VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: v1.0.0) */ @@ -135,12 +177,24 @@ typedef enum { # endif } virStorageVolType; +/** + * virStorageVolDeleteFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v1.0.0) */ VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v1.0.0) */ VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: v1.2.21) */ } virStorageVolDeleteFlags; +/** + * virStorageVolWipeAlgorithm: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: v1.0.0) */ VIR_STORAGE_VOL_WIPE_ALG_NNSA = 1, /* 4-pass NNSA Policy Letter @@ -173,6 +227,12 @@ typedef enum { # endif } virStorageVolWipeAlgorithm; +/** + * virStorageVolInfoFlags: + * + * Since: v3.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_USE_ALLOCATION = 0, @@ -181,6 +241,12 @@ typedef enum { } virStorageVolInfoFlags; +/** + * virStorageVolInfo: + * + * Since: v1.0.0 + * + */ typedef struct _virStorageVolInfo virStorageVolInfo; struct _virStorageVolInfo { @@ -226,6 +292,9 @@ int virConnectListDefinedStoragePools(virConnectPtr conn, * Flags used to tune pools returned by virConnectListAllStoragePools(). * 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 + * */ typedef enum { VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, @@ -351,6 +420,12 @@ virStorageVolPtr virStorageVolLookupByPath (virConnectPtr conn, const char* virStorageVolGetName (virStorageVolPtr vol); const char* virStorageVolGetKey (virStorageVolPtr vol); +/** + * virStorageVolCreateFlags: + * + * 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 (Since: v1.2.13) */ @@ -432,6 +507,9 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * An enumeration of supported eventId parameters for * virConnectStoragePoolEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v2.0.0 + * */ typedef enum { VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: v2.0.0) */ @@ -479,6 +557,9 @@ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, * * a virStoragePoolEventLifecycleType is emitted during storage pool * lifecycle events + * + * Since: v2.0.0 + * */ typedef enum { VIR_STORAGE_POOL_EVENT_DEFINED = 0, diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-stream.h index 076f9ee8b8..5feb66ac35 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -28,6 +28,12 @@ # endif +/** + * virStreamFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STREAM_NONBLOCK = (1 << 0), } virStreamFlags; @@ -44,6 +50,12 @@ int virStreamRecv(virStreamPtr st, char *data, size_t nbytes); +/** + * virStreamRecvFlagsValues: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), } virStreamRecvFlagsValues; @@ -229,6 +241,12 @@ int virStreamSparseRecvAll(virStreamPtr stream, virStreamSinkHoleFunc holeHandler, void *opaque); +/** + * virStreamEventType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STREAM_EVENT_READABLE = (1 << 0), VIR_STREAM_EVENT_WRITABLE = (1 << 1), diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 5cdcf17dd9..4feaffd1e3 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -34,6 +34,9 @@ extern "C" { * virErrorLevel: * * Indicates the level of an error + * + * Since: v1.0.0 + * */ typedef enum { VIR_ERR_NONE = 0, @@ -46,6 +49,9 @@ 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: v1.0.0 + * */ typedef enum { VIR_FROM_NONE = 0, @@ -152,6 +158,9 @@ typedef enum { * The conn, dom and net fields should be used with extreme care. * Reference counts are not incremented so the underlying objects * may be deleted without notice after the error has been delivered. + * + * Since: v1.0.0 + * */ typedef struct _virError virError; @@ -205,6 +214,9 @@ struct _virError { * break; * default: * } + * + * Since: v1.0.0 + * */ typedef enum { VIR_ERR_OK = 0, -- 2.35.1