[PATCH v3 09/30] docstring: macros: admin: Add 'Since version' metadata

Either create or append to existing docstring, the version (git tag) that a given macro was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso(a)redhat.com&gt; --- include/libvirt/libvirt-admin.h | 60 +++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h index f65886f20d..defca505f8 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -132,6 +132,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * VIR_THREADPOOL_WORKERS_MIN: * Macro for the threadpool minWorkers limit: represents the bottom limit to * number of active workers in threadpool, as VIR_TYPED_PARAM_UINT. + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_WORKERS_MIN "minWorkers" @@ -142,6 +145,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * number of active workers in threadpool, as VIR_TYPED_PARAM_UINT. * The value of this limit has to be greater than VIR_THREADPOOL_WORKERS_MIN * at all times. + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_WORKERS_MAX "maxWorkers" @@ -150,6 +156,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * VIR_THREADPOOL_WORKERS_PRIORITY: * Macro for the threadpool nPrioWorkers attribute: represents the current number * of active priority workers in threadpool, as VIR_TYPED_PARAM_UINT. + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers" @@ -161,6 +170,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_WORKERS_FREE "freeWorkers" @@ -172,6 +184,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers" @@ -183,6 +198,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.4 + * */ # define VIR_THREADPOOL_JOB_QUEUE_DEPTH "jobQueueDepth" @@ -233,6 +251,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_READONLY "readonly" @@ -244,6 +265,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_SOCKET_ADDR "sock_addr" @@ -255,6 +279,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_SASL_USER_NAME "sasl_user_name" @@ -267,6 +294,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME "tls_x509_dname" @@ -279,6 +309,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_UNIX_USER_ID "unix_user_id" @@ -291,6 +324,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_UNIX_USER_NAME "unix_user_name" @@ -303,6 +339,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_UNIX_GROUP_ID "unix_group_id" @@ -315,6 +354,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_UNIX_GROUP_NAME "unix_group_name" @@ -327,6 +369,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_UNIX_PROCESS_ID "unix_process_id" @@ -339,6 +384,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be denied * by daemon + * + * Since: v1.3.5 + * */ # define VIR_CLIENT_INFO_SELINUX_CONTEXT "selinux_context" @@ -356,6 +404,9 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * VIR_SERVER_CLIENTS_MAX: * Macro for per-server nclients_max limit: represents the upper limit to * number of clients connected to the server, as uint. + * + * Since: v1.3.5 + * */ # define VIR_SERVER_CLIENTS_MAX "nclients_max" @@ -367,6 +418,9 @@ 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: v1.3.5 + * */ # define VIR_SERVER_CLIENTS_CURRENT "nclients" @@ -376,6 +430,9 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags); * Macro for per-server nclients_unauth_max limit: represents the upper limit * to number of clients connected to the server, but not authenticated yet, * as VIR_TYPED_PARAM_UINT. + * + * Since: v1.3.5 + * */ # define VIR_SERVER_CLIENTS_UNAUTH_MAX "nclients_unauth_max" @@ -388,6 +445,9 @@ 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: v1.3.5 + * */ # define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth" -- 2.35.1