From nobody Tue Feb 10 21:19:05 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1650655568; cv=none; d=zohomail.com; s=zohoarc; b=FRjJWGvrf+A/Kn+BGiSXB6a+9JsFwasOZRzeWeDgiq0mA5NRwtkgrirt46kkwsL6GZL8G0IT7J0WuTVBwKxUrBghrGLv/dKkzPT8sGS/DXxMTqnzfeV3aL28cIPQ+LiY84qLEOCybEjwaJIDwiQZsz0DfqqpjKWvIAkezEQUxnM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655568; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=yjcwDzQb0UPlxYiWVT8fEFYqU81h1KfrUq8dGWp9rss=; b=UE/oRAN1LoEKjbaYpRT7YIqAIUxHw9fyS3yiRFJI+zG5tnf+zd24Ns0RL15PZ4YnfxWzWclFx3gezWf39MWQTQu9yUC4CwxQkvO4nj7EnZIwqTRy9CnkdAHq8cwxKa/DhQnQJ+vaRZcG7tvCRpF44TOF27UxKyXBVJYXGoyrv60= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1650655568603967.8891333122785; Fri, 22 Apr 2022 12:26:08 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-629-8MhH4CF-PSSvD0zkVpyG5A-1; Fri, 22 Apr 2022 15:24:59 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id AA0318002BF; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 95CC141636D; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 293791940352; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 083171940351 for ; Fri, 22 Apr 2022 19:24:53 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id BD9E92024CC3; Fri, 22 Apr 2022 19:24:53 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2CF952026614 for ; Fri, 22 Apr 2022 19:24:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655567; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=yjcwDzQb0UPlxYiWVT8fEFYqU81h1KfrUq8dGWp9rss=; b=dBkr0Fnl89N1ngMUNY3xPKzNjTGlf7ErrjPP87RQREB+BykBbBaG06i/pGMrsRDeU0qxPX Tu7kH5QvII8TCe/vKOWQ4mOymOhDBt2vTTNcMjkOzlUvW9WqrWigCiyqDgSI7R0AT1mRFo 0TWNRpNJBj8qW1sRFmmYRoDVO0Gf3U4= X-MC-Unique: 8MhH4CF-PSSvD0zkVpyG5A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 12/19] docstring: function: admin: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:37 +0200 Message-Id: <20220422192344.830350-13-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.10 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1650655569631100001 Content-Type: text/plain; charset="utf-8" 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 --- 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-admi= n.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, bu= t 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 erro= r. + * + * 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 e= rror. * 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(virAdmConnectP= tr 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 @cli= ent * (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 c= ase * 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 successful= ly * 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, --=20 2.35.1