]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docstring: enums: qemu: Add 'Since version' metadata
authorVictor Toso <victortoso@redhat.com>
Wed, 20 Apr 2022 19:07:55 +0000 (21:07 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Fri, 22 Apr 2022 07:45:09 +0000 (09:45 +0200)
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@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
include/libvirt/libvirt-qemu.h

index 98f2ac38236ed6498c953d15dea51a7083ffbee2..a2569a9fbd83d21c1c99be5e14bf13e67116a1b2 100644 (file)
@@ -31,8 +31,8 @@ extern "C" {
 # endif
 
 typedef enum {
-    VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0,
-    VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP     = (1 << 0), /* cmd is in HMP */
+    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) */
 } virDomainQemuMonitorCommandFlags;
 
 int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
@@ -51,11 +51,11 @@ virDomainPtr virDomainQemuAttach(virConnectPtr domain,
                                  unsigned int flags);
 
 typedef enum {
-    VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK,
-    VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK,
-    VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT,
-    VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT,
-    VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60,
+    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) */
 } virDomainQemuAgentCommandTimeoutValues;
 
 char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd,
@@ -85,10 +85,10 @@ typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn,
 
 
 typedef enum {
-    /* Event filter is a regex rather than a literal string */
+    /* Event filter is a regex rather than a literal string (Since: v1.2.3) */
     VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX = (1 << 0),
 
-    /* Event filter is case insensitive */
+    /* Event filter is case insensitive (Since: v1.2.3) */
     VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE = (1 << 1),
 } virConnectDomainQemuMonitorEventRegisterFlags;