From nobody Sat May 18 17:16:09 2024 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=1650481745; cv=none; d=zohomail.com; s=zohoarc; b=gEwyyeU/LJAY4AvQirDQcdhk9NBBeZVkmhwH/EQ3MjYqmLdZM4gShaTsoEjnZ7wGEYkEmZdoAop1kE+sVDuq1j4vFZ8uHyCxTWQ5oU6zvSNt+IO7wyepuUJ/AZh5aUEJ1rqdIb5YGErV324n3jKBKTPhZ09kNfG0UwgNQF6moB4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481745; 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=PoUgKjWEUCkdkdSVswxQFzGRbqo92b1nFafwFpZ5qJ4=; b=i3qwe2xvvleRsL1kTt1iTLz6XbtP8VN+z3VSt4J12B+EEzlZX29I9caKRyiwZHKrijSv5vBNmCgqqe5V5aZeCuwp0B1yp92NPHGbXV/fIGaPs4ijr2FPu0rARkyj7Nc+IPpxkTxReoTZvLRT6JPq3wiqGF6Q8kGp2O7SOxcDTsU= 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 1650481745246408.17365047237263; Wed, 20 Apr 2022 12:09:05 -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-397-5xuPHGacNG2Atx1yU-zqNg-1; Wed, 20 Apr 2022 15:08:29 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 50F0D804191; Wed, 20 Apr 2022 19:08:26 +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 18E2A551E86; Wed, 20 Apr 2022 19:08:26 +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 7AA461940359; Wed, 20 Apr 2022 19:08:23 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 32D8A19451EC for ; Wed, 20 Apr 2022 19:08:22 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 04C44551E87; Wed, 20 Apr 2022 19:08:22 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7E55D551E82 for ; Wed, 20 Apr 2022 19:08:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481744; 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=PoUgKjWEUCkdkdSVswxQFzGRbqo92b1nFafwFpZ5qJ4=; b=UYJLare0+0MxENCJPrD4xStKW0qXlWkCMnZdbE1A5j6wXYhemi4Ci3xlRFEdlF68BAp+0r qsk7QcCZc1bkw1U3vqyyTTdqTJ87a5BRIoNrnTOifjg6L/qLjjhe9WFLRhGiF9G5rkdRVQ ZDtzHeOZjJ1xTLAf/7dtP1+esZoeS7E= X-MC-Unique: 5xuPHGacNG2Atx1yU-zqNg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 01/30] syntax-check: sc_prohibit_nonreentrant: skip comments Date: Wed, 20 Apr 2022 21:07:50 +0200 Message-Id: <20220420190819.3093205-2-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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.9 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: 1650481746094100019 Content-Type: text/plain; charset="utf-8" It doesn't need to fail the test if a reentrant function is found in a comment. Fixes: | ... | prohibit_nonreentrant | libvirt/ci/helper:33: default=3Dos.getlogin(), # exempt from= syntax-check | libvirt/include/libvirt/libvirt-storage.h:223: VIR_STORAGE_VOL_WIPE_A= LG_PFITZNER7 =3D 6, /* 7-pass random (Since: v1.0.0) */ | libvirt/include/libvirt/libvirt-storage.h:225: VIR_STORAGE_VOL_WIPE_A= LG_PFITZNER33 =3D 7, /* 33-pass random (Since: v1.0.0) */ | libvirt/include/libvirt/libvirt-storage.h:227: VIR_STORAGE_VOL_WIPE_A= LG_RANDOM =3D 8, /* 1-pass random (Since: v1.0.0) */ Signed-off-by: Victor Toso --- build-aux/syntax-check.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk index a6e3ada300..eb403f3d3f 100644 --- a/build-aux/syntax-check.mk +++ b/build-aux/syntax-check.mk @@ -300,7 +300,7 @@ sc_prohibit_PATH_MAX: include $(top_srcdir)/build-aux/Makefile.nonreentrant sc_prohibit_nonreentrant: @prohibit=3D"\\<(${NON_REENTRANT_RE}) *\\(" \ - exclude=3D'exempt from syntax-check' \ + exclude=3D'exempt from syntax-check|\/\*.*\*\/' \ halt=3D"use re-entrant functions (usually ending with _r)" \ $(_sc_search_regexp) =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481714; cv=none; d=zohomail.com; s=zohoarc; b=TOp5ymjFUw1GTpqOnFO50na9kOB8tt6iuWqkDYkcpmrmmUqtcf28IWhwGe5zfxRtIkZZCyt3VTQTq6vZpRn0YerDeZMlN4WrNVruR1kJRfBY++68kwuLrm6/d/MjOS4V3dZPJ37HNRiJmEbaV5tPQv3pt/BgrKMiwTyVicuI1gI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481714; 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=AHIik0LUBEsNkWOZpoOTT871SxdITcqU5FQrIwz5vpE=; b=AuyVwLg0d+N5YFBsAPz912SP9itYf1yDsJk5a+Oj5Dp2nMp1qiiF8sCSqiI9D5nmpq4MSqSCGUjNEMSFTrK22YEUJXqsB0W9vh94EZJ52TBJeWhDZxgkMlUlqIGCPJyVuwLK7i9IqAm0gx/1zA8lpd8jZjva5j9cTkgeGJj9txU= 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 165048171447870.88941915489045; Wed, 20 Apr 2022 12:08:34 -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-508-S0j9Bp8mOHOkIOMzi5KPFQ-1; Wed, 20 Apr 2022 15:08:30 -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 DA302803533; Wed, 20 Apr 2022 19:08:26 +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 C62CD572326; Wed, 20 Apr 2022 19:08:26 +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 B5FAA1940351; Wed, 20 Apr 2022 19:08:25 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 201271940354 for ; Wed, 20 Apr 2022 19:08:23 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 05464551E88; Wed, 20 Apr 2022 19:08:23 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6B00F551E82 for ; Wed, 20 Apr 2022 19:08:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481713; 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=AHIik0LUBEsNkWOZpoOTT871SxdITcqU5FQrIwz5vpE=; b=DlMRF7itQkgL5iqRGHqVfZPyJNkNmskNs7h4pnGH9vIFRb5cSg9XX9sHFaX0Ze9IJ5BLlx DsgEmVe+ewR5MvPf9yIMViqVG3v1SVxI31rxMKCyvAqoNv+j0q+K7Cbt3FPYyqzYJEoTjo Uu1tNxqqQ639nG8HPSEnxMB5MRo90ik= X-MC-Unique: S0j9Bp8mOHOkIOMzi5KPFQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 02/30] syntax-check: prohibit_virXXXFree: skip strings Date: Wed, 20 Apr 2022 21:07:51 +0200 Message-Id: <20220420190819.3093205-3-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481716296100003 Content-Type: text/plain; charset="utf-8" We should allow strings (not the functions) in the format of "virDomainFree" and friends. This fixes an error in latter commit "scripts: apibuild: parse 'Since' for functions" as it uses this function names as keys in a dictionary. Fixes: | ... | prohibit_virXXXFree | libvirt/scripts/apibuild.py:163: 'virDomainFree': '0.0.1', | make: Leaving directory '/home/toso/src/libvirt/build/build-aux' | stderr: | build-aux/syntax-check.mk: avoid using virXXXFree, use virObjectUnref i= nstead | make: *** [libvirt/build-aux/syntax-check.mk:829: sc_prohibit_virXXXFre= e] Error 1 Signed-off-by: Victor Toso --- build-aux/syntax-check.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk index eb403f3d3f..07e0295995 100644 --- a/build-aux/syntax-check.mk +++ b/build-aux/syntax-check.mk @@ -827,7 +827,7 @@ sc_prohibit_system_error_with_vir_err: # docs, examples, tools, src/libvirt-*.c, and include/libvirt/libvirt-*.h sc_prohibit_virXXXFree: @prohibit=3D'\bvir(Domain|Network|NodeDevice|StorageVol|StoragePool|Strea= m|Secret|NWFilter|Interface|DomainSnapshot)Free\b' \ - exclude=3D'sc_prohibit_virXXXFree' \ + exclude=3D"sc_prohibit_virXXXFree|'vir.*?Free'" \ halt=3D'avoid using virXXXFree, use virObjectUnref instead' \ $(_sc_search_regexp) =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481719; cv=none; d=zohomail.com; s=zohoarc; b=lo9Zkj6HPPe9IOXDDG/7b1iA5DeppnSgiIw1ZtU47aLS+3kmbx8WbLPrA1/ih8cGnvxFEG0MGZBdl0V8shWN+R/9bd6g+2R7vNzHSTya+zvqThfKj/h5WHNF2PAf7gn6QkTC7ZpNTUg/OGj+C+BwCTTo9G2SfjfvVB0umIMqzQM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481719; 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=u07I5l7SElfGXtCY++hkrgAWAL2XEp1/ulFLHyRZo2E=; b=ac5C2uhd3Rho6Awuz4lij3/pHRCtN/lpi+gONWA+hRS3f0x2tbLjjYHSpV6GL+tuD8LNMhnJjbZu+jpj23Dtq3kWK+nB+yawqWcycXwqczODEy8YjTSEWxQg+I01jQb5T49GiXvkkULLlJoFJ6FB322GL24ZEQUMhmNDFKCE1FU= 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 1650481719554630.3705687407645; Wed, 20 Apr 2022 12:08:39 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-122-AaDvANH3NdK2k1v88OYc3A-1; Wed, 20 Apr 2022 15:08:32 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 092EE3811F2D; Wed, 20 Apr 2022 19:08:28 +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 EA295145BA63; Wed, 20 Apr 2022 19:08:27 +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 9444F194036E; Wed, 20 Apr 2022 19:08:26 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1D2121940361 for ; Wed, 20 Apr 2022 19:08:24 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 06DAB551E85; Wed, 20 Apr 2022 19:08:24 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 70BFB551E86 for ; Wed, 20 Apr 2022 19:08:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481718; 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=u07I5l7SElfGXtCY++hkrgAWAL2XEp1/ulFLHyRZo2E=; b=B55nxXlz8JB4oH5t8yC1eNrV3T1rcaY/5XBplcOK5t8hDZeVRcqiHxWwCEuVH7geOuR5vW XA0psCzsb/KW9JOqudwqhjiXjm/bWvha+xBi8Lq/ZfhFfb6cln7gRoWeYsN/8S37EdtMJu GXBATrx1Mqa+MkHLlYnroeapoWRIjSA= X-MC-Unique: AaDvANH3NdK2k1v88OYc3A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 03/30] docstring: Fix generated documentation of virConnectListAllNodeDeviceFlags Date: Wed, 20 Apr 2022 21:07:52 +0200 Message-Id: <20220420190819.3093205-4-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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.7 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: 1650481720417100002 Content-Type: text/plain; charset="utf-8" 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. Either way, virConnectListAllNodeDeviceFlags documentation is explicit that this enum is about filtering node devices. We can move the information that it is either by "capability" or "active" state to the block of comment above. Using git diff --word-diff to show the fixed ouput xml (redacted). = -]{+Matrix'/>+} -]{+Queue'/>+} -]{+info=3D'DRM device'/>+} -]{+info=3D'FC Host Bus Adapter'/>+} -]{+info=3D'Mediated device'/>+} -]{+info=3D'Capable of mediated devices'/>+} -]{+info=3D'Network device'/>+} -]{+info=3D'PCI device'/>+} -]{+= device'/>+} +} -]{+info=3D'SCSI Host Bus Adapter'/>+} -]{+Target'/>+} -]{+info=3D'System capability'/>+} -]{+interface'/>+} -]{+info=3D'Device with VPD'/>+} -]{+info=3D'Capable of vport'/>+} -]{+info=3D'Inactive device= s'/>+} Signed-off-by: Victor Toso Reviewed-by: Peter Krempa --- include/libvirt/libvirt-nodedev.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 0c01d51aab..8efcd7f506 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -60,9 +60,9 @@ int virNodeListDevices (virConne= ctPtr conn, /* * virConnectListAllNodeDevices: * - * Flags used to filter the returned node devices. */ + * Flags used to filter either by capability or active state, the + * returned node devices. */ typedef enum { - /* filter the devices by cap type */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM =3D 1 << 0, /* System= capability */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV =3D 1 << 1, /* PCI de= vice */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV =3D 1 << 2, /* USB de= vice */ @@ -86,7 +86,6 @@ typedef enum { VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX =3D 1 << 20, /* s390 A= P Matrix */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD =3D 1 << 21, /* Device= with VPD */ =20 - /* filter the devices by active state */ VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE =3D 1 << 30, /* Inacti= ve devices */ VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE =3D 1U << 31, /* Activ= e devices */ } virConnectListAllNodeDeviceFlags; --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481743; cv=none; d=zohomail.com; s=zohoarc; b=cnvq37xgRju+oStMJlXSaZdE58sH1lRm6AlpgcaSi3S7YIGGcPpScuHQDpePtlW41sNq+Xe5NqG9MMe7GI+9svpNHWqaIAUlgwaKYYllvgaf8E4sgsojYsBUzvyYfDgBCRYrQWRcW17D/GM+7k8jJIcR32m6T2Mo0P6+RKLKrk8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481743; 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=Z+Cbcp2mLtBU1fZmZOvGWsi1S4WIEsTtd8qCKpSKX2g=; b=ALuiVnDT/2eYDNAdxfFIWXXZgbN7OTqYm2AXge6TbaAeAwcvhRHB/v8INHteB39zJ9lRwqkfr+Sofz5WgFbhkCPq4OlLvTMjvK933Zt5DUTbEu/LXDXQHz6FFMvW8+j4HB5ezkCofZJkN2JMWp9aO+UHNL9U7z759gHD1fG3BqU= 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 1650481743061270.6796000104214; Wed, 20 Apr 2022 12:09:03 -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-90-jqj0oHXXOwC_SfWdnZ3nMg-1; Wed, 20 Apr 2022 15:08:30 -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 3170A1802CFF; Wed, 20 Apr 2022 19:08:28 +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 1A08C572326; Wed, 20 Apr 2022 19:08:28 +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 977F41940370; Wed, 20 Apr 2022 19:08:26 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 122571940351 for ; Wed, 20 Apr 2022 19:08:25 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 00C31551E86; Wed, 20 Apr 2022 19:08:25 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 51750551E82 for ; Wed, 20 Apr 2022 19:08:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481742; 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=Z+Cbcp2mLtBU1fZmZOvGWsi1S4WIEsTtd8qCKpSKX2g=; b=YT++Fi/NL2sHSOGM508YjibQ4JJ0/4GV2m2ocQh+gmMJLImbsWhxe5t+gYzKM3fjXXYwka 7neAG6acgzgNnCbQj+thW/rXlpDvzsw4rJixuyAce1zb2fUCH2F97WCzXr2ZzUMUwyNsHN 3kjGHf5YNT4cxLfLG461WQ7/Upx7W8Q= X-MC-Unique: jqj0oHXXOwC_SfWdnZ3nMg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 04/30] docstring: variable: Move docstring from source to header file Date: Wed, 20 Apr 2022 21:07:53 +0200 Message-Id: <20220420190819.3093205-5-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481744116100013 Content-Type: text/plain; charset="utf-8" virConnectAuthPtrDefault is the only variable that we export and with the documentation being at the C file, it makes harder to find it. With this patch, the documentation of this variable can be found by those who look at the header file for guidance plus, it will also be included in the XML API, as the followup patch will fix apibuild.py to store what is documented in the header file for this variable. Note that the apibuild, does not do the same with .c files. It'd require adding it for (parsing) recursion, similar to what is done for functions. Considering the pros/cons, seems more reasonable to move the docstring to the header file instead. Signed-off-by: Victor Toso Reviewed-by: Peter Krempa --- include/libvirt/libvirt-host.h | 13 +++++++++++++ src/libvirt.c | 11 +---------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 1dc4b8a147..8cccf2921f 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -562,6 +562,19 @@ struct _virConnectAuth { typedef struct _virConnectAuth virConnectAuth; typedef virConnectAuth *virConnectAuthPtr; =20 +/* + * virConnectAuthPtrDefault: + * + * A default implementation of the authentication callbacks. This + * implementation is suitable for command line based tools. It will + * prompt for username, passwords, realm and one time keys as needed. + * It will print on STDOUT, and read from STDIN. If this is not + * suitable for the application's needs an alternative implementation + * should be provided. + * + * Since: v0.4.1 + * + */ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault; =20 /** diff --git a/src/libvirt.c b/src/libvirt.c index 45315f484c..6cda75d1ca 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -197,16 +197,7 @@ static virConnectAuth virConnectAuthDefault =3D { NULL, }; =20 -/* - * virConnectAuthPtrDefault - * - * A default implementation of the authentication callbacks. This - * implementation is suitable for command line based tools. It will - * prompt for username, passwords, realm and one time keys as needed. - * It will print on STDOUT, and read from STDIN. If this is not - * suitable for the application's needs an alternative implementation - * should be provided. - */ +/* Explanation in the header file */ virConnectAuthPtr virConnectAuthPtrDefault =3D &virConnectAuthDefault; =20 static bool virGlobalError; --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481719; cv=none; d=zohomail.com; s=zohoarc; b=H9Z3zVa9IthclXoLpvP1+hz8KPELt9WGd5N9dyMLgaXYhvowFygup7wB1YhNUQNVJcLXJq0kHpO4Q8jR+LubMBIeFf0zEAiJjbhjeLpl0w+4vAM02yPpd4S/8yxPTZ+qTMO3YxM/etMiXU+RbZos96aNLjsEN5R21fqZxjyno+8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481719; 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=Aig4P7SD7N3d/ouSrY/kyFId/fZ0tcVaMKxM5zd56ck=; b=PB7DkykalpVHhkakifbkcy6ym4S62kpBYMFNF4FVJWW7LiZ+hYhGH93D3vFDK6DiQDSnYM4ttTKsnB1UoWcDJh4+mqirVl/bprzUm793c156Yt/7Zx6CQe5Gxo5l3PjGhqsD5zEPJP3MuVvDTJH7Gvooy8UWEjp7x8cOklzfyH0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.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.129.124]) by mx.zohomail.com with SMTPS id 1650481719528368.99012940679677; Wed, 20 Apr 2022 12:08:39 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-587-RNib7q0sNaivZj4mclm75A-1; Wed, 20 Apr 2022 15:08:32 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D1B9A3C0F096; Wed, 20 Apr 2022 19:08:29 +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 A638A40EC001; Wed, 20 Apr 2022 19:08:29 +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 6CCFC1940347; Wed, 20 Apr 2022 19:08:29 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 244141940352 for ; Wed, 20 Apr 2022 19:08:27 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id D131C551E86; Wed, 20 Apr 2022 19:08:26 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 63140551E82 for ; Wed, 20 Apr 2022 19:08:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481718; 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=Aig4P7SD7N3d/ouSrY/kyFId/fZ0tcVaMKxM5zd56ck=; b=L9pbGSNZmx0wu1A0rAu9yzgOuTvCbFtLjVPJ8uRPZqIwfpMTdA4ay1POXEK92D13R/e7ru HCquuLOdFy+zwiyxwIGnZyPKeH2HdBE2mz1/LVUdWBjrhQ5uvyNyye2Dg1u85YF5mN8Puw MDN1fJMsB1wyatNhRob0uL/aswD6jdQ= X-MC-Unique: RNib7q0sNaivZj4mclm75A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 05/30] docstring: enums: libvirt: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:54 +0200 Message-Id: <20220420190819.3093205-6-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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.84 on 10.11.54.2 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: 1650481720558100007 Content-Type: text/plain; charset="utf-8" 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 --- include/libvirt/libvirt-domain-checkpoint.h | 28 +- include/libvirt/libvirt-domain-snapshot.h | 60 +- include/libvirt/libvirt-domain.h | 1183 +++++++++++-------- 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 | 120 +- include/libvirt/libvirt-stream.h | 12 +- include/libvirt/virterror.h | 406 +++---- 13 files changed, 1121 insertions(+), 956 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/= libvirt-domain-checkpoint.h index a2f97531f8..a59578b857 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -52,13 +52,13 @@ virConnectPtr virDomainCheckpointGetConnect(virDomainCh= eckpointPtr checkpoint); =20 typedef enum { VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE =3D (1 << 0), /* Restore or a= lter - metadata */ + metadata (Sinc= e: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_QUIESCE =3D (1 << 1), /* use guest ag= ent to quiesce all mo= unted file systems w= ithin - the domain */ + the domain (Si= nce: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE_VALIDATE =3D (1 << 2), /* val= idate disk data state - when = redefining a checkpoint */ + when = redefining a checkpoint (Since: v6.10.0) */ } virDomainCheckpointCreateFlags; =20 /* Create a checkpoint using the current VM state. */ @@ -67,11 +67,11 @@ virDomainCheckpointPtr virDomainCheckpointCreateXML(vir= DomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_CHECKPOINT_XML_SECURE =3D (1 << 0), /* Include sensitive= data */ + VIR_DOMAIN_CHECKPOINT_XML_SECURE =3D (1 << 0), /* Include sensitive= data (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN =3D (1 << 1), /* Suppress - subelement */ + subelement (Since: = v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_SIZE =3D (1 << 2), /* Include dynamic - per- size */ + per- size (Si= nce: v5.6.0) */ } virDomainCheckpointXMLFlags; =20 /* Dump the XML of a checkpoint */ @@ -90,18 +90,18 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpoint= Ptr checkpoint, typedef enum { VIR_DOMAIN_CHECKPOINT_LIST_ROOTS =3D (1 << 0), /* Filter by chec= kpoints with no parents,= when - listing a domain= */ + listing a domain= (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_DESCENDANTS =3D (1 << 0), /* List all desce= ndants, not just childre= n, when - listing a checkp= oint */ + listing a checkp= oint (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL =3D (1 << 1), /* Ensure parents= occur before children = in - the resulting li= st */ + the resulting li= st (Since: v5.6.0) */ =20 VIR_DOMAIN_CHECKPOINT_LIST_LEAVES =3D (1 << 2), /* Filter by chec= kpoints - with no children= */ + with no children= (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES =3D (1 << 3), /* Filter by chec= kpoints - that have childr= en */ + that have childr= en (Since: v5.6.0) */ } virDomainCheckpointListFlags; =20 /* Get all checkpoint objects for this domain */ @@ -125,9 +125,9 @@ virDomainCheckpointPtr virDomainCheckpointGetParent(vir= DomainCheckpointPtr check =20 /* Delete a checkpoint */ typedef enum { - VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN =3D (1 << 0), /* Also delet= e children */ - VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete jus= t metadata */ - VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY =3D (1 << 2), /* Delete jus= t children */ + VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN =3D (1 << 0), /* Also delet= e children (Since: v5.6.0) */ + VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete jus= t metadata (Since: v5.6.0) */ + VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY =3D (1 << 2), /* Delete jus= t children (Since: v5.6.0) */ } virDomainCheckpointDeleteFlags; =20 int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/li= bvirt-domain-snapshot.h index d729d1a532..5dffabb764 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -51,28 +51,28 @@ virConnectPtr virDomainSnapshotGetConnect(virDomainSnap= shotPtr snapshot); =20 typedef enum { VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE =3D (1 << 0), /* Restore or alt= er - metadata */ + metadata (Since:= v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT =3D (1 << 1), /* With redefine,= make - snapshot current= */ + snapshot current= (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA =3D (1 << 2), /* Make snapshot = without - remembering it */ + remembering it (= Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_HALT =3D (1 << 3), /* Stop running g= uest - after snapshot */ + after snapshot (= Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY =3D (1 << 4), /* disk snapshot,= not - full system */ + full system (Sin= ce: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT =3D (1 << 5), /* reuse any exis= ting - external files */ + external files (= Since: v0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE =3D (1 << 6), /* use guest agen= t to quiesce all moun= ted file systems wit= hin - the domain */ + the domain (Sinc= e: v0.9.10) */ VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC =3D (1 << 7), /* atomically avo= id - partial changes = */ + partial changes = (Since: v0.9.11) */ VIR_DOMAIN_SNAPSHOT_CREATE_LIVE =3D (1 << 8), /* create the sna= pshot while the guest = is - running */ + running (Since: = v1.0.1) */ VIR_DOMAIN_SNAPSHOT_CREATE_VALIDATE =3D (1 << 9), /* validate the X= ML - against the sche= ma */ + against the sche= ma (Since: v5.6.0) */ } virDomainSnapshotCreateFlags; =20 /* Take a snapshot of the current VM state */ @@ -81,7 +81,7 @@ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomain= Ptr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_SNAPSHOT_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /* d= ump security sensitive information too */ + VIR_DOMAIN_SNAPSHOT_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /* d= ump security sensitive information too (Since: v5.1.0) */ } virDomainSnapshotXMLFlags; =20 /* Dump the XML of a snapshot */ @@ -102,45 +102,45 @@ char *virDomainSnapshotGetXMLDesc(virDomainSnapshotPt= r snapshot, typedef enum { VIR_DOMAIN_SNAPSHOT_LIST_ROOTS =3D (1 << 0), /* Filter by snapsh= ots with no parents, w= hen - listing a domain */ + listing a domain (= Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS =3D (1 << 0), /* List all descend= ants, not just children,= when listing a snapshot= */ =20 - /* For historical reasons, groups do not use contiguous bits. */ + /* For historical reasons, groups do not use contiguous bits. (Since: = v0.9.7) */ =20 VIR_DOMAIN_SNAPSHOT_LIST_LEAVES =3D (1 << 2), /* Filter by snapsh= ots - with no children */ + with no children (= Since: v0.9.7) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_LEAVES =3D (1 << 3), /* Filter by snapsh= ots - that have children= */ + that have children= (Since: v0.9.13) */ =20 VIR_DOMAIN_SNAPSHOT_LIST_METADATA =3D (1 << 1), /* Filter by snapsh= ots - which have metadat= a */ + which have metadat= a (Since: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_LIST_NO_METADATA =3D (1 << 4), /* Filter by snapsh= ots - with no metadata */ + with no metadata (= Since: v0.9.13) */ =20 VIR_DOMAIN_SNAPSHOT_LIST_INACTIVE =3D (1 << 5), /* Filter by snapsh= ots taken while guest = was - shut off */ + shut off (Since: v= 1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_ACTIVE =3D (1 << 6), /* Filter by snapsh= ots taken while guest = was active, and with - memory state */ + memory state (Sinc= e: v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_DISK_ONLY =3D (1 << 7), /* Filter by snapsh= ots taken while guest = was active, but without - memory state */ + memory state (Sinc= e: v1.0.1) */ =20 VIR_DOMAIN_SNAPSHOT_LIST_INTERNAL =3D (1 << 8), /* Filter by snapsh= ots stored internal to - disk images */ + disk images (Since= : v1.0.1) */ VIR_DOMAIN_SNAPSHOT_LIST_EXTERNAL =3D (1 << 9), /* Filter by snapsh= ots that use files ext= ernal - to disk images */ + to disk images (Si= nce: v1.0.1) */ =20 VIR_DOMAIN_SNAPSHOT_LIST_TOPOLOGICAL =3D (1 << 10), /* Ensure parents = occur before children in - the resulting lis= t */ + the resulting lis= t (Since: v5.2.0) */ } virDomainSnapshotListFlags; =20 /* Return the number of snapshots for this domain */ @@ -195,10 +195,10 @@ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr= snapshot, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING =3D 1 << 0, /* Run after revert */ - VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED =3D 1 << 1, /* Pause after revert */ - VIR_DOMAIN_SNAPSHOT_REVERT_FORCE =3D 1 << 2, /* Allow risky reverts = */ - VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM =3D 1 << 3, /* Re-initialize NV= RAM from template */ + VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING =3D 1 << 0, /* Run after revert (Si= nce: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED =3D 1 << 1, /* Pause after revert (= Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_REVERT_FORCE =3D 1 << 2, /* Allow risky reverts = (Since: v0.9.7) */ + VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM =3D 1 << 3, /* Re-initialize NV= RAM from template (Since: v8.1.0) */ } virDomainSnapshotRevertFlags; =20 /* Revert the domain to a point-in-time snapshot. The @@ -210,9 +210,9 @@ int virDomainRevertToSnapshot(virDomainSnapshotPtr snap= shot, =20 /* Delete a snapshot */ typedef enum { - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN =3D (1 << 0), /* Also delete = children */ - VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete just = metadata */ - VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY =3D (1 << 2), /* Delete just = children */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN =3D (1 << 0), /* Also delete = children (Since: v0.8.0) */ + VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete just = metadata (Since: v0.9.5) */ + VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY =3D (1 << 2), /* Delete just = children (Since: v0.9.5) */ } virDomainSnapshotDeleteFlags; =20 int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 1275f4530d..de2d14d4af 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -49,15 +49,15 @@ typedef virDomain *virDomainPtr; * A domain may be in different states at a given point in time */ typedef enum { - VIR_DOMAIN_NOSTATE =3D 0, /* no state */ - VIR_DOMAIN_RUNNING =3D 1, /* the domain is running */ - VIR_DOMAIN_BLOCKED =3D 2, /* the domain is blocked on resource */ - VIR_DOMAIN_PAUSED =3D 3, /* the domain is paused by user */ - VIR_DOMAIN_SHUTDOWN=3D 4, /* the domain is being shut down */ - VIR_DOMAIN_SHUTOFF =3D 5, /* the domain is shut off */ - VIR_DOMAIN_CRASHED =3D 6, /* the domain is crashed */ + VIR_DOMAIN_NOSTATE =3D 0, /* no state (Since: v0.0.1) */ + VIR_DOMAIN_RUNNING =3D 1, /* the domain is running (Since: v0.0.1)= */ + VIR_DOMAIN_BLOCKED =3D 2, /* the domain is blocked on resource (Si= nce: v0.0.1) */ + VIR_DOMAIN_PAUSED =3D 3, /* the domain is paused by user (Since: = v0.0.1) */ + VIR_DOMAIN_SHUTDOWN=3D 4, /* the domain is being shut down (Since:= v0.0.1) */ + VIR_DOMAIN_SHUTOFF =3D 5, /* the domain is shut off (Since: v0.0.1= ) */ + VIR_DOMAIN_CRASHED =3D 6, /* the domain is crashed (Since: v0.0.2)= */ VIR_DOMAIN_PMSUSPENDED =3D 7, /* the domain is suspended by guest - power management */ + power management (Since: v0.9.11) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_LAST @@ -65,114 +65,116 @@ 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; =20 typedef enum { - VIR_DOMAIN_NOSTATE_UNKNOWN =3D 0, + VIR_DOMAIN_NOSTATE_UNKNOWN =3D 0, /* (Since: v0.9.2) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_NOSTATE_LAST + VIR_DOMAIN_NOSTATE_LAST /* (Since: v0.9.10) */ # endif } virDomainNostateReason; =20 typedef enum { - VIR_DOMAIN_RUNNING_UNKNOWN =3D 0, - VIR_DOMAIN_RUNNING_BOOTED =3D 1, /* normal startup from boot = */ - VIR_DOMAIN_RUNNING_MIGRATED =3D 2, /* migrated from another hos= t */ - VIR_DOMAIN_RUNNING_RESTORED =3D 3, /* restored from a state fil= e */ - VIR_DOMAIN_RUNNING_FROM_SNAPSHOT =3D 4, /* restored from snapshot */ - VIR_DOMAIN_RUNNING_UNPAUSED =3D 5, /* returned from paused stat= e */ - VIR_DOMAIN_RUNNING_MIGRATION_CANCELED =3D 6, /* returned from migrati= on */ - VIR_DOMAIN_RUNNING_SAVE_CANCELED =3D 7, /* returned from failed save= process */ + VIR_DOMAIN_RUNNING_UNKNOWN =3D 0, /* (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_BOOTED =3D 1, /* normal startup from boot = (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATED =3D 2, /* migrated from another hos= t (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_RESTORED =3D 3, /* restored from a state fil= e (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_FROM_SNAPSHOT =3D 4, /* restored from snapshot (S= ince: v0.9.2) */ + VIR_DOMAIN_RUNNING_UNPAUSED =3D 5, /* returned from paused stat= e (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_MIGRATION_CANCELED =3D 6, /* returned from migrati= on (Since: v0.9.2) */ + VIR_DOMAIN_RUNNING_SAVE_CANCELED =3D 7, /* returned from failed save= process (Since: v0.9.2) */ VIR_DOMAIN_RUNNING_WAKEUP =3D 8, /* returned from pmsuspended= due to - wakeup event */ - VIR_DOMAIN_RUNNING_CRASHED =3D 9, /* resumed from crashed */ - VIR_DOMAIN_RUNNING_POSTCOPY =3D 10, /* running in post-copy migr= ation mode */ + wakeup event (Since: v0.9.1= 1) */ + VIR_DOMAIN_RUNNING_CRASHED =3D 9, /* resumed from crashed (Sin= ce: v1.1.1) */ + VIR_DOMAIN_RUNNING_POSTCOPY =3D 10, /* running in post-copy migr= ation mode (Since: v1.3.3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_RUNNING_LAST + VIR_DOMAIN_RUNNING_LAST /* (Since: v0.9.10) */ # endif } virDomainRunningReason; =20 typedef enum { - VIR_DOMAIN_BLOCKED_UNKNOWN =3D 0, /* the reason is unknown */ + VIR_DOMAIN_BLOCKED_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCKED_LAST + VIR_DOMAIN_BLOCKED_LAST /* (Since: v0.9.10) */ # endif } virDomainBlockedReason; =20 typedef enum { - VIR_DOMAIN_PAUSED_UNKNOWN =3D 0, /* the reason is unknown */ - VIR_DOMAIN_PAUSED_USER =3D 1, /* paused on user request */ - VIR_DOMAIN_PAUSED_MIGRATION =3D 2, /* paused for offline migration = */ - VIR_DOMAIN_PAUSED_SAVE =3D 3, /* paused for save */ - VIR_DOMAIN_PAUSED_DUMP =3D 4, /* paused for offline core dump = */ - VIR_DOMAIN_PAUSED_IOERROR =3D 5, /* paused due to a disk I/O erro= r */ - VIR_DOMAIN_PAUSED_WATCHDOG =3D 6, /* paused due to a watchdog even= t */ - VIR_DOMAIN_PAUSED_FROM_SNAPSHOT =3D 7, /* paused after restoring from = snapshot */ - VIR_DOMAIN_PAUSED_SHUTTING_DOWN =3D 8, /* paused during shutdown proce= ss */ - VIR_DOMAIN_PAUSED_SNAPSHOT =3D 9, /* paused while creating a snap= shot */ - VIR_DOMAIN_PAUSED_CRASHED =3D 10, /* paused due to a guest crash */ - VIR_DOMAIN_PAUSED_STARTING_UP =3D 11, /* the domain is being started */ - VIR_DOMAIN_PAUSED_POSTCOPY =3D 12, /* paused for post-copy migratio= n */ - VIR_DOMAIN_PAUSED_POSTCOPY_FAILED =3D 13, /* paused after failed post-= copy */ + VIR_DOMAIN_PAUSED_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ + VIR_DOMAIN_PAUSED_USER =3D 1, /* paused on user request (Since= : v0.9.2) */ + VIR_DOMAIN_PAUSED_MIGRATION =3D 2, /* paused for offline migration = (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_SAVE =3D 3, /* paused for save (Since: v0.9.= 2) */ + VIR_DOMAIN_PAUSED_DUMP =3D 4, /* paused for offline core dump = (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_IOERROR =3D 5, /* paused due to a disk I/O erro= r (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_WATCHDOG =3D 6, /* paused due to a watchdog even= t (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_FROM_SNAPSHOT =3D 7, /* paused after restoring from = snapshot (Since: v0.9.2) */ + VIR_DOMAIN_PAUSED_SHUTTING_DOWN =3D 8, /* paused during shutdown proce= ss (Since: v0.9.5) */ + VIR_DOMAIN_PAUSED_SNAPSHOT =3D 9, /* paused while creating a snap= shot (Since: v1.0.1) */ + VIR_DOMAIN_PAUSED_CRASHED =3D 10, /* paused due to a guest crash (= Since: v1.1.1) */ + VIR_DOMAIN_PAUSED_STARTING_UP =3D 11, /* the domain is being started (= Since: v1.2.14) */ + VIR_DOMAIN_PAUSED_POSTCOPY =3D 12, /* paused for post-copy migratio= n (Since: v1.3.3) */ + VIR_DOMAIN_PAUSED_POSTCOPY_FAILED =3D 13, /* paused after failed post-= copy (Since: v1.3.3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PAUSED_LAST + VIR_DOMAIN_PAUSED_LAST /* (Since: v0.9.10) */ # endif } virDomainPausedReason; =20 typedef enum { - VIR_DOMAIN_SHUTDOWN_UNKNOWN =3D 0, /* the reason is unknown */ - VIR_DOMAIN_SHUTDOWN_USER =3D 1, /* shutting down on user request= */ + VIR_DOMAIN_SHUTDOWN_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ + VIR_DOMAIN_SHUTDOWN_USER =3D 1, /* shutting down on user request= (Since: v0.9.2) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_SHUTDOWN_LAST + VIR_DOMAIN_SHUTDOWN_LAST /* (Since: v0.9.10) */ # endif } virDomainShutdownReason; =20 typedef enum { - VIR_DOMAIN_SHUTOFF_UNKNOWN =3D 0, /* the reason is unknown */ - VIR_DOMAIN_SHUTOFF_SHUTDOWN =3D 1, /* normal shutdown */ - VIR_DOMAIN_SHUTOFF_DESTROYED =3D 2, /* forced poweroff */ - VIR_DOMAIN_SHUTOFF_CRASHED =3D 3, /* domain crashed */ - VIR_DOMAIN_SHUTOFF_MIGRATED =3D 4, /* migrated to another host */ - VIR_DOMAIN_SHUTOFF_SAVED =3D 5, /* saved to a file */ - VIR_DOMAIN_SHUTOFF_FAILED =3D 6, /* domain failed to start */ + VIR_DOMAIN_SHUTOFF_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ + VIR_DOMAIN_SHUTOFF_SHUTDOWN =3D 1, /* normal shutdown (Since: v0.9.= 2) */ + VIR_DOMAIN_SHUTOFF_DESTROYED =3D 2, /* forced poweroff (Since: v0.9.= 2) */ + VIR_DOMAIN_SHUTOFF_CRASHED =3D 3, /* domain crashed (Since: v0.9.2= ) */ + VIR_DOMAIN_SHUTOFF_MIGRATED =3D 4, /* migrated to another host (Sin= ce: v0.9.2) */ + VIR_DOMAIN_SHUTOFF_SAVED =3D 5, /* saved to a file (Since: v0.9.= 2) */ + VIR_DOMAIN_SHUTOFF_FAILED =3D 6, /* domain failed to start (Since= : v0.9.2) */ VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT =3D 7, /* restored from a snapshot wh= ich was - * taken while domain was shutof= f */ + * taken while domain was shutof= f (Since: v0.9.2) */ VIR_DOMAIN_SHUTOFF_DAEMON =3D 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; =20 typedef enum { - VIR_DOMAIN_CRASHED_UNKNOWN =3D 0, /* crashed for unknown reason */ - VIR_DOMAIN_CRASHED_PANICKED =3D 1, /* domain panicked */ + VIR_DOMAIN_CRASHED_UNKNOWN =3D 0, /* crashed for unknown reason (S= ince: v0.9.2) */ + VIR_DOMAIN_CRASHED_PANICKED =3D 1, /* domain panicked (Since: v1.1.= 1) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CRASHED_LAST + VIR_DOMAIN_CRASHED_LAST /* (Since: v0.9.10) */ # endif } virDomainCrashedReason; =20 typedef enum { - VIR_DOMAIN_PMSUSPENDED_UNKNOWN =3D 0, + VIR_DOMAIN_PMSUSPENDED_UNKNOWN =3D 0, /* (Since: v0.9.11) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_LAST + VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: v0.9.11) */ # endif } virDomainPMSuspendedReason; =20 typedef enum { - VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN =3D 0, + VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN =3D 0, /* (Since: v1.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PMSUSPENDED_DISK_LAST + VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: v1.0.0) */ # endif } virDomainPMSuspendedDiskReason; =20 @@ -182,17 +184,17 @@ typedef enum { * Current state of a control interface to the domain. */ typedef enum { - VIR_DOMAIN_CONTROL_OK =3D 0, /* operational, ready to accept com= mands */ + VIR_DOMAIN_CONTROL_OK =3D 0, /* operational, ready to accept com= mands (Since: v0.9.3) */ VIR_DOMAIN_CONTROL_JOB =3D 1, /* background job is running (can be monitored by virDomainGetJobInfo);= only - limited set of commands may be all= owed */ - VIR_DOMAIN_CONTROL_OCCUPIED =3D 2, /* occupied by a running command */ + limited set of commands may be all= owed (Since: v0.9.3) */ + VIR_DOMAIN_CONTROL_OCCUPIED =3D 2, /* occupied by a running command (S= ince: v0.9.3) */ VIR_DOMAIN_CONTROL_ERROR =3D 3, /* unusable, domain cannot be fully operated, possible reason is provi= ded - in the details field */ + in the details field (Since: v0.9.= 3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_CONTROL_LAST + VIR_DOMAIN_CONTROL_LAST /* (Since: v0.9.10) */ # endif } virDomainControlState; =20 @@ -203,16 +205,16 @@ typedef enum { */ typedef enum { VIR_DOMAIN_CONTROL_ERROR_REASON_NONE =3D 0, /* server didn't provi= de a - reason */ + reason (Since: v1.2.1= 4) */ VIR_DOMAIN_CONTROL_ERROR_REASON_UNKNOWN =3D 1, /* unknown reason for = the - error */ + error (Since: v1.2.14= ) */ VIR_DOMAIN_CONTROL_ERROR_REASON_MONITOR =3D 2, /* monitor connection = is - broken */ + broken (Since: v1.2.1= 4) */ VIR_DOMAIN_CONTROL_ERROR_REASON_INTERNAL =3D 3, /* error caused due to - internal failure in l= ibvirt + internal failure in l= ibvirt (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; =20 @@ -258,10 +260,10 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * These enums should not conflict with those of virTypedParameterFlags. */ typedef enum { - VIR_DOMAIN_AFFECT_CURRENT =3D 0, /* Affect current domain state. = */ - VIR_DOMAIN_AFFECT_LIVE =3D 1 << 0, /* Affect running domain state. = */ + VIR_DOMAIN_AFFECT_CURRENT =3D 0, /* Affect current domain state. = (Since: v0.9.2) */ + VIR_DOMAIN_AFFECT_LIVE =3D 1 << 0, /* Affect running domain state. = (Since: v0.9.2) */ VIR_DOMAIN_AFFECT_CONFIG =3D 1 << 1, /* Affect persistent domain stat= e. */ - /* 1 << 2 is reserved for virTypedParameterFlags */ + /* 1 << 2 is reserved for virTypedParameterFlags (Since: v0.9.2) */ } virDomainModificationImpact; =20 /** @@ -296,13 +298,13 @@ typedef virDomainInfo *virDomainInfoPtr; * Domain. */ typedef enum { - VIR_DOMAIN_NONE =3D 0, /* Default behavior */ - VIR_DOMAIN_START_PAUSED =3D 1 << 0, /* Launch guest in paused st= ate */ - VIR_DOMAIN_START_AUTODESTROY =3D 1 << 1, /* Automatically kill guest = when virConnectPtr is closed */ - VIR_DOMAIN_START_BYPASS_CACHE =3D 1 << 2, /* Avoid file system cache p= ollution */ - VIR_DOMAIN_START_FORCE_BOOT =3D 1 << 3, /* Boot, discarding any mana= ged save */ - VIR_DOMAIN_START_VALIDATE =3D 1 << 4, /* Validate the XML document= against schema */ - VIR_DOMAIN_START_RESET_NVRAM =3D 1 << 5, /* Re-initialize NVRAM from = template */ + VIR_DOMAIN_NONE =3D 0, /* Default behavior (Since: = v0.0.1) */ + VIR_DOMAIN_START_PAUSED =3D 1 << 0, /* Launch guest in paused st= ate (Since: v0.8.2) */ + VIR_DOMAIN_START_AUTODESTROY =3D 1 << 1, /* Automatically kill guest = when virConnectPtr is closed (Since: v0.9.3) */ + VIR_DOMAIN_START_BYPASS_CACHE =3D 1 << 2, /* Avoid file system cache p= ollution (Since: v0.9.4) */ + VIR_DOMAIN_START_FORCE_BOOT =3D 1 << 3, /* Boot, discarding any mana= ged save (Since: v0.9.5) */ + VIR_DOMAIN_START_VALIDATE =3D 1 << 4, /* Validate the XML document= against schema (Since: v1.2.12) */ + VIR_DOMAIN_START_RESET_NVRAM =3D 1 << 5, /* Re-initialize NVRAM from = template (Since: v8.1.0) */ } virDomainCreateFlags; =20 =20 @@ -585,9 +587,9 @@ typedef virDomainInterfaceStatsStruct *virDomainInterfa= ceStatsPtr; * Memory Statistics Tags: */ 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 =3D 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). (Sinc= e: v0.7.5) */ VIR_DOMAIN_MEMORY_STAT_SWAP_OUT =3D 1, =20 /* @@ -595,14 +597,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 fa= ult. * These are expressed as the number of faults that have occurred. + * + * Since: v0.7.5 + * */ VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT =3D 2, + + /* + * Since: v0.7.5 + */ VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT =3D 3, =20 /* * 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 =3D 4, =20 @@ -611,52 +623,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 =3D 5, =20 - /* Current balloon value (in KB). */ + /* + * Current balloon value (in KB). + * + * Since: v0.9.3 + * + */ VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON =3D 6, =20 /* 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 =3D 7, =20 /* * How much the balloon can be inflated without pushing the guest syst= em * to swap, corresponds to 'Available' in /proc/meminfo + * + * Since: v2.1.0 + * */ VIR_DOMAIN_MEMORY_STAT_USABLE =3D 8, =20 - /* 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 =3D 9, =20 /* * 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 =3D 10, =20 /* * The number of successful huge page allocations from inside the doma= in via * virtio balloon. + * + * Since: v5.4.0 + * */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGALLOC =3D 11, =20 /* * The number of failed huge page allocations from inside the domain v= ia * virtio balloon. + * + * Since: v5.4.0 + * */ VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGFAIL =3D 12, =20 /* * 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 =3D 13, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_MEMORY_STAT_LAST =3D VIR_DOMAIN_MEMORY_STAT_NR + VIR_DOMAIN_MEMORY_STAT_LAST =3D VIR_DOMAIN_MEMORY_STAT_NR /* (Since: v= 0.9.10) */ # endif } virDomainMemoryStatTags; =20 @@ -672,11 +714,11 @@ typedef virDomainMemoryStatStruct *virDomainMemorySta= tPtr; =20 /* Domain core dump flags. */ typedef enum { - VIR_DUMP_CRASH =3D (1 << 0), /* crash after dump */ - VIR_DUMP_LIVE =3D (1 << 1), /* live dump */ - VIR_DUMP_BYPASS_CACHE =3D (1 << 2), /* avoid file system cache polluti= on */ - VIR_DUMP_RESET =3D (1 << 3), /* reset domain after dump finishe= s */ - VIR_DUMP_MEMORY_ONLY =3D (1 << 4), /* use dump-guest-memory */ + VIR_DUMP_CRASH =3D (1 << 0), /* crash after dump (Since: v0.7.5= ) */ + VIR_DUMP_LIVE =3D (1 << 1), /* live dump (Since: v0.7.5) */ + VIR_DUMP_BYPASS_CACHE =3D (1 << 2), /* avoid file system cache polluti= on (Since: v0.9.4) */ + VIR_DUMP_RESET =3D (1 << 3), /* reset domain after dump finishe= s (Since: v0.9.7) */ + VIR_DUMP_MEMORY_ONLY =3D (1 << 4), /* use dump-guest-memory (Since: v= 0.9.13) */ } virDomainCoreDumpFlags; =20 /** @@ -685,20 +727,22 @@ typedef enum { * Values for specifying different formats of domain core dumps. */ 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: v= 1.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 fo= rmat */ + * snappy compression (Since= : v1.2.3) */ + VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump fo= rmat (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; @@ -710,6 +754,9 @@ typedef enum { * The migration may never converge if the domain is changing its memo= ry * faster then it can be transferred. The domain can be manually paused * anytime during migration using virDomainSuspend. + * + * Since: v0.3.2 + * */ VIR_MIGRATE_LIVE =3D (1 << 0), =20 @@ -718,6 +765,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 =3D (1 << 1), =20 @@ -728,6 +778,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 =3D (1 << 2), =20 @@ -735,17 +788,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 =3D (1 << 3), =20 /* Undefine the domain on the source host once migration successfully * finishes. + * + * Since: v0.7.3 + * */ VIR_MIGRATE_UNDEFINE_SOURCE =3D (1 << 4), =20 /* 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 =3D (1 << 5), =20 @@ -755,6 +817,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 =3D (1 << 6), =20 @@ -765,6 +830,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 =3D (1 << 7), =20 @@ -772,6 +840,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 =3D (1 << 8), =20 @@ -782,6 +853,9 @@ typedef enum { * without explicitly setting cache mode to "none". Migrating such dom= ains * is unsafe unless the disk images are stored on coherent clustered * filesystem, such as GFS2 or GPFS. + * + * Since: v0.9.11 + * */ VIR_MIGRATE_UNSAFE =3D (1 << 9), =20 @@ -791,6 +865,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 =3D (1 << 10), =20 @@ -798,11 +875,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 =3D (1 << 11), =20 /* Cancel migration if a soft error (such as I/O error) happens during * migration. + * + * Since: v1.1.0 + * */ VIR_MIGRATE_ABORT_ON_ERROR =3D (1 << 12), =20 @@ -811,6 +894,9 @@ typedef enum { * not change its memory faster than a hypervisor can transfer the cha= nged * 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 =3D (1 << 13), =20 @@ -828,6 +914,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 =3D (1 << 14), =20 @@ -835,6 +924,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 =3D (1 << 15), =20 @@ -842,12 +934,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 =3D (1 << 16), =20 /* 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 =3D (1 << 17), =20 @@ -858,6 +956,9 @@ typedef enum { * * Requires one of VIR_MIGRATE_NON_SHARED_DISK, VIR_MIGRATE_NON_SHARE= D_INC * to be present as well. + * + * Since: v8.0.0 + * */ VIR_MIGRATE_NON_SHARED_SYNCHRONOUS_WRITES =3D (1 << 18), =20 @@ -1138,7 +1239,7 @@ int virDomainMigrateSetCompressionCache(virDomainPtr = domain, =20 /* Domain migration speed flags. */ 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 =3D (1 << 0), } virDomainMigrateMaxSpeedFlags; =20 @@ -1200,12 +1301,12 @@ virDomainPtr virDomainLookupByUUIDString= (virConnectPtr conn, const char *uuid); =20 typedef enum { - VIR_DOMAIN_SHUTDOWN_DEFAULT =3D 0, /* hypervisor choice = */ - VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event */ - VIR_DOMAIN_SHUTDOWN_GUEST_AGENT =3D (1 << 1), /* Use guest agent */ - VIR_DOMAIN_SHUTDOWN_INITCTL =3D (1 << 2), /* Use initctl */ - VIR_DOMAIN_SHUTDOWN_SIGNAL =3D (1 << 3), /* Send a signal */ - VIR_DOMAIN_SHUTDOWN_PARAVIRT =3D (1 << 4), /* Use paravirt guest= control */ + VIR_DOMAIN_SHUTDOWN_DEFAULT =3D 0, /* hypervisor choice = (Since: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event (S= ince: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_GUEST_AGENT =3D (1 << 1), /* Use guest agent (S= ince: v0.9.10) */ + VIR_DOMAIN_SHUTDOWN_INITCTL =3D (1 << 2), /* Use initctl (Since= : v1.0.1) */ + VIR_DOMAIN_SHUTDOWN_SIGNAL =3D (1 << 3), /* Send a signal (Sin= ce: v1.0.1) */ + VIR_DOMAIN_SHUTDOWN_PARAVIRT =3D (1 << 4), /* Use paravirt guest= control (Since: v1.2.5) */ } virDomainShutdownFlagValues; =20 int virDomainShutdown (virDomainPtr domain); @@ -1213,12 +1314,12 @@ int virDomainShutdownFlags (vi= rDomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_REBOOT_DEFAULT =3D 0, /* hypervisor choice */ - VIR_DOMAIN_REBOOT_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event */ - VIR_DOMAIN_REBOOT_GUEST_AGENT =3D (1 << 1), /* Use guest agent */ - VIR_DOMAIN_REBOOT_INITCTL =3D (1 << 2), /* Use initctl */ - VIR_DOMAIN_REBOOT_SIGNAL =3D (1 << 3), /* Send a signal */ - VIR_DOMAIN_REBOOT_PARAVIRT =3D (1 << 4), /* Use paravirt guest c= ontrol */ + VIR_DOMAIN_REBOOT_DEFAULT =3D 0, /* hypervisor choice (S= ince: v0.9.10) */ + VIR_DOMAIN_REBOOT_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event (Sin= ce: v0.9.10) */ + VIR_DOMAIN_REBOOT_GUEST_AGENT =3D (1 << 1), /* Use guest agent (Sin= ce: v0.9.10) */ + VIR_DOMAIN_REBOOT_INITCTL =3D (1 << 2), /* Use initctl (Since: = v1.0.1) */ + VIR_DOMAIN_REBOOT_SIGNAL =3D (1 << 3), /* Send a signal (Since= : v1.0.1) */ + VIR_DOMAIN_REBOOT_PARAVIRT =3D (1 << 4), /* Use paravirt guest c= ontrol (Since: v1.2.5) */ } virDomainRebootFlagValues; =20 int virDomainReboot (virDomainPtr domain, @@ -1235,9 +1336,9 @@ int virDomainDestroy (virD= omainPtr domain); * virDomainDestroyFlags() function */ typedef enum { - VIR_DOMAIN_DESTROY_DEFAULT =3D 0, /* Default behavior - could l= ead to data loss!! */ - VIR_DOMAIN_DESTROY_GRACEFUL =3D 1 << 0, /* only SIGTERM, no SIGKILL */ - VIR_DOMAIN_DESTROY_REMOVE_LOGS =3D 1 << 1, /* remove VM logs on destro= y */ + VIR_DOMAIN_DESTROY_DEFAULT =3D 0, /* Default behavior - could l= ead to data loss!! (Since: v0.9.10) */ + VIR_DOMAIN_DESTROY_GRACEFUL =3D 1 << 0, /* only SIGTERM, no SIGKILL (= Since: v0.9.10) */ + VIR_DOMAIN_DESTROY_REMOVE_LOGS =3D 1 << 1, /* remove VM logs on destro= y (Since: v8.3.0) */ } virDomainDestroyFlagsValues; =20 int virDomainDestroyFlags (virDomainPtr domain, @@ -1267,10 +1368,10 @@ int virDomainPMWakeup (vi= rDomainPtr domain, * flags apply to all these functions. */ typedef enum { - VIR_DOMAIN_SAVE_BYPASS_CACHE =3D 1 << 0, /* Avoid file system cache po= llution */ - VIR_DOMAIN_SAVE_RUNNING =3D 1 << 1, /* Favor running over paused = */ - VIR_DOMAIN_SAVE_PAUSED =3D 1 << 2, /* Favor paused over running = */ - VIR_DOMAIN_SAVE_RESET_NVRAM =3D 1 << 3, /* Re-initialize NVRAM from t= emplate */ + VIR_DOMAIN_SAVE_BYPASS_CACHE =3D 1 << 0, /* Avoid file system cache po= llution (Since: v0.9.4) */ + VIR_DOMAIN_SAVE_RUNNING =3D 1 << 1, /* Favor running over paused = (Since: v0.9.5) */ + VIR_DOMAIN_SAVE_PAUSED =3D 1 << 2, /* Favor paused over running = (Since: v0.9.5) */ + VIR_DOMAIN_SAVE_RESET_NVRAM =3D 1 << 3, /* Re-initialize NVRAM from t= emplate (Since: v8.1.0) */ } virDomainSaveRestoreFlags; =20 int virDomainSave (virDomainPtr domain, @@ -1520,12 +1621,12 @@ int virDomainGetMemoryParameters(virDomainPtr d= omain, =20 /* Memory size modification flags. */ typedef enum { - /* See virDomainModificationImpact for these flags. */ + /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_MEM_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_MEM_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_MEM_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, =20 - /* Additionally, these flags may be bitwise-OR'd in. */ + /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ VIR_DOMAIN_MEM_MAXIMUM =3D (1 << 2), /* affect Max rather than current= */ } virDomainMemoryModFlags; =20 @@ -1538,13 +1639,13 @@ typedef enum { * a domain. */ typedef enum { - VIR_DOMAIN_NUMATUNE_MEM_STRICT =3D 0, - VIR_DOMAIN_NUMATUNE_MEM_PREFERRED =3D 1, - VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE =3D 2, - VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE =3D 3, + VIR_DOMAIN_NUMATUNE_MEM_STRICT =3D 0, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_PREFERRED =3D 1, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE =3D 2, /* (Since: v0.9.9) */ + VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE =3D 3, /* (Since: v7.3.0) */ =20 # 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 (Si= nce: v0.9.9) */ # endif } virDomainNumatuneMemMode; =20 @@ -1597,8 +1698,8 @@ int virDomainGetSecurityLabel (vi= rDomainPtr domain, virSecurityLabelPtr sec= label); =20 typedef enum { - VIR_DOMAIN_GET_HOSTNAME_LEASE =3D (1 << 0), /* Parse DHCP lease file */ - VIR_DOMAIN_GET_HOSTNAME_AGENT =3D (1 << 1), /* Query qemu guest agent = */ + VIR_DOMAIN_GET_HOSTNAME_LEASE =3D (1 << 0), /* Parse DHCP lease file (= Since: v6.1.0) */ + VIR_DOMAIN_GET_HOSTNAME_AGENT =3D (1 << 1), /* Query qemu guest agent = (Since: v6.1.0) */ } virDomainGetHostnameFlags; =20 char * virDomainGetHostname (virDomainPtr domain, @@ -1607,12 +1708,12 @@ int virDomainGetSecurityLabelLi= st (virDomainPtr domain, virSecurityLabelPtr= * seclabels); =20 typedef enum { - VIR_DOMAIN_METADATA_DESCRIPTION =3D 0, /* Operate on */ - VIR_DOMAIN_METADATA_TITLE =3D 1, /* Operate on */ - VIR_DOMAIN_METADATA_ELEMENT =3D 2, /* Operate on <metadata> */ + VIR_DOMAIN_METADATA_DESCRIPTION =3D 0, /* Operate on <description> (Si= nce: v0.9.10) */ + VIR_DOMAIN_METADATA_TITLE =3D 1, /* Operate on <title> (Since: v= 0.9.10) */ + VIR_DOMAIN_METADATA_ELEMENT =3D 2, /* Operate on <metadata> (Since= : v0.9.10) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_METADATA_LAST + VIR_DOMAIN_METADATA_LAST /* (Since: v0.9.10) */ # endif } virDomainMetadataType; =20 @@ -1640,14 +1741,14 @@ virDomainGetMetadata(virDomainPtr domain, */ =20 typedef enum { - VIR_DOMAIN_XML_SECURE =3D (1 << 0), /* dump security sensitive i= nformation too */ - VIR_DOMAIN_XML_INACTIVE =3D (1 << 1), /* dump inactive domain info= rmation */ - VIR_DOMAIN_XML_UPDATE_CPU =3D (1 << 2), /* update guest CPU requirem= ents according to host CPU */ - VIR_DOMAIN_XML_MIGRATABLE =3D (1 << 3), /* dump XML suitable for mig= ration */ + VIR_DOMAIN_XML_SECURE =3D (1 << 0), /* dump security sensitive i= nformation too (Since: v0.3.3) */ + VIR_DOMAIN_XML_INACTIVE =3D (1 << 1), /* dump inactive domain info= rmation (Since: v0.3.3) */ + VIR_DOMAIN_XML_UPDATE_CPU =3D (1 << 2), /* update guest CPU requirem= ents according to host CPU (Since: v0.8.0) */ + VIR_DOMAIN_XML_MIGRATABLE =3D (1 << 3), /* dump XML suitable for mig= ration (Since: v1.0.0) */ } virDomainXMLFlags; =20 typedef enum { - VIR_DOMAIN_SAVE_IMAGE_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /*= dump security sensitive information too */ + VIR_DOMAIN_SAVE_IMAGE_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /*= dump security sensitive information too (Since: v5.1.0) */ } virDomainSaveImageXMLFlags; =20 char * virDomainGetXMLDesc (virDomainPtr domain, @@ -1752,7 +1853,7 @@ int virDomainBlockPeek (virDomain= Ptr dom, * Flags available for virDomainBlockResize(). */ typedef enum { - VIR_DOMAIN_BLOCK_RESIZE_BYTES =3D 1 << 0, /* size in bytes instead of = KiB */ + VIR_DOMAIN_BLOCK_RESIZE_BYTES =3D 1 << 0, /* size in bytes instead of = KiB (Since: v0.9.11) */ } virDomainBlockResizeFlags; =20 int virDomainBlockResize (virDomainPtr dom, @@ -1814,8 +1915,8 @@ int virDomainMemoryStats (virDoma= inPtr dom, /* Memory peeking flags. */ =20 typedef enum { - VIR_MEMORY_VIRTUAL =3D 1 << 0, /* addresses are virtual add= resses */ - VIR_MEMORY_PHYSICAL =3D 1 << 1, /* addresses are physical ad= dresses */ + VIR_MEMORY_VIRTUAL =3D 1 << 0, /* addresses are virtual add= resses (Since: v0.4.4) */ + VIR_MEMORY_PHYSICAL =3D 1 << 1, /* addresses are physical ad= dresses (Since: v0.7.0) */ } virDomainMemoryFlags; =20 int virDomainMemoryPeek (virDomainPtr dom, @@ -1825,7 +1926,7 @@ int virDomainMemoryPeek (virDomai= nPtr dom, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_DEFINE_VALIDATE =3D (1 << 0), /* Validate the XML document = against schema */ + VIR_DOMAIN_DEFINE_VALIDATE =3D (1 << 0), /* Validate the XML document = against schema (Since: v1.2.12) */ } virDomainDefineFlags; =20 /* @@ -1841,18 +1942,18 @@ int virDomainUndefine (vi= rDomainPtr domain); =20 typedef enum { VIR_DOMAIN_UNDEFINE_MANAGED_SAVE =3D (1 << 0), /* Also remove any - managed save */ + managed save (Si= nce: v0.9.4) */ VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA =3D (1 << 1), /* If last use of= domain, then also remove= any - snapshot metadat= a */ + snapshot metadat= a (Since: v0.9.5) */ VIR_DOMAIN_UNDEFINE_NVRAM =3D (1 << 2), /* Also remove any - nvram file */ - VIR_DOMAIN_UNDEFINE_KEEP_NVRAM =3D (1 << 3), /* Keep nvram fil= e */ + nvram file (Sinc= e: v1.2.9) */ + VIR_DOMAIN_UNDEFINE_KEEP_NVRAM =3D (1 << 3), /* Keep nvram fil= e (Since: v2.3.0) */ VIR_DOMAIN_UNDEFINE_CHECKPOINTS_METADATA =3D (1 << 4), /* If last use = of domain, then also remo= ve any checkpoint met= adata */ =20 - /* Future undefine control flags should come here. */ + /* Future undefine control flags should come here. (Since: v5.6.0) */ } virDomainUndefineFlagsValues; =20 =20 @@ -1870,28 +1971,28 @@ int virConnectListDefinedDomain= s (virConnectPtr conn, * then that group is not used to filter results. */ typedef enum { - VIR_CONNECT_LIST_DOMAINS_ACTIVE =3D 1 << 0, - VIR_CONNECT_LIST_DOMAINS_INACTIVE =3D 1 << 1, + VIR_CONNECT_LIST_DOMAINS_ACTIVE =3D 1 << 0, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_INACTIVE =3D 1 << 1, /* (Since: v0.9.13= ) */ =20 - VIR_CONNECT_LIST_DOMAINS_PERSISTENT =3D 1 << 2, - VIR_CONNECT_LIST_DOMAINS_TRANSIENT =3D 1 << 3, + VIR_CONNECT_LIST_DOMAINS_PERSISTENT =3D 1 << 2, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_TRANSIENT =3D 1 << 3, /* (Since: v0.9.13= ) */ =20 - VIR_CONNECT_LIST_DOMAINS_RUNNING =3D 1 << 4, - VIR_CONNECT_LIST_DOMAINS_PAUSED =3D 1 << 5, - VIR_CONNECT_LIST_DOMAINS_SHUTOFF =3D 1 << 6, - VIR_CONNECT_LIST_DOMAINS_OTHER =3D 1 << 7, + VIR_CONNECT_LIST_DOMAINS_RUNNING =3D 1 << 4, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_PAUSED =3D 1 << 5, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_SHUTOFF =3D 1 << 6, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_OTHER =3D 1 << 7, /* (Since: v0.9.13= ) */ =20 - VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE =3D 1 << 8, - VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE =3D 1 << 9, + VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE =3D 1 << 8, /* (Since: v0.9.13= ) */ + VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE =3D 1 << 9, /* (Since: v0.9.13= ) */ =20 - VIR_CONNECT_LIST_DOMAINS_AUTOSTART =3D 1 << 10, - VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART =3D 1 << 11, + VIR_CONNECT_LIST_DOMAINS_AUTOSTART =3D 1 << 10, /* (Since: v0.9.1= 3) */ + VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART =3D 1 << 11, /* (Since: v0.9.1= 3) */ =20 - VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT =3D 1 << 12, - VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT =3D 1 << 13, + VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT =3D 1 << 12, /* (Since: v0.9.1= 3) */ + VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT =3D 1 << 13, /* (Since: v0.9.1= 3) */ =20 - VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT =3D 1 << 14, - VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT =3D 1 << 15, + VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT =3D 1 << 14, /* (Since: v5.6.0= ) */ + VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT =3D 1 << 15, /* (Since: v5.6.0= ) */ } virConnectListAllDomainsFlags; =20 int virConnectListAllDomains (virConnectPtr conn, @@ -1916,18 +2017,18 @@ int virDomainSetAutostart (vi= rDomainPtr domain, */ =20 typedef enum { - VIR_VCPU_OFFLINE =3D 0, /* the virtual CPU is offline */ - VIR_VCPU_RUNNING =3D 1, /* the virtual CPU is running */ - VIR_VCPU_BLOCKED =3D 2, /* the virtual CPU is blocked on resourc= e */ + VIR_VCPU_OFFLINE =3D 0, /* the virtual CPU is offline (Since: v0= .1.4) */ + VIR_VCPU_RUNNING =3D 1, /* the virtual CPU is running (Since: v0= .1.4) */ + VIR_VCPU_BLOCKED =3D 2, /* the virtual CPU is blocked on resourc= e (Since: v0.1.4) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_VCPU_LAST + VIR_VCPU_LAST /* (Since: v0.9.10) */ # endif } virVcpuState; =20 typedef enum { - VIR_VCPU_INFO_CPU_OFFLINE =3D -1, /* the vCPU is offline */ - VIR_VCPU_INFO_CPU_UNAVAILABLE =3D -2, /* the hypervisor does not expos= e real CPU information */ + VIR_VCPU_INFO_CPU_OFFLINE =3D -1, /* the vCPU is offline (Since: v= 6.10.0) */ + VIR_VCPU_INFO_CPU_UNAVAILABLE =3D -2, /* the hypervisor does not expos= e real CPU information (Since: v6.10.0) */ } virVcpuHostCpuState; =20 typedef struct _virVcpuInfo virVcpuInfo; @@ -1941,14 +2042,14 @@ typedef virVcpuInfo *virVcpuInfoPtr; =20 /* Flags for controlling virtual CPU hot-plugging. */ typedef enum { - /* See virDomainModificationImpact for these flags. */ + /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_VCPU_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_VCPU_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_VCPU_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, =20 - /* Additionally, these flags may be bitwise-OR'd in. */ - VIR_DOMAIN_VCPU_MAXIMUM =3D (1 << 2), /* Max rather than current count= */ - VIR_DOMAIN_VCPU_GUEST =3D (1 << 3), /* Modify state of the cpu in th= e guest */ + /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ + VIR_DOMAIN_VCPU_MAXIMUM =3D (1 << 2), /* Max rather than current count= (Since: v1.1.0) */ + VIR_DOMAIN_VCPU_GUEST =3D (1 << 3), /* Modify state of the cpu in th= e guest (Since: v2.4.0) */ VIR_DOMAIN_VCPU_HOTPLUGGABLE =3D (1 << 4), /* Make vcpus added hot(un)= pluggable */ } virDomainVcpuFlags; =20 @@ -2159,12 +2260,12 @@ int virDomainGetVcpus (vi= rDomainPtr domain, =20 =20 typedef enum { - /* See virDomainModificationImpact for these flags. */ + /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_DEVICE_MODIFY_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_DEVICE_MODIFY_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_DEVICE_MODIFY_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, =20 - /* Additionally, these flags may be bitwise-OR'd in. */ + /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ VIR_DOMAIN_DEVICE_MODIFY_FORCE =3D (1 << 2), /* Forcibly modify device (ex. force eject a cdrom= ) */ } virDomainDeviceModifyFlags; @@ -2191,34 +2292,34 @@ struct _virDomainStatsRecord { }; =20 typedef enum { - VIR_DOMAIN_STATS_STATE =3D (1 << 0), /* return domain state */ - VIR_DOMAIN_STATS_CPU_TOTAL =3D (1 << 1), /* return domain CPU info */ - VIR_DOMAIN_STATS_BALLOON =3D (1 << 2), /* return domain balloon info */ - VIR_DOMAIN_STATS_VCPU =3D (1 << 3), /* return domain virtual CPU info = */ - VIR_DOMAIN_STATS_INTERFACE =3D (1 << 4), /* return domain interfaces i= nfo */ - VIR_DOMAIN_STATS_BLOCK =3D (1 << 5), /* return domain block info */ - VIR_DOMAIN_STATS_PERF =3D (1 << 6), /* return domain perf event info */ - VIR_DOMAIN_STATS_IOTHREAD =3D (1 << 7), /* return iothread poll info */ - VIR_DOMAIN_STATS_MEMORY =3D (1 << 8), /* return domain memory info */ - VIR_DOMAIN_STATS_DIRTYRATE =3D (1 << 9), /* return domain dirty rate i= nfo */ + VIR_DOMAIN_STATS_STATE =3D (1 << 0), /* return domain state (Since: v1= .2.8) */ + VIR_DOMAIN_STATS_CPU_TOTAL =3D (1 << 1), /* return domain CPU info (Si= nce: v1.2.9) */ + VIR_DOMAIN_STATS_BALLOON =3D (1 << 2), /* return domain balloon info (= Since: v1.2.9) */ + VIR_DOMAIN_STATS_VCPU =3D (1 << 3), /* return domain virtual CPU info = (Since: v1.2.9) */ + VIR_DOMAIN_STATS_INTERFACE =3D (1 << 4), /* return domain interfaces i= nfo (Since: v1.2.9) */ + VIR_DOMAIN_STATS_BLOCK =3D (1 << 5), /* return domain block info (Sinc= e: v1.2.9) */ + VIR_DOMAIN_STATS_PERF =3D (1 << 6), /* return domain perf event info (= Since: v1.3.3) */ + VIR_DOMAIN_STATS_IOTHREAD =3D (1 << 7), /* return iothread poll info (= Since: v4.10.0) */ + VIR_DOMAIN_STATS_MEMORY =3D (1 << 8), /* return domain memory info (Si= nce: v6.0.0) */ + VIR_DOMAIN_STATS_DIRTYRATE =3D (1 << 9), /* return domain dirty rate i= nfo (Since: v7.2.0) */ } virDomainStatsTypes; =20 typedef enum { - VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE =3D VIR_CONNECT_LIST_DOMAINS_= ACTIVE, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE =3D VIR_CONNECT_LIST_DOMAIN= S_INACTIVE, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE =3D VIR_CONNECT_LIST_DOMAINS_= ACTIVE, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE =3D VIR_CONNECT_LIST_DOMAIN= S_INACTIVE, /* (Since: v1.2.8) */ =20 - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT =3D VIR_CONNECT_LIST_DOMA= INS_PERSISTENT, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT =3D VIR_CONNECT_LIST_DOMAI= NS_TRANSIENT, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT =3D VIR_CONNECT_LIST_DOMA= INS_PERSISTENT, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT =3D VIR_CONNECT_LIST_DOMAI= NS_TRANSIENT, /* (Since: v1.2.8) */ =20 - VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING =3D VIR_CONNECT_LIST_DOMAINS= _RUNNING, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED =3D VIR_CONNECT_LIST_DOMAINS_= PAUSED, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF =3D VIR_CONNECT_LIST_DOMAINS= _SHUTOFF, - VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER =3D VIR_CONNECT_LIST_DOMAINS_O= THER, + VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING =3D VIR_CONNECT_LIST_DOMAINS= _RUNNING, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED =3D VIR_CONNECT_LIST_DOMAINS_= PAUSED, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF =3D VIR_CONNECT_LIST_DOMAINS= _SHUTOFF, /* (Since: v1.2.8) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER =3D VIR_CONNECT_LIST_DOMAINS_O= THER, /* (Since: v1.2.8) */ =20 VIR_CONNECT_GET_ALL_DOMAINS_STATS_NOWAIT =3D 1 << 29, /* report statis= tics that can be obtained - immediately wit= hout any blocking */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING =3D 1 << 30, /* include back= ing chain for block stats */ - VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS =3D 1U << 31, /* enfor= ce requested stats */ + immediately wit= hout any blocking (Since: v4.5.0) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING =3D 1 << 30, /* include back= ing chain for block stats (Since: v1.2.12) */ + VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS =3D 1U << 31, /* enfor= ce requested stats (Since: v1.2.8) */ } virConnectGetAllDomainStatsFlags; =20 int virConnectGetAllDomainStats(virConnectPtr conn, @@ -2482,30 +2583,45 @@ int virDomainSetPerfEvents(virDomainPtr dom, * Describes various possible block jobs. */ typedef enum { - /* Placeholder */ + /* Placeholder (Since: v0.9.4) */ VIR_DOMAIN_BLOCK_JOB_TYPE_UNKNOWN =3D 0, =20 /* 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 =3D 1, =20 /* 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 =3D 2, =20 /* Block Commit (virDomainBlockCommit without flags), job ends on - * completion */ + * completion + * + * Since: v0.10.2 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT =3D 3, =20 /* 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 =3D 4, =20 - /* Backup (virDomainBackupBegin) */ + /* Backup (virDomainBackupBegin) + * + * Since: v6.0.0 + */ VIR_DOMAIN_BLOCK_JOB_TYPE_BACKUP =3D 5, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_TYPE_LAST + VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: v0.9.10) */ # endif } virDomainBlockJobType; =20 @@ -2517,8 +2633,8 @@ typedef enum { * active commit job */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC =3D 1 << 0, - VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT =3D 1 << 1, + VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC =3D 1 << 0, /* (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT =3D 1 << 1, /* (Since: v0.9.12) */ } virDomainBlockJobAbortFlags; =20 int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, @@ -2527,7 +2643,7 @@ int virDomainBlockJobAbort(virDomainPtr dom, const ch= ar *disk, /* Flags for use with virDomainGetBlockJobInfo */ typedef enum { VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in = bytes/s - instead of MiB/= s */ + instead of MiB/= s (Since: v1.2.9) */ } virDomainBlockJobInfoFlags; =20 /* An iterator for monitoring block job operations */ @@ -2556,7 +2672,7 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const = char *disk, /* Flags for use with virDomainBlockJobSetSpeed */ typedef enum { VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in= bytes/s - instead of MiB= /s */ + instead of MiB= /s (Since: v1.2.9) */ } virDomainBlockJobSetSpeedFlags; =20 int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, @@ -2566,7 +2682,7 @@ int virDomainBlockJobSetSpeed(virDomainPtr dom, const= char *disk, * of the flags for virDomainBlockRebase) */ typedef enum { VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES =3D 1 << 6, /* bandwidth in byte= s/s - instead of MiB/s */ + instead of MiB/s (S= ince: v1.2.9) */ } virDomainBlockPullFlags; =20 int virDomainBlockPull(virDomainPtr dom, const char *disk, @@ -2579,18 +2695,18 @@ int virDomainBlockPull(virDomainPtr dom, const char= *disk, */ typedef enum { VIR_DOMAIN_BLOCK_REBASE_SHALLOW =3D 1 << 0, /* Limit copy to top of = source - backing chain */ + backing chain (Since: v= 0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT =3D 1 << 1, /* Reuse existing extern= al - file for a copy */ - VIR_DOMAIN_BLOCK_REBASE_COPY_RAW =3D 1 << 2, /* Make destination file= raw */ - VIR_DOMAIN_BLOCK_REBASE_COPY =3D 1 << 3, /* Start a copy job */ + file for a copy (Since:= v0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY_RAW =3D 1 << 2, /* Make destination file= raw (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_REBASE_COPY =3D 1 << 3, /* Start a copy job (Sin= ce: v0.9.12) */ VIR_DOMAIN_BLOCK_REBASE_RELATIVE =3D 1 << 4, /* Keep backing chain referenced using relati= ve - names */ + names (Since: v1.2.7) */ VIR_DOMAIN_BLOCK_REBASE_COPY_DEV =3D 1 << 5, /* Treat destination as = block - device instead of file = */ + device instead of file = (Since: v1.2.9) */ VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES =3D 1 << 6, /* bandwidth in by= tes/s - instead of MiB/s = */ + instead of MiB/s = (Since: v1.2.9) */ } virDomainBlockRebaseFlags; =20 int virDomainBlockRebase(virDomainPtr dom, const char *disk, @@ -2603,17 +2719,20 @@ int virDomainBlockRebase(virDomainPtr dom, const ch= ar *disk, * Flags available for virDomainBlockCopy(). */ 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 =3D 1 << 0, =20 - /* Reuse existing external file for a copy */ + /* Reuse existing external file for a copy (Since: v1.2.8) */ VIR_DOMAIN_BLOCK_COPY_REUSE_EXT =3D 1 << 1, =20 - /* 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 =3D 1 << 2, =20 /* 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 =3D 1 << 3, } virDomainBlockCopyFlags; =20 @@ -2669,17 +2788,17 @@ int virDomainBlockCopy(virDomainPtr dom, const char= *disk, */ typedef enum { VIR_DOMAIN_BLOCK_COMMIT_SHALLOW =3D 1 << 0, /* NULL base means next ba= cking - file, not whole chain */ + file, not whole chain (Si= nce: v0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_DELETE =3D 1 << 1, /* Delete any files that a= re now invalid after their conte= nts - have been committed */ + have been committed (Sinc= e: v0.10.2) */ VIR_DOMAIN_BLOCK_COMMIT_ACTIVE =3D 1 << 2, /* Allow a two-phase commi= t when - top is the active layer */ + top is the active layer (= Since: v1.2.6) */ VIR_DOMAIN_BLOCK_COMMIT_RELATIVE =3D 1 << 3, /* keep the backing chain referenced using relative - names */ + names (Since: v1.2.7) */ VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES =3D 1 << 4, /* bandwidth in by= tes/s - instead of MiB/s = */ + instead of MiB/s = (Since: v1.2.9) */ } virDomainBlockCommitFlags; =20 int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *b= ase, @@ -2864,12 +2983,12 @@ virDomainGetBlockIoTune(virDomainPtr dom, * Disk I/O error. */ typedef enum { - VIR_DOMAIN_DISK_ERROR_NONE =3D 0, /* no error */ - VIR_DOMAIN_DISK_ERROR_UNSPEC =3D 1, /* unspecified I/O error */ - VIR_DOMAIN_DISK_ERROR_NO_SPACE =3D 2, /* no space left on the device = */ + VIR_DOMAIN_DISK_ERROR_NONE =3D 0, /* no error (Since: v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_UNSPEC =3D 1, /* unspecified I/O error (Since= : v0.9.10) */ + VIR_DOMAIN_DISK_ERROR_NO_SPACE =3D 2, /* no space left on the device = (Since: v0.9.10) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DISK_ERROR_LAST + VIR_DOMAIN_DISK_ERROR_LAST /* (Since: v0.9.10) */ # endif } virDomainDiskErrorCode; =20 @@ -2898,16 +3017,16 @@ int virDomainGetDiskErrors(virDomainPtr dom, * Enum to specify which keycode mapping is in use for virDomainSendKey(). */ typedef enum { - VIR_KEYCODE_SET_LINUX =3D 0, - VIR_KEYCODE_SET_XT =3D 1, - VIR_KEYCODE_SET_ATSET1 =3D 2, - VIR_KEYCODE_SET_ATSET2 =3D 3, - VIR_KEYCODE_SET_ATSET3 =3D 4, - VIR_KEYCODE_SET_OSX =3D 5, - VIR_KEYCODE_SET_XT_KBD =3D 6, - VIR_KEYCODE_SET_USB =3D 7, - VIR_KEYCODE_SET_WIN32 =3D 8, - VIR_KEYCODE_SET_QNUM =3D 9, + VIR_KEYCODE_SET_LINUX =3D 0, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_XT =3D 1, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET1 =3D 2, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET2 =3D 3, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_ATSET3 =3D 4, /* (Since: v0.9.3) */ + VIR_KEYCODE_SET_OSX =3D 5, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_XT_KBD =3D 6, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_USB =3D 7, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_WIN32 =3D 8, /* (Since: v0.9.4) */ + VIR_KEYCODE_SET_QNUM =3D 9, /* (Since: v4.2.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_KEYCODE_SET_LAST @@ -2915,6 +3034,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; @@ -2951,80 +3072,80 @@ int virDomainSendKey(virDomainPtr domain, * mapping in Linux. */ typedef enum { - VIR_DOMAIN_PROCESS_SIGNAL_NOP =3D 0, /* No constant in POSIX/L= inux */ - VIR_DOMAIN_PROCESS_SIGNAL_HUP =3D 1, /* SIGHUP */ - VIR_DOMAIN_PROCESS_SIGNAL_INT =3D 2, /* SIGINT */ - VIR_DOMAIN_PROCESS_SIGNAL_QUIT =3D 3, /* SIGQUIT */ - VIR_DOMAIN_PROCESS_SIGNAL_ILL =3D 4, /* SIGILL */ - VIR_DOMAIN_PROCESS_SIGNAL_TRAP =3D 5, /* SIGTRAP */ - VIR_DOMAIN_PROCESS_SIGNAL_ABRT =3D 6, /* SIGABRT */ - VIR_DOMAIN_PROCESS_SIGNAL_BUS =3D 7, /* SIGBUS */ - VIR_DOMAIN_PROCESS_SIGNAL_FPE =3D 8, /* SIGFPE */ - VIR_DOMAIN_PROCESS_SIGNAL_KILL =3D 9, /* SIGKILL */ - - VIR_DOMAIN_PROCESS_SIGNAL_USR1 =3D 10, /* SIGUSR1 */ - VIR_DOMAIN_PROCESS_SIGNAL_SEGV =3D 11, /* SIGSEGV */ - VIR_DOMAIN_PROCESS_SIGNAL_USR2 =3D 12, /* SIGUSR2 */ - VIR_DOMAIN_PROCESS_SIGNAL_PIPE =3D 13, /* SIGPIPE */ - VIR_DOMAIN_PROCESS_SIGNAL_ALRM =3D 14, /* SIGALRM */ - VIR_DOMAIN_PROCESS_SIGNAL_TERM =3D 15, /* SIGTERM */ - VIR_DOMAIN_PROCESS_SIGNAL_STKFLT =3D 16, /* Not in POSIX (SIGSTKFL= T on Linux )*/ - VIR_DOMAIN_PROCESS_SIGNAL_CHLD =3D 17, /* SIGCHLD */ - VIR_DOMAIN_PROCESS_SIGNAL_CONT =3D 18, /* SIGCONT */ - VIR_DOMAIN_PROCESS_SIGNAL_STOP =3D 19, /* SIGSTOP */ - - VIR_DOMAIN_PROCESS_SIGNAL_TSTP =3D 20, /* SIGTSTP */ - VIR_DOMAIN_PROCESS_SIGNAL_TTIN =3D 21, /* SIGTTIN */ - VIR_DOMAIN_PROCESS_SIGNAL_TTOU =3D 22, /* SIGTTOU */ - VIR_DOMAIN_PROCESS_SIGNAL_URG =3D 23, /* SIGURG */ - VIR_DOMAIN_PROCESS_SIGNAL_XCPU =3D 24, /* SIGXCPU */ - VIR_DOMAIN_PROCESS_SIGNAL_XFSZ =3D 25, /* SIGXFSZ */ - VIR_DOMAIN_PROCESS_SIGNAL_VTALRM =3D 26, /* SIGVTALRM */ - VIR_DOMAIN_PROCESS_SIGNAL_PROF =3D 27, /* SIGPROF */ - VIR_DOMAIN_PROCESS_SIGNAL_WINCH =3D 28, /* Not in POSIX (SIGWINCH= on Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_POLL =3D 29, /* SIGPOLL (also known as= SIGIO on Linux) */ - - VIR_DOMAIN_PROCESS_SIGNAL_PWR =3D 30, /* Not in POSIX (SIGPWR o= n Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_SYS =3D 31, /* SIGSYS (also known as = SIGUNUSED on Linux) */ - VIR_DOMAIN_PROCESS_SIGNAL_RT0 =3D 32, /* SIGRTMIN */ - VIR_DOMAIN_PROCESS_SIGNAL_RT1 =3D 33, /* SIGRTMIN + 1 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT2 =3D 34, /* SIGRTMIN + 2 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT3 =3D 35, /* SIGRTMIN + 3 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT4 =3D 36, /* SIGRTMIN + 4 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT5 =3D 37, /* SIGRTMIN + 5 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT6 =3D 38, /* SIGRTMIN + 6 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT7 =3D 39, /* SIGRTMIN + 7 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT8 =3D 40, /* SIGRTMIN + 8 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT9 =3D 41, /* SIGRTMIN + 9 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT10 =3D 42, /* SIGRTMIN + 10 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT11 =3D 43, /* SIGRTMIN + 11 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT12 =3D 44, /* SIGRTMIN + 12 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT13 =3D 45, /* SIGRTMIN + 13 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT14 =3D 46, /* SIGRTMIN + 14 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT15 =3D 47, /* SIGRTMIN + 15 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT16 =3D 48, /* SIGRTMIN + 16 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT17 =3D 49, /* SIGRTMIN + 17 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT18 =3D 50, /* SIGRTMIN + 18 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT19 =3D 51, /* SIGRTMIN + 19 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT20 =3D 52, /* SIGRTMIN + 20 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT21 =3D 53, /* SIGRTMIN + 21 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT22 =3D 54, /* SIGRTMIN + 22 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT23 =3D 55, /* SIGRTMIN + 23 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT24 =3D 56, /* SIGRTMIN + 24 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT25 =3D 57, /* SIGRTMIN + 25 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT26 =3D 58, /* SIGRTMIN + 26 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT27 =3D 59, /* SIGRTMIN + 27 */ - - VIR_DOMAIN_PROCESS_SIGNAL_RT28 =3D 60, /* SIGRTMIN + 28 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT29 =3D 61, /* SIGRTMIN + 29 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT30 =3D 62, /* SIGRTMIN + 30 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT31 =3D 63, /* SIGRTMIN + 31 */ - VIR_DOMAIN_PROCESS_SIGNAL_RT32 =3D 64, /* SIGRTMIN + 32 / SIGRTM= AX */ + VIR_DOMAIN_PROCESS_SIGNAL_NOP =3D 0, /* No constant in POSIX/L= inux (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_HUP =3D 1, /* SIGHUP (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_INT =3D 2, /* SIGINT (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_QUIT =3D 3, /* SIGQUIT (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_ILL =3D 4, /* SIGILL (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_TRAP =3D 5, /* SIGTRAP (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_ABRT =3D 6, /* SIGABRT (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_BUS =3D 7, /* SIGBUS (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_FPE =3D 8, /* SIGFPE (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_KILL =3D 9, /* SIGKILL (Since: v1.0.1= ) */ + + VIR_DOMAIN_PROCESS_SIGNAL_USR1 =3D 10, /* SIGUSR1 (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_SEGV =3D 11, /* SIGSEGV (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_USR2 =3D 12, /* SIGUSR2 (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_PIPE =3D 13, /* SIGPIPE (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_ALRM =3D 14, /* SIGALRM (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_TERM =3D 15, /* SIGTERM (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_STKFLT =3D 16, /* Not in POSIX (SIGSTKFL= T on Linux (Since: v1.0.1) )*/ + VIR_DOMAIN_PROCESS_SIGNAL_CHLD =3D 17, /* SIGCHLD (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_CONT =3D 18, /* SIGCONT (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_STOP =3D 19, /* SIGSTOP (Since: v1.0.1= ) */ + + VIR_DOMAIN_PROCESS_SIGNAL_TSTP =3D 20, /* SIGTSTP (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTIN =3D 21, /* SIGTTIN (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_TTOU =3D 22, /* SIGTTOU (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_URG =3D 23, /* SIGURG (Since: v1.0.1)= */ + VIR_DOMAIN_PROCESS_SIGNAL_XCPU =3D 24, /* SIGXCPU (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_XFSZ =3D 25, /* SIGXFSZ (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_VTALRM =3D 26, /* SIGVTALRM (Since: v1.0= .1) */ + VIR_DOMAIN_PROCESS_SIGNAL_PROF =3D 27, /* SIGPROF (Since: v1.0.1= ) */ + VIR_DOMAIN_PROCESS_SIGNAL_WINCH =3D 28, /* Not in POSIX (SIGWINCH= on Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_POLL =3D 29, /* SIGPOLL (also known as= SIGIO on Linux) (Since: v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_PWR =3D 30, /* Not in POSIX (SIGPWR o= n Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_SYS =3D 31, /* SIGSYS (also known as = SIGUNUSED on Linux) (Since: v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT0 =3D 32, /* SIGRTMIN (Since: v1.0.= 1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT1 =3D 33, /* SIGRTMIN + 1 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT2 =3D 34, /* SIGRTMIN + 2 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT3 =3D 35, /* SIGRTMIN + 3 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT4 =3D 36, /* SIGRTMIN + 4 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT5 =3D 37, /* SIGRTMIN + 5 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT6 =3D 38, /* SIGRTMIN + 6 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT7 =3D 39, /* SIGRTMIN + 7 (Since: v= 1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT8 =3D 40, /* SIGRTMIN + 8 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT9 =3D 41, /* SIGRTMIN + 9 (Since: v= 1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT10 =3D 42, /* SIGRTMIN + 10 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT11 =3D 43, /* SIGRTMIN + 11 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT12 =3D 44, /* SIGRTMIN + 12 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT13 =3D 45, /* SIGRTMIN + 13 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT14 =3D 46, /* SIGRTMIN + 14 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT15 =3D 47, /* SIGRTMIN + 15 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT16 =3D 48, /* SIGRTMIN + 16 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT17 =3D 49, /* SIGRTMIN + 17 (Since: = v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT18 =3D 50, /* SIGRTMIN + 18 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT19 =3D 51, /* SIGRTMIN + 19 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT20 =3D 52, /* SIGRTMIN + 20 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT21 =3D 53, /* SIGRTMIN + 21 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT22 =3D 54, /* SIGRTMIN + 22 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT23 =3D 55, /* SIGRTMIN + 23 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT24 =3D 56, /* SIGRTMIN + 24 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT25 =3D 57, /* SIGRTMIN + 25 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT26 =3D 58, /* SIGRTMIN + 26 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT27 =3D 59, /* SIGRTMIN + 27 (Since: = v1.0.1) */ + + VIR_DOMAIN_PROCESS_SIGNAL_RT28 =3D 60, /* SIGRTMIN + 28 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT29 =3D 61, /* SIGRTMIN + 29 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT30 =3D 62, /* SIGRTMIN + 30 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT31 =3D 63, /* SIGRTMIN + 31 (Since: = v1.0.1) */ + VIR_DOMAIN_PROCESS_SIGNAL_RT32 =3D 64, /* SIGRTMIN + 32 / SIGRTM= AX (Since: v1.0.1) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_PROCESS_SIGNAL_LAST + VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: v1.0.1) */ # endif } virDomainProcessSignal; =20 @@ -3051,18 +3172,18 @@ virDomainPtr virDomainCreateLinux (vi= rConnectPtr conn, * a virDomainEventType is emitted during domain lifecycle events */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED =3D 0, - VIR_DOMAIN_EVENT_UNDEFINED =3D 1, - VIR_DOMAIN_EVENT_STARTED =3D 2, - VIR_DOMAIN_EVENT_SUSPENDED =3D 3, - VIR_DOMAIN_EVENT_RESUMED =3D 4, - VIR_DOMAIN_EVENT_STOPPED =3D 5, - VIR_DOMAIN_EVENT_SHUTDOWN =3D 6, - VIR_DOMAIN_EVENT_PMSUSPENDED =3D 7, - VIR_DOMAIN_EVENT_CRASHED =3D 8, + VIR_DOMAIN_EVENT_DEFINED =3D 0, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED =3D 1, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED =3D 2, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED =3D 3, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED =3D 4, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED =3D 5, /* (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SHUTDOWN =3D 6, /* (Since: v0.9.8) */ + VIR_DOMAIN_EVENT_PMSUSPENDED =3D 7, /* (Since: v0.10.2) */ + VIR_DOMAIN_EVENT_CRASHED =3D 8, /* (Since: v1.1.1) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_LAST + VIR_DOMAIN_EVENT_LAST /* (Since: v0.9.10) */ # endif } virDomainEventType; =20 @@ -3072,13 +3193,13 @@ typedef enum { * Details on the cause of a 'defined' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_DEFINED_ADDED =3D 0, /* Newly created config file= */ - VIR_DOMAIN_EVENT_DEFINED_UPDATED =3D 1, /* Changed config file */ - VIR_DOMAIN_EVENT_DEFINED_RENAMED =3D 2, /* Domain was renamed */ - VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT =3D 3, /* Config was restored= from a snapshot */ + VIR_DOMAIN_EVENT_DEFINED_ADDED =3D 0, /* Newly created config file= (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_UPDATED =3D 1, /* Changed config file (Sinc= e: v0.5.0) */ + VIR_DOMAIN_EVENT_DEFINED_RENAMED =3D 2, /* Domain was renamed (Since= : v1.2.19) */ + VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT =3D 3, /* Config was restored= from a snapshot (Since: v1.3.3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DEFINED_LAST + VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventDefinedDetailType; =20 @@ -3088,11 +3209,11 @@ typedef enum { * Details on the cause of an 'undefined' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_UNDEFINED_REMOVED =3D 0, /* Deleted the config file */ - VIR_DOMAIN_EVENT_UNDEFINED_RENAMED =3D 1, /* Domain was renamed */ + VIR_DOMAIN_EVENT_UNDEFINED_REMOVED =3D 0, /* Deleted the config file (= Since: v0.5.0) */ + VIR_DOMAIN_EVENT_UNDEFINED_RENAMED =3D 1, /* Domain was renamed (Since= : v1.2.19) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_UNDEFINED_LAST + VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventUndefinedDetailType; =20 @@ -3102,14 +3223,14 @@ typedef enum { * Details on the cause of a 'started' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_STARTED_BOOTED =3D 0, /* Normal startup from boot */ - VIR_DOMAIN_EVENT_STARTED_MIGRATED =3D 1, /* Incoming migration from an= other host */ - VIR_DOMAIN_EVENT_STARTED_RESTORED =3D 2, /* Restored from a state file= */ - VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT =3D 3, /* Restored from snapsho= t */ - VIR_DOMAIN_EVENT_STARTED_WAKEUP =3D 4, /* Started due to wakeup even= t */ + VIR_DOMAIN_EVENT_STARTED_BOOTED =3D 0, /* Normal startup from boot (= Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_MIGRATED =3D 1, /* Incoming migration from an= other host (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_RESTORED =3D 2, /* Restored from a state file= (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT =3D 3, /* Restored from snapsho= t (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_STARTED_WAKEUP =3D 4, /* Started due to wakeup even= t (Since: v0.9.11) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STARTED_LAST + VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventStartedDetailType; =20 @@ -3119,18 +3240,18 @@ typedef enum { * Details on the cause of a 'suspended' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_SUSPENDED_PAUSED =3D 0, /* Normal suspend due to ad= min pause */ - VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED =3D 1, /* Suspended for offline mi= gration */ - VIR_DOMAIN_EVENT_SUSPENDED_IOERROR =3D 2, /* Suspended due to a disk = I/O error */ - VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG =3D 3, /* Suspended due to a watc= hdog firing */ - VIR_DOMAIN_EVENT_SUSPENDED_RESTORED =3D 4, /* Restored from paused st= ate file */ - VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT =3D 5, /* Restored from pause= d snapshot */ - VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR =3D 6, /* suspended after failure= during libvirt API call */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY =3D 7, /* suspended for post-copy = migration */ - VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED =3D 8, /* suspended after f= ailed post-copy */ + VIR_DOMAIN_EVENT_SUSPENDED_PAUSED =3D 0, /* Normal suspend due to ad= min pause (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED =3D 1, /* Suspended for offline mi= gration (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_IOERROR =3D 2, /* Suspended due to a disk = I/O error (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG =3D 3, /* Suspended due to a watc= hdog firing (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_SUSPENDED_RESTORED =3D 4, /* Restored from paused st= ate file (Since: v0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT =3D 5, /* Restored from pause= d snapshot (Since: v0.9.5) */ + VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR =3D 6, /* suspended after failure= during libvirt API call (Since: v1.0.1) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY =3D 7, /* suspended for post-copy = migration (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED =3D 8, /* suspended after f= ailed post-copy (Since: v1.3.3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SUSPENDED_LAST + VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventSuspendedDetailType; =20 @@ -3140,14 +3261,14 @@ typedef enum { * Details on the cause of a 'resumed' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_RESUMED_UNPAUSED =3D 0, /* Normal resume due to adm= in unpause */ - VIR_DOMAIN_EVENT_RESUMED_MIGRATED =3D 1, /* Resumed for completion o= f migration */ - VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT =3D 2, /* Resumed from snapshot= */ + VIR_DOMAIN_EVENT_RESUMED_UNPAUSED =3D 0, /* Normal resume due to adm= in unpause (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_MIGRATED =3D 1, /* Resumed for completion o= f migration (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT =3D 2, /* Resumed from snapshot= (Since: v0.9.5) */ VIR_DOMAIN_EVENT_RESUMED_POSTCOPY =3D 3, /* Resumed, but migration i= s still - running in post-copy mode = */ + running in post-copy mode = (Since: v1.3.3) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_RESUMED_LAST + VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventResumedDetailType; =20 @@ -3157,16 +3278,16 @@ typedef enum { * Details on the cause of a 'stopped' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN =3D 0, /* Normal shutdown */ - VIR_DOMAIN_EVENT_STOPPED_DESTROYED =3D 1, /* Forced poweroff from host= */ - VIR_DOMAIN_EVENT_STOPPED_CRASHED =3D 2, /* Guest crashed */ - VIR_DOMAIN_EVENT_STOPPED_MIGRATED =3D 3, /* Migrated off to another h= ost */ - VIR_DOMAIN_EVENT_STOPPED_SAVED =3D 4, /* Saved to a state file */ - VIR_DOMAIN_EVENT_STOPPED_FAILED =3D 5, /* Host emulator/mgmt failed= */ - VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT =3D 6, /* offline snapshot load= ed */ + VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN =3D 0, /* Normal shutdown (Since: v= 0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_DESTROYED =3D 1, /* Forced poweroff from host= (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_CRASHED =3D 2, /* Guest crashed (Since: v0.= 5.0) */ + VIR_DOMAIN_EVENT_STOPPED_MIGRATED =3D 3, /* Migrated off to another h= ost (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_SAVED =3D 4, /* Saved to a state file (Si= nce: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FAILED =3D 5, /* Host emulator/mgmt failed= (Since: v0.5.0) */ + VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT =3D 6, /* offline snapshot load= ed (Since: v0.8.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_STOPPED_LAST + VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: v0.9.10) */ # endif } virDomainEventStoppedDetailType; =20 @@ -3177,19 +3298,22 @@ typedef enum { * Details on the cause of a 'shutdown' lifecycle event */ typedef enum { - /* Guest finished shutdown sequence */ + /* Guest finished shutdown sequence (Since: v0.9.8) */ VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED =3D 0, =20 /* 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 =3D 1, =20 /* Domain finished shutting down after request from the host (e.g. kil= led by - * a signal) */ + * a signal) + * + * Since: v3.4.0 + */ VIR_DOMAIN_EVENT_SHUTDOWN_HOST =3D 2, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_SHUTDOWN_LAST + VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: v0.9.10) */ # endif } virDomainEventShutdownDetailType; =20 @@ -3199,11 +3323,11 @@ typedef enum { * Details on the cause of a 'pmsuspended' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY =3D 0, /* Guest was PM suspended t= o memory */ - VIR_DOMAIN_EVENT_PMSUSPENDED_DISK =3D 1, /* Guest was PM suspended to = disk */ + VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY =3D 0, /* Guest was PM suspended t= o memory (Since: v0.10.2) */ + VIR_DOMAIN_EVENT_PMSUSPENDED_DISK =3D 1, /* Guest was PM suspended to = disk (Since: v1.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_PMSUSPENDED_LAST + VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: v0.10.2) */ # endif } virDomainEventPMSuspendedDetailType; =20 @@ -3213,11 +3337,11 @@ typedef enum { * Details on the cause of a 'crashed' lifecycle event */ typedef enum { - VIR_DOMAIN_EVENT_CRASHED_PANICKED =3D 0, /* Guest was panicked */ - VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED =3D 1, /* Guest was crashloaded */ + VIR_DOMAIN_EVENT_CRASHED_PANICKED =3D 0, /* Guest was panicked (Since:= v1.1.1) */ + VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED =3D 1, /* Guest was crashloaded (= Since: v6.1.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_CRASHED_LAST + VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: v1.1.1) */ # endif } virDomainEventCrashedDetailType; =20 @@ -3227,14 +3351,14 @@ typedef enum { * Recipient of a memory failure event. */ 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 =3D 0, =20 - /* 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 =3D 1, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST + VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: v6.9.0) */ # endif } virDomainMemoryFailureRecipientType; =20 @@ -3246,35 +3370,50 @@ 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 =3D 0, =20 /* memory failure occurred in guest memory, the guest enabled MCE hand= ling * mechanism, and hypervisor could inject the MCE into the guest - * successfully. */ + * successfully. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_INJECT =3D 1, =20 /* the failure is unrecoverable. This occurs for action-required fail= ures - * 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 =3D 2, =20 /* the failure is unrecoverable but confined to the guest. This occurs= if - * the recipient is a guest which is not ready to handle memory failur= es. */ + * the recipient is a guest which is not ready to handle memory failur= es. + * + * Since: v6.9.0 + */ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_RESET =3D 3, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST + VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: v6.9.0) */ # endif } virDomainMemoryFailureActionType; =20 =20 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 =3D (1 << 0), =20 /* whether the failure occurred while the previous failure was still in - * progress. */ + * progress. + * + * Since: v6.9.0 + */ VIR_DOMAIN_MEMORY_FAILURE_RECURSIVE =3D (1 << 1), } virDomainMemoryFailureFlags; =20 @@ -3311,15 +3450,15 @@ int virDomainIsPersistent(virDomainPtr dom); int virDomainIsUpdated(virDomainPtr dom); =20 typedef enum { - VIR_DOMAIN_JOB_NONE =3D 0, /* No job is active */ - VIR_DOMAIN_JOB_BOUNDED =3D 1, /* Job with a finite completion time */ - VIR_DOMAIN_JOB_UNBOUNDED =3D 2, /* Job without a finite completion tim= e */ - VIR_DOMAIN_JOB_COMPLETED =3D 3, /* Job has finished, but isn't cleaned= up */ - VIR_DOMAIN_JOB_FAILED =3D 4, /* Job hit error, but isn't cleaned up= */ - VIR_DOMAIN_JOB_CANCELLED =3D 5, /* Job was aborted, but isn't cleaned = up */ + VIR_DOMAIN_JOB_NONE =3D 0, /* No job is active (Since: v0.7.7) */ + VIR_DOMAIN_JOB_BOUNDED =3D 1, /* Job with a finite completion time (= Since: v0.7.7) */ + VIR_DOMAIN_JOB_UNBOUNDED =3D 2, /* Job without a finite completion tim= e (Since: v0.7.7) */ + VIR_DOMAIN_JOB_COMPLETED =3D 3, /* Job has finished, but isn't cleaned= up (Since: v0.7.7) */ + VIR_DOMAIN_JOB_FAILED =3D 4, /* Job hit error, but isn't cleaned up= (Since: v0.7.7) */ + VIR_DOMAIN_JOB_CANCELLED =3D 5, /* Job was aborted, but isn't cleaned = up (Since: v0.7.7) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_LAST + VIR_DOMAIN_JOB_LAST /* (Since: v0.9.10) */ # endif } virDomainJobType; =20 @@ -3367,9 +3506,9 @@ struct _virDomainJobInfo { */ typedef enum { VIR_DOMAIN_JOB_STATS_COMPLETED =3D 1 << 0, /* return stats of a recent= ly - * completed job */ + * completed job (Since: v1.2= .9) */ VIR_DOMAIN_JOB_STATS_KEEP_COMPLETED =3D 1 << 1, /* don't remove comple= ted - stats when reading th= em */ + stats when reading th= em (Since: v6.0.0) */ } virDomainGetJobStatsFlags; =20 int virDomainGetJobInfo(virDomainPtr dom, @@ -3382,19 +3521,19 @@ int virDomainGetJobStats(virDomainPtr domain, int virDomainAbortJob(virDomainPtr dom); =20 typedef enum { - VIR_DOMAIN_JOB_OPERATION_UNKNOWN =3D 0, - VIR_DOMAIN_JOB_OPERATION_START =3D 1, - VIR_DOMAIN_JOB_OPERATION_SAVE =3D 2, - VIR_DOMAIN_JOB_OPERATION_RESTORE =3D 3, - VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN =3D 4, - VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT =3D 5, - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT =3D 6, - VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT =3D 7, - VIR_DOMAIN_JOB_OPERATION_DUMP =3D 8, - VIR_DOMAIN_JOB_OPERATION_BACKUP =3D 9, + VIR_DOMAIN_JOB_OPERATION_UNKNOWN =3D 0, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_START =3D 1, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SAVE =3D 2, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_RESTORE =3D 3, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN =3D 4, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT =3D 5, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT =3D 6, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT =3D 7, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_DUMP =3D 8, /* (Since: v3.3.0) */ + VIR_DOMAIN_JOB_OPERATION_BACKUP =3D 9, /* (Since: v6.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_JOB_OPERATION_LAST + VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: v3.3.0) */ # endif } virDomainJobOperation; =20 @@ -3769,16 +3908,16 @@ typedef void (*virConnectDomainEventRTCChangeCallba= ck)(virConnectPtr conn, * The action that is to be taken due to the watchdog device firing */ typedef enum { - VIR_DOMAIN_EVENT_WATCHDOG_NONE =3D 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 gracefull= y shutdown */ - VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logg= ed */ - VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt= into guest */ + VIR_DOMAIN_EVENT_WATCHDOG_NONE =3D 0, /* No action, watchdog ignored (= Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: v= 0.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 gracefull= y shutdown (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logg= ed (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt= into guest (Since: v1.2.17) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_WATCHDOG_LAST + VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: v0.9.10) */ # endif } virDomainEventWatchdogAction; =20 @@ -3804,12 +3943,12 @@ typedef void (*virConnectDomainEventWatchdogCallbac= k)(virConnectPtr conn, * The action that is to be taken due to an IO error occurring */ typedef enum { - VIR_DOMAIN_EVENT_IO_ERROR_NONE =3D 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 =3D 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) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_IO_ERROR_LAST + VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: v0.9.10) */ # endif } virDomainEventIOErrorAction; =20 @@ -3867,12 +4006,12 @@ typedef void (*virConnectDomainEventIOErrorReasonCa= llback)(virConnectPtr conn, * The phase of the graphics client connection */ typedef enum { - VIR_DOMAIN_EVENT_GRAPHICS_CONNECT =3D 0, /* Initial socket connection= established */ - VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup comp= leted */ - VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection = */ + VIR_DOMAIN_EVENT_GRAPHICS_CONNECT =3D 0, /* Initial socket connection= established (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup comp= leted (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection = (Since: v0.8.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_LAST + VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: v0.9.10) */ # endif } virDomainEventGraphicsPhase; =20 @@ -3882,12 +4021,12 @@ typedef enum { * The type of address for the connection */ 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: v= 0.9.7) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST + VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: v0.9.10) */ # endif } virDomainEventGraphicsAddressType; =20 @@ -3969,13 +4108,13 @@ typedef void (*virConnectDomainEventGraphicsCallbac= k)(virConnectPtr conn, * virDomainBlockCopy(), or virDomainBlockCommit() operation */ typedef enum { - VIR_DOMAIN_BLOCK_JOB_COMPLETED =3D 0, - VIR_DOMAIN_BLOCK_JOB_FAILED =3D 1, - VIR_DOMAIN_BLOCK_JOB_CANCELED =3D 2, - VIR_DOMAIN_BLOCK_JOB_READY =3D 3, + VIR_DOMAIN_BLOCK_JOB_COMPLETED =3D 0, /* (Since: v0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_FAILED =3D 1, /* (Since: v0.9.4) */ + VIR_DOMAIN_BLOCK_JOB_CANCELED =3D 2, /* (Since: v0.9.12) */ + VIR_DOMAIN_BLOCK_JOB_READY =3D 3, /* (Since: v1.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_BLOCK_JOB_LAST + VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: v0.9.10) */ # endif } virConnectDomainEventBlockJobStatus; =20 @@ -4017,15 +4156,21 @@ typedef void (*virConnectDomainEventBlockJobCallbac= k)(virConnectPtr conn, */ typedef enum { /* Removable media changed to empty according to startup policy as sou= rce - * 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 =3D 0, =20 /* 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 =3D 1, =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_DISK_CHANGE_LAST + VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: v0.9.10) */ # endif } virConnectDomainEventDiskChangeReason; =20 @@ -4062,11 +4207,11 @@ typedef void (*virConnectDomainEventDiskChangeCallb= ack)(virConnectPtr conn, * The reason describing why the callback was called */ typedef enum { - VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN =3D 0, - VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, + VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN =3D 0, /* (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: v0.9.11) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST + VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: v0.9.11) */ # endif } virDomainEventTrayChangeReason; =20 @@ -4579,21 +4724,21 @@ typedef void (*virConnectDomainEventTunableCallback= )(virConnectPtr conn, =20 =20 typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED =3D 1, /* age= nt connected */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED =3D 2, /* = agent disconnected */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED =3D 1, /* age= nt connected (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED =3D 2, /* = agent disconnected (Since: v1.2.11) */ =20 # 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; =20 typedef enum { - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN =3D 0, /* unkn= own state change reason */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED =3D 1, = /* state changed due to domain start */ - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL =3D 2, /* chan= nel state changed */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN =3D 0, /* unkn= own state change reason (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED =3D 1, = /* state changed due to domain start (Since: v1.2.11) */ + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL =3D 2, /* chan= nel state changed (Since: v1.2.11) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST + VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: v1.2.1= 1) */ # endif } virConnectDomainEventAgentLifecycleReason; =20 @@ -4713,33 +4858,33 @@ typedef void (*virConnectDomainEventMemoryDeviceSiz= eChangeCallback)(virConnectPt * signature of callback function will be used. */ typedef enum { - VIR_DOMAIN_EVENT_ID_LIFECYCLE =3D 0, /* virConnectDomainEventCal= lback */ - VIR_DOMAIN_EVENT_ID_REBOOT =3D 1, /* virConnectDomainEventGen= ericCallback */ - VIR_DOMAIN_EVENT_ID_RTC_CHANGE =3D 2, /* virConnectDomainEventRTC= ChangeCallback */ - VIR_DOMAIN_EVENT_ID_WATCHDOG =3D 3, /* virConnectDomainEventWat= chdogCallback */ - VIR_DOMAIN_EVENT_ID_IO_ERROR =3D 4, /* virConnectDomainEventIOE= rrorCallback */ - VIR_DOMAIN_EVENT_ID_GRAPHICS =3D 5, /* virConnectDomainEventGra= phicsCallback */ - VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON =3D 6, /* virConnectDomainEventIOE= rrorReasonCallback */ - VIR_DOMAIN_EVENT_ID_CONTROL_ERROR =3D 7, /* virConnectDomainEventGen= ericCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB =3D 8, /* virConnectDomainEventBlo= ckJobCallback */ - VIR_DOMAIN_EVENT_ID_DISK_CHANGE =3D 9, /* virConnectDomainEventDis= kChangeCallback */ - VIR_DOMAIN_EVENT_ID_TRAY_CHANGE =3D 10, /* virConnectDomainEventTra= yChangeCallback */ - VIR_DOMAIN_EVENT_ID_PMWAKEUP =3D 11, /* virConnectDomainEventPMW= akeupCallback */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND =3D 12, /* virConnectDomainEventPMS= uspendCallback */ - VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE =3D 13, /* virConnectDomainEventBal= loonChangeCallback */ - VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK =3D 14, /* virConnectDomainEventPMS= uspendDiskCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED =3D 15, /* virConnectDomainEventDev= iceRemovedCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 =3D 16, /* virConnectDomainEventBlo= ckJobCallback */ - VIR_DOMAIN_EVENT_ID_TUNABLE =3D 17, /* virConnectDomainEventTun= ableCallback */ - VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE =3D 18,/* virConnectDomainEventAge= ntLifecycleCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_ADDED =3D 19, /* virConnectDomainEventDev= iceAddedCallback */ - VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION =3D 20, /* virConnectDomainEve= ntMigrationIterationCallback */ - VIR_DOMAIN_EVENT_ID_JOB_COMPLETED =3D 21, /* virConnectDomainEventJob= CompletedCallback */ - VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED =3D 22, /* virConnectDomainE= ventDeviceRemovalFailedCallback */ - VIR_DOMAIN_EVENT_ID_METADATA_CHANGE =3D 23, /* virConnectDomainEventMe= tadataChangeCallback */ - VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD =3D 24, /* virConnectDomainEventBl= ockThresholdCallback */ - VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE =3D 25, /* virConnectDomainEventMe= moryFailureCallback */ - VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE =3D 26, /* virConnectDom= ainEventMemoryDeviceSizeChangeCallback */ + VIR_DOMAIN_EVENT_ID_LIFECYCLE =3D 0, /* virConnectDomainEventCal= lback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_REBOOT =3D 1, /* virConnectDomainEventGen= ericCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_RTC_CHANGE =3D 2, /* virConnectDomainEventRTC= ChangeCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_WATCHDOG =3D 3, /* virConnectDomainEventWat= chdogCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR =3D 4, /* virConnectDomainEventIOE= rrorCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_GRAPHICS =3D 5, /* virConnectDomainEventGra= phicsCallback (Since: v0.8.0) */ + VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON =3D 6, /* virConnectDomainEventIOE= rrorReasonCallback (Since: v0.8.1) */ + VIR_DOMAIN_EVENT_ID_CONTROL_ERROR =3D 7, /* virConnectDomainEventGen= ericCallback (Since: v0.9.2) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB =3D 8, /* virConnectDomainEventBlo= ckJobCallback (Since: v0.9.4) */ + VIR_DOMAIN_EVENT_ID_DISK_CHANGE =3D 9, /* virConnectDomainEventDis= kChangeCallback (Since: v0.9.7) */ + VIR_DOMAIN_EVENT_ID_TRAY_CHANGE =3D 10, /* virConnectDomainEventTra= yChangeCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMWAKEUP =3D 11, /* virConnectDomainEventPMW= akeupCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND =3D 12, /* virConnectDomainEventPMS= uspendCallback (Since: v0.9.11) */ + VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE =3D 13, /* virConnectDomainEventBal= loonChangeCallback (Since: v0.10.0) */ + VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK =3D 14, /* virConnectDomainEventPMS= uspendDiskCallback (Since: v1.0.0) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED =3D 15, /* virConnectDomainEventDev= iceRemovedCallback (Since: v1.1.1) */ + VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 =3D 16, /* virConnectDomainEventBlo= ckJobCallback (Since: v1.2.6) */ + VIR_DOMAIN_EVENT_ID_TUNABLE =3D 17, /* virConnectDomainEventTun= ableCallback (Since: v1.2.9) */ + VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE =3D 18,/* virConnectDomainEventAge= ntLifecycleCallback (Since: v1.2.11) */ + VIR_DOMAIN_EVENT_ID_DEVICE_ADDED =3D 19, /* virConnectDomainEventDev= iceAddedCallback (Since: v1.2.15) */ + VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION =3D 20, /* virConnectDomainEve= ntMigrationIterationCallback (Since: v1.3.2) */ + VIR_DOMAIN_EVENT_ID_JOB_COMPLETED =3D 21, /* virConnectDomainEventJob= CompletedCallback (Since: v1.3.3) */ + VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED =3D 22, /* virConnectDomainE= ventDeviceRemovalFailedCallback (Since: v1.3.4) */ + VIR_DOMAIN_EVENT_ID_METADATA_CHANGE =3D 23, /* virConnectDomainEventMe= tadataChangeCallback (Since: v3.0.0) */ + VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD =3D 24, /* virConnectDomainEventBl= ockThresholdCallback (Since: v3.2.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE =3D 25, /* virConnectDomainEventMe= moryFailureCallback (Since: v6.9.0) */ + VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE =3D 26, /* virConnectDom= ainEventMemoryDeviceSizeChangeCallback (Since: v7.9.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_EVENT_ID_LAST @@ -4747,6 +4892,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; @@ -4773,9 +4920,9 @@ typedef enum { =20 VIR_DOMAIN_CONSOLE_FORCE =3D (1 << 0), /* abort a (possibly) active co= nsole connection to force a new - connection */ + connection (Since: v0.9.11) */ VIR_DOMAIN_CONSOLE_SAFE =3D (1 << 1), /* check if the console driver s= upports - safe console operations */ + safe console operations (Since:= v0.9.11) */ } virDomainConsoleFlags; =20 int virDomainOpenConsole(virDomainPtr dom, @@ -4791,7 +4938,7 @@ int virDomainOpenConsole(virDomainPtr dom, typedef enum { VIR_DOMAIN_CHANNEL_FORCE =3D (1 << 0), /* abort a (possibly) active ch= annel connection to force a new - connection */ + connection (Since: v1.0.2) */ } virDomainChannelFlags; =20 int virDomainOpenChannel(virDomainPtr dom, @@ -4800,7 +4947,7 @@ int virDomainOpenChannel(virDomainPtr dom, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH =3D (1 << 0), + VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH =3D (1 << 0), /* (Since: v0.9.7) */ } virDomainOpenGraphicsFlags; =20 int virDomainOpenGraphics(virDomainPtr dom, @@ -4857,7 +5004,7 @@ int virDomainGetTime(virDomainPtr dom, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_TIME_SYNC =3D (1 << 0), /* Re-sync domain time from domain'= s RTC */ + VIR_DOMAIN_TIME_SYNC =3D (1 << 0), /* Re-sync domain time from domain'= s RTC (Since: v1.2.5) */ } virDomainSetTimeFlags; =20 int virDomainSetTime(virDomainPtr dom, @@ -4873,12 +5020,12 @@ int virDomainSetTime(virDomainPtr dom, * 0.9.2. */ typedef enum { - VIR_DOMAIN_SCHED_FIELD_INT =3D VIR_TYPED_PARAM_INT, - VIR_DOMAIN_SCHED_FIELD_UINT =3D VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_SCHED_FIELD_LLONG =3D VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_SCHED_FIELD_ULLONG =3D VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_SCHED_FIELD_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_SCHED_FIELD_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_SCHED_FIELD_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0.= 2.3) */ + VIR_DOMAIN_SCHED_FIELD_UINT =3D VIR_TYPED_PARAM_UINT, /* (Since: v0= .2.3) */ + VIR_DOMAIN_SCHED_FIELD_LLONG =3D VIR_TYPED_PARAM_LLONG, /* (Since: v= 0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_ULLONG =3D VIR_TYPED_PARAM_ULLONG, /* (Since: = v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, /* (Since: = v0.2.3) */ + VIR_DOMAIN_SCHED_FIELD_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, /* (Since:= v0.2.3) */ } virSchedParameterType; =20 /** @@ -4917,12 +5064,12 @@ typedef virSchedParameter *virSchedParameterPtr; * 0.9.2. */ typedef enum { - VIR_DOMAIN_BLKIO_PARAM_INT =3D VIR_TYPED_PARAM_INT, - VIR_DOMAIN_BLKIO_PARAM_UINT =3D VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_BLKIO_PARAM_LLONG =3D VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_BLKIO_PARAM_ULLONG =3D VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_BLKIO_PARAM_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_BLKIO_PARAM_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_BLKIO_PARAM_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0.= 9.0) */ + VIR_DOMAIN_BLKIO_PARAM_UINT =3D VIR_TYPED_PARAM_UINT, /* (Since: v0= .9.0) */ + VIR_DOMAIN_BLKIO_PARAM_LLONG =3D VIR_TYPED_PARAM_LLONG, /* (Since: v= 0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_ULLONG =3D VIR_TYPED_PARAM_ULLONG, /* (Since: = v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, /* (Since: = v0.9.0) */ + VIR_DOMAIN_BLKIO_PARAM_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, /* (Since:= v0.9.0) */ } virBlkioParameterType; =20 /** @@ -4961,12 +5108,12 @@ typedef virBlkioParameter *virBlkioParameterPtr; * 0.9.2. */ typedef enum { - VIR_DOMAIN_MEMORY_PARAM_INT =3D VIR_TYPED_PARAM_INT, - VIR_DOMAIN_MEMORY_PARAM_UINT =3D VIR_TYPED_PARAM_UINT, - VIR_DOMAIN_MEMORY_PARAM_LLONG =3D VIR_TYPED_PARAM_LLONG, - VIR_DOMAIN_MEMORY_PARAM_ULLONG =3D VIR_TYPED_PARAM_ULLONG, - VIR_DOMAIN_MEMORY_PARAM_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, - VIR_DOMAIN_MEMORY_PARAM_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, + VIR_DOMAIN_MEMORY_PARAM_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0= .8.5) */ + VIR_DOMAIN_MEMORY_PARAM_UINT =3D VIR_TYPED_PARAM_UINT, /* (Since: v= 0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_LLONG =3D VIR_TYPED_PARAM_LLONG, /* (Since: = v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_ULLONG =3D VIR_TYPED_PARAM_ULLONG, /* (Since:= v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_DOUBLE =3D VIR_TYPED_PARAM_DOUBLE, /* (Since:= v0.8.5) */ + VIR_DOMAIN_MEMORY_PARAM_BOOLEAN =3D VIR_TYPED_PARAM_BOOLEAN, /* (Since= : v0.8.5) */ } virMemoryParameterType; =20 /** @@ -4998,12 +5145,12 @@ typedef struct _virTypedParameter virMemoryParamete= r; typedef virMemoryParameter *virMemoryParameterPtr; =20 typedef enum { - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE =3D 0, /* Parse DHCP lease fi= le */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT =3D 1, /* Query qemu guest ag= ent */ - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP =3D 2, /* Query ARP tables */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE =3D 0, /* Parse DHCP lease fi= le (Since: v1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT =3D 1, /* Query qemu guest ag= ent (Since: v1.2.14) */ + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP =3D 2, /* Query ARP tables (Sin= ce: v4.2.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST + VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: v1.2.14) */ # endif } virDomainInterfaceAddressesSource; =20 @@ -5032,7 +5179,7 @@ int virDomainInterfaceAddresses(virDomainPtr dom, void virDomainInterfaceFree(virDomainInterfacePtr iface); =20 typedef enum { - VIR_DOMAIN_PASSWORD_ENCRYPTED =3D 1 << 0, /* the password is already e= ncrypted */ + VIR_DOMAIN_PASSWORD_ENCRYPTED =3D 1 << 0, /* the password is already e= ncrypted (Since: v1.2.16) */ } virDomainSetUserPasswordFlags; =20 int virDomainSetUserPassword(virDomainPtr dom, @@ -5065,25 +5212,25 @@ int virDomainSetBlockThreshold(virDomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_LIFECYCLE_POWEROFF =3D 0, - VIR_DOMAIN_LIFECYCLE_REBOOT =3D 1, - VIR_DOMAIN_LIFECYCLE_CRASH =3D 2, + VIR_DOMAIN_LIFECYCLE_POWEROFF =3D 0, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_REBOOT =3D 1, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_CRASH =3D 2, /* (Since: v3.9.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_LAST + VIR_DOMAIN_LIFECYCLE_LAST /* (Since: v3.9.0) */ # endif } virDomainLifecycle; =20 typedef enum { - VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY =3D 0, - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART =3D 1, - VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME =3D 2, - VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE =3D 3, - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY =3D 4, - VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART =3D 5, + VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY =3D 0, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART =3D 1, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME =3D 2, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE =3D 3, /* (Since: v3.9.0) */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY =3D 4, /* (Since: v3.9.0)= */ + VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART =3D 5, /* (Since: v3.9.0)= */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_LIFECYCLE_ACTION_LAST + VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: v3.9.0) */ # endif } virDomainLifecycleAction; =20 @@ -5178,13 +5325,13 @@ int virDomainSetLaunchSecurityState(virDomainPtr do= main, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_GUEST_INFO_USERS =3D (1 << 0), /* return active users */ - VIR_DOMAIN_GUEST_INFO_OS =3D (1 << 1), /* return OS information */ - VIR_DOMAIN_GUEST_INFO_TIMEZONE =3D (1 << 2), /* return timezone inform= ation */ - VIR_DOMAIN_GUEST_INFO_HOSTNAME =3D (1 << 3), /* return hostname inform= ation */ - VIR_DOMAIN_GUEST_INFO_FILESYSTEM =3D (1 << 4), /* return filesystem in= formation */ - VIR_DOMAIN_GUEST_INFO_DISKS =3D (1 << 5), /* return disks information = */ - VIR_DOMAIN_GUEST_INFO_INTERFACES =3D (1 << 6), /* return interfaces in= formation */ + VIR_DOMAIN_GUEST_INFO_USERS =3D (1 << 0), /* return active users (Sinc= e: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_OS =3D (1 << 1), /* return OS information (Since= : v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_TIMEZONE =3D (1 << 2), /* return timezone inform= ation (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_HOSTNAME =3D (1 << 3), /* return hostname inform= ation (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_FILESYSTEM =3D (1 << 4), /* return filesystem in= formation (Since: v5.7.0) */ + VIR_DOMAIN_GUEST_INFO_DISKS =3D (1 << 5), /* return disks information = (Since: v7.0.0) */ + VIR_DOMAIN_GUEST_INFO_INTERFACES =3D (1 << 6), /* return interfaces in= formation (Since: v7.10.0) */ } virDomainGuestInfoTypes; =20 int virDomainGetGuestInfo(virDomainPtr domain, @@ -5194,9 +5341,9 @@ int virDomainGetGuestInfo(virDomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK =3D -2, - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT =3D -1, - VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT =3D 0, + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK =3D -2, /* (Since: v5.10.0) */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT =3D -1, /* (Since: v5.10.0) = */ + VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT =3D 0, /* (Since: v5.10.0) */ } virDomainAgentResponseTimeoutValues; =20 int virDomainAgentSetResponseTimeout(virDomainPtr domain, @@ -5205,7 +5352,7 @@ int virDomainAgentSetResponseTimeout(virDomainPtr dom= ain, =20 typedef enum { VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL =3D (1 << 0), /* reuse separate= ly - provided images = */ + provided images = (Since: v6.0.0) */ } virDomainBackupBeginFlags; =20 int virDomainBackupBegin(virDomainPtr domain, @@ -5222,8 +5369,8 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND =3D (1 << 0), /* don't trunc= ate file, just append */ - VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE =3D (1 << 1), /* remove keys= , instead of adding them */ + VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND =3D (1 << 0), /* don't trunc= ate file, just append (Since: v6.10.0) */ + VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE =3D (1 << 1), /* remove keys= , instead of adding them (Since: v6.10.0) */ =20 } virDomainAuthorizedSSHKeysSetFlags; =20 @@ -5234,8 +5381,8 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_MESSAGE_DEPRECATION =3D (1 << 0), - VIR_DOMAIN_MESSAGE_TAINTING =3D (1 << 1), + VIR_DOMAIN_MESSAGE_DEPRECATION =3D (1 << 0), /* (Since: v7.1.0) */ + VIR_DOMAIN_MESSAGE_TAINTING =3D (1 << 1), /* (Since: v7.1.0) */ } virDomainMessageType; =20 int virDomainGetMessages(virDomainPtr domain, @@ -5249,14 +5396,14 @@ int virDomainGetMessages(virDomainPtr domain, */ typedef enum { VIR_DOMAIN_DIRTYRATE_UNSTARTED =3D 0, /* the dirtyrate calculation has - not been started */ + not been started (Since: v7.2.0= ) */ VIR_DOMAIN_DIRTYRATE_MEASURING =3D 1, /* the dirtyrate calculation is - measuring */ + measuring (Since: v7.2.0) */ VIR_DOMAIN_DIRTYRATE_MEASURED =3D 2, /* the dirtyrate calculation is - completed */ + completed (Since: v7.2.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_DOMAIN_DIRTYRATE_LAST + VIR_DOMAIN_DIRTYRATE_LAST /* (Since: v7.2.0) */ # endif } virDomainDirtyRateStatus; =20 @@ -5268,9 +5415,9 @@ typedef enum { * */ typedef enum { - VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING =3D 0, /* default mode = - page-sampling */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP =3D 1 << 0, /* dirty-bitmap = mode */ - VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING =3D 1 << 1, /* dirty-ring mo= de */ + VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING =3D 0, /* default mode = - page-sampling (Since: v8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP =3D 1 << 0, /* dirty-bitmap = mode (Since: v8.1.0) */ + VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING =3D 1 << 1, /* dirty-ring mo= de (Since: v8.1.0) */ } virDomainDirtyRateCalcFlags; =20 int virDomainStartDirtyRateCalc(virDomainPtr domain, diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-even= t.h index facdc3a3ec..f86a55ecf6 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -36,10 +36,10 @@ * this construct. */ typedef enum { - VIR_EVENT_HANDLE_READABLE =3D (1 << 0), - VIR_EVENT_HANDLE_WRITABLE =3D (1 << 1), - VIR_EVENT_HANDLE_ERROR =3D (1 << 2), - VIR_EVENT_HANDLE_HANGUP =3D (1 << 3), + VIR_EVENT_HANDLE_READABLE =3D (1 << 0), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_WRITABLE =3D (1 << 1), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_ERROR =3D (1 << 2), /* (Since: v0.5.0) */ + VIR_EVENT_HANDLE_HANGUP =3D (1 << 3), /* (Since: v0.5.0) */ } virEventHandleType; =20 /** diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 8cccf2921f..15e4e7ea72 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -51,12 +51,12 @@ typedef virConnect *virConnectPtr; * transitioned to. */ typedef enum { - VIR_NODE_SUSPEND_TARGET_MEM =3D 0, - VIR_NODE_SUSPEND_TARGET_DISK =3D 1, - VIR_NODE_SUSPEND_TARGET_HYBRID =3D 2, + VIR_NODE_SUSPEND_TARGET_MEM =3D 0, /* (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_DISK =3D 1, /* (Since: v0.9.8) */ + VIR_NODE_SUSPEND_TARGET_HYBRID =3D 2, /* (Since: v0.9.8) */ =20 # 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 (Si= nce: v0.9.8) */ # endif } virNodeSuspendTarget; =20 @@ -185,7 +185,7 @@ struct _virNodeInfo { * Value for specifying request for the total CPU time/utilization */ typedef enum { - VIR_NODE_CPU_STATS_ALL_CPUS =3D -1, + VIR_NODE_CPU_STATS_ALL_CPUS =3D -1, /* (Since: v0.9.3) */ } virNodeGetCPUStatsAllCPUs; =20 /** @@ -263,7 +263,7 @@ struct _virNodeCPUStats { * Value for specifying request for the total memory of all cells. */ typedef enum { - VIR_NODE_MEMORY_STATS_ALL_CELLS =3D -1, + VIR_NODE_MEMORY_STATS_ALL_CELLS =3D -1, /* (Since: v0.9.3) */ } virNodeGetMemoryStatsAllCells; =20 /** @@ -499,24 +499,24 @@ int virNodeGetSEVInfo (virConnectPtr conn, * Flags when opening a connection to a hypervisor */ typedef enum { - VIR_CONNECT_RO =3D (1 << 0), /* A readonly connection */ - VIR_CONNECT_NO_ALIASES =3D (1 << 1), /* Don't try to resolve URI alia= ses */ + VIR_CONNECT_RO =3D (1 << 0), /* A readonly connection (Since:= v0.4.1) */ + VIR_CONNECT_NO_ALIASES =3D (1 << 1), /* Don't try to resolve URI alia= ses (Since: v0.9.7) */ } virConnectFlags; =20 =20 typedef enum { - VIR_CRED_USERNAME =3D 1, /* Identity to act as */ - VIR_CRED_AUTHNAME =3D 2, /* Identify to authorize as */ - VIR_CRED_LANGUAGE =3D 3, /* RFC 1766 languages, comma separated */ - VIR_CRED_CNONCE =3D 4, /* client supplies a nonce */ - VIR_CRED_PASSPHRASE =3D 5, /* Passphrase secret */ - VIR_CRED_ECHOPROMPT =3D 6, /* Challenge response */ - VIR_CRED_NOECHOPROMPT =3D 7, /* Challenge response */ - VIR_CRED_REALM =3D 8, /* Authentication realm */ - VIR_CRED_EXTERNAL =3D 9, /* Externally managed credential */ + VIR_CRED_USERNAME =3D 1, /* Identity to act as (Since: v0.4.1) */ + VIR_CRED_AUTHNAME =3D 2, /* Identify to authorize as (Since: v0.4.= 1) */ + VIR_CRED_LANGUAGE =3D 3, /* RFC 1766 languages, comma separated (S= ince: v0.4.1) */ + VIR_CRED_CNONCE =3D 4, /* client supplies a nonce (Since: v0.4.1= ) */ + VIR_CRED_PASSPHRASE =3D 5, /* Passphrase secret (Since: v0.4.1) */ + VIR_CRED_ECHOPROMPT =3D 6, /* Challenge response (Since: v0.4.1) */ + VIR_CRED_NOECHOPROMPT =3D 7, /* Challenge response (Since: v0.4.1) */ + VIR_CRED_REALM =3D 8, /* Authentication realm (Since: v0.4.1) */ + VIR_CRED_EXTERNAL =3D 9, /* Externally managed credential (Since: = v0.4.1) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CRED_LAST /* More may be added - expect the unexpecte= d */ + VIR_CRED_LAST /* More may be added - expect the unexpecte= d (Since: v0.9.10) */ # endif } virConnectCredentialType; =20 @@ -770,21 +770,21 @@ int virConnectIsAlive(virConnectPtr conn); */ =20 typedef enum { - VIR_CPU_COMPARE_ERROR =3D -1, - VIR_CPU_COMPARE_INCOMPATIBLE =3D 0, - VIR_CPU_COMPARE_IDENTICAL =3D 1, - VIR_CPU_COMPARE_SUPERSET =3D 2, + VIR_CPU_COMPARE_ERROR =3D -1, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_INCOMPATIBLE =3D 0, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_IDENTICAL =3D 1, /* (Since: v0.7.5) */ + VIR_CPU_COMPARE_SUPERSET =3D 2, /* (Since: v0.7.5) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CPU_COMPARE_LAST + VIR_CPU_COMPARE_LAST /* (Since: v0.9.10) */ # endif } virCPUCompareResult; =20 typedef enum { VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE =3D (1 << 0), /* treat incom= patible - CPUs as failu= re */ + CPUs as failu= re (Since: v1.2.6) */ VIR_CONNECT_COMPARE_CPU_VALIDATE_XML =3D (1 << 1), /* validate the xml - document */ + document (Since: v= 6.9.0) */ } virConnectCompareCPUFlags; =20 int virConnectCompareCPU(virConnectPtr conn, @@ -809,8 +809,8 @@ int virConnectGetCPUModelNames(virConnectPtr conn, * Flags when getting XML description of a computed CPU */ typedef enum { - VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES =3D (1 << 0), /* show all f= eatures */ - VIR_CONNECT_BASELINE_CPU_MIGRATABLE =3D (1 << 1), /* filter out non-m= igratable features */ + VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES =3D (1 << 0), /* show all f= eatures (Since: v1.1.2) */ + VIR_CONNECT_BASELINE_CPU_MIGRATABLE =3D (1 << 1), /* filter out non-m= igratable features (Since: v1.2.14) */ } virConnectBaselineCPUFlags; =20 char *virConnectBaselineCPU(virConnectPtr conn, @@ -837,10 +837,10 @@ int virNodeGetFreePages(virConnectPtr conn, =20 typedef enum { VIR_NODE_ALLOC_PAGES_ADD =3D 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 =3D (1 << 0), /* Don't add @pageCounts, inste= ad set passed number of pages. This c= an be - used to free allocated pages. = */ + used to free allocated pages. = (Since: v1.2.9) */ } virNodeAllocPagesFlags; =20 int virNodeAllocPages(virConnectPtr conn, diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-= interface.h index 803cb33ffe..64bcb08c94 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -59,8 +59,8 @@ int virConnectListDefinedInterfaces = (virConnectPtr conn, * Flags used to filter the returned interfaces. */ typedef enum { - VIR_CONNECT_LIST_INTERFACES_INACTIVE =3D 1 << 0, - VIR_CONNECT_LIST_INTERFACES_ACTIVE =3D 1 << 1, + VIR_CONNECT_LIST_INTERFACES_INACTIVE =3D 1 << 0, /* (Since: v0.10= .2) */ + VIR_CONNECT_LIST_INTERFACES_ACTIVE =3D 1 << 1, /* (Since: v0.10= .2) */ } virConnectListAllInterfacesFlags; =20 int virConnectListAllInterfaces (virConnectPtr conn, @@ -76,11 +76,11 @@ const char* virInterfaceGetName (virI= nterfacePtr iface); const char* virInterfaceGetMACString (virInterfacePtr iface); =20 typedef enum { - VIR_INTERFACE_XML_INACTIVE =3D 1 << 0 /* dump inactive interface infor= mation */ + VIR_INTERFACE_XML_INACTIVE =3D 1 << 0 /* dump inactive interface infor= mation (Since: v0.7.3) */ } virInterfaceXMLFlags; =20 typedef enum { - VIR_INTERFACE_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document= against schema */ + VIR_INTERFACE_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document= against schema (Since: v7.7.0) */ } virInterfaceDefineFlags; =20 char * virInterfaceGetXMLDesc (virInterfacePtr iface, diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-ne= twork.h index 80bd03878b..ad02e4d5f4 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -28,7 +28,7 @@ # endif =20 typedef enum { - VIR_NETWORK_XML_INACTIVE =3D (1 << 0), /* dump inactive network inform= ation */ + VIR_NETWORK_XML_INACTIVE =3D (1 << 0), /* dump inactive network inform= ation (Since: v0.9.10) */ } virNetworkXMLFlags; =20 /** @@ -89,14 +89,14 @@ int virConnectListDefinedNetworks = (virConnectPtr conn, * are exclusive attributes of a network. */ typedef enum { - VIR_CONNECT_LIST_NETWORKS_INACTIVE =3D 1 << 0, - VIR_CONNECT_LIST_NETWORKS_ACTIVE =3D 1 << 1, + VIR_CONNECT_LIST_NETWORKS_INACTIVE =3D 1 << 0, /* (Since: v0.10.2= ) */ + VIR_CONNECT_LIST_NETWORKS_ACTIVE =3D 1 << 1, /* (Since: v0.10.2= ) */ =20 - VIR_CONNECT_LIST_NETWORKS_PERSISTENT =3D 1 << 2, - VIR_CONNECT_LIST_NETWORKS_TRANSIENT =3D 1 << 3, + VIR_CONNECT_LIST_NETWORKS_PERSISTENT =3D 1 << 2, /* (Since: v0.10.2= ) */ + VIR_CONNECT_LIST_NETWORKS_TRANSIENT =3D 1 << 3, /* (Since: v0.10.2= ) */ =20 - VIR_CONNECT_LIST_NETWORKS_AUTOSTART =3D 1 << 4, - VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART =3D 1 << 5, + VIR_CONNECT_LIST_NETWORKS_AUTOSTART =3D 1 << 4, /* (Since: v0.10.2= ) */ + VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART =3D 1 << 5, /* (Since: v0.10.2= ) */ } virConnectListAllNetworksFlags; =20 int virConnectListAllNetworks (virConnectPtr con= n, @@ -114,7 +114,7 @@ virNetworkPtr virNetworkLookupByUUIDString = (virConnectPtr conn, const char *uuid); =20 typedef enum { - VIR_NETWORK_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema */ + VIR_NETWORK_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.8.0) */ } virNetworkCreateFlags; =20 /* @@ -127,7 +127,7 @@ virNetworkPtr virNetworkCreateXMLFlags(virCon= nectPtr conn, unsigned int flags); =20 typedef enum { - VIR_NETWORK_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema */ + VIR_NETWORK_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.7.0) */ } virNetworkDefineFlags; =20 /* @@ -152,13 +152,13 @@ int virNetworkUndefine (virN= etworkPtr network); * */ typedef enum { - VIR_NETWORK_UPDATE_COMMAND_NONE =3D 0, /* (invalid) */ - VIR_NETWORK_UPDATE_COMMAND_MODIFY =3D 1, /* modify an existing elem= ent */ - VIR_NETWORK_UPDATE_COMMAND_DELETE =3D 2, /* delete an existing elem= ent */ - VIR_NETWORK_UPDATE_COMMAND_ADD_LAST =3D 3, /* add an element at end o= f list */ - VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST =3D 4, /* add an element at start= of list */ + VIR_NETWORK_UPDATE_COMMAND_NONE =3D 0, /* (invalid (Since: v0.10.= 2) */ + VIR_NETWORK_UPDATE_COMMAND_MODIFY =3D 1, /* modify an existing elem= ent (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_DELETE =3D 2, /* delete an existing elem= ent (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_LAST =3D 3, /* add an element at end o= f list (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST =3D 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; =20 @@ -170,21 +170,21 @@ typedef enum { * */ typedef enum { - VIR_NETWORK_SECTION_NONE =3D 0, /* (invalid) */ - VIR_NETWORK_SECTION_BRIDGE =3D 1, /* <bridge> */ - VIR_NETWORK_SECTION_DOMAIN =3D 2, /* <domain> */ - VIR_NETWORK_SECTION_IP =3D 3, /* <ip> */ - VIR_NETWORK_SECTION_IP_DHCP_HOST =3D 4, /* <ip>/<dhcp>/<host> */ - VIR_NETWORK_SECTION_IP_DHCP_RANGE =3D 5, /* <ip>/<dhcp>/<range> */ - VIR_NETWORK_SECTION_FORWARD =3D 6, /* <forward> */ - VIR_NETWORK_SECTION_FORWARD_INTERFACE =3D 7, /* <forward>/<interface>= */ - VIR_NETWORK_SECTION_FORWARD_PF =3D 8, /* <forward>/<pf> */ - VIR_NETWORK_SECTION_PORTGROUP =3D 9, /* <portgroup> */ - VIR_NETWORK_SECTION_DNS_HOST =3D 10, /* <dns>/<host> */ - VIR_NETWORK_SECTION_DNS_TXT =3D 11, /* <dns>/<txt> */ - VIR_NETWORK_SECTION_DNS_SRV =3D 12, /* <dns>/<srv> */ + VIR_NETWORK_SECTION_NONE =3D 0, /* (invalid (Since: v0.1= 0.2) */ + VIR_NETWORK_SECTION_BRIDGE =3D 1, /* <bridge> (Since: v0.1= 0.2) */ + VIR_NETWORK_SECTION_DOMAIN =3D 2, /* <domain> (Since: v0.1= 0.2) */ + VIR_NETWORK_SECTION_IP =3D 3, /* <ip> (Since: v0.10.2)= */ + VIR_NETWORK_SECTION_IP_DHCP_HOST =3D 4, /* <ip>/<dhcp>/<host> (S= ince: v0.10.2) */ + VIR_NETWORK_SECTION_IP_DHCP_RANGE =3D 5, /* <ip>/<dhcp>/<range> (= Since: v0.10.2) */ + VIR_NETWORK_SECTION_FORWARD =3D 6, /* <forward> (Since: v0.= 10.2) */ + VIR_NETWORK_SECTION_FORWARD_INTERFACE =3D 7, /* <forward>/<interface>= (Since: v0.10.2) */ + VIR_NETWORK_SECTION_FORWARD_PF =3D 8, /* <forward>/<pf> (Since= : v0.10.2) */ + VIR_NETWORK_SECTION_PORTGROUP =3D 9, /* <portgroup> (Since: v= 0.10.2) */ + VIR_NETWORK_SECTION_DNS_HOST =3D 10, /* <dns>/<host> (Since: = v0.10.2) */ + VIR_NETWORK_SECTION_DNS_TXT =3D 11, /* <dns>/<txt> (Since: v= 0.10.2) */ + VIR_NETWORK_SECTION_DNS_SRV =3D 12, /* <dns>/<srv> (Since: v= 0.10.2) */ # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_SECTION_LAST + VIR_NETWORK_SECTION_LAST /* (Since: v0.10.2) */ # endif } virNetworkUpdateSection; =20 @@ -195,9 +195,9 @@ typedef enum { */ typedef enum { VIR_NETWORK_UPDATE_AFFECT_CURRENT =3D 0, /* affect live if networ= k is active, - config if it's not acti= ve */ - VIR_NETWORK_UPDATE_AFFECT_LIVE =3D 1 << 0, /* affect live state of = network only */ - VIR_NETWORK_UPDATE_AFFECT_CONFIG =3D 1 << 1, /* affect persistent con= fig only */ + config if it's not acti= ve (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_LIVE =3D 1 << 0, /* affect live state of = network only (Since: v0.10.2) */ + VIR_NETWORK_UPDATE_AFFECT_CONFIG =3D 1 << 1, /* affect persistent con= fig only (Since: v0.10.2) */ } virNetworkUpdateFlags; =20 /* @@ -248,13 +248,13 @@ int virNetworkIsPersistent(virNetworkPtr net); * a virNetworkEventLifecycleType is emitted during network lifecycle even= ts */ typedef enum { - VIR_NETWORK_EVENT_DEFINED =3D 0, - VIR_NETWORK_EVENT_UNDEFINED =3D 1, - VIR_NETWORK_EVENT_STARTED =3D 2, - VIR_NETWORK_EVENT_STOPPED =3D 3, + VIR_NETWORK_EVENT_DEFINED =3D 0, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_UNDEFINED =3D 1, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_STARTED =3D 2, /* (Since: v1.2.1) */ + VIR_NETWORK_EVENT_STOPPED =3D 3, /* (Since: v1.2.1) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_NETWORK_EVENT_LAST + VIR_NETWORK_EVENT_LAST /* (Since: v1.2.1) */ # endif } virNetworkEventLifecycleType; =20 @@ -294,7 +294,7 @@ typedef void (*virConnectNetworkEventLifecycleCallback)= (virConnectPtr conn, * signature of callback function will be used. */ typedef enum { - VIR_NETWORK_EVENT_ID_LIFECYCLE =3D 0, /* virConnectNetworkEventL= ifecycleCallback */ + VIR_NETWORK_EVENT_ID_LIFECYCLE =3D 0, /* virConnectNetworkEventL= ifecycleCallback (Since: v1.2.1) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_NETWORK_EVENT_ID_LAST @@ -302,16 +302,18 @@ 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; =20 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) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_IP_ADDR_TYPE_LAST + VIR_IP_ADDR_TYPE_LAST /* (Since: v1.2.6) */ # endif } virIPAddrType; =20 @@ -373,8 +375,8 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, const char *uuidstr); =20 typedef enum { - VIR_NETWORK_PORT_CREATE_RECLAIM =3D (1 << 0), /* reclaim existing used= resources */ - VIR_NETWORK_PORT_CREATE_VALIDATE =3D (1 << 1), /* Validate the XML doc= ument against schema */ + VIR_NETWORK_PORT_CREATE_RECLAIM =3D (1 << 0), /* reclaim existing used= resources (Since: v5.5.0) */ + VIR_NETWORK_PORT_CREATE_VALIDATE =3D (1 << 1), /* Validate the XML doc= ument against schema (Since: v7.8.0) */ } virNetworkPortCreateFlags; =20 virNetworkPortPtr diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 8efcd7f506..4e68d09814 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -63,31 +63,31 @@ int virNodeListDevices (virCon= nectPtr conn, * Flags used to filter either by capability or active state, the * returned node devices. */ typedef enum { - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM =3D 1 << 0, /* System= capability */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV =3D 1 << 1, /* PCI de= vice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV =3D 1 << 2, /* USB de= vice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE =3D 1 << 3, /* USB in= terface */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET =3D 1 << 4, /* Networ= k device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST =3D 1 << 5, /* SCSI H= ost Bus Adapter */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET =3D 1 << 6, /* SCSI T= arget */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI =3D 1 << 7, /* SCSI d= evice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE =3D 1 << 8, /* Storag= e device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST =3D 1 << 9, /* FC Hos= t Bus Adapter */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS =3D 1 << 10, /* Capabl= e of vport */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC =3D 1 << 11, /* Capabl= e of scsi_generic */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM =3D 1 << 12, /* DRM de= vice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES =3D 1 << 13, /* Capabl= e of mediated devices */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV =3D 1 << 14, /* Mediat= ed device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV =3D 1 << 15, /* CCW de= vice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV =3D 1 << 16, /* CSS de= vice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA =3D 1 << 17, /* vDPA d= evice */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD =3D 1 << 18, /* s390 A= P Card device */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE =3D 1 << 19, /* s390 A= P Queue */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX =3D 1 << 20, /* s390 A= P Matrix */ - VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD =3D 1 << 21, /* Device= with VPD */ - - VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE =3D 1 << 30, /* Inacti= ve devices */ - VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE =3D 1U << 31, /* Activ= e devices */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM =3D 1 << 0, /* System= capability (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV =3D 1 << 1, /* PCI de= vice (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV =3D 1 << 2, /* USB de= vice (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE =3D 1 << 3, /* USB in= terface (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET =3D 1 << 4, /* Networ= k device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST =3D 1 << 5, /* SCSI H= ost Bus Adapter (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET =3D 1 << 6, /* SCSI T= arget (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI =3D 1 << 7, /* SCSI d= evice (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE =3D 1 << 8, /* Storag= e device (Since: v0.10.2) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST =3D 1 << 9, /* FC Hos= t Bus Adapter (Since: v1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS =3D 1 << 10, /* Capabl= e of vport (Since: v1.0.4) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC =3D 1 << 11, /* Capabl= e of scsi_generic (Since: v1.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM =3D 1 << 12, /* DRM de= vice (Since: v3.1.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES =3D 1 << 13, /* Capabl= e of mediated devices (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV =3D 1 << 14, /* Mediat= ed device (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV =3D 1 << 15, /* CCW de= vice (Since: v3.4.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV =3D 1 << 16, /* CSS de= vice (Since: v6.8.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA =3D 1 << 17, /* vDPA d= evice (Since: v6.9.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD =3D 1 << 18, /* s390 A= P Card device (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE =3D 1 << 19, /* s390 A= P Queue (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX =3D 1 << 20, /* s390 A= P Matrix (Since: v7.0.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD =3D 1 << 21, /* Device= with VPD (Since: v7.9.0) */ + + VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE =3D 1 << 30, /* Inacti= ve devices (Since: v7.3.0) */ + VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE =3D 1U << 31, /* Activ= e devices (Since: v7.3.0) */ } virConnectListAllNodeDeviceFlags; =20 int virConnectListAllNodeDevices (virConnectPtr conn, @@ -167,8 +167,8 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * signature of callback function will be used. */ typedef enum { - VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE =3D 0, /* virConnectNodeDeviceEvent= LifecycleCallback */ - VIR_NODE_DEVICE_EVENT_ID_UPDATE =3D 1, /* virConnectNodeDeviceEventGen= ericCallback */ + VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE =3D 0, /* virConnectNodeDeviceEvent= LifecycleCallback (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_ID_UPDATE =3D 1, /* virConnectNodeDeviceEventGen= ericCallback (Since: v2.2.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_NODE_DEVICE_EVENT_ID_LAST @@ -176,6 +176,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; @@ -214,13 +216,13 @@ int virConnectNodeDeviceEventDeregisterAny(virConnect= Ptr conn, * lifecycle events */ typedef enum { - VIR_NODE_DEVICE_EVENT_CREATED =3D 0, - VIR_NODE_DEVICE_EVENT_DELETED =3D 1, - VIR_NODE_DEVICE_EVENT_DEFINED =3D 2, - VIR_NODE_DEVICE_EVENT_UNDEFINED =3D 3, + VIR_NODE_DEVICE_EVENT_CREATED =3D 0, /* (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_DELETED =3D 1, /* (Since: v2.2.0) */ + VIR_NODE_DEVICE_EVENT_DEFINED =3D 2, /* (Since: v7.3.0) */ + VIR_NODE_DEVICE_EVENT_UNDEFINED =3D 3, /* (Since: v7.3.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_NODE_DEVICE_EVENT_LAST + VIR_NODE_DEVICE_EVENT_LAST /* (Since: v2.2.0) */ # endif } virNodeDeviceEventLifecycleType; =20 diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-n= wfilter.h index 4e28801006..aa8872e156 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -81,7 +81,7 @@ virNWFilterPtr virNWFilterLookupByUUIDString (vi= rConnectPtr conn, const char *uuid); =20 typedef enum { - VIR_NWFILTER_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document = against schema */ + VIR_NWFILTER_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document = against schema (Since: v7.7.0) */ } virNWFilterDefineFlags; =20 /* @@ -109,7 +109,7 @@ int virNWFilterFree (virNWF= ilterPtr nwfilter); */ =20 typedef enum { - VIR_NWFILTER_BINDING_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML d= ocument against schema */ + VIR_NWFILTER_BINDING_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML d= ocument against schema (Since: v7.8.0) */ } virNWFilterBindingCreateFlags; =20 const char* virNWFilterGetName (virNWFilterPtr nwfilter); diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-sec= ret.h index 82e18b8611..94722a46af 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -38,12 +38,12 @@ typedef struct _virSecret virSecret; typedef virSecret *virSecretPtr; =20 typedef enum { - VIR_SECRET_USAGE_TYPE_NONE =3D 0, - VIR_SECRET_USAGE_TYPE_VOLUME =3D 1, - VIR_SECRET_USAGE_TYPE_CEPH =3D 2, - VIR_SECRET_USAGE_TYPE_ISCSI =3D 3, - VIR_SECRET_USAGE_TYPE_TLS =3D 4, - VIR_SECRET_USAGE_TYPE_VTPM =3D 5, + VIR_SECRET_USAGE_TYPE_NONE =3D 0, /* (Since: v0.7.1) */ + VIR_SECRET_USAGE_TYPE_VOLUME =3D 1, /* (Since: v0.7.1) */ + VIR_SECRET_USAGE_TYPE_CEPH =3D 2, /* (Since: v0.9.7) */ + VIR_SECRET_USAGE_TYPE_ISCSI =3D 3, /* (Since: v1.0.4) */ + VIR_SECRET_USAGE_TYPE_TLS =3D 4, /* (Since: v2.3.0) */ + VIR_SECRET_USAGE_TYPE_VTPM =3D 5, /* (Since: v5.6.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_SECRET_USAGE_TYPE_LAST @@ -51,6 +51,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; @@ -69,13 +71,13 @@ int virConnectListSecrets (virCon= nectPtr conn, */ typedef enum { VIR_CONNECT_LIST_SECRETS_EPHEMERAL =3D 1 << 0, /* kept in memory, n= ever - stored persistently= */ - VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL =3D 1 << 1, + stored persistently= (Since: v0.10.2) */ + VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL =3D 1 << 1, /* (Since: v0.10.2) = */ =20 VIR_CONNECT_LIST_SECRETS_PRIVATE =3D 1 << 2, /* not revealed to a= ny caller of libvirt, nor to = any other - node */ - VIR_CONNECT_LIST_SECRETS_NO_PRIVATE =3D 1 << 3, + node (Since: v0.10.= 2) */ + VIR_CONNECT_LIST_SECRETS_NO_PRIVATE =3D 1 << 3, /* (Since: v0.10.2) = */ } virConnectListAllSecretsFlags; =20 int virConnectListAllSecrets(virConnectPtr conn, @@ -90,7 +92,7 @@ virSecretPtr virSecretLookupByUsage(virConnect= Ptr conn, const char *usageID); =20 typedef enum { - VIR_SECRET_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document ag= ainst schema */ + VIR_SECRET_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document ag= ainst schema (Since: v7.7.0) */ } virSecretDefineFlags; =20 virSecretPtr virSecretDefineXML (virConnectPtr conn, @@ -131,8 +133,8 @@ int virSecretFree (virSec= retPtr secret); * signature of callback function will be used. */ typedef enum { - VIR_SECRET_EVENT_ID_LIFECYCLE =3D 0, /* virConnectSecretEventLifecycle= Callback */ - VIR_SECRET_EVENT_ID_VALUE_CHANGED =3D 1, /* virConnectSecretEventGener= icCallback */ + VIR_SECRET_EVENT_ID_LIFECYCLE =3D 0, /* virConnectSecretEventLifecycle= Callback (Since: v3.0.0) */ + VIR_SECRET_EVENT_ID_VALUE_CHANGED =3D 1, /* virConnectSecretEventGener= icCallback (Since: v3.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_SECRET_EVENT_ID_LAST @@ -140,6 +142,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; @@ -178,11 +182,11 @@ int virConnectSecretEventDeregisterAny(virConnectPtr = conn, * lifecycle events */ typedef enum { - VIR_SECRET_EVENT_DEFINED =3D 0, - VIR_SECRET_EVENT_UNDEFINED =3D 1, + VIR_SECRET_EVENT_DEFINED =3D 0, /* (Since: v3.0.0) */ + VIR_SECRET_EVENT_UNDEFINED =3D 1, /* (Since: v3.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_SECRET_EVENT_LAST + VIR_SECRET_EVENT_LAST /* (Since: v3.0.0) */ # endif } virSecretEventLifecycleType; =20 diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index bee738880d..9ffcdc6180 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -45,45 +45,51 @@ typedef virStoragePool *virStoragePoolPtr; =20 =20 typedef enum { - VIR_STORAGE_POOL_INACTIVE =3D 0, /* Not running */ - VIR_STORAGE_POOL_BUILDING =3D 1, /* Initializing pool, not available */ - VIR_STORAGE_POOL_RUNNING =3D 2, /* Running normally */ - VIR_STORAGE_POOL_DEGRADED =3D 3, /* Running degraded */ - VIR_STORAGE_POOL_INACCESSIBLE =3D 4, /* Running, but not accessible */ + VIR_STORAGE_POOL_INACTIVE =3D 0, /* Not running (Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILDING =3D 1, /* Initializing pool, not available (= Since: v0.4.1) */ + VIR_STORAGE_POOL_RUNNING =3D 2, /* Running normally (Since: v0.4.1) */ + VIR_STORAGE_POOL_DEGRADED =3D 3, /* Running degraded (Since: v0.4.1) */ + VIR_STORAGE_POOL_INACCESSIBLE =3D 4, /* Running, but not accessible (S= ince: v0.8.2) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_STATE_LAST + VIR_STORAGE_POOL_STATE_LAST /* (Since: v0.9.10) */ # endif } virStoragePoolState; =20 typedef enum { - VIR_STORAGE_POOL_BUILD_NEW =3D 0, /* Regular build from scratch */ - VIR_STORAGE_POOL_BUILD_REPAIR =3D (1 << 0), /* Repair / reinitialize */ - VIR_STORAGE_POOL_BUILD_RESIZE =3D (1 << 1), /* Extend existing pool */ - VIR_STORAGE_POOL_BUILD_NO_OVERWRITE =3D (1 << 2), /* Do not overwrite= existing pool */ - VIR_STORAGE_POOL_BUILD_OVERWRITE =3D (1 << 3), /* Overwrite data */ + VIR_STORAGE_POOL_BUILD_NEW =3D 0, /* Regular build from scratch (Si= nce: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_REPAIR =3D (1 << 0), /* Repair / reinitialize (= Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_RESIZE =3D (1 << 1), /* Extend existing pool (= Since: v0.4.1) */ + VIR_STORAGE_POOL_BUILD_NO_OVERWRITE =3D (1 << 2), /* Do not overwrite= existing pool (Since: v0.9.5) */ + VIR_STORAGE_POOL_BUILD_OVERWRITE =3D (1 << 3), /* Overwrite data (Sin= ce: v0.9.5) */ } virStoragePoolBuildFlags; =20 typedef enum { - VIR_STORAGE_POOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast= ) */ - VIR_STORAGE_POOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros= (slow) */ + VIR_STORAGE_POOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast= ) (Since: v0.4.1) */ + VIR_STORAGE_POOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros= (slow) (Since: v0.4.1) */ } virStoragePoolDeleteFlags; =20 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 =3D 0, =20 - /* 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 =3D 1 << 0, =20 /* 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 =3D 1 << 1, =20 /* 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 =3D 1 << 2, } virStoragePoolCreateFlags; =20 @@ -116,46 +122,46 @@ typedef virStorageVol *virStorageVolPtr; =20 =20 typedef enum { - VIR_STORAGE_VOL_FILE =3D 0, /* Regular file based volumes */ - VIR_STORAGE_VOL_BLOCK =3D 1, /* Block based volumes */ - VIR_STORAGE_VOL_DIR =3D 2, /* Directory-passthrough based volume = */ - VIR_STORAGE_VOL_NETWORK =3D 3, /* Network volumes like RBD (RADOS Blo= ck Device) */ + VIR_STORAGE_VOL_FILE =3D 0, /* Regular file based volumes (Since: = v0.4.1) */ + VIR_STORAGE_VOL_BLOCK =3D 1, /* Block based volumes (Since: v0.4.1)= */ + VIR_STORAGE_VOL_DIR =3D 2, /* Directory-passthrough based volume = (Since: v0.9.5) */ + VIR_STORAGE_VOL_NETWORK =3D 3, /* Network volumes like RBD (RADOS Blo= ck Device) (Since: v0.9.13) */ VIR_STORAGE_VOL_NETDIR =3D 4, /* Network accessible directory that c= an - * contain other network volumes */ - VIR_STORAGE_VOL_PLOOP =3D 5, /* Ploop based volumes */ + * contain other network volumes (Since:= v1.2.0) */ + VIR_STORAGE_VOL_PLOOP =3D 5, /* Ploop based volumes (Since: v1.3.4)= */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_VOL_LAST + VIR_STORAGE_VOL_LAST /* (Since: v0.9.10) */ # endif } virStorageVolType; =20 typedef enum { - VIR_STORAGE_VOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast)= */ - VIR_STORAGE_VOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros = (slow) */ - VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS =3D 1 << 1, /* Force removal of = volume, even if in use */ + VIR_STORAGE_VOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast)= (Since: v0.4.1) */ + VIR_STORAGE_VOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros = (slow) (Since: v0.4.1) */ + VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS =3D 1 << 1, /* Force removal of = volume, even if in use (Since: v1.2.21) */ } virStorageVolDeleteFlags; =20 typedef enum { - VIR_STORAGE_VOL_WIPE_ALG_ZERO =3D 0, /* 1-pass, all zeroes */ + VIR_STORAGE_VOL_WIPE_ALG_ZERO =3D 0, /* 1-pass, all zeroes (Since: v0.= 9.10) */ VIR_STORAGE_VOL_WIPE_ALG_NNSA =3D 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 =3D 2, /* 4-pass DoD 5220.22-M section - 8-306 procedure */ + 8-306 procedure (Since: v0.9.10) = */ VIR_STORAGE_VOL_WIPE_ALG_BSI =3D 3, /* 9-pass method recommended by the German Center of Security in - Information Technologies */ - VIR_STORAGE_VOL_WIPE_ALG_GUTMANN =3D 4, /* The canonical 35-pass seque= nce */ + Information Technologies (Since: = v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_GUTMANN =3D 4, /* The canonical 35-pass seque= nce (Since: v0.9.10) */ VIR_STORAGE_VOL_WIPE_ALG_SCHNEIER =3D 5, /* 7-pass method described by Bruce Schneier in "Applied - Cryptography" (1996) */ - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 =3D 6, /* 7-pass random */ + Cryptography" (1996) (Since:= v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 =3D 6, /* 7-pass random (Since: v0.= 9.10) */ =20 - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random (Since: v= 0.9.10) */ =20 - VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random */ + VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random (Since: v0.9.1= 0) */ =20 VIR_STORAGE_VOL_WIPE_ALG_TRIM =3D 9, /* 1-pass, trim all data on the - volume by using TRIM or DISCARD = */ + volume by using TRIM or DISCARD = (Since: v1.3.2) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_VOL_WIPE_ALG_LAST @@ -163,6 +169,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; @@ -186,7 +194,7 @@ struct _virStorageVolInfo { typedef virStorageVolInfo *virStorageVolInfoPtr; =20 typedef enum { - VIR_STORAGE_XML_INACTIVE =3D (1 << 0), /* dump inactive pool/volume= information */ + VIR_STORAGE_XML_INACTIVE =3D (1 << 0), /* dump inactive pool/volume= information (Since: v0.9.13) */ } virStorageXMLFlags; =20 /* @@ -273,7 +281,7 @@ virStoragePoolPtr virStoragePoolLookupByTargetPat= h(virConnectPtr conn, const char *path); =20 typedef enum { - VIR_STORAGE_POOL_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML docum= ent against schema */ + VIR_STORAGE_POOL_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML docum= ent against schema (Since: v7.7.0) */ } virStoragePoolDefineFlags; =20 /* @@ -346,8 +354,8 @@ const char* virStorageVolGetName = (virStorageVolPtr vol); const char* virStorageVolGetKey (virStorageVolPtr = vol); =20 typedef enum { - VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA =3D 1 << 0, - VIR_STORAGE_VOL_CREATE_REFLINK =3D 1 << 1, /* perform a btrfs lightwei= ght copy */ + VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA =3D 1 << 0, /* (Since: v1.0.1= ) */ + VIR_STORAGE_VOL_CREATE_REFLINK =3D 1 << 1, /* perform a btrfs lightwei= ght copy (Since: v1.2.13) */ } virStorageVolCreateFlags; =20 virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr= pool, @@ -359,7 +367,7 @@ virStorageVolPtr virStorageVolCreateXMLFrom = (virStoragePoolPtr pool, unsigned int flag= s); =20 typedef enum { - VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse strea= m */ + VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse strea= m (Since: v3.4.0) */ } virStorageVolDownloadFlags; =20 int virStorageVolDownload (virStorageVolPtr = vol, @@ -368,7 +376,7 @@ int virStorageVolDownload = (virStorageVolPtr vol, unsigned long lon= g length, unsigned int flag= s); typedef enum { - VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse stream= */ + VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse stream= (Since: v3.4.0) */ } virStorageVolUploadFlags; =20 int virStorageVolUpload (virStorageVolPtr = vol, @@ -397,9 +405,9 @@ char * virStorageVolGetXMLDesc = (virStorageVolPtr pool, char * virStorageVolGetPath (virStorageVolPtr = vol); =20 typedef enum { - VIR_STORAGE_VOL_RESIZE_ALLOCATE =3D 1 << 0, /* force allocation of new= size */ - VIR_STORAGE_VOL_RESIZE_DELTA =3D 1 << 1, /* size is relative to cur= rent */ - VIR_STORAGE_VOL_RESIZE_SHRINK =3D 1 << 2, /* allow decrease in capac= ity */ + VIR_STORAGE_VOL_RESIZE_ALLOCATE =3D 1 << 0, /* force allocation of new= size (Since: v0.9.10) */ + VIR_STORAGE_VOL_RESIZE_DELTA =3D 1 << 1, /* size is relative to cur= rent (Since: v0.9.10) */ + VIR_STORAGE_VOL_RESIZE_SHRINK =3D 1 << 2, /* allow decrease in capac= ity (Since: v0.9.10) */ } virStorageVolResizeFlags; =20 int virStorageVolResize (virStorageVolPtr = vol, @@ -425,8 +433,8 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * signature of callback function will be used. */ typedef enum { - VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE =3D 0, /* virConnectStoragePoolEve= ntLifecycleCallback */ - VIR_STORAGE_POOL_EVENT_ID_REFRESH =3D 1, /* virConnectStoragePoolEvent= GenericCallback */ + VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE =3D 0, /* virConnectStoragePoolEve= ntLifecycleCallback (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_ID_REFRESH =3D 1, /* virConnectStoragePoolEvent= GenericCallback (Since: v2.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS VIR_STORAGE_POOL_EVENT_ID_LAST @@ -434,6 +442,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; @@ -472,15 +482,15 @@ int virConnectStoragePoolEventDeregisterAny(virConnec= tPtr conn, * lifecycle events */ typedef enum { - VIR_STORAGE_POOL_EVENT_DEFINED =3D 0, - VIR_STORAGE_POOL_EVENT_UNDEFINED =3D 1, - VIR_STORAGE_POOL_EVENT_STARTED =3D 2, - VIR_STORAGE_POOL_EVENT_STOPPED =3D 3, - VIR_STORAGE_POOL_EVENT_CREATED =3D 4, - VIR_STORAGE_POOL_EVENT_DELETED =3D 5, + VIR_STORAGE_POOL_EVENT_DEFINED =3D 0, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_UNDEFINED =3D 1, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_STARTED =3D 2, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_STOPPED =3D 3, /* (Since: v2.0.0) */ + VIR_STORAGE_POOL_EVENT_CREATED =3D 4, /* (Since: v3.8.0) */ + VIR_STORAGE_POOL_EVENT_DELETED =3D 5, /* (Since: v3.8.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_STORAGE_POOL_EVENT_LAST + VIR_STORAGE_POOL_EVENT_LAST /* (Since: v2.0.0) */ # endif } virStoragePoolEventLifecycleType; =20 diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-str= eam.h index 076f9ee8b8..d69131030b 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -29,7 +29,7 @@ =20 =20 typedef enum { - VIR_STREAM_NONBLOCK =3D (1 << 0), + VIR_STREAM_NONBLOCK =3D (1 << 0), /* (Since: v0.7.2) */ } virStreamFlags; =20 virStreamPtr virStreamNew(virConnectPtr conn, @@ -45,7 +45,7 @@ int virStreamRecv(virStreamPtr st, size_t nbytes); =20 typedef enum { - VIR_STREAM_RECV_STOP_AT_HOLE =3D (1 << 0), + VIR_STREAM_RECV_STOP_AT_HOLE =3D (1 << 0), /* (Since: v3.4.0) */ } virStreamRecvFlagsValues; =20 int virStreamRecvFlags(virStreamPtr st, @@ -230,10 +230,10 @@ int virStreamSparseRecvAll(virStreamPtr stream, void *opaque); =20 typedef enum { - VIR_STREAM_EVENT_READABLE =3D (1 << 0), - VIR_STREAM_EVENT_WRITABLE =3D (1 << 1), - VIR_STREAM_EVENT_ERROR =3D (1 << 2), - VIR_STREAM_EVENT_HANGUP =3D (1 << 3), + VIR_STREAM_EVENT_READABLE =3D (1 << 0), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_WRITABLE =3D (1 << 1), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_ERROR =3D (1 << 2), /* (Since: v0.7.2) */ + VIR_STREAM_EVENT_HANGUP =3D (1 << 3), /* (Since: v0.7.2) */ } virStreamEventType; =20 =20 diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 57986931fd..3c1b27a36f 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -36,9 +36,9 @@ extern "C" { * Indicates the level of an error */ typedef enum { - VIR_ERR_NONE =3D 0, - VIR_ERR_WARNING =3D 1, /* A simple warning */ - VIR_ERR_ERROR =3D 2 /* An error */ + VIR_ERR_NONE =3D 0, /* (Since: v0.1.0) */ + VIR_ERR_WARNING =3D 1, /* A simple warning (Since: v0.1.0) */ + VIR_ERR_ERROR =3D 2 /* An error (Since: v0.1.0) */ } virErrorLevel; =20 /** @@ -48,98 +48,98 @@ typedef enum { * stable, with all additions placed at the end since libvirt 0.1.0. */ typedef enum { - VIR_FROM_NONE =3D 0, - VIR_FROM_XEN =3D 1, /* Error at Xen hypervisor layer */ - VIR_FROM_XEND =3D 2, /* Error at connection with xend daemon = */ - VIR_FROM_XENSTORE =3D 3, /* Error at connection with xen store */ - VIR_FROM_SEXPR =3D 4, /* Error in the S-Expression code */ - - VIR_FROM_XML =3D 5, /* Error in the XML code */ - VIR_FROM_DOM =3D 6, /* Error when operating on a domain */ - VIR_FROM_RPC =3D 7, /* Error in the XML-RPC code */ + VIR_FROM_NONE =3D 0, /* (Since: v0.1.0) */ + VIR_FROM_XEN =3D 1, /* Error at Xen hypervisor layer (Since:= v0.1.0) */ + VIR_FROM_XEND =3D 2, /* Error at connection with xend daemon = (Since: v0.1.0) */ + VIR_FROM_XENSTORE =3D 3, /* Error at connection with xen store (S= ince: v0.1.0) */ + VIR_FROM_SEXPR =3D 4, /* Error in the S-Expression code (Since= : v0.1.0) */ + + VIR_FROM_XML =3D 5, /* Error in the XML code (Since: v0.1.0)= */ + VIR_FROM_DOM =3D 6, /* Error when operating on a domain (Sin= ce: v0.1.0) */ + VIR_FROM_RPC =3D 7, /* Error in the XML-RPC code (Since: v0.= 1.1) */ VIR_FROM_PROXY =3D 8, /* Error in the proxy code; unused since - 0.8.6 */ - VIR_FROM_CONF =3D 9, /* Error in the configuration file handl= ing */ - - VIR_FROM_QEMU =3D 10, /* Error at the QEMU daemon */ - VIR_FROM_NET =3D 11, /* Error when operating on a network */ - VIR_FROM_TEST =3D 12, /* Error from test driver */ - VIR_FROM_REMOTE =3D 13, /* Error from remote driver */ - VIR_FROM_OPENVZ =3D 14, /* Error from OpenVZ driver */ - - VIR_FROM_XENXM =3D 15, /* Error at Xen XM layer */ - VIR_FROM_STATS_LINUX =3D 16, /* Error in the Linux Stats code */ - VIR_FROM_LXC =3D 17, /* Error from Linux Container driver */ - VIR_FROM_STORAGE =3D 18, /* Error from storage driver */ - VIR_FROM_NETWORK =3D 19, /* Error from network config */ - - VIR_FROM_DOMAIN =3D 20, /* Error from domain config */ - VIR_FROM_UML =3D 21, /* Error at the UML driver; unused since= 5.0.0 */ - VIR_FROM_NODEDEV =3D 22, /* Error from node device monitor */ - VIR_FROM_XEN_INOTIFY =3D 23, /* Error from xen inotify layer */ - VIR_FROM_SECURITY =3D 24, /* Error from security framework */ - - VIR_FROM_VBOX =3D 25, /* Error from VirtualBox driver */ - VIR_FROM_INTERFACE =3D 26, /* Error when operating on an interface = */ + 0.8.6 (Since: v0.1.3) */ + VIR_FROM_CONF =3D 9, /* Error in the configuration file handl= ing (Since: v0.1.6) */ + + VIR_FROM_QEMU =3D 10, /* Error at the QEMU daemon (Since: v0.2= .0) */ + VIR_FROM_NET =3D 11, /* Error when operating on a network (Si= nce: v0.2.0) */ + VIR_FROM_TEST =3D 12, /* Error from test driver (Since: v0.2.3= ) */ + VIR_FROM_REMOTE =3D 13, /* Error from remote driver (Since: v0.2= .3) */ + VIR_FROM_OPENVZ =3D 14, /* Error from OpenVZ driver (Since: v0.3= .1) */ + + VIR_FROM_XENXM =3D 15, /* Error at Xen XM layer (Since: v0.4.1)= */ + VIR_FROM_STATS_LINUX =3D 16, /* Error in the Linux Stats code (Since:= v0.4.1) */ + VIR_FROM_LXC =3D 17, /* Error from Linux Container driver (Si= nce: v0.4.2) */ + VIR_FROM_STORAGE =3D 18, /* Error from storage driver (Since: v0.= 4.1) */ + VIR_FROM_NETWORK =3D 19, /* Error from network config (Since: v0.= 4.6) */ + + VIR_FROM_DOMAIN =3D 20, /* Error from domain config (Since: v0.4= .6) */ + VIR_FROM_UML =3D 21, /* Error at the UML driver; unused since= 5.0.0 (Since: v0.5.0) */ + VIR_FROM_NODEDEV =3D 22, /* Error from node device monitor (Since= : v0.5.0) */ + VIR_FROM_XEN_INOTIFY =3D 23, /* Error from xen inotify layer (Since: = v0.5.0) */ + VIR_FROM_SECURITY =3D 24, /* Error from security framework (Since:= v0.6.1) */ + + VIR_FROM_VBOX =3D 25, /* Error from VirtualBox driver (Since: = v0.6.3) */ + VIR_FROM_INTERFACE =3D 26, /* Error when operating on an interface = (Since: v0.6.4) */ VIR_FROM_ONE =3D 27, /* The OpenNebula driver no longer exist= s. - Retained for ABI/API compat only */ - VIR_FROM_ESX =3D 28, /* Error from ESX driver */ - VIR_FROM_PHYP =3D 29, /* Error from the phyp driver, unused si= nce 6.0.0 */ - - VIR_FROM_SECRET =3D 30, /* Error from secret storage */ - VIR_FROM_CPU =3D 31, /* Error from CPU driver */ - VIR_FROM_XENAPI =3D 32, /* Error from XenAPI */ - VIR_FROM_NWFILTER =3D 33, /* Error from network filter driver */ - VIR_FROM_HOOK =3D 34, /* Error from Synchronous hooks */ - - VIR_FROM_DOMAIN_SNAPSHOT =3D 35,/* Error from domain snapshot */ - VIR_FROM_AUDIT =3D 36, /* Error from auditing subsystem */ - VIR_FROM_SYSINFO =3D 37, /* Error from sysinfo/SMBIOS */ - VIR_FROM_STREAMS =3D 38, /* Error from I/O streams */ - VIR_FROM_VMWARE =3D 39, /* Error from VMware driver */ - - VIR_FROM_EVENT =3D 40, /* Error from event loop impl */ - VIR_FROM_LIBXL =3D 41, /* Error from libxenlight driver */ - VIR_FROM_LOCKING =3D 42, /* Error from lock manager */ - VIR_FROM_HYPERV =3D 43, /* Error from Hyper-V driver */ - VIR_FROM_CAPABILITIES =3D 44, /* Error from capabilities */ - - VIR_FROM_URI =3D 45, /* Error from URI handling */ - VIR_FROM_AUTH =3D 46, /* Error from auth handling */ - VIR_FROM_DBUS =3D 47, /* Error from DBus */ - VIR_FROM_PARALLELS =3D 48, /* Error from Parallels */ - VIR_FROM_DEVICE =3D 49, /* Error from Device */ - - VIR_FROM_SSH =3D 50, /* Error from libssh2 connection transpo= rt */ - VIR_FROM_LOCKSPACE =3D 51, /* Error from lockspace */ - VIR_FROM_INITCTL =3D 52, /* Error from initctl device communicati= on */ - VIR_FROM_IDENTITY =3D 53, /* Error from identity code */ - VIR_FROM_CGROUP =3D 54, /* Error from cgroups */ - - VIR_FROM_ACCESS =3D 55, /* Error from access control manager */ - VIR_FROM_SYSTEMD =3D 56, /* Error from systemd code */ - VIR_FROM_BHYVE =3D 57, /* Error from bhyve driver */ - VIR_FROM_CRYPTO =3D 58, /* Error from crypto code */ - VIR_FROM_FIREWALL =3D 59, /* Error from firewall */ - - VIR_FROM_POLKIT =3D 60, /* Error from polkit code */ - VIR_FROM_THREAD =3D 61, /* Error from thread utils */ - VIR_FROM_ADMIN =3D 62, /* Error from admin backend */ - VIR_FROM_LOGGING =3D 63, /* Error from log manager */ - VIR_FROM_XENXL =3D 64, /* Error from Xen xl config code */ - - VIR_FROM_PERF =3D 65, /* Error from perf */ - VIR_FROM_LIBSSH =3D 66, /* Error from libssh connection transpor= t */ - VIR_FROM_RESCTRL =3D 67, /* Error from resource control */ - VIR_FROM_FIREWALLD =3D 68, /* Error from firewalld */ - VIR_FROM_DOMAIN_CHECKPOINT =3D 69, /* Error from domain checkpoint */ - - VIR_FROM_TPM =3D 70, /* Error from TPM */ - VIR_FROM_BPF =3D 71, /* Error from BPF code */ - VIR_FROM_CH =3D 72, /* Error from Cloud-Hypervisor driver */ + Retained for ABI/API compat only (Since= : v0.6.4) */ + VIR_FROM_ESX =3D 28, /* Error from ESX driver (Since: v0.7.0)= */ + VIR_FROM_PHYP =3D 29, /* Error from the phyp driver, unused si= nce 6.0.0 (Since: v0.7.0) */ + + VIR_FROM_SECRET =3D 30, /* Error from secret storage (Since: v0.= 7.1) */ + VIR_FROM_CPU =3D 31, /* Error from CPU driver (Since: v0.7.5)= */ + VIR_FROM_XENAPI =3D 32, /* Error from XenAPI (Since: v0.8.0) */ + VIR_FROM_NWFILTER =3D 33, /* Error from network filter driver (Sin= ce: v0.8.0) */ + VIR_FROM_HOOK =3D 34, /* Error from Synchronous hooks (Since: = v0.8.0) */ + + VIR_FROM_DOMAIN_SNAPSHOT =3D 35,/* Error from domain snapshot (Since: = v0.8.0) */ + VIR_FROM_AUDIT =3D 36, /* Error from auditing subsystem (Since:= v0.8.5) */ + VIR_FROM_SYSINFO =3D 37, /* Error from sysinfo/SMBIOS (Since: v0.= 8.6) */ + VIR_FROM_STREAMS =3D 38, /* Error from I/O streams (Since: v0.8.6= ) */ + VIR_FROM_VMWARE =3D 39, /* Error from VMware driver (Since: v0.8= .7) */ + + VIR_FROM_EVENT =3D 40, /* Error from event loop impl (Since: v0= .9.0) */ + VIR_FROM_LIBXL =3D 41, /* Error from libxenlight driver (Since:= v0.9.0) */ + VIR_FROM_LOCKING =3D 42, /* Error from lock manager (Since: v0.9.= 2) */ + VIR_FROM_HYPERV =3D 43, /* Error from Hyper-V driver (Since: v0.= 9.5) */ + VIR_FROM_CAPABILITIES =3D 44, /* Error from capabilities (Since: v0.9.= 8) */ + + VIR_FROM_URI =3D 45, /* Error from URI handling (Since: v0.9.= 11) */ + VIR_FROM_AUTH =3D 46, /* Error from auth handling (Since: v0.9= .11) */ + VIR_FROM_DBUS =3D 47, /* Error from DBus (Since: v0.9.12) */ + VIR_FROM_PARALLELS =3D 48, /* Error from Parallels (Since: v0.10.0)= */ + VIR_FROM_DEVICE =3D 49, /* Error from Device (Since: v0.10.0) */ + + VIR_FROM_SSH =3D 50, /* Error from libssh2 connection transpo= rt (Since: v0.10.0) */ + VIR_FROM_LOCKSPACE =3D 51, /* Error from lockspace (Since: v1.0.0) = */ + VIR_FROM_INITCTL =3D 52, /* Error from initctl device communicati= on (Since: v1.0.1) */ + VIR_FROM_IDENTITY =3D 53, /* Error from identity code (Since: v1.0= .4) */ + VIR_FROM_CGROUP =3D 54, /* Error from cgroups (Since: v1.0.5) */ + + VIR_FROM_ACCESS =3D 55, /* Error from access control manager (Si= nce: v1.1.0) */ + VIR_FROM_SYSTEMD =3D 56, /* Error from systemd code (Since: v1.1.= 1) */ + VIR_FROM_BHYVE =3D 57, /* Error from bhyve driver (Since: v1.2.= 2) */ + VIR_FROM_CRYPTO =3D 58, /* Error from crypto code (Since: v1.2.3= ) */ + VIR_FROM_FIREWALL =3D 59, /* Error from firewall (Since: v1.2.4) */ + + VIR_FROM_POLKIT =3D 60, /* Error from polkit code (Since: v1.2.9= ) */ + VIR_FROM_THREAD =3D 61, /* Error from thread utils (Since: v1.2.= 14) */ + VIR_FROM_ADMIN =3D 62, /* Error from admin backend (Since: v1.2= .17) */ + VIR_FROM_LOGGING =3D 63, /* Error from log manager (Since: v1.3.0= ) */ + VIR_FROM_XENXL =3D 64, /* Error from Xen xl config code (Since:= v1.3.2) */ + + VIR_FROM_PERF =3D 65, /* Error from perf (Since: v1.3.3) */ + VIR_FROM_LIBSSH =3D 66, /* Error from libssh connection transpor= t (Since: v2.5.0) */ + VIR_FROM_RESCTRL =3D 67, /* Error from resource control (Since: v= 3.7.0) */ + VIR_FROM_FIREWALLD =3D 68, /* Error from firewalld (Since: v5.1.0) = */ + VIR_FROM_DOMAIN_CHECKPOINT =3D 69, /* Error from domain checkpoint (Si= nce: v5.2.0) */ + + VIR_FROM_TPM =3D 70, /* Error from TPM (Since: v5.6.0) */ + VIR_FROM_BPF =3D 71, /* Error from BPF code (Since: v5.10.0) = */ + VIR_FROM_CH =3D 72, /* Error from Cloud-Hypervisor driver (S= ince: v7.5.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_ERR_DOMAIN_LAST + VIR_ERR_DOMAIN_LAST /* (Since: v0.9.13) */ # endif } virErrorDomain; =20 @@ -207,137 +207,137 @@ struct _virError { * } */ typedef enum { - VIR_ERR_OK =3D 0, - VIR_ERR_INTERNAL_ERROR =3D 1, /* internal error */ - VIR_ERR_NO_MEMORY =3D 2, /* memory allocation failure */ - VIR_ERR_NO_SUPPORT =3D 3, /* no support for this function = */ - VIR_ERR_UNKNOWN_HOST =3D 4, /* could not resolve hostname */ - VIR_ERR_NO_CONNECT =3D 5, /* can't connect to hypervisor */ - VIR_ERR_INVALID_CONN =3D 6, /* invalid connection object */ - VIR_ERR_INVALID_DOMAIN =3D 7, /* invalid domain object */ - VIR_ERR_INVALID_ARG =3D 8, /* invalid function argument */ - VIR_ERR_OPERATION_FAILED =3D 9, /* a command to hypervisor faile= d */ - VIR_ERR_GET_FAILED =3D 10, /* a HTTP GET command to failed = */ - VIR_ERR_POST_FAILED =3D 11, /* a HTTP POST command to failed= */ - VIR_ERR_HTTP_ERROR =3D 12, /* unexpected HTTP error code */ - VIR_ERR_SEXPR_SERIAL =3D 13, /* failure to serialize an S-Exp= r */ + VIR_ERR_OK =3D 0, /* (Since: v0.1.0) */ + VIR_ERR_INTERNAL_ERROR =3D 1, /* internal error (Since: v0.1.0= ) */ + VIR_ERR_NO_MEMORY =3D 2, /* memory allocation failure (Si= nce: v0.1.0) */ + VIR_ERR_NO_SUPPORT =3D 3, /* no support for this function = (Since: v0.1.0) */ + VIR_ERR_UNKNOWN_HOST =3D 4, /* could not resolve hostname (S= ince: v0.1.0) */ + VIR_ERR_NO_CONNECT =3D 5, /* can't connect to hypervisor (= Since: v0.1.0) */ + VIR_ERR_INVALID_CONN =3D 6, /* invalid connection object (Si= nce: v0.1.0) */ + VIR_ERR_INVALID_DOMAIN =3D 7, /* invalid domain object (Since:= v0.1.0) */ + VIR_ERR_INVALID_ARG =3D 8, /* invalid function argument (Si= nce: v0.1.0) */ + VIR_ERR_OPERATION_FAILED =3D 9, /* a command to hypervisor faile= d (Since: v0.1.0) */ + VIR_ERR_GET_FAILED =3D 10, /* a HTTP GET command to failed = (Since: v0.1.0) */ + VIR_ERR_POST_FAILED =3D 11, /* a HTTP POST command to failed= (Since: v0.1.0) */ + VIR_ERR_HTTP_ERROR =3D 12, /* unexpected HTTP error code (S= ince: v0.1.0) */ + VIR_ERR_SEXPR_SERIAL =3D 13, /* failure to serialize an S-Exp= r (Since: v0.1.0) */ VIR_ERR_NO_XEN =3D 14, /* could not open Xen hypervisor - control */ - VIR_ERR_XEN_CALL =3D 15, /* failure doing an hypervisor c= all */ - VIR_ERR_OS_TYPE =3D 16, /* unknown OS type */ - VIR_ERR_NO_KERNEL =3D 17, /* missing kernel information */ - VIR_ERR_NO_ROOT =3D 18, /* missing root device informati= on */ - VIR_ERR_NO_SOURCE =3D 19, /* missing source device informa= tion */ - VIR_ERR_NO_TARGET =3D 20, /* missing target device informa= tion */ - VIR_ERR_NO_NAME =3D 21, /* missing domain name informati= on */ - VIR_ERR_NO_OS =3D 22, /* missing domain OS information= */ - VIR_ERR_NO_DEVICE =3D 23, /* missing domain devices inform= ation */ - VIR_ERR_NO_XENSTORE =3D 24, /* could not open Xen Store cont= rol */ - VIR_ERR_DRIVER_FULL =3D 25, /* too many drivers registered */ + control (Since: v0.1.0) */ + VIR_ERR_XEN_CALL =3D 15, /* failure doing an hypervisor c= all (Since: v0.1.0) */ + VIR_ERR_OS_TYPE =3D 16, /* unknown OS type (Since: v0.1.= 0) */ + VIR_ERR_NO_KERNEL =3D 17, /* missing kernel information (S= ince: v0.1.0) */ + VIR_ERR_NO_ROOT =3D 18, /* missing root device informati= on (Since: v0.1.0) */ + VIR_ERR_NO_SOURCE =3D 19, /* missing source device informa= tion (Since: v0.1.0) */ + VIR_ERR_NO_TARGET =3D 20, /* missing target device informa= tion (Since: v0.1.0) */ + VIR_ERR_NO_NAME =3D 21, /* missing domain name informati= on (Since: v0.1.0) */ + VIR_ERR_NO_OS =3D 22, /* missing domain OS information= (Since: v0.1.0) */ + VIR_ERR_NO_DEVICE =3D 23, /* missing domain devices inform= ation (Since: v0.1.0) */ + VIR_ERR_NO_XENSTORE =3D 24, /* could not open Xen Store cont= rol (Since: v0.1.0) */ + VIR_ERR_DRIVER_FULL =3D 25, /* too many drivers registered (= Since: v0.1.0) */ VIR_ERR_CALL_FAILED =3D 26, /* not supported by the drivers - (DEPRECATED) */ + (DEPRECATED) (Since: v0.1.0) */ VIR_ERR_XML_ERROR =3D 27, /* an XML description is not well - formed or broken */ - VIR_ERR_DOM_EXIST =3D 28, /* the domain already exist */ + formed or broken (Since: v0.1.1= ) */ + VIR_ERR_DOM_EXIST =3D 28, /* the domain already exist (Sin= ce: v0.1.1) */ VIR_ERR_OPERATION_DENIED =3D 29, /* operation forbidden on read-o= nly - connections */ - VIR_ERR_OPEN_FAILED =3D 30, /* failed to open a conf file */ - VIR_ERR_READ_FAILED =3D 31, /* failed to read a conf file */ - VIR_ERR_PARSE_FAILED =3D 32, /* failed to parse a conf file */ + connections (Since: v0.1.4) */ + VIR_ERR_OPEN_FAILED =3D 30, /* failed to open a conf file (S= ince: v0.1.6) */ + VIR_ERR_READ_FAILED =3D 31, /* failed to read a conf file (S= ince: v0.1.6) */ + VIR_ERR_PARSE_FAILED =3D 32, /* failed to parse a conf file (= Since: v0.1.6) */ VIR_ERR_CONF_SYNTAX =3D 33, /* failed to parse the syntax of= a - conf file */ - VIR_ERR_WRITE_FAILED =3D 34, /* failed to write a conf file */ - VIR_ERR_XML_DETAIL =3D 35, /* detail of an XML error */ - VIR_ERR_INVALID_NETWORK =3D 36, /* invalid network object */ - VIR_ERR_NETWORK_EXIST =3D 37, /* the network already exist */ - VIR_ERR_SYSTEM_ERROR =3D 38, /* general system call failure */ - VIR_ERR_RPC =3D 39, /* some sort of RPC error */ - VIR_ERR_GNUTLS_ERROR =3D 40, /* error from a GNUTLS call */ - VIR_WAR_NO_NETWORK =3D 41, /* failed to start network */ + conf file (Since: v0.1.6) */ + VIR_ERR_WRITE_FAILED =3D 34, /* failed to write a conf file (= Since: v0.1.6) */ + VIR_ERR_XML_DETAIL =3D 35, /* detail of an XML error (Since= : v0.1.9) */ + VIR_ERR_INVALID_NETWORK =3D 36, /* invalid network object (Since= : v0.2.0) */ + VIR_ERR_NETWORK_EXIST =3D 37, /* the network already exist (Si= nce: v0.2.0) */ + VIR_ERR_SYSTEM_ERROR =3D 38, /* general system call failure (= Since: v0.2.1) */ + VIR_ERR_RPC =3D 39, /* some sort of RPC error (Since= : v0.2.3) */ + VIR_ERR_GNUTLS_ERROR =3D 40, /* error from a GNUTLS call (Sin= ce: v0.2.3) */ + VIR_WAR_NO_NETWORK =3D 41, /* failed to start network (Sinc= e: v0.2.3) */ VIR_ERR_NO_DOMAIN =3D 42, /* domain not found or unexpecte= dly - disappeared */ - VIR_ERR_NO_NETWORK =3D 43, /* network not found */ - VIR_ERR_INVALID_MAC =3D 44, /* invalid MAC address */ - VIR_ERR_AUTH_FAILED =3D 45, /* authentication failed */ - VIR_ERR_INVALID_STORAGE_POOL =3D 46, /* invalid storage pool object */ - VIR_ERR_INVALID_STORAGE_VOL =3D 47, /* invalid storage vol object */ - VIR_WAR_NO_STORAGE =3D 48, /* failed to start storage */ - VIR_ERR_NO_STORAGE_POOL =3D 49, /* storage pool not found */ - VIR_ERR_NO_STORAGE_VOL =3D 50, /* storage volume not found */ - VIR_WAR_NO_NODE =3D 51, /* failed to start node driver */ - VIR_ERR_INVALID_NODE_DEVICE =3D 52, /* invalid node device object */ - VIR_ERR_NO_NODE_DEVICE =3D 53, /* node device not found */ - VIR_ERR_NO_SECURITY_MODEL =3D 54, /* security model not found */ + disappeared (Since: v0.3.0) */ + VIR_ERR_NO_NETWORK =3D 43, /* network not found (Since: v0.= 3.0) */ + VIR_ERR_INVALID_MAC =3D 44, /* invalid MAC address (Since: v= 0.3.1) */ + VIR_ERR_AUTH_FAILED =3D 45, /* authentication failed (Since:= v0.4.1) */ + VIR_ERR_INVALID_STORAGE_POOL =3D 46, /* invalid storage pool object (= Since: v0.4.1) */ + VIR_ERR_INVALID_STORAGE_VOL =3D 47, /* invalid storage vol object (S= ince: v0.4.1) */ + VIR_WAR_NO_STORAGE =3D 48, /* failed to start storage (Sinc= e: v0.4.1) */ + VIR_ERR_NO_STORAGE_POOL =3D 49, /* storage pool not found (Since= : v0.4.1) */ + VIR_ERR_NO_STORAGE_VOL =3D 50, /* storage volume not found (Sin= ce: v0.4.1) */ + VIR_WAR_NO_NODE =3D 51, /* failed to start node driver (= Since: v0.5.0) */ + VIR_ERR_INVALID_NODE_DEVICE =3D 52, /* invalid node device object (S= ince: v0.5.0) */ + VIR_ERR_NO_NODE_DEVICE =3D 53, /* node device not found (Since:= v0.5.0) */ + VIR_ERR_NO_SECURITY_MODEL =3D 54, /* security model not found (Sin= ce: v0.6.1) */ VIR_ERR_OPERATION_INVALID =3D 55, /* operation is not applicable a= t this - time */ - VIR_WAR_NO_INTERFACE =3D 56, /* failed to start interface dri= ver */ - VIR_ERR_NO_INTERFACE =3D 57, /* interface driver not running = */ - VIR_ERR_INVALID_INTERFACE =3D 58, /* invalid interface object */ + time (Since: v0.6.4) */ + VIR_WAR_NO_INTERFACE =3D 56, /* failed to start interface dri= ver (Since: v0.6.4) */ + VIR_ERR_NO_INTERFACE =3D 57, /* interface driver not running = (Since: v0.6.4) */ + VIR_ERR_INVALID_INTERFACE =3D 58, /* invalid interface object (Sin= ce: v0.6.4) */ VIR_ERR_MULTIPLE_INTERFACES =3D 59, /* more than one matching interf= ace - found */ - VIR_WAR_NO_NWFILTER =3D 60, /* failed to start nwfilter driv= er */ - VIR_ERR_INVALID_NWFILTER =3D 61, /* invalid nwfilter object */ - VIR_ERR_NO_NWFILTER =3D 62, /* nw filter pool not found */ - VIR_ERR_BUILD_FIREWALL =3D 63, /* nw filter pool not found */ - VIR_WAR_NO_SECRET =3D 64, /* failed to start secret storag= e */ - VIR_ERR_INVALID_SECRET =3D 65, /* invalid secret */ - VIR_ERR_NO_SECRET =3D 66, /* secret not found */ + found (Since: v0.7.0) */ + VIR_WAR_NO_NWFILTER =3D 60, /* failed to start nwfilter driv= er (Since: v0.8.0) */ + VIR_ERR_INVALID_NWFILTER =3D 61, /* invalid nwfilter object (Sinc= e: v0.8.0) */ + VIR_ERR_NO_NWFILTER =3D 62, /* nw filter pool not found (Sin= ce: v0.8.0) */ + VIR_ERR_BUILD_FIREWALL =3D 63, /* nw filter pool not found (Sin= ce: v0.8.0) */ + VIR_WAR_NO_SECRET =3D 64, /* failed to start secret storag= e (Since: v0.7.1) */ + VIR_ERR_INVALID_SECRET =3D 65, /* invalid secret (Since: v0.7.1= ) */ + VIR_ERR_NO_SECRET =3D 66, /* secret not found (Since: v0.7= .1) */ VIR_ERR_CONFIG_UNSUPPORTED =3D 67, /* unsupported configuration - construct */ - VIR_ERR_OPERATION_TIMEOUT =3D 68, /* timeout occurred during opera= tion */ + construct (Since: v0.7.3) */ + VIR_ERR_OPERATION_TIMEOUT =3D 68, /* timeout occurred during opera= tion (Since: v0.7.3) */ VIR_ERR_MIGRATE_PERSIST_FAILED =3D 69,/* a migration worked, but makin= g the - VM persist on the dest host fai= led */ - VIR_ERR_HOOK_SCRIPT_FAILED =3D 70, /* a synchronous hook script fai= led */ - VIR_ERR_INVALID_DOMAIN_SNAPSHOT =3D 71,/* invalid domain snapshot */ - VIR_ERR_NO_DOMAIN_SNAPSHOT =3D 72, /* domain snapshot not found */ - VIR_ERR_INVALID_STREAM =3D 73, /* stream pointer not valid */ + VM persist on the dest host fai= led (Since: v0.7.3) */ + VIR_ERR_HOOK_SCRIPT_FAILED =3D 70, /* a synchronous hook script fai= led (Since: v0.8.0) */ + VIR_ERR_INVALID_DOMAIN_SNAPSHOT =3D 71,/* invalid domain snapshot (Sin= ce: v0.8.0) */ + VIR_ERR_NO_DOMAIN_SNAPSHOT =3D 72, /* domain snapshot not found (Si= nce: v0.8.0) */ + VIR_ERR_INVALID_STREAM =3D 73, /* stream pointer not valid (Sin= ce: v0.9.0) */ VIR_ERR_ARGUMENT_UNSUPPORTED =3D 74, /* valid API use but unsupported= by - the given driver */ - VIR_ERR_STORAGE_PROBE_FAILED =3D 75, /* storage pool probe failed */ - VIR_ERR_STORAGE_POOL_BUILT =3D 76, /* storage pool already built */ + the given driver (Since: v0.9.4= ) */ + VIR_ERR_STORAGE_PROBE_FAILED =3D 75, /* storage pool probe failed (Si= nce: v0.9.5) */ + VIR_ERR_STORAGE_POOL_BUILT =3D 76, /* storage pool already built (S= ince: v0.9.5) */ VIR_ERR_SNAPSHOT_REVERT_RISKY =3D 77, /* force was not requested for a - risky domain snapshot revert */ + risky domain snapshot revert (S= ince: v0.9.7) */ VIR_ERR_OPERATION_ABORTED =3D 78, /* operation on a domain was - canceled/aborted by user */ - VIR_ERR_AUTH_CANCELLED =3D 79, /* authentication cancelled */ - VIR_ERR_NO_DOMAIN_METADATA =3D 80, /* The metadata is not present */ - VIR_ERR_MIGRATE_UNSAFE =3D 81, /* Migration is not safe */ - VIR_ERR_OVERFLOW =3D 82, /* integer overflow */ - VIR_ERR_BLOCK_COPY_ACTIVE =3D 83, /* action prevented by block cop= y job */ + canceled/aborted by user (Since= : v0.9.9) */ + VIR_ERR_AUTH_CANCELLED =3D 79, /* authentication cancelled (Sin= ce: v0.9.10) */ + VIR_ERR_NO_DOMAIN_METADATA =3D 80, /* The metadata is not present (= Since: v0.9.10) */ + VIR_ERR_MIGRATE_UNSAFE =3D 81, /* Migration is not safe (Since:= v0.9.11) */ + VIR_ERR_OVERFLOW =3D 82, /* integer overflow (Since: v0.9= .11) */ + VIR_ERR_BLOCK_COPY_ACTIVE =3D 83, /* action prevented by block cop= y job (Since: v0.9.12) */ VIR_ERR_OPERATION_UNSUPPORTED =3D 84, /* The requested operation is not - supported */ - VIR_ERR_SSH =3D 85, /* error in ssh transport driver= */ + supported (Since: v0.10.0) */ + VIR_ERR_SSH =3D 85, /* error in ssh transport driver= (Since: v0.10.0) */ VIR_ERR_AGENT_UNRESPONSIVE =3D 86, /* guest agent is unresponsive, - not running or not usable */ - VIR_ERR_RESOURCE_BUSY =3D 87, /* resource is already in use */ + not running or not usable (Sinc= e: v0.10.0) */ + VIR_ERR_RESOURCE_BUSY =3D 87, /* resource is already in use (S= ince: v1.0.0) */ VIR_ERR_ACCESS_DENIED =3D 88, /* operation on the object/resou= rce - was denied */ - VIR_ERR_DBUS_SERVICE =3D 89, /* error from a dbus service */ - VIR_ERR_STORAGE_VOL_EXIST =3D 90, /* the storage vol already exist= s */ - VIR_ERR_CPU_INCOMPATIBLE =3D 91, /* given CPU is incompatible wit= h host CPU */ - VIR_ERR_XML_INVALID_SCHEMA =3D 92, /* XML document doesn't validate= against schema */ - VIR_ERR_MIGRATE_FINISH_OK =3D 93, /* Finish API succeeded but it i= s expected to return NULL */ - VIR_ERR_AUTH_UNAVAILABLE =3D 94, /* authentication unavailable */ - VIR_ERR_NO_SERVER =3D 95, /* Server was not found */ - VIR_ERR_NO_CLIENT =3D 96, /* Client was not found */ + was denied (Since: v1.1.0) */ + VIR_ERR_DBUS_SERVICE =3D 89, /* error from a dbus service (Si= nce: v1.1.1) */ + VIR_ERR_STORAGE_VOL_EXIST =3D 90, /* the storage vol already exist= s (Since: v1.1.4) */ + VIR_ERR_CPU_INCOMPATIBLE =3D 91, /* given CPU is incompatible wit= h host CPU (Since: v1.2.6) */ + VIR_ERR_XML_INVALID_SCHEMA =3D 92, /* XML document doesn't validate= against schema (Since: v1.2.12) */ + VIR_ERR_MIGRATE_FINISH_OK =3D 93, /* Finish API succeeded but it i= s expected to return NULL (Since: v1.2.18) */ + VIR_ERR_AUTH_UNAVAILABLE =3D 94, /* authentication unavailable (S= ince: v1.3.3) */ + VIR_ERR_NO_SERVER =3D 95, /* Server was not found (Since: = v1.3.3) */ + VIR_ERR_NO_CLIENT =3D 96, /* Client was not found (Since: = v1.3.5) */ VIR_ERR_AGENT_UNSYNCED =3D 97, /* guest agent replies with wron= g id - to guest-sync command (DEPRECAT= ED) */ - VIR_ERR_LIBSSH =3D 98, /* error in libssh transport dri= ver */ - VIR_ERR_DEVICE_MISSING =3D 99, /* fail to find the desired devi= ce */ - VIR_ERR_INVALID_NWFILTER_BINDING =3D 100, /* invalid nwfilter binding= */ - VIR_ERR_NO_NWFILTER_BINDING =3D 101, /* no nwfilter binding */ - VIR_ERR_INVALID_DOMAIN_CHECKPOINT =3D 102, /* invalid domain checkpoin= t */ - VIR_ERR_NO_DOMAIN_CHECKPOINT =3D 103, /* domain checkpoint not found */ - VIR_ERR_NO_DOMAIN_BACKUP =3D 104, /* domain backup job id not foun= d */ - VIR_ERR_INVALID_NETWORK_PORT =3D 105, /* invalid network port object */ - VIR_ERR_NETWORK_PORT_EXIST =3D 106, /* the network port already exis= t */ - VIR_ERR_NO_NETWORK_PORT =3D 107, /* network port not found */ - VIR_ERR_NO_HOSTNAME =3D 108, /* no domain's hostname found */ - VIR_ERR_CHECKPOINT_INCONSISTENT =3D 109, /* checkpoint can't be used */ - VIR_ERR_MULTIPLE_DOMAINS =3D 110, /* more than one matching domain= found */ + to guest-sync command (DEPRECAT= ED) (Since: v2.3.0) */ + VIR_ERR_LIBSSH =3D 98, /* error in libssh transport dri= ver (Since: v2.5.0) */ + VIR_ERR_DEVICE_MISSING =3D 99, /* fail to find the desired devi= ce (Since: v4.1.0) */ + VIR_ERR_INVALID_NWFILTER_BINDING =3D 100, /* invalid nwfilter binding= (Since: v4.5.0) */ + VIR_ERR_NO_NWFILTER_BINDING =3D 101, /* no nwfilter binding (Since: v= 4.5.0) */ + VIR_ERR_INVALID_DOMAIN_CHECKPOINT =3D 102, /* invalid domain checkpoin= t (Since: v5.2.0) */ + VIR_ERR_NO_DOMAIN_CHECKPOINT =3D 103, /* domain checkpoint not found (= Since: v5.2.0) */ + VIR_ERR_NO_DOMAIN_BACKUP =3D 104, /* domain backup job id not foun= d (Since: v5.2.0) */ + VIR_ERR_INVALID_NETWORK_PORT =3D 105, /* invalid network port object (= Since: v5.5.0) */ + VIR_ERR_NETWORK_PORT_EXIST =3D 106, /* the network port already exis= t (Since: v5.5.0) */ + VIR_ERR_NO_NETWORK_PORT =3D 107, /* network port not found (Since= : v5.5.0) */ + VIR_ERR_NO_HOSTNAME =3D 108, /* no domain's hostname found (S= ince: v6.1.0) */ + VIR_ERR_CHECKPOINT_INCONSISTENT =3D 109, /* checkpoint can't be used (= Since: v6.10.0) */ + VIR_ERR_MULTIPLE_DOMAINS =3D 110, /* more than one matching domain= found (Since: v7.1.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_ERR_NUMBER_LAST + VIR_ERR_NUMBER_LAST /* (Since: v5.0.0) */ # endif } virErrorNumber; =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481719; cv=none; d=zohomail.com; s=zohoarc; b=SALkopG/Fqcl+F58f23JQdvOxyxvV627fnErj28ObvMHFwoMcIAj8SeHkMNQXRYXyajiQD2Dk05HibXRrw0grl28C927sojXx3YtWrGlAvgX2OYZiiNs6qYjE5+QXy8Oe1/8/ycVl2lbTUnpc5Zn8nwCByIBDN1nTB2kEXnDatw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481719; 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=uzeShCJIgJNrZdYC+OTx/Y7cw+uDAvFRVV7aL8+wYec=; b=c1rwbOoiK7DYZT/0UosP5IxdaS24siDuqnZMxvRfVNowD7Ug8LLTASA49HI29HZf/m60Ufe49cnY4Qy1CRpMx3N+X3zQju7Ujpb8HDXzRdD4ZpPdkUvNUMK6rIdj3563DGcoSlOeJWbvQ6+S/WGlCNI4JfkNTXdN+R99xjYfNiA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481719212679.3879584244942; Wed, 20 Apr 2022 12:08:39 -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-271-jfIDDKimP8qaZdFq0fuF2A-1; Wed, 20 Apr 2022 15:08:33 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id C6002804194; Wed, 20 Apr 2022 19:08:30 +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 B1892551E85; Wed, 20 Apr 2022 19:08:30 +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 CB250194035D; Wed, 20 Apr 2022 19:08:29 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 03D49194035D for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:27 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id D4A89551E82; Wed, 20 Apr 2022 19:08:27 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3D183551E87 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481718; 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=uzeShCJIgJNrZdYC+OTx/Y7cw+uDAvFRVV7aL8+wYec=; b=VeZXCIK6B/sTx7VY4eUBrbCidZpzFMDuqxzGNzR4NsPlsbLylzZfH7fwvY9CUSDHrML1IH +Mnyz1Lxo8PjepghU2BMw7LZ/iqQ8oyH469hPtKnnw1hnwK6AlvPhjBgTK/KJ56bKbXi7L +Ia85mUl/+C9b3qi4pw29Mdtq62FltI= X-MC-Unique: jfIDDKimP8qaZdFq0fuF2A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 06/30] docstring: enums: qemu: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:55 +0200 Message-Id: <20220420190819.3093205-7-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481720392100001 Content-Type: text/plain; charset="utf-8" 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 | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index 98f2ac3823..a2569a9fbd 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -31,8 +31,8 @@ extern "C" { # endif =20 typedef enum { - VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT =3D 0, - VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP =3D (1 << 0), /* cmd is in HMP= */ + VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT =3D 0, /* (Since: v0.8.8) */ + VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP =3D (1 << 0), /* cmd is in HMP= (Since: v0.8.8) */ } virDomainQemuMonitorCommandFlags; =20 int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, @@ -51,11 +51,11 @@ virDomainPtr virDomainQemuAttach(virConnectPtr domain, unsigned int flags); =20 typedef enum { - VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN =3D VIR_DOMAIN_AGENT_RESPONSE_TIMEOU= T_BLOCK, - VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK =3D VIR_DOMAIN_AGENT_RESPONSE_TIME= OUT_BLOCK, - VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT =3D VIR_DOMAIN_AGENT_RESPONSE_TI= MEOUT_DEFAULT, - VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT =3D VIR_DOMAIN_AGENT_RESPONSE_TIM= EOUT_NOWAIT, - VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN =3D 60, + VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN =3D VIR_DOMAIN_AGENT_RESPONSE_TIMEOU= T_BLOCK, /* (Since: v0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK =3D VIR_DOMAIN_AGENT_RESPONSE_TIME= OUT_BLOCK, /* (Since: v0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT =3D VIR_DOMAIN_AGENT_RESPONSE_TI= MEOUT_DEFAULT, /* (Since: v0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT =3D VIR_DOMAIN_AGENT_RESPONSE_TIM= EOUT_NOWAIT, /* (Since: v0.10.0) */ + VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN =3D 60, /* (Since: v1.2.15) */ } virDomainQemuAgentCommandTimeoutValues; =20 char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd, @@ -85,10 +85,10 @@ typedef void (*virConnectDomainQemuMonitorEventCallback= )(virConnectPtr conn, =20 =20 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 =3D (1 << 0), =20 - /* Event filter is case insensitive */ + /* Event filter is case insensitive (Since: v1.2.3) */ VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE =3D (1 << 1), } virConnectDomainQemuMonitorEventRegisterFlags; =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481726; cv=none; d=zohomail.com; s=zohoarc; b=lvZPQAjk3ex7l9e5oKg3O1RxbOuF8qxG6Y8r7IDC28dr5u80862EEiQCYo6x3WSBRKP+xTAY8ayk+s0tyhmoQaDTeiAIajuQZmcUT9freIXH4WnYVDpSG//QzVaHrTNplhadavGACkSXknAo7tb/921FR88cRtWrxx06IGdvfJk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481726; 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=f/gHzSyhJhTjreClwL5BoFxnuNNF10H1g57C03Wg6RI=; b=JMEVeU8hR1Y4/s/TtpnD0xY7yH4yrj+3ysZlCaT2LWcA7HmZNJXOZgYm+2VjfzBJQcKpsEIL4Y3gvuW0bbykrzxy6d0R/yq7UKiHGn7Ii583mnCu/IiTAAmacCnJX4n0kOWBNa8S5bm2wSMMG2t0kM4W80IBqBp0n5mZV0Zo7BE= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481726954335.6020477382966; Wed, 20 Apr 2022 12:08:46 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-230-LpcRE7lgPkCfCm_kBZ9fyg-1; Wed, 20 Apr 2022 15:08:38 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B8BF63C0F0B9; Wed, 20 Apr 2022 19:08:34 +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 A48D6551E89; Wed, 20 Apr 2022 19:08:34 +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 0C9391940347; Wed, 20 Apr 2022 19:08:34 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 00CFF1949763 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:28 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C14CF551E82; Wed, 20 Apr 2022 19:08:28 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 43183551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481726; 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=f/gHzSyhJhTjreClwL5BoFxnuNNF10H1g57C03Wg6RI=; b=L3cHeNajem3zKSbJqeQ45Ib1HF21uh5U1hpmLS8j7JrqREYO5LIvHdT2zKDj8AeVTgvPEl 6etAAnvSuQGuzQep/Pr+vo2yFcj2isRaT8/q5/pnEtcIGJvS4yDedOqb2dgAGt+p9wBSTa v9jce6fw7YOX71FparkliPFEU4yz2R0= X-MC-Unique: LpcRE7lgPkCfCm_kBZ9fyg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 07/30] docstring: enums: admin: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:56 +0200 Message-Id: <20220420190819.3093205-8-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481728350100001 Content-Type: text/plain; charset="utf-8" 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-admin.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index e414f776e4..f65886f20d 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); =20 typedef enum { - VIR_CLIENT_TRANS_UNIX =3D 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 =3D 0, /* connection via UNIX socket (Since: v1.= 3.5) */ + VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (S= ince: v1.3.5) */ + VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Sin= ce: v1.3.5) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CLIENT_TRANS_LAST + VIR_CLIENT_TRANS_LAST /* (Since: v1.3.5) */ # endif } virClientTransport; =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481720; cv=none; d=zohomail.com; s=zohoarc; b=KgdmU4BQJOjnMsIVwprLnjBUlD0m5sqiyBlW3cxdnZI928m1GyFTo7oskQFr1LvIVrt+9Fs8xLGxW0asigzj9HPwkNU0JZcqKb7TibWtJxJ2Q1InbNwdU/kK79UcQeUTSDDOE5Bs3hbq6tJUKNnyV/QSHxPKXrz8Mge610MK3ac= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481720; 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=ZWlaK8B/gwgM0mKOjHuYjnlw3av0fTHyIky/kPJqLYU=; b=d+XHLyNeN84FhY21TKbrEBRfQ9wmzQHDEelPKaImPSI7Afcjpa24oBZGH//JK3llysrlklNQ3Qp3r7NY8hYbBwq8OSX57fvwp5kvGOv61LPqP7SMA0qJI4yL7DodrPpUpZHn3YtPZQnmB7gC5VgSES1hpKYKFGI6E8mnfJmBjs0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481720518500.2563910582214; Wed, 20 Apr 2022 12:08:40 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-633-UC5zRkLYMxe6hkp2DYWIFA-1; Wed, 20 Apr 2022 15:08:36 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id CAB3C3C0F090; Wed, 20 Apr 2022 19:08:32 +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 A451B40D016C; Wed, 20 Apr 2022 19:08:32 +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 7C1BF194035A; Wed, 20 Apr 2022 19:08:31 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 299471949763 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:30 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 06713551E88; Wed, 20 Apr 2022 19:08:30 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2F976551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481719; 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=ZWlaK8B/gwgM0mKOjHuYjnlw3av0fTHyIky/kPJqLYU=; b=QTRoZSlPu5zHz3kU7PtU7aXYe4sRKuj+4yjbGvfsmg7auG5daxnKfWdWpv56uM9Z9tALxu doAzOTTW9kQaW8DQVflLDiXjLAZ+Y6yMkf4RqN2YdRiNYXPdcto4KgMXEJOl/w/H9A4IWm heL64f1vXYTxfkIKEEZoRIGE9//ug28= X-MC-Unique: UC5zRkLYMxe6hkp2DYWIFA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 08/30] docstring: macros: libvirt: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:57 +0200 Message-Id: <20220420190819.3093205-9-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481722432100009 Content-Type: text/plain; charset="utf-8" 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@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- include/libvirt/libvirt-domain.h | 663 +++++++++++++++++++++++++++++- include/libvirt/libvirt-host.h | 123 ++++++ include/libvirt/libvirt-network.h | 24 ++ include/libvirt/libvirt-nodedev.h | 3 + include/libvirt/libvirt-secret.h | 3 + include/libvirt/libvirt-storage.h | 3 + 6 files changed, 810 insertions(+), 9 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index de2d14d4af..01ea2a750f 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -315,6 +315,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_CPU_SHARES "cpu_shares" =20 @@ -323,6 +326,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_GLOBAL_PERIOD "global_period" =20 @@ -331,6 +337,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA "global_quota" =20 @@ -339,6 +348,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD "vcpu_period" =20 @@ -347,6 +359,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA "vcpu_quota" =20 @@ -356,6 +371,9 @@ typedef enum { * Macro represents the enforcement period for a quota in microseconds, * when using the posix scheduler, for all emulator activity not tied to * vcpus, as a ullong. + * + * Since: v0.10.0 + * */ # define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD "emulator_period" =20 @@ -365,6 +383,9 @@ typedef enum { * Macro represents the maximum bandwidth to be used within a period for * all emulator activity not tied to vcpus, when using the posix scheduler, * as an llong. + * + * Since: v0.10.0 + * */ # define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA "emulator_quota" =20 @@ -373,6 +394,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD "iothread_period" =20 @@ -381,6 +405,9 @@ 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 + * */ # define VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA "iothread_quota" =20 @@ -389,6 +416,9 @@ typedef enum { * * Macro represents the relative weight, when using the credit * scheduler, as a uint. + * + * Since: v0.9.7 + * */ # define VIR_DOMAIN_SCHEDULER_WEIGHT "weight" =20 @@ -397,6 +427,9 @@ typedef enum { * * Macro represents the maximum scheduler cap, when using the credit * scheduler, as a uint. + * + * Since: v0.9.7 + * */ # define VIR_DOMAIN_SCHEDULER_CAP "cap" =20 @@ -405,6 +438,9 @@ typedef enum { * * Macro represents the scheduler reservation value, when using the * allocation scheduler, as an llong. + * + * Since: v0.9.7 + * */ # define VIR_DOMAIN_SCHEDULER_RESERVATION "reservation" =20 @@ -413,6 +449,9 @@ typedef enum { * * Macro represents the scheduler limit value, when using the * allocation scheduler, as an llong. + * + * Since: v0.9.7 + * */ # define VIR_DOMAIN_SCHEDULER_LIMIT "limit" =20 @@ -421,6 +460,9 @@ typedef enum { * * Macro represents the scheduler shares value, when using the * allocation scheduler, as an int. + * + * Since: v0.9.7 + * */ # define VIR_DOMAIN_SCHEDULER_SHARES "shares" =20 @@ -479,6 +521,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro providing the field length of parameter names when using * virDomainBlockStatsFlags(). + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH =20 @@ -487,6 +532,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total number of read bytes of the * block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_READ_BYTES "rd_bytes" =20 @@ -495,6 +543,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total read requests of the * block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_READ_REQ "rd_operations" =20 @@ -503,6 +554,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total time spend on cache reads in * nano-seconds of the block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES "rd_total_times" =20 @@ -511,6 +565,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total number of write bytes of the * block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES "wr_bytes" =20 @@ -519,6 +576,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total write requests of the * block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ "wr_operations" =20 @@ -527,6 +587,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total time spend on cache writes in * nano-seconds of the block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES "wr_total_times" =20 @@ -535,6 +598,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total flush requests of the * block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ "flush_operations" =20 @@ -543,6 +609,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * * Macro represents the total time spend on cache flushing in * nano-seconds of the block device, as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES "flush_total_times" =20 @@ -550,6 +619,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * VIR_DOMAIN_BLOCK_STATS_ERRS: * * In Xen this returns the mysterious 'oo_req', as an llong. + * + * Since: v0.9.5 + * */ # define VIR_DOMAIN_BLOCK_STATS_ERRS "errs" =20 @@ -977,6 +1049,9 @@ typedef enum { * required to transmit migration data. * * This field may not be used when VIR_MIGRATE_TUNNELLED flag is set. + * + * Since: v1.1.0 + * */ # define VIR_MIGRATE_PARAM_URI "migrate_uri" =20 @@ -987,6 +1062,9 @@ typedef enum { * destination host as VIR_TYPED_PARAM_STRING. Omitting this parameter kee= ps * 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 + * */ # define VIR_MIGRATE_PARAM_DEST_NAME "destination_name" =20 @@ -1006,6 +1084,9 @@ typedef enum { * Omitting this parameter keeps the original domain configuration. Using = this * field with hypervisors that do not support changing domain configuration * during migration will result in a failure. + * + * Since: v1.1.0 + * */ # define VIR_MIGRATE_PARAM_DEST_XML "destination_xml" =20 @@ -1021,6 +1102,9 @@ typedef enum { * Omitting this parameter keeps the original domain persistent configurat= ion. * Using this field with hypervisors that do not support changing domain * configuration during migration will result in a failure. + * + * Since: v1.3.4 + * */ # define VIR_MIGRATE_PARAM_PERSIST_XML "persistent_xml" =20 @@ -1031,6 +1115,9 @@ typedef enum { * be used for migration as VIR_TYPED_PARAM_ULLONG. If set to 0 or omitted, * 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 + * */ # define VIR_MIGRATE_PARAM_BANDWIDTH "bandwidth" =20 @@ -1040,6 +1127,9 @@ typedef enum { * virDomainMigrate* params field: the maximum bandwidth (in MiB/s) that w= ill * be used for post-copy phase of a migration as VIR_TYPED_PARAM_ULLONG. I= f set * to 0 or omitted, post-copy migration speed will not be limited. + * + * Since: v5.1.0 + * */ # define VIR_MIGRATE_PARAM_BANDWIDTH_POSTCOPY "bandwidth.postcopy" =20 @@ -1061,6 +1151,9 @@ typedef enum { * parameters are "tlsPort" and "tlsSubject". For example, * * spice://target.host.com:1234/?tlsPort=3D4567 + * + * Since: v1.1.0 + * */ # define VIR_MIGRATE_PARAM_GRAPHICS_URI "graphics_uri" =20 @@ -1072,6 +1165,9 @@ typedef enum { * addresses are accepted as well as hostnames (the resolving is done on * destination). Some hypervisors do not support this feature and will ret= urn * an error if this field is used. + * + * Since: v1.1.4 + * */ # define VIR_MIGRATE_PARAM_LISTEN_ADDRESS "listen_address" =20 @@ -1081,6 +1177,9 @@ typedef enum { * virDomainMigrate* params multiple field: The multiple values that list * 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 + * */ # define VIR_MIGRATE_PARAM_MIGRATE_DISKS "migrate_disks" =20 @@ -1091,6 +1190,9 @@ typedef enum { * for incoming disks migration. Type is VIR_TYPED_PARAM_INT. If set to 0 = or * omitted, libvirt will choose a suitable default. At the moment this is = only * supported by the QEMU driver. + * + * Since: v1.3.3 + * */ # define VIR_MIGRATE_PARAM_DISKS_PORT "disks_port" =20 @@ -1104,6 +1206,9 @@ typedef enum { * currently only supported by the QEMU driver. UNIX URI is only usable i= f the * 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 + * */ # define VIR_MIGRATE_PARAM_DISKS_URI "disks_uri" =20 @@ -1114,6 +1219,9 @@ typedef enum { * compress migration traffic. Supported compression methods: xbzrle, mt. * The parameter may be specified multiple times if more than one method * should be used. + * + * Since: v1.3.4 + * */ # define VIR_MIGRATE_PARAM_COMPRESSION "compression" =20 @@ -1123,6 +1231,9 @@ typedef enum { * virDomainMigrate* params field: the level of compression for multithread * 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 + * */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL "compression.mt.level" =20 @@ -1131,6 +1242,9 @@ typedef enum { * * virDomainMigrate* params field: the number of compression threads for * multithread compression as VIR_TYPED_PARAM_INT. + * + * Since: v1.3.4 + * */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS "compression.mt.threads" =20 @@ -1139,6 +1253,9 @@ typedef enum { * * virDomainMigrate* params field: the number of decompression threads for * multithread compression as VIR_TYPED_PARAM_INT. + * + * Since: v1.3.4 + * */ # define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS "compression.mt.dthread= s" =20 @@ -1147,6 +1264,9 @@ typedef enum { * * virDomainMigrate* params field: the size of page cache for xbzrle * compression as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.3.4 + * */ # define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE "compression.xbzrle.ca= che" =20 @@ -1156,6 +1276,9 @@ typedef enum { * virDomainMigrate* params field: the initial percentage guest CPUs are * throttled to when auto-convergence decides migration is not converging. * As VIR_TYPED_PARAM_INT. + * + * Since: v2.0.0 + * */ # define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL "auto_converge.initial" =20 @@ -1166,6 +1289,9 @@ typedef enum { * VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL whenever the hypervisor decides * the current rate is not enough to ensure convergence of the migration. * As VIR_TYPED_PARAM_INT. + * + * Since: v2.0.0 + * */ # define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT "auto_converge.increme= nt" =20 @@ -1174,6 +1300,9 @@ typedef enum { * * virDomainMigrate* params field: number of connections used during paral= lel * migration. As VIR_TYPED_PARAM_INT. + * + * Since: v5.2.0 + * */ # define VIR_MIGRATE_PARAM_PARALLEL_CONNECTIONS "parallel.connections" =20 @@ -1188,6 +1317,9 @@ typedef enum { * the destination hostname and the expected certificate's hostname is kno= wn, * this parameter can be used to pass this expected hostname when starting * the migration. + * + * Since: v6.0.0 + * */ # define VIR_MIGRATE_PARAM_TLS_DESTINATION "tls.destination" =20 @@ -1450,18 +1582,27 @@ int virDomainGetState (vi= rDomainPtr domain, * VIR_DOMAIN_CPU_STATS_CPUTIME: * cpu usage (sum of both vcpu and hypervisor usage) in nanoseconds, * as a ullong + * + * Since: v0.9.10 + * */ # define VIR_DOMAIN_CPU_STATS_CPUTIME "cpu_time" =20 /** * VIR_DOMAIN_CPU_STATS_USERTIME: * cpu time charged to user instructions in nanoseconds, as a ullong + * + * Since: v0.9.11 + * */ # define VIR_DOMAIN_CPU_STATS_USERTIME "user_time" =20 /** * VIR_DOMAIN_CPU_STATS_SYSTEMTIME: * cpu time charged to system instructions in nanoseconds, as a ullong + * + * Since: v0.9.11 + * */ # define VIR_DOMAIN_CPU_STATS_SYSTEMTIME "system_time" =20 @@ -1469,6 +1610,9 @@ int virDomainGetState (virD= omainPtr domain, * VIR_DOMAIN_CPU_STATS_VCPUTIME: * vcpu usage in nanoseconds (cpu_time excluding hypervisor time), * as a ullong + * + * Since: v0.9.13 + * */ # define VIR_DOMAIN_CPU_STATS_VCPUTIME "vcpu_time" =20 @@ -1497,6 +1641,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * * Macro for the Blkio tunable weight: it represents the io weight * the guest can use, as a uint. + * + * Since: v0.9.0 + * */ =20 # define VIR_DOMAIN_BLKIO_WEIGHT "weight" @@ -1507,6 +1654,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * Macro for the blkio tunable weight_device: it represents the * 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 + * */ =20 # define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT "device_weight" @@ -1518,6 +1668,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * the number of reading the block device per second, as a string. The * string is parsed as a series of /path/to/device, read_iops elements, * separated by ','. + * + * Since: v1.2.2 + * */ =20 # define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS "device_read_iops_sec" @@ -1530,6 +1683,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * the number of writing the block device per second, as a string. The * string is parsed as a series of /path/to/device, write_iops elements, * separated by ','. + * + * Since: v1.2.2 + * */ # define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS "device_write_iops_sec" =20 @@ -1541,6 +1697,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * the bytes of reading the block device per second, as a string. The * string is parsed as a series of /path/to/device, read_bps elements, * separated by ','. + * + * Since: v1.2.2 + * */ # define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS "device_read_bytes_sec" =20 @@ -1552,6 +1711,9 @@ char * virDomainGetSchedulerType(vir= DomainPtr domain, * the number of reading the block device per second, as a string. The * string is parsed as a series of /path/to/device, write_bps elements, * separated by ','. + * + * Since: v1.2.2 + * */ # define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS "device_write_bytes_sec" =20 @@ -1570,6 +1732,9 @@ int virDomainGetBlkioParameters(virDomainPtr doma= in, * VIR_DOMAIN_MEMORY_PARAM_UNLIMITED: * * Macro providing the virMemoryParameter value that indicates "unlimited" + * + * Since: v0.8.8 + * */ =20 # define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED 9007199254740991LL /* =3D INT64= _MAX >> 10 */ @@ -1579,6 +1744,9 @@ int virDomainGetBlkioParameters(virDomainPtr doma= in, * * Macro for the memory tunable hard_limit: it represents the maximum memo= ry * the guest can use, as a ullong. + * + * Since: v0.8.5 + * */ =20 # define VIR_DOMAIN_MEMORY_HARD_LIMIT "hard_limit" @@ -1588,6 +1756,9 @@ int virDomainGetBlkioParameters(virDomainPtr doma= in, * * Macro for the memory tunable soft_limit: it represents the memory upper * limit enforced during memory contention, as a ullong. + * + * Since: v0.8.5 + * */ =20 # define VIR_DOMAIN_MEMORY_SOFT_LIMIT "soft_limit" @@ -1597,6 +1768,9 @@ int virDomainGetBlkioParameters(virDomainPtr doma= in, * * 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 + * */ =20 # define VIR_DOMAIN_MEMORY_MIN_GUARANTEE "min_guarantee" @@ -1607,6 +1781,9 @@ int virDomainGetBlkioParameters(virDomainPtr doma= in, * Macro for the swap tunable swap_hard_limit: it represents the maximum s= wap * plus memory the guest can use, as a ullong. This limit has to be more t= han * VIR_DOMAIN_MEMORY_HARD_LIMIT. + * + * Since: v0.8.5 + * */ =20 # define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT "swap_hard_limit" @@ -1654,6 +1831,9 @@ typedef enum { * * Macro for typed parameter name that lists the numa nodeset of a * domain, as a string. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_NUMA_NODESET "numa_nodeset" =20 @@ -1662,6 +1842,9 @@ 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 + * */ # define VIR_DOMAIN_NUMA_MODE "numa_mode" =20 @@ -1784,6 +1967,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_IN_AVERAGE: * * Macro represents the inbound average of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE "inbound.average" =20 @@ -1791,6 +1977,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_IN_PEAK: * * Macro represents the inbound peak of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_IN_PEAK "inbound.peak" =20 @@ -1798,6 +1987,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_IN_BURST: * * Macro represents the inbound burst of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_IN_BURST "inbound.burst" =20 @@ -1805,6 +1997,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_IN_FLOOR: * * Macro represents the inbound floor of NIC bandwidth, as a uint. + * + * Since: v1.2.19 + * */ # define VIR_DOMAIN_BANDWIDTH_IN_FLOOR "inbound.floor" =20 @@ -1812,6 +2007,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE: * * Macro represents the outbound average of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE "outbound.average" =20 @@ -1819,6 +2017,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_OUT_PEAK: * * Macro represents the outbound peak of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_OUT_PEAK "outbound.peak" =20 @@ -1826,6 +2027,9 @@ int virDomainInterfaceStats (virD= omainPtr dom, * VIR_DOMAIN_BANDWIDTH_OUT_BURST: * * Macro represents the outbound burst of NIC bandwidth, as a uint. + * + * Since: v0.9.9 + * */ # define VIR_DOMAIN_BANDWIDTH_OUT_BURST "outbound.burst" =20 @@ -2131,6 +2335,9 @@ int virDomainDelIOThread(virDomainPt= r domain, * will cause more CPU time to be allocated the guest. A value set too * 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 + * */ # define VIR_DOMAIN_IOTHREAD_POLL_MAX_NS "poll_max_ns" =20 @@ -2141,6 +2348,9 @@ int virDomainDelIOThread(virDomainPt= r domain, * use to grow its polling interval up to the poll_max_ns value. A value * of 0 (zero) allows the hypervisor to choose its own value. The algorithm * to use for adjustment is hypervisor specific. + * + * Since: v4.10.0 + * */ # define VIR_DOMAIN_IOTHREAD_POLL_GROW "poll_grow" =20 @@ -2152,6 +2362,9 @@ int virDomainDelIOThread(virDomainPt= r domain, * the poll_max_ns value. A value of 0 (zero) allows the hypervisor to * choose its own value. The algorithm to use for adjustment is hypervisor * specific. + * + * Since: v4.10.0 + * */ # define VIR_DOMAIN_IOTHREAD_POLL_SHRINK "poll_shrink" =20 @@ -2169,6 +2382,9 @@ int virDomainSetIOThreadParams(virDo= mainPtr 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 + * */ =20 # define VIR_USE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] |=3D (1 << ((cpu) %= 8))) @@ -2180,6 +2396,9 @@ int virDomainSetIOThreadParams(virDo= mainPtr 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 + * */ =20 # define VIR_UNUSE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] &=3D ~(1 << ((cpu= ) % 8))) @@ -2191,6 +2410,9 @@ int virDomainSetIOThreadParams(virDo= mainPtr 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 + * */ =20 # define VIR_CPU_USED(cpumap, cpu) ((cpumap)[(cpu) / 8] & (1 << ((cpu) % 8= ))) @@ -2202,6 +2424,9 @@ int virDomainSetIOThreadParams(virDo= mainPtr domain, * This macro is to be used in conjunction with virDomainPinVcpu() API. * 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 + * */ =20 # define VIR_CPU_MAPLEN(cpu) (((cpu) + 7) / 8) @@ -2223,6 +2448,9 @@ int virDomainGetVcpus (virD= omainPtr domain, * This macro is to be used in conjunction with virDomainGetVcpus() API. * 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 + * */ =20 # define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu) \ @@ -2241,6 +2469,9 @@ int virDomainGetVcpus (virD= omainPtr domain, * virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extracts the cpumap of * the specified vcpu from cpumaps array and copies it into cpumap to be u= sed * later by virDomainPinVcpu() API. + * + * Since: v0.1.4 + * */ # define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap) \ memcpy(cpumap, VIR_GET_CPUMAP(cpumaps, maplen, vcpu), maplen) @@ -2255,6 +2486,9 @@ int virDomainGetVcpus (virD= omainPtr domain, * This macro is to be used in conjunction with virDomainGetVcpus() and * virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the * cpumap of the specified vcpu from cpumaps array. + * + * Since: v0.1.4 + * */ # define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (mapl= en)])) =20 @@ -2345,6 +2579,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * which can be used to measure the usage of cache (bytes) by * applications running on the platform. It corresponds to the * "perf.cmt" field in the *Stats APIs. + * + * Since: v1.3.3 + * */ # define VIR_PERF_PARAM_CMT "cmt" =20 @@ -2355,6 +2592,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * which can be used to monitor total system bandwidth (bytes/s) * from one level of cache to another. It corresponds to the * "perf.mbmt" field in the *Stats APIs. + * + * Since: v1.3.5 + * =20 */ # define VIR_PERF_PARAM_MBMT "mbmt" @@ -2366,6 +2606,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * which can be used to monitor the amount of data (bytes/s) sent * through the memory controller on the socket. It corresponds to * the "perf.mbml" field in the *Stats APIs. + * + * Since: v1.3.5 + * */ # define VIR_PERF_PARAM_MBML "mbml" =20 @@ -2376,6 +2619,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * event which can be used to measure the count of cache misses by * applications running on the platform. It corresponds to the * "perf.cache_misses" field in the *Stats APIs. + * + * Since: v2.3.0 + * */ # define VIR_PERF_PARAM_CACHE_MISSES "cache_misses" =20 @@ -2386,6 +2632,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of cache hits * by applications running on the platform. It corresponds to the * "perf.cache_references" field in the *Stats APIs. + * + * Since: v2.3.0 + * */ # define VIR_PERF_PARAM_CACHE_REFERENCES "cache_references" =20 @@ -2396,6 +2645,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * event which can be used to measure the count of instructions * by applications running on the platform. It corresponds to the * "perf.instructions" field in the *Stats APIs. + * + * Since: v2.3.0 + * */ # define VIR_PERF_PARAM_INSTRUCTIONS "instructions" =20 @@ -2406,6 +2658,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * describing the total/elapsed cpu cycles. This can be used to measure * how many cpu cycles one instruction needs. * It corresponds to the "perf.cpu_cycles" field in the *Stats APIs. + * + * Since: v2.3.0 + * */ # define VIR_PERF_PARAM_CPU_CYCLES "cpu_cycles" =20 @@ -2416,6 +2671,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of branch instructions * by applications running on the platform. It corresponds to the * "perf.branch_instructions" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS "branch_instructions" =20 @@ -2426,6 +2684,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of branch misses * by applications running on the platform. It corresponds to the * "perf.branch_misses" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_BRANCH_MISSES "branch_misses" =20 @@ -2436,6 +2697,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of bus cycles * by applications running on the platform. It corresponds to the * "perf.bus_cycles" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_BUS_CYCLES "bus_cycles" =20 @@ -2447,6 +2711,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * in the frontend of the instruction processor pipeline by applications * running on the platform. It corresponds to the * "perf.stalled_cycles_frontend" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND "stalled_cycles_frontend" =20 @@ -2458,6 +2725,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * in the backend of the instruction processor pipeline by application * running on the platform. It corresponds to the * "perf.stalled_cycles_backend" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND "stalled_cycles_backend" =20 @@ -2469,6 +2739,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * cycles not affected by CPU frequency scaling by applications * running on the platform. It corresponds to the * "perf.ref_cpu_cycles" field in the *Stats APIs. + * + * Since: v3.0.0 + * */ # define VIR_PERF_PARAM_REF_CPU_CYCLES "ref_cpu_cycles" =20 @@ -2480,6 +2753,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * clock time by applications running on the platform. It * corresponds to the "perf.cpu_clock" field in the *Stats * APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock" =20 @@ -2491,6 +2767,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * clock time by applications running on the platform. It * corresponds to the "perf.task_clock" field in the *Stats * APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_TASK_CLOCK "task_clock" =20 @@ -2501,6 +2780,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of page * faults by applications running on the platform. It corresponds * to the "perf.page_faults" field in the *Stats APIs. +* +* Since: v3.2.0 +* */ # define VIR_PERF_PARAM_PAGE_FAULTS "page_faults" =20 @@ -2511,6 +2793,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of context * switches by applications running on the platform. It corresponds * to the "perf.context_switches" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_CONTEXT_SWITCHES "context_switches" =20 @@ -2521,6 +2806,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of cpu * migrations by applications running on the platform. It corresponds * to the "perf.cpu_migrations" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_CPU_MIGRATIONS "cpu_migrations" =20 @@ -2531,6 +2819,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of minor page * faults by applications running on the platform. It corresponds * to the "perf.page_faults_min" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_PAGE_FAULTS_MIN "page_faults_min" =20 @@ -2541,6 +2832,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of major page * faults by applications running on the platform. It corresponds * to the "perf.page_faults_maj" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_PAGE_FAULTS_MAJ "page_faults_maj" =20 @@ -2551,6 +2845,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of alignment * faults by applications running on the platform. It corresponds * to the "perf.alignment_faults" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_ALIGNMENT_FAULTS "alignment_faults" =20 @@ -2561,6 +2858,9 @@ void virDomainStatsRecordListFree(virDomainStatsRecor= dPtr *stats); * perf event which can be used to measure the count of emulation * faults by applications running on the platform. It corresponds * to the "perf.emulation_faults" field in the *Stats APIs. + * + * Since: v3.2.0 + * */ # define VIR_PERF_PARAM_EMULATION_FAULTS "emulation_faults" =20 @@ -2752,6 +3052,9 @@ typedef enum { * allowing a subsequent change of bandwidth via * virDomainBlockJobSetSpeed(). The actual speed can be determined * with virDomainGetBlockJobInfo(). + * + * Since: v1.2.8 + * */ # define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH "bandwidth" =20 @@ -2763,6 +3066,9 @@ typedef enum { * restrict this to be a power of two or fall within a certain * range. Specifying 0 is the same as omitting this parameter, to * request the hypervisor default. + * + * Since: v1.2.8 + * */ # define VIR_DOMAIN_BLOCK_COPY_GRANULARITY "granularity" =20 @@ -2772,6 +3078,9 @@ typedef enum { * how much data in bytes can be in flight between source and destination, * as an unsigned long long. Specifying 0 is the same as omitting this * parameter, to request the hypervisor default. + * + * Since: v1.2.8 + * */ # define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE "buf-size" =20 @@ -2813,6 +3122,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC "total_bytes_sec" =20 @@ -2821,6 +3133,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC "read_bytes_sec" =20 @@ -2829,6 +3144,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC "write_bytes_sec" =20 @@ -2837,6 +3155,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC "total_iops_sec" =20 @@ -2845,6 +3166,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC "read_iops_sec" =20 @@ -2852,6 +3176,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC: * 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC "write_iops_sec" =20 @@ -2860,6 +3187,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * * Macro for the BlockIoTune tunable weight: it represents the maximum tot= al * bytes per second permitted through a block device, as a ullong. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX "total_bytes_sec_max" =20 @@ -2868,6 +3198,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX "read_bytes_sec_max" =20 @@ -2876,6 +3209,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * * Macro for the BlockIoTune tunable weight: it represents the maximum wri= te * bytes per second permitted through a block device, as a ullong. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX "write_bytes_sec_max" =20 @@ -2884,6 +3220,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX "total_iops_sec_max" =20 @@ -2892,6 +3231,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX "read_iops_sec_max" =20 @@ -2899,6 +3241,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX: * Macro for the BlockIoTune tunable weight: it represents the maximum wri= te * I/O operations per second permitted through a block device, as a ullong. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX "write_iops_sec_max" =20 @@ -2907,6 +3252,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH "total_bytes_s= ec_max_length" =20 @@ -2915,6 +3263,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH "read_bytes_sec= _max_length" =20 @@ -2923,6 +3274,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH "write_bytes_s= ec_max_length" =20 @@ -2931,6 +3285,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH "total_iops_sec= _max_length" =20 @@ -2939,6 +3296,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH "read_iops_sec_m= ax_length" =20 @@ -2947,6 +3307,9 @@ 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH "write_iops_sec= _max_length" =20 @@ -2954,6 +3317,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC: * 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 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC "size_iops_sec" =20 @@ -2961,6 +3327,9 @@ int virDomainBlockCommit(virDomainPtr dom, const char= *disk, const char *base, * VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME: * Macro for the BlockIoTune tunable weight: it represents a group name to * allow sharing of I/O throttling quota between multiple drives, as a str= ing. + * + * Since: v3.0.0 + * */ # define VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME "group_name" =20 @@ -3044,6 +3413,9 @@ typedef enum { * VIR_KEYCODE_SET_RFB: * * Compatibility alias for VIR_KEYCODE_SET_QNUM, which replaced it since 4= .2.0. + * + * Since: v0.9.5 + * */ # define VIR_KEYCODE_SET_RFB VIR_KEYCODE_SET_QNUM =20 @@ -3051,6 +3423,9 @@ typedef enum { * VIR_DOMAIN_SEND_KEY_MAX_KEYS: * * Maximum number of keycodes that can be sent in one virDomainSendKey() c= all. + * + * Since: v0.9.3 + * */ # define VIR_DOMAIN_SEND_KEY_MAX_KEYS 16 =20 @@ -3543,6 +3918,9 @@ typedef enum { * virDomainGetJobStats field: the operation which started the job as * VIR_TYPED_PARAM_INT. The values correspond to the items in * virDomainJobOperation enum. + * + * Since: v3.3.0 + * */ # define VIR_DOMAIN_JOB_OPERATION "operation" =20 @@ -3553,6 +3931,9 @@ typedef enum { * job, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to timeElapsed field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_TIME_ELAPSED "time_elapsed" =20 @@ -3563,6 +3944,9 @@ typedef enum { * migration job NOT including the time required to transfer control * flow from the source host to the destination host, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.15 + * */ # define VIR_DOMAIN_JOB_TIME_ELAPSED_NET "time_elapsed_net" =20 @@ -3573,6 +3957,9 @@ typedef enum { * jobs, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to timeRemaining field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_TIME_REMAINING "time_remaining" =20 @@ -3583,6 +3970,9 @@ typedef enum { * during migration, as VIR_TYPED_PARAM_ULLONG. The real computed downtime * between the time guest CPUs were paused and the time they were resumed * is reported for completed migration. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DOWNTIME "downtime" =20 @@ -3592,6 +3982,9 @@ typedef enum { * virDomainGetJobStats field: real measured downtime (ms) NOT including * the time required to transfer control flow from the source host to the * destination host, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.15 + * */ # define VIR_DOMAIN_JOB_DOWNTIME_NET "downtime_net" =20 @@ -3601,6 +3994,9 @@ typedef enum { * virDomainGetJobStats field: total time in milliseconds spent preparing * the migration in the 'setup' phase before the iterations begin, as * VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_JOB_SETUP_TIME "setup_time" =20 @@ -3616,6 +4012,9 @@ typedef enum { * VIR_DOMAIN_JOB_DATA_PROCESSED + VIR_DOMAIN_JOB_DATA_REMAINING. * * This field corresponds to dataTotal field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DATA_TOTAL "data_total" =20 @@ -3626,6 +4025,9 @@ typedef enum { * beginning of the job, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to dataProcessed field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DATA_PROCESSED "data_processed" =20 @@ -3636,6 +4038,9 @@ typedef enum { * transferred, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to dataRemaining field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DATA_REMAINING "data_remaining" =20 @@ -3646,6 +4051,9 @@ typedef enum { * tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to memTotal field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_TOTAL "memory_total" =20 @@ -3656,6 +4064,9 @@ typedef enum { * tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to memProcessed field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_PROCESSED "memory_processed" =20 @@ -3666,6 +4077,9 @@ typedef enum { * tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to memRemaining field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_REMAINING "memory_remaining" =20 @@ -3678,6 +4092,9 @@ typedef enum { * * The most common example of such pages are zero pages, i.e., pages filled * with zero bytes. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_CONSTANT "memory_constant" =20 @@ -3688,6 +4105,9 @@ typedef enum { * any kind of compression (i.e., pages which were not filled with a const= ant * byte and which could not be compressed) transferred since the beginning * of the migration job, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_NORMAL "memory_normal" =20 @@ -3698,6 +4118,9 @@ typedef enum { * as VIR_TYPED_PARAM_ULLONG. * * See VIR_DOMAIN_JOB_MEMORY_NORMAL for more details. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES "memory_normal_bytes" =20 @@ -3706,6 +4129,9 @@ typedef enum { * * virDomainGetJobStats field: network throughput used while migrating * memory in Bytes per second, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_JOB_MEMORY_BPS "memory_bps" =20 @@ -3714,6 +4140,9 @@ typedef enum { * virDomainGetJobStats field: number of memory pages dirtied by the guest * per second, as VIR_TYPED_PARAM_ULLONG. This statistics makes sense only * when live migration is running. + * + * Since: v1.3.1 + * */ # define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE "memory_dirty_rate" =20 @@ -3725,6 +4154,9 @@ typedef enum { * convert other page based statistics, such as * VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE or VIR_DOMAIN_JOB_COMPRESSION_PAGES * to bytes. + * + * Since: v3.9.0 + * */ # define VIR_DOMAIN_JOB_MEMORY_PAGE_SIZE "memory_page_size" =20 @@ -3736,6 +4168,9 @@ typedef enum { * when memory starts to be transferred and the value is increased by one * every time a new iteration is started to transfer memory pages dirtied * since the last iteration. + * + * Since: v1.3.1 + * */ # define VIR_DOMAIN_JOB_MEMORY_ITERATION "memory_iteration" =20 @@ -3746,6 +4181,9 @@ typedef enum { * destination host during post-copy migration, as VIR_TYPED_PARAM_ULLONG. * 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 + * */ # define VIR_DOMAIN_JOB_MEMORY_POSTCOPY_REQS "memory_postcopy_requests" =20 @@ -3756,6 +4194,9 @@ typedef enum { * tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to fileTotal field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DISK_TOTAL "disk_total" =20 @@ -3766,6 +4207,9 @@ typedef enum { * tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to fileProcessed field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DISK_PROCESSED "disk_processed" =20 @@ -3776,6 +4220,9 @@ typedef enum { * tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. * * This field corresponds to fileRemaining field in virDomainJobInfo. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_DISK_REMAINING "disk_remaining" =20 @@ -3784,6 +4231,9 @@ typedef enum { * * virDomainGetJobStats field: network throughput used while migrating * disks in Bytes per second, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_JOB_DISK_BPS "disk_bps" =20 @@ -3793,6 +4243,9 @@ typedef enum { * virDomainGetJobStats field: size of the cache (in bytes) used for * compressing repeatedly transferred memory pages during live migration, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_COMPRESSION_CACHE "compression_cache" =20 @@ -3801,6 +4254,9 @@ typedef enum { * * virDomainGetJobStats field: number of compressed bytes transferred * since the beginning of migration, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_COMPRESSION_BYTES "compression_bytes" =20 @@ -3809,6 +4265,9 @@ typedef enum { * * virDomainGetJobStats field: number of compressed pages transferred * since the beginning of migration, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_COMPRESSION_PAGES "compression_pages" =20 @@ -3818,6 +4277,9 @@ typedef enum { * virDomainGetJobStats field: number of repeatedly changing pages that * were not found in compression cache and thus could not be compressed, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES "compression_cache_misses" =20 @@ -3828,6 +4290,9 @@ typedef enum { * were found in compression cache but were sent uncompressed because * the result of compression was larger than the original page as a whole, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.0.3 + * */ # define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW "compression_overflow" =20 @@ -3837,6 +4302,9 @@ typedef enum { * virDomainGetJobStats field: current percentage guest CPUs are throttled * to when auto-convergence decided migration was not converging, as * VIR_TYPED_PARAM_INT. + * + * Since: v2.0.0 + * */ # define VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE "auto_converge_throttle" =20 @@ -3845,6 +4313,9 @@ 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 + * */ # define VIR_DOMAIN_JOB_SUCCESS "success" =20 @@ -3853,6 +4324,9 @@ typedef enum { * * virDomainGetJobStats field: Present only in statistics for a completed = job. * Optional error message for a failed job. + * + * Since: v6.3.0 + * */ # define VIR_DOMAIN_JOB_ERRMSG "errmsg" =20 @@ -3861,6 +4335,9 @@ typedef enum { * VIR_DOMAIN_JOB_DISK_TEMP_USED: * virDomainGetJobStats field: current usage of temporary disk space for t= he * job in bytes as VIR_TYPED_PARAM_ULLONG. + * + * Since: v6.0.0 + * */ # define VIR_DOMAIN_JOB_DISK_TEMP_USED "disk_temp_used" =20 @@ -3868,6 +4345,9 @@ typedef enum { * VIR_DOMAIN_JOB_DISK_TEMP_TOTAL: * virDomainGetJobStats field: possible total temporary disk space for the * job in bytes as VIR_TYPED_PARAM_ULLONG. + * + * Since: v6.0.0 + * */ # define VIR_DOMAIN_JOB_DISK_TEMP_TOTAL "disk_temp_total" =20 @@ -4429,6 +4909,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents formatted pinning for one vcpu specified by id which is * appended to the parameter name, for example "cputune.vcpupin1", * as VIR_TYPED_PARAM_STRING. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN "cputune.vcpupin%u" =20 @@ -4437,6 +4920,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents formatted pinning for emulator process, * as VIR_TYPED_PARAM_STRING. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN "cputune.emulatorpin" =20 @@ -4446,6 +4932,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents formatted pinning for one IOThread specified by id whi= ch is * appended to the parameter name, for example "cputune.iothreadpin1", * as VIR_TYPED_PARAM_STRING. + * + * Since: v1.2.14 + * */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN "cputune.iothreadpin%u" =20 @@ -4454,6 +4943,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(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 + * */ # define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES "cputune.cpu_shares" =20 @@ -4462,6 +4954,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the enforcement period for a quota, in microseconds, * for whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_UL= LONG. + * + * Since: v1.3.3 + * */ # define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_PERIOD "cputune.global_period" =20 @@ -4470,6 +4965,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(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 + * */ # define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA "cputune.global_quota" =20 @@ -4478,6 +4976,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the enforcement period for a quota, in microseconds, * for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLO= NG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD "cputune.vcpu_period" =20 @@ -4486,6 +4987,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(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 + * */ # define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA "cputune.vcpu_quota" =20 @@ -4495,6 +4999,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the enforcement period for a quota in microseconds, * when using the posix scheduler, for all emulator activity not tied to * vcpus, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD "cputune.emulator_period" =20 @@ -4504,6 +5011,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the maximum bandwidth to be used within a period for * all emulator activity not tied to vcpus, when using the posix scheduler, * as an VIR_TYPED_PARAM_LLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA "cputune.emulator_quota" =20 @@ -4512,6 +5022,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the enforcement period for a quota, in microseconds, f= or * iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLO= NG. + * + * Since: v2.2.0 + * */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD "cputune.iothread_period" =20 @@ -4520,6 +5033,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(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_LLON= G. + * + * Since: v2.2.0 + * */ # define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA "cputune.iothread_quota" =20 @@ -4528,6 +5044,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the name of guest disk for which the values are update= d, * as VIR_TYPED_PARAM_STRING. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_DISK "blkdeviotune.disk" =20 @@ -4536,6 +5055,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the total throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC "blkdeviotune.total_byt= es_sec" =20 @@ -4544,6 +5066,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the read throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC "blkdeviotune.read_bytes= _sec" =20 @@ -4552,6 +5077,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the write throughput limit in bytes per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC "blkdeviotune.write_byt= es_sec" =20 @@ -4560,6 +5088,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the total I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC "blkdeviotune.total_iops= _sec" =20 @@ -4568,6 +5099,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the read I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC "blkdeviotune.read_iops_s= ec" =20 @@ -4576,6 +5110,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the write I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.9 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC "blkdeviotune.write_iops= _sec" =20 @@ -4584,6 +5121,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the total throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX "blkdeviotune.total= _bytes_sec_max" =20 @@ -4592,6 +5132,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the read throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX "blkdeviotune.read_b= ytes_sec_max" =20 @@ -4600,6 +5143,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the write throughput limit during bursts in * maximum bytes per second, as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX "blkdeviotune.write= _bytes_sec_max" =20 @@ -4608,6 +5154,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the total maximum I/O operations per second during bur= sts, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX "blkdeviotune.total_= iops_sec_max" =20 @@ -4616,6 +5165,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the read maximum I/O operations per second during burs= ts, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX "blkdeviotune.read_io= ps_sec_max" =20 @@ -4624,6 +5176,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the write maximum I/O operations per second during bur= sts, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX "blkdeviotune.write_= iops_sec_max" =20 @@ -4632,6 +5187,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the size maximum I/O operations per second, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v1.2.11 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC "blkdeviotune.size_iops_s= ec" =20 @@ -4640,6 +5198,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * * Macro represents the group name to be used, * as VIR_TYPED_PARAM_STRING. + * + * Since: v3.0.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_GROUP_NAME "blkdeviotune.group_name" =20 @@ -4649,6 +5210,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.total_bytes_sec_max, * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH "blkdeviotun= e.total_bytes_sec_max_length" =20 @@ -4658,6 +5222,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.read_bytes_sec_max * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH "blkdeviotune= .read_bytes_sec_max_length" =20 @@ -4667,6 +5234,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.write_bytes_sec_max * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH "blkdeviotun= e.write_bytes_sec_max_length" =20 @@ -4676,6 +5246,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.total_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH "blkdeviotune= .total_iops_sec_max_length" =20 @@ -4685,6 +5258,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.read_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH "blkdeviotune.= read_iops_sec_max_length" =20 @@ -4694,6 +5270,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(virConnectPtr conn, * Macro represents the length in seconds allowed for a burst period * for the blkdeviotune.write_iops_sec_max * as VIR_TYPED_PARAM_ULLONG. + * + * Since: v2.4.0 + * */ # define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH "blkdeviotune= .write_iops_sec_max_length" =20 @@ -4846,6 +5425,9 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeC= hangeCallback)(virConnectPt * * Used to cast the event specific callback into the generic one * for use for virConnectDomainEventRegisterAny() + * + * Since: v0.8.0 + * */ # define VIR_DOMAIN_EVENT_CALLBACK(cb) ((virConnectDomainEventGenericCallb= ack)(cb)) =20 @@ -5033,18 +5615,31 @@ typedef enum { * * Macro providing the field length of virSchedParameter. Provided * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the - * preferred value since 0.9.2. + * preferred value + * + * Since: v0.2.3 + * */ # define VIR_DOMAIN_SCHED_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH =20 +/** + * _virSchedParameter: + * + * Since: v0.2.3 + * + */ +# define _virSchedParameter _virTypedParameter + /** * virSchedParameter: * * a virSchedParameter is the set of scheduler parameters. * Provided for backwards compatibility; virTypedParameter is the - * preferred alias since 0.9.2. + * preferred alias. + * + * Since: v0.9.2 + * */ -# define _virSchedParameter _virTypedParameter typedef struct _virTypedParameter virSchedParameter; =20 /** @@ -5077,18 +5672,31 @@ typedef enum { * * Macro providing the field length of virBlkioParameter. Provided * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the - * preferred value since 0.9.2. + * preferred value. + * + * Since: v0.9.0 + * */ # define VIR_DOMAIN_BLKIO_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH =20 +/** + * _virBlkioParameter: + * + * Since: v0.9.0 + * + */ +# define _virBlkioParameter _virTypedParameter + /** * virBlkioParameter: * * a virBlkioParameter is the set of blkio parameters. * Provided for backwards compatibility; virTypedParameter is the - * preferred alias since 0.9.2. + * preferred alias. + * + * Since: v0.9.2 + * */ -# define _virBlkioParameter _virTypedParameter typedef struct _virTypedParameter virBlkioParameter; =20 /** @@ -5121,18 +5729,31 @@ typedef enum { * * Macro providing the field length of virMemoryParameter. Provided * for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the - * preferred value since 0.9.2. + * preferred value. + * + * Since: v0.8.5 + * */ # define VIR_DOMAIN_MEMORY_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH =20 +/** + * _virMemoryParameter: + * + * Since: v0.8.5 + * + */ +# define _virMemoryParameter _virTypedParameter + /** * virMemoryParameter: * * a virMemoryParameter is the set of scheduler parameters. * Provided for backwards compatibility; virTypedParameter is the - * preferred alias since 0.9.2. + * preferred alias. + * + * Since: v0.9.2 + * */ -# define _virMemoryParameter _virTypedParameter typedef struct _virTypedParameter virMemoryParameter; =20 /** @@ -5248,6 +5869,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Macro represents the launch measurement of the SEV guest, * as VIR_TYPED_PARAM_STRING. + * + * Since: v4.5.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_MEASUREMENT "sev-measurement" =20 @@ -5257,6 +5881,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Macro represents the API major version of the SEV host, * as VIR_TYPED_PARAM_UINT. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MAJOR "sev-api-major" =20 @@ -5265,6 +5892,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Macro represents the API minor version of the SEV guest, * as VIR_TYPED_PARAM_UINT. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MINOR "sev-api-minor" =20 @@ -5273,6 +5903,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Macro represents the build ID of the SEV host, * as VIR_TYPED_PARAM_UINT. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_BUILD_ID "sev-build-id" =20 @@ -5281,6 +5914,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * * Macro represents the policy of the SEV guest, * as VIR_TYPED_PARAM_UINT. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_POLICY "sev-policy" =20 @@ -5292,6 +5928,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * the SEV firmware to recover the plain text of the launch secret. See * section "6.6 LAUNCH_SECRET" in the SEV API specification for a detailed * description of the secret header. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_HEADER "sev-secret-header" =20 @@ -5302,6 +5941,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * base64-encoded VIR_TYPED_PARAM_STRING containing an encrypted launch * secret. The secret is created by the domain owner after the SEV launch * measurement is retrieved and verified. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET "sev-secret" =20 @@ -5311,6 +5953,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * A macro used to represent the physical address within the guest's memory * where the secret will be set, as VIR_TYPED_PARAM_ULLONG. If not specifi= ed, * the address will be determined by the hypervisor. + * + * Since: v8.0.0 + * */ # define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_SET_ADDRESS "sev-secret-set= -address" =20 diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 15e4e7ea72..de08dcc118 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -80,6 +80,9 @@ 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 + * */ # define VIR_SECURITY_LABEL_BUFLEN (4096 + 1) =20 @@ -108,6 +111,9 @@ typedef virSecurityLabel *virSecurityLabelPtr; * VIR_SECURITY_MODEL_BUFLEN: * * Macro providing the maximum length of the virSecurityModel model string. + * + * Since: v0.6.1 + * */ # define VIR_SECURITY_MODEL_BUFLEN (256 + 1) =20 @@ -115,6 +121,9 @@ typedef virSecurityLabel *virSecurityLabelPtr; * VIR_SECURITY_DOI_BUFLEN: * * Macro providing the maximum length of the virSecurityModel doi string. + * + * Since: v0.6.1 + * */ # define VIR_SECURITY_DOI_BUFLEN (256 + 1) =20 @@ -176,6 +185,9 @@ struct _virNodeInfo { * VIR_NODE_CPU_STATS_FIELD_LENGTH: * * Macro providing the field length of virNodeCPUStats + * + * Since: v0.9.3 + * */ # define VIR_NODE_CPU_STATS_FIELD_LENGTH 80 =20 @@ -193,6 +205,9 @@ 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 + * */ # define VIR_NODE_CPU_STATS_KERNEL "kernel" =20 @@ -201,6 +216,9 @@ typedef enum { * * The cumulative CPU time which was spent by user processes, * since the node booting up (in nanoseconds). + * + * Since: v0.9.3 + * */ # define VIR_NODE_CPU_STATS_USER "user" =20 @@ -209,6 +227,9 @@ typedef enum { * * The cumulative idle CPU time, * since the node booting up (in nanoseconds). + * + * Since: v0.9.3 + * */ # define VIR_NODE_CPU_STATS_IDLE "idle" =20 @@ -217,6 +238,9 @@ typedef enum { * * The cumulative I/O wait CPU time, * since the node booting up (in nanoseconds). + * + * Since: v0.9.3 + * */ # define VIR_NODE_CPU_STATS_IOWAIT "iowait" =20 @@ -225,6 +249,9 @@ typedef enum { * * The cumulative interrupt CPU time, * since the node booting up (in nanoseconds). + * + * Since: v1.2.2 + * */ # define VIR_NODE_CPU_STATS_INTR "intr" =20 @@ -234,6 +261,9 @@ typedef enum { * The CPU utilization of a node. * The usage value is in percent and 100% represents all CPUs of * the node. + * + * Since: v0.9.3 + * */ # define VIR_NODE_CPU_STATS_UTILIZATION "utilization" =20 @@ -254,6 +284,9 @@ struct _virNodeCPUStats { * VIR_NODE_MEMORY_STATS_FIELD_LENGTH: * * Macro providing the field length of virNodeMemoryStats + * + * Since: v0.9.3 + * */ # define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80 =20 @@ -271,6 +304,9 @@ typedef enum { * * Macro for the total memory of specified cell: * it represents the maximum memory. + * + * Since: v0.9.3 + * */ # define VIR_NODE_MEMORY_STATS_TOTAL "total" =20 @@ -280,6 +316,9 @@ typedef enum { * Macro for the free memory of specified cell: * On Linux, it includes buffer and cached memory, in case of * VIR_NODE_MEMORY_STATS_ALL_CELLS. + * + * Since: v0.9.3 + * */ # define VIR_NODE_MEMORY_STATS_FREE "free" =20 @@ -288,6 +327,9 @@ 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 + * */ # define VIR_NODE_MEMORY_STATS_BUFFERS "buffers" =20 @@ -296,6 +338,9 @@ 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 + * */ # define VIR_NODE_MEMORY_STATS_CACHED "cached" =20 @@ -317,6 +362,9 @@ 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 + * */ # define VIR_NODE_MEMORY_SHARED_PAGES_TO_SCAN "shm_pages_to_scan" =20 @@ -325,6 +373,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many milliseconds * the shared memory service should sleep before next scan. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_SLEEP_MILLISECS "shm_sleep_millisecs" =20 @@ -333,6 +384,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many the shared * memory pages are being used. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_PAGES_SHARED "shm_pages_shared" =20 @@ -341,6 +395,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many sites are * sharing the pages i.e. how much saved. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_PAGES_SHARING "shm_pages_sharing" =20 @@ -349,6 +406,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many pages unique * but repeatedly checked for merging. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_PAGES_UNSHARED "shm_pages_unshared" =20 @@ -357,6 +417,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many pages changing * too fast to be placed in a tree. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_PAGES_VOLATILE "shm_pages_volatile" =20 @@ -365,6 +428,9 @@ struct _virNodeMemoryStats { * * Macro for typed parameter that represents how many times all * mergeable areas have been scanned. + * + * Since: v0.10.2 + * */ # define VIR_NODE_MEMORY_SHARED_FULL_SCANS "shm_full_scans" =20 @@ -377,6 +443,9 @@ struct _virNodeMemoryStats { * memory area of same NUMA node are merged; When its value is 1, * pages from all nodes can be merged. Other values are reserved * for future use. + * + * Since: v1.0.0 + * */ # define VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES "shm_merge_across_nodes" =20 @@ -406,6 +475,9 @@ 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 + * */ =20 =20 @@ -445,6 +517,9 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * VIR_NODE_SEV_PDH: * * Macro represents the Platform Diffie-Hellman key, as VIR_TYPED_PARAMS_S= TRING. + * + * Since: v4.5.0 + * */ # define VIR_NODE_SEV_PDH "pdh" =20 @@ -454,6 +529,9 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * Macro represents the platform certificate chain that includes the platf= orm * endorsement key (PEK), owner certificate authority (OCD) and chip * endorsement key (CEK), as VIR_TYPED_PARAMS_STRING. + * + * Since: v4.5.0 + * */ # define VIR_NODE_SEV_CERT_CHAIN "cert-chain" =20 @@ -461,6 +539,9 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr; * VIR_NODE_SEV_CBITPOS: * * Macro represents the CBit Position used by hypervisor when SEV is enabl= ed. + * + * Since: v4.5.0 + * */ # define VIR_NODE_SEV_CBITPOS "cbitpos" =20 @@ -469,6 +550,9 @@ 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 + * */ # define VIR_NODE_SEV_REDUCED_PHYS_BITS "reduced-phys-bits" =20 @@ -477,6 +561,9 @@ 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 + * */ # define VIR_NODE_SEV_MAX_GUESTS "max-guests" =20 @@ -485,6 +572,9 @@ 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 + * */ # define VIR_NODE_SEV_MAX_ES_GUESTS "max-es-guests" =20 @@ -582,6 +672,9 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefau= lt; * * This macro provides the length of the buffer required * for virDomainGetUUID() + * + * Since: v0.2.0 + * */ =20 # define VIR_UUID_BUFLEN (16) @@ -591,6 +684,9 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefau= lt; * * This macro provides the length of the buffer required * for virDomainGetUUIDString() + * + * Since: v0.2.0 + * */ =20 # define VIR_UUID_STRING_BUFLEN (36+1) @@ -617,6 +713,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_USER_NAME: * * The operating system user name as VIR_TYPED_PARAM_STRING. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_USER_NAME "user-name" =20 @@ -624,6 +723,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_UNIX_USER_ID: * * The UNIX user ID as VIR_TYPED_PARAM_ULLONG. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_UNIX_USER_ID "unix-user-id" =20 @@ -631,6 +733,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_GROUP_NAME: * * The operating system group name as VIR_TYPED_PARAM_STRING. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_GROUP_NAME "group-name" =20 @@ -638,6 +743,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_UNIX_GROUP_ID: * * The UNIX group ID as VIR_TYPED_PARAM_ULLONG. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_UNIX_GROUP_ID "unix-group-id" =20 @@ -645,6 +753,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_PROCESS_ID: * * The operating system process ID as VIR_TYPED_PARAM_LLONG. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_PROCESS_ID "process-id" =20 @@ -656,6 +767,9 @@ int virConnectClose (virCon= nectPtr conn); * The units the time is measured in vary according to the * host operating system. On Linux this is usually clock * ticks (as reported in /proc/$PID/stat field 22). + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_PROCESS_TIME "process-time" =20 @@ -663,6 +777,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_SASL_USER_NAME: * * The SASL authenticated username as VIR_TYPED_PARAM_STRING + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_SASL_USER_NAME "sasl-user-name" =20 @@ -670,6 +787,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_X509_DISTINGUISHED_NAME: * * The TLS x509 certificate distinguished named as VIR_TYPED_PARAM_STRING + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_X509_DISTINGUISHED_NAME "x509-distinguished-= name" =20 @@ -677,6 +797,9 @@ int virConnectClose (virCon= nectPtr conn); * VIR_CONNECT_IDENTITY_SELINUX_CONTEXT: * * The application's SELinux context as VIR_TYPED_PARAM_STRING. + * + * Since: v5.8.0 + * */ # define VIR_CONNECT_IDENTITY_SELINUX_CONTEXT "selinux-context" =20 diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-ne= twork.h index ad02e4d5f4..161c61de28 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -283,6 +283,9 @@ typedef void (*virConnectNetworkEventLifecycleCallback)= (virConnectPtr conn, * * Used to cast the event specific callback into the generic one * for use for virConnectNetworkEventRegisterAny() + * + * Since: v1.2.1 + * */ # define VIR_NETWORK_EVENT_CALLBACK(cb) ((virConnectNetworkEventGenericCal= lback)(cb)) =20 @@ -404,6 +407,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE: * * Macro represents the inbound average of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE "inbound.average" =20 @@ -411,6 +417,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK: * * Macro represents the inbound peak of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK "inbound.peak" =20 @@ -418,6 +427,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_IN_BURST: * * Macro represents the inbound burst of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_BURST "inbound.burst" =20 @@ -425,6 +437,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR: * * Macro represents the inbound floor of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR "inbound.floor" =20 @@ -432,6 +447,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE: * * Macro represents the outbound average of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE "outbound.average" =20 @@ -439,6 +457,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK: * * Macro represents the outbound peak of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK "outbound.peak" =20 @@ -446,6 +467,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST: * * Macro represents the outbound burst of NIC bandwidth, as a uint. + * + * Since: v5.5.0 + * */ # define VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST "outbound.burst" =20 diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 4e68d09814..8fdded2f34 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -156,6 +156,9 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * * Used to cast the event specific callback into the generic one * for use for virConnectNodeDeviceEventRegisterAny() + * + * Since: v2.2.0 + * */ # define VIR_NODE_DEVICE_EVENT_CALLBACK(cb)((virConnectNodeDeviceEventGene= ricCallback)(cb)) =20 diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-sec= ret.h index 94722a46af..cee27155a3 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -122,6 +122,9 @@ int virSecretFree (virSec= retPtr secret); * * Used to cast the event specific callback into the generic one * for use for virConnectSecretEventRegisterAny() + * + * Since: v3.0.0 + * */ # define VIR_SECRET_EVENT_CALLBACK(cb)((virConnectSecretEventGenericCallba= ck)(cb)) =20 diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 9ffcdc6180..9bd437bf66 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -422,6 +422,9 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * * Used to cast the event specific callback into the generic one * for use for virConnectStoragePoolEventRegisterAny() + * + * Since: v2.0.0 + * */ # define VIR_STORAGE_POOL_EVENT_CALLBACK(cb)((virConnectStoragePoolEventGe= nericCallback)(cb)) =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481886; cv=none; d=zohomail.com; s=zohoarc; b=lBOFmHJ/gyUMapu1t8MA9yfpGA3Gnu5vF3hdLjzvT32An4z0bA889e8x/eJrzlAlyTMyCU52Oajpc4ohRGU6F5Ein88bcIIsGpHcGdwm9tbVcjexJuxrg86Zv7FIDB88WBuOvokE/qraw7FgT1ybka/9hQb2z+TloPYRB3/SLNg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481886; 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=LZXi9fOulyqjvtbLnXji4pCAiBWjeZsqByyzHh0mwVA=; b=Qjy4BaqNK7v/0dbGTjuunwGM5AkSGPfSPZb5dgvQo8jsL1kmnKynCJRIqcttgt/pgwVkQa9rDHisf7xJxnfru2cMrzvFosuV2we1BulRhBLZrvHX0zJ+/HBFy55vLH/O3j398xUHc2cDdAlUhpnaUmDN4gcqpvo3xVr5yJcPdrE= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 16504818869241000.3521376272136; Wed, 20 Apr 2022 12:11:26 -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-138-DIMejmdgO9SuwIpG_4gbmQ-1; Wed, 20 Apr 2022 15:10:31 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id DF866180138A; Wed, 20 Apr 2022 19:08:35 +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 CBEE4551E87; Wed, 20 Apr 2022 19:08:35 +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 327DF1940359; Wed, 20 Apr 2022 19:08:35 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 02CFC19451EC for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:31 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id E62A5551E86; Wed, 20 Apr 2022 19:08:30 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 69C03551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481886; 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=LZXi9fOulyqjvtbLnXji4pCAiBWjeZsqByyzHh0mwVA=; b=HrSoZ4R6yOE/2dU9OzY0w81J6ugOKiSKC8KMJiSAaxT9qO5NzIewD54QGORyKcnz09E2e5 2tJBkhY6J/l/IMXccvjdRCpwsTNdCXaK6NIWjSaQxVdukaVlpP76+jE/KsNPlpIV/N7rZR DZoUt2KuAGIDyB9vOx8xFuN9pnWghnk= X-MC-Unique: DIMejmdgO9SuwIpG_4gbmQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 09/30] docstring: macros: admin: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:58 +0200 Message-Id: <20220420190819.3093205-10-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481887336100002 Content-Type: text/plain; charset="utf-8" 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@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- include/libvirt/libvirt-admin.h | 60 +++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index f65886f20d..defca505f8 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -132,6 +132,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr 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 + * */ =20 # define VIR_THREADPOOL_WORKERS_MIN "minWorkers" @@ -142,6 +145,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr 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_M= IN * at all times. + * + * Since: v1.3.4 + * */ =20 # define VIR_THREADPOOL_WORKERS_MAX "maxWorkers" @@ -150,6 +156,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr 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 + * */ =20 # define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers" @@ -161,6 +170,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v1.3.4 + * */ =20 # define VIR_THREADPOOL_WORKERS_FREE "freeWorkers" @@ -172,6 +184,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v1.3.4 + * */ =20 # define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers" @@ -183,6 +198,9 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v1.3.4 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # 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 li= mit * to number of clients connected to the server, but not authenticated yet, * as VIR_TYPED_PARAM_UINT. + * + * Since: v1.3.5 + * */ =20 # 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 den= ied * by daemon + * + * Since: v1.3.5 + * */ =20 # define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth" --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481727; cv=none; d=zohomail.com; s=zohoarc; b=Vs7bT7YQDM+HTtMI+mXJSx45V/KINq9bJiZZp2hLVSXak/+oMy1LiNbV+p7U2aCcmQKhevUcQS4deVCQp4vta/2hIf70paUzwvcblzKFYCocFFkMmceD26mPVHFvlbDpZx51hSKY221dXqdU11Rku89eO20U/17YOE5sLRReu6s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481727; 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=7ig9dEZC78OycwgDSwWKqiwj3E2aOE+xXosvmE05z+Y=; b=cxtI8dMKc9WhiQ5CXZZqQARN3mZ3pPm04Uifxko/drRLlqWdmtDOWFtM+8fw5OSlBBgEqfxJhkwLKDBtiTzhDhnkKxFWwUkgtsfls965viRMYk9Q1YvdSucpx+X3KwmiJgQks+dJC72A1BKUT/O8uCnczxzNNeXLFpu1eDtNFdk= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481727048657.7911605358129; Wed, 20 Apr 2022 12:08:47 -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-102-nl3XZFDDMDi-ezHNMkNqSw-1; Wed, 20 Apr 2022 15:08:41 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 65E0E1014A86; Wed, 20 Apr 2022 19:08:35 +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 4ADC5C52C82; Wed, 20 Apr 2022 19:08:35 +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 DB8D91940353; Wed, 20 Apr 2022 19:08:34 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 618081940347 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:32 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 43D95551E88; Wed, 20 Apr 2022 19:08:32 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6D72F551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481725; 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=7ig9dEZC78OycwgDSwWKqiwj3E2aOE+xXosvmE05z+Y=; b=N7Pj5Uk5bGATvY2L9jWqUUw5DiYoyZwhcyiGRHZ62PyiAeQu0Uv5fKZmW2Fl6NaC3qsgnz vdaA2TIviW2vSnUFpEN6s0cHScyW6bsY2CtlVdjP5+dkTXapTWcHu4d/MkCoPFqzagXF/q yx+THm7Ha+MeibqgAGR78rjZuw0ELbw= X-MC-Unique: nl3XZFDDMDi-ezHNMkNqSw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 10/30] docstring: typedef: libvirt:: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:07:59 +0200 Message-Id: <20220420190819.3093205-11-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.8 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: 1650481728448100002 Content-Type: text/plain; charset="utf-8" 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@redhat.com> --- include/libvirt/libvirt-domain-checkpoint.h | 34 +- include/libvirt/libvirt-domain-snapshot.h | 40 +- include/libvirt/libvirt-domain.h | 734 ++++++++++++++++++-- include/libvirt/libvirt-event.h | 3 + include/libvirt/libvirt-host.h | 120 +++- include/libvirt/libvirt-interface.h | 25 +- include/libvirt/libvirt-network.h | 77 +- include/libvirt/libvirt-nodedev.h | 22 +- include/libvirt/libvirt-nwfilter.h | 25 +- include/libvirt/libvirt-secret.h | 36 +- include/libvirt/libvirt-storage.h | 133 +++- include/libvirt/libvirt-stream.h | 18 + include/libvirt/virterror.h | 19 + 13 files changed, 1212 insertions(+), 74 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/= libvirt-domain-checkpoint.h index a59578b857..5a53717175 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; =20 @@ -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; =20 @@ -50,6 +56,12 @@ const char *virDomainCheckpointGetName(virDomainCheckpoi= ntPtr checkpoint); virDomainPtr virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoin= t); virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpo= int); =20 +/** + * virDomainCheckpointCreateFlags: + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE =3D (1 << 0), /* Restore or a= lter metadata (Sinc= e: v5.6.0) */ @@ -65,7 +77,12 @@ typedef enum { virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, const char *xmlDesc, unsigned int flags); - +/** + * virDomainCheckpointXMLFlags: + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_XML_SECURE =3D (1 << 0), /* Include sensitive= data (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN =3D (1 << 1), /* Suppress <domain> @@ -86,7 +103,11 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpoint= Ptr 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 =3D (1 << 0), /* Filter by chec= kpoints with no parents,= when @@ -123,7 +144,14 @@ virDomainCheckpointPtr virDomainCheckpointLookupByName= (virDomainPtr domain, virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr= checkpoint, unsigned int flags); =20 -/* Delete a checkpoint */ +/** + * virDomainCheckpointDeleteFlags: + * + * Delete a checkpoint + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN =3D (1 << 0), /* Also delet= e children (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete jus= t metadata (Since: v5.6.0) */ diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/li= bvirt-domain-snapshot.h index 5dffabb764..cdf82b29ce 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: v0.8.0 + * */ typedef struct _virDomainSnapshot virDomainSnapshot; =20 @@ -42,6 +45,9 @@ typedef struct _virDomainSnapshot virDomainSnapshot; * * A virDomainSnapshotPtr is pointer to a virDomainSnapshot private struct= ure, * and is the type used to reference a domain snapshot in the API. + * + * Since: v0.8.0 + * */ typedef virDomainSnapshot *virDomainSnapshotPtr; =20 @@ -49,6 +55,12 @@ const char *virDomainSnapshotGetName(virDomainSnapshotPt= r snapshot); virDomainPtr virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot); virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot); =20 +/** + * virDomainSnapshotCreateFlags: + * + * Since: v0.9.5 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE =3D (1 << 0), /* Restore or alt= er metadata (Since:= v0.9.5) */ @@ -79,7 +91,12 @@ typedef enum { virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, const char *xmlDesc, unsigned int flags); - +/** + * virDomainSnapshotXMLFlags: + * + * Since: v5.1.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /* d= ump security sensitive information too (Since: v5.1.0) */ } virDomainSnapshotXMLFlags; @@ -98,7 +115,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: v0.9.5 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_LIST_ROOTS =3D (1 << 0), /* Filter by snapsh= ots with no parents, w= hen @@ -194,6 +215,12 @@ int virDomainSnapshotIsCurrent(virDomainSnapshotPtr sn= apshot, int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, unsigned int flags); =20 +/** + * virDomainSnapshotRevertFlags: + * + * Since: v0.9.5 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING =3D 1 << 0, /* Run after revert (Si= nce: v0.9.5) */ VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED =3D 1 << 1, /* Pause after revert (= Since: v0.9.5) */ @@ -208,7 +235,14 @@ typedef enum { int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, unsigned int flags); =20 -/* Delete a snapshot */ +/** + * virDomainSnapshotDeleteFlags: + * + * Delete a snapshot + * + * Since: v0.8.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN =3D (1 << 0), /* Also delete = children (Since: v0.8.0) */ VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete just = metadata (Since: v0.9.5) */ diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 01ea2a750f..5654a50c7e 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: v0.0.1 + * */ typedef struct _virDomain virDomain; =20 @@ -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: v0.0.1 + * */ typedef virDomain *virDomainPtr; =20 @@ -47,6 +53,9 @@ typedef virDomain *virDomainPtr; * virDomainState: * * A domain may be in different states at a given point in time + * + * Since: v0.0.1 + * */ typedef enum { VIR_DOMAIN_NOSTATE =3D 0, /* no state (Since: v0.0.1) */ @@ -71,6 +80,12 @@ typedef enum { # endif } virDomainState; =20 +/** + * virDomainNostateReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_NOSTATE_UNKNOWN =3D 0, /* (Since: v0.9.2) */ =20 @@ -79,6 +94,12 @@ typedef enum { # endif } virDomainNostateReason; =20 +/** + * virDomainRunningReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_RUNNING_UNKNOWN =3D 0, /* (Since: v0.9.2) */ VIR_DOMAIN_RUNNING_BOOTED =3D 1, /* normal startup from boot = (Since: v0.9.2) */ @@ -98,6 +119,12 @@ typedef enum { # endif } virDomainRunningReason; =20 +/** + * virDomainBlockedReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_BLOCKED_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ =20 @@ -106,6 +133,12 @@ typedef enum { # endif } virDomainBlockedReason; =20 +/** + * virDomainPausedReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_PAUSED_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ VIR_DOMAIN_PAUSED_USER =3D 1, /* paused on user request (Since= : v0.9.2) */ @@ -127,6 +160,12 @@ typedef enum { # endif } virDomainPausedReason; =20 +/** + * virDomainShutdownReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_SHUTDOWN_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ VIR_DOMAIN_SHUTDOWN_USER =3D 1, /* shutting down on user request= (Since: v0.9.2) */ @@ -136,6 +175,12 @@ typedef enum { # endif } virDomainShutdownReason; =20 +/** + * virDomainShutoffReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_SHUTOFF_UNKNOWN =3D 0, /* the reason is unknown (Since:= v0.9.2) */ VIR_DOMAIN_SHUTOFF_SHUTDOWN =3D 1, /* normal shutdown (Since: v0.9.= 2) */ @@ -153,6 +198,12 @@ typedef enum { # endif } virDomainShutoffReason; =20 +/** + * virDomainCrashedReason: + * + * Since: v0.9.2 + * + */ typedef enum { VIR_DOMAIN_CRASHED_UNKNOWN =3D 0, /* crashed for unknown reason (S= ince: v0.9.2) */ VIR_DOMAIN_CRASHED_PANICKED =3D 1, /* domain panicked (Since: v1.1.= 1) */ @@ -162,6 +213,12 @@ typedef enum { # endif } virDomainCrashedReason; =20 +/** + * virDomainPMSuspendedReason: + * + * Since: v0.9.11 + * + */ typedef enum { VIR_DOMAIN_PMSUSPENDED_UNKNOWN =3D 0, /* (Since: v0.9.11) */ =20 @@ -170,6 +227,12 @@ typedef enum { # endif } virDomainPMSuspendedReason; =20 +/** + * virDomainPMSuspendedDiskReason: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN =3D 0, /* (Since: v1.0.0) */ =20 @@ -182,6 +245,9 @@ typedef enum { * virDomainControlState: * * Current state of a control interface to the domain. + * + * Since: v0.9.3 + * */ typedef enum { VIR_DOMAIN_CONTROL_OK =3D 0, /* operational, ready to accept com= mands (Since: v0.9.3) */ @@ -202,6 +268,9 @@ typedef enum { * virDomainControlErrorReason: * * Reason for the error state. + * + * Since: v1.2.14 + * */ typedef enum { VIR_DOMAIN_CONTROL_ERROR_REASON_NONE =3D 0, /* server didn't provi= de a @@ -223,6 +292,9 @@ typedef enum { * * Structure filled in by virDomainGetControlInfo and providing details ab= out * current state of control interface to a domain. + * + * Since: v0.9.3 + * */ typedef struct _virDomainControlInfo virDomainControlInfo; struct _virDomainControlInfo { @@ -238,6 +310,9 @@ struct _virDomainControlInfo { * virDomainControlInfoPtr: * * Pointer to virDomainControlInfo structure. + * + * Since: v0.9.3 + * */ typedef virDomainControlInfo *virDomainControlInfoPtr; =20 @@ -258,6 +333,9 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * (whether or not it is running). * * These enums should not conflict with those of virTypedParameterFlags. + * + * Since: v0.9.2 + * */ typedef enum { VIR_DOMAIN_AFFECT_CURRENT =3D 0, /* Affect current domain state. = (Since: v0.9.2) */ @@ -267,12 +345,14 @@ typedef enum { } virDomainModificationImpact; =20 /** - * virDomainInfoPtr: + * virDomainInfo: * * a virDomainInfo is a structure filled by virDomainGetInfo() and extract= ing * runtime information for a given active Domain + * + * Since: v0.0.1 + * */ - typedef struct _virDomainInfo virDomainInfo; =20 struct _virDomainInfo { @@ -287,6 +367,9 @@ struct _virDomainInfo { * virDomainInfoPtr: * * a virDomainInfoPtr is a pointer to a virDomainInfo structure. + * + * Since: v0.0.1 + * */ =20 typedef virDomainInfo *virDomainInfoPtr; @@ -296,6 +379,9 @@ typedef virDomainInfo *virDomainInfoPtr; * * Flags OR'ed together to provide specific behaviour when creating a * Domain. + * + * Since: v0.0.1 + * */ typedef enum { VIR_DOMAIN_NONE =3D 0, /* Default behavior (Since: = v0.0.1) */ @@ -489,7 +575,7 @@ int virDomainSetSchedulerParametersFlags (virDomain= Ptr domain, unsigned int flags); =20 /** - * virDomainBlockStats: + * virDomainBlockStatsStruct: * * Block device stats for virDomainBlockStats. * @@ -497,6 +583,9 @@ int virDomainSetSchedulerParametersFlags (virDomain= Ptr domain, * that the hypervisor does not support that statistic. * * NB. Here 'long long' means 64 bit integer. + * + * Since: v0.3.3 + * */ typedef struct _virDomainBlockStats virDomainBlockStatsStruct; =20 @@ -512,6 +601,9 @@ struct _virDomainBlockStats { * virDomainBlockStatsPtr: * * A pointer to a virDomainBlockStats structure + * + * Since: v0.3.2 + * */ typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr; =20 @@ -626,7 +718,7 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; # define VIR_DOMAIN_BLOCK_STATS_ERRS "errs" =20 /** - * virDomainInterfaceStats: + * virDomainInterfaceStatsStruct: * * Network interface stats for virDomainInterfaceStats. * @@ -634,6 +726,9 @@ typedef virDomainBlockStatsStruct *virDomainBlockStatsP= tr; * that the hypervisor does not support that statistic. * * NB. Here 'long long' means 64 bit integer. + * + * Since: v0.3.3 + * */ typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct; =20 @@ -652,11 +747,19 @@ struct _virDomainInterfaceStats { * virDomainInterfaceStatsPtr: * * A pointer to a virDomainInterfaceStats structure + * + * Since: v0.3.2 + * */ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr; =20 /** + * virDomainMemoryStatTags: + * * Memory Statistics Tags: + * + * Since: v0.7.5 + * */ typedef enum { /* The total amount of data read from swap space (in kB). (Since: v0.7= .5) */ @@ -774,6 +877,12 @@ typedef enum { # endif } virDomainMemoryStatTags; =20 +/** + * virDomainMemoryStatStruct: + * + * Since: v0.7.5 + * + */ typedef struct _virDomainMemoryStat virDomainMemoryStatStruct; =20 struct _virDomainMemoryStat { @@ -781,10 +890,23 @@ struct _virDomainMemoryStat { unsigned long long val; }; =20 +/** + * virDomainMemoryStatPtr: + * + * Since: v0.7.5 + * + */ typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; =20 =20 -/* Domain core dump flags. */ +/** + * virDomainCoreDumpFlags: + * + * Domain core dump flags. + * + * Since: v0.7.5 + * + */ typedef enum { VIR_DUMP_CRASH =3D (1 << 0), /* crash after dump (Since: v0.7.5= ) */ VIR_DUMP_LIVE =3D (1 << 1), /* live dump (Since: v0.7.5) */ @@ -797,6 +919,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) */ @@ -819,7 +944,14 @@ typedef enum { # endif } virDomainCoreDumpFormat; =20 -/* Domain migration flags. */ +/** + * virDomainMigrateFlags: + * + * Domain migration flags. + * + * Since: v0.3.2 + * + */ 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. @@ -1369,7 +1501,14 @@ int virDomainMigrateSetCompressionCache(virDomainPtr= domain, unsigned long long cacheSize, unsigned int flags); =20 -/* 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 =3D (1 << 0), @@ -1432,6 +1571,12 @@ virDomainPtr virDomainLookupByUUID (vir= ConnectPtr conn, virDomainPtr virDomainLookupByUUIDString (virConnectPtr con= n, const char *uuid); =20 +/** + * virDomainShutdownFlagValues: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_DOMAIN_SHUTDOWN_DEFAULT =3D 0, /* hypervisor choice = (Since: v0.9.10) */ VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event (S= ince: v0.9.10) */ @@ -1445,6 +1590,12 @@ int virDomainShutdown (vir= DomainPtr domain); int virDomainShutdownFlags (virDomainPtr domain, unsigned int flags); =20 +/** + * virDomainRebootFlagValues: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_DOMAIN_REBOOT_DEFAULT =3D 0, /* hypervisor choice (S= ince: v0.9.10) */ VIR_DOMAIN_REBOOT_ACPI_POWER_BTN =3D (1 << 0), /* Send ACPI event (Sin= ce: v0.9.10) */ @@ -1466,6 +1617,9 @@ int virDomainDestroy (virD= omainPtr domain); * * Flags used to provide specific behaviour to the * virDomainDestroyFlags() function + * + * Since: v0.9.4 + * */ typedef enum { VIR_DOMAIN_DESTROY_DEFAULT =3D 0, /* Default behavior - could l= ead to data loss!! (Since: v0.9.10) */ @@ -1495,9 +1649,13 @@ int virDomainPMWakeup (vir= DomainPtr domain, =20 /** * virDomainSaveRestoreFlags: + * * Flags for use in virDomainSaveFlags(), virDomainManagedSave(), * virDomainRestoreFlags(), and virDomainSaveImageDefineXML(). Not all * flags apply to all these functions. + * + * Since: v0.9.4 + * */ typedef enum { VIR_DOMAIN_SAVE_BYPASS_CACHE =3D 1 << 0, /* Avoid file system cache po= llution (Since: v0.9.4) */ @@ -1796,7 +1954,14 @@ int virDomainGetMemoryParameters(virDomainPtr do= main, virTypedParameterPtr params, int *nparams, unsigned int flags); =20 -/* 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 =3D VIR_DOMAIN_AFFECT_CURRENT, @@ -1814,6 +1979,9 @@ typedef enum { * virDomainNumatuneMemMode: * Representation of the various modes in the <numatune> element of * a domain. + * + * Since: v0.9.9 + * */ typedef enum { VIR_DOMAIN_NUMATUNE_MEM_STRICT =3D 0, /* (Since: v0.9.9) */ @@ -1879,7 +2047,12 @@ int virDomainSetMemoryStatsPerio= d (virDomainPtr domain, int virDomainGetMaxVcpus (virDomainPtr domain); int virDomainGetSecurityLabel (virDomainPtr domain, virSecurityLabelPtr sec= label); - +/** + * virDomainGetHostnameFlags: + * + * Since: v6.1.0 + * + */ typedef enum { VIR_DOMAIN_GET_HOSTNAME_LEASE =3D (1 << 0), /* Parse DHCP lease file (= Since: v6.1.0) */ VIR_DOMAIN_GET_HOSTNAME_AGENT =3D (1 << 1), /* Query qemu guest agent = (Since: v6.1.0) */ @@ -1890,6 +2063,12 @@ char * virDomainGetHostname (vir= DomainPtr domain, int virDomainGetSecurityLabelList (virDomainPtr domain, virSecurityLabelPtr= * seclabels); =20 +/** + * virDomainMetadataType: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_DOMAIN_METADATA_DESCRIPTION =3D 0, /* Operate on <description> (Si= nce: v0.9.10) */ VIR_DOMAIN_METADATA_TITLE =3D 1, /* Operate on <title> (Since: v= 0.9.10) */ @@ -1917,12 +2096,15 @@ virDomainGetMetadata(virDomainPtr domain, /* * XML domain description */ + /** * virDomainXMLFlags: * * Flags available for virDomainGetXMLDesc + * + * Since: v0.3.3 + * */ - typedef enum { VIR_DOMAIN_XML_SECURE =3D (1 << 0), /* dump security sensitive i= nformation too (Since: v0.3.3) */ VIR_DOMAIN_XML_INACTIVE =3D (1 << 1), /* dump inactive domain info= rmation (Since: v0.3.3) */ @@ -1930,6 +2112,12 @@ typedef enum { VIR_DOMAIN_XML_MIGRATABLE =3D (1 << 3), /* dump XML suitable for mig= ration (Since: v1.0.0) */ } virDomainXMLFlags; =20 +/** + * virDomainSaveImageXMLFlags: + * + * Since: v5.1.0 + * + */ typedef enum { VIR_DOMAIN_SAVE_IMAGE_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /*= dump security sensitive information too (Since: v5.1.0) */ } virDomainSaveImageXMLFlags; @@ -2055,6 +2243,9 @@ int virDomainBlockPeek (virDomain= Ptr dom, * virDomainBlockResizeFlags: * * Flags available for virDomainBlockResize(). + * + * Since: v0.9.11 + * */ typedef enum { VIR_DOMAIN_BLOCK_RESIZE_BYTES =3D 1 << 0, /* size in bytes instead of = KiB (Since: v0.9.11) */ @@ -2088,8 +2279,18 @@ int virDomainBlockResize (virDom= ainPtr dom, * * capacity: logical size from qcow2 header * * allocation: highest qcow extent written for an active domain * * physical: size of the block device container + * + * Since: v0.8.1 + * */ typedef struct _virDomainBlockInfo virDomainBlockInfo; + +/** + * virDomainBlockInfoPtr: + * + * Since: v0.8.1 + * + */ typedef virDomainBlockInfo *virDomainBlockInfoPtr; struct _virDomainBlockInfo { unsigned long long capacity; /* logical size in bytes of the @@ -2116,8 +2317,14 @@ int virDomainMemoryStats (virDom= ainPtr dom, unsigned int nr_stats, unsigned int flags); =20 -/* Memory peeking flags. */ - +/** + * virDomainMemoryFlags: + * + * Memory peeking flags. + * + * Since: v0.4.4 + * + */ typedef enum { VIR_MEMORY_VIRTUAL =3D 1 << 0, /* addresses are virtual add= resses (Since: v0.4.4) */ VIR_MEMORY_PHYSICAL =3D 1 << 1, /* addresses are physical ad= dresses (Since: v0.7.0) */ @@ -2129,6 +2336,12 @@ int virDomainMemoryPeek (virDoma= inPtr dom, void *buffer, unsigned int flags); =20 +/** + * virDomainDefineFlags: + * + * Since: v1.2.12 + * + */ typedef enum { VIR_DOMAIN_DEFINE_VALIDATE =3D (1 << 0), /* Validate the XML document = against schema (Since: v1.2.12) */ } virDomainDefineFlags; @@ -2144,6 +2357,12 @@ virDomainPtr virDomainDefineXMLFlags (vir= ConnectPtr conn, unsigned int flags); int virDomainUndefine (virDomainPtr domain); =20 +/** + * virDomainUndefineFlagsValues: + * + * Since: v0.9.4 + * + */ typedef enum { VIR_DOMAIN_UNDEFINE_MANAGED_SAVE =3D (1 << 0), /* Also remove any managed save (Si= nce: v0.9.4) */ @@ -2173,6 +2392,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: v0.9.13 */ typedef enum { VIR_CONNECT_LIST_DOMAINS_ACTIVE =3D 1 << 0, /* (Since: v0.9.13= ) */ @@ -2217,9 +2438,13 @@ int virDomainSetAutostart (vir= DomainPtr domain, int autostart); =20 /** - * virVcpuInfo: structure for information about a virtual CPU in a domain. + * virVcpuState: + * + * structure for information about a virtual CPU in a domain. + * + * Since: v0.1.4 + * */ - typedef enum { VIR_VCPU_OFFLINE =3D 0, /* the virtual CPU is offline (Since: v0= .1.4) */ VIR_VCPU_RUNNING =3D 1, /* the virtual CPU is running (Since: v0= .1.4) */ @@ -2230,11 +2455,23 @@ typedef enum { # endif } virVcpuState; =20 +/** + * virVcpuHostCpuState: + * + * Since: v6.10.0 + * + */ typedef enum { VIR_VCPU_INFO_CPU_OFFLINE =3D -1, /* the vCPU is offline (Since: v= 6.10.0) */ VIR_VCPU_INFO_CPU_UNAVAILABLE =3D -2, /* the hypervisor does not expos= e real CPU information (Since: v6.10.0) */ } virVcpuHostCpuState; =20 +/** + * virVcpuInfo: + * + * Since: v0.1.4 + * + */ typedef struct _virVcpuInfo virVcpuInfo; struct _virVcpuInfo { unsigned int number; /* virtual CPU number */ @@ -2242,9 +2479,23 @@ struct _virVcpuInfo { unsigned long long cpuTime; /* CPU time used, in nanoseconds */ int cpu; /* real CPU number, or one of the values f= rom virVcpuHostCpuState */ }; + +/** + * virVcpuInfoPtr: + * + * Since: v0.1.4 + * + */ typedef virVcpuInfo *virVcpuInfoPtr; =20 -/* 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 =3D VIR_DOMAIN_AFFECT_CURRENT, @@ -2292,11 +2543,22 @@ int virDomainGetEmulatorPinInfo= (virDomainPtr domain, unsigned int flags); =20 /** - * virIOThreadInfo: + * virDomainIOThreadInfo: * * The data structure for information about all IOThreads in a domain + * + * Since: v1.2.14 + * */ typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo; + + +/** + * virDomainIOThreadInfoPtr: + * + * Since: v1.2.14 + * + */ typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr; struct _virDomainIOThreadInfo { unsigned int iothread_id; /* IOThread ID */ @@ -2493,6 +2755,12 @@ int virDomainGetVcpus (vir= DomainPtr domain, # define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (mapl= en)])) =20 =20 +/** + * virDomainDeviceModifyFlags: + * + * Since: v1.0.0 + * + */ typedef enum { /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ VIR_DOMAIN_DEVICE_MODIFY_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, @@ -2517,7 +2785,20 @@ int virDomainUpdateDeviceFlags(virDomainPtr domain, int virDomainDetachDeviceAlias(virDomainPtr domain, const char *alias, unsigned int flags); =20 +/** + * virDomainStatsRecord: + * + * Since: v1.2.8 + * + */ typedef struct _virDomainStatsRecord virDomainStatsRecord; + +/** + * virDomainStatsRecordPtr: + * + * Since: v1.2.8 + * + */ typedef virDomainStatsRecord *virDomainStatsRecordPtr; struct _virDomainStatsRecord { virDomainPtr dom; @@ -2525,6 +2806,12 @@ struct _virDomainStatsRecord { int nparams; }; =20 +/** + * virDomainStatsTypes: + * + * Since: v1.2.8 + * + */ typedef enum { VIR_DOMAIN_STATS_STATE =3D (1 << 0), /* return domain state (Since: v1= .2.8) */ VIR_DOMAIN_STATS_CPU_TOTAL =3D (1 << 1), /* return domain CPU info (Si= nce: v1.2.9) */ @@ -2538,6 +2825,12 @@ typedef enum { VIR_DOMAIN_STATS_DIRTYRATE =3D (1 << 9), /* return domain dirty rate i= nfo (Since: v7.2.0) */ } virDomainStatsTypes; =20 +/** + * virConnectGetAllDomainStatsFlags: + * + * Since: v1.2.8 + * + */ typedef enum { VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE =3D VIR_CONNECT_LIST_DOMAINS_= ACTIVE, /* (Since: v1.2.8) */ VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE =3D VIR_CONNECT_LIST_DOMAIN= S_INACTIVE, /* (Since: v1.2.8) */ @@ -2881,6 +3174,9 @@ int virDomainSetPerfEvents(virDomainPtr dom, * virDomainBlockJobType: * * Describes various possible block jobs. + * + * Since: v0.9.4 + * */ typedef enum { /* Placeholder (Since: v0.9.4) */ @@ -2931,6 +3227,9 @@ typedef enum { * VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC: Request only, do not wait for complet= ion * VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT: Pivot to new file when ending a copy = or * active commit job + * + * Since: v0.9.12 + * */ typedef enum { VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC =3D 1 << 0, /* (Since: v0.9.12) */ @@ -2940,17 +3239,37 @@ typedef enum { int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, unsigned int flags); =20 -/* Flags for use with virDomainGetBlockJobInfo */ +/** + * virDomainBlockJobInfoFlags: + * + * Flags for use with virDomainGetBlockJobInfo + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in = bytes/s instead of MiB/= s (Since: v1.2.9) */ } virDomainBlockJobInfoFlags; =20 -/* An iterator for monitoring block job operations */ -typedef unsigned long long virDomainBlockJobCursor; - -typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo; -struct _virDomainBlockJobInfo { +/** + * virDomainBlockJobCursor: + * + * An iterator for monitoring block job operations + * + * Since: v0.9.4 + * + */ +typedef unsigned long long virDomainBlockJobCursor; + +/** + * virDomainBlockJobInfo: + * + * Since: v0.9.4 + * + */ +typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo; +struct _virDomainBlockJobInfo { int type; /* virDomainBlockJobType */ unsigned long bandwidth; /* either bytes/s or MiB/s, according to flag= s */ =20 @@ -2963,13 +3282,27 @@ struct _virDomainBlockJobInfo { virDomainBlockJobCursor cur; virDomainBlockJobCursor end; }; + +/** + * virDomainBlockJobInfoPtr: + * + * Since: v0.9.4 + * + */ typedef virDomainBlockJobInfo *virDomainBlockJobInfoPtr; =20 int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, virDomainBlockJobInfoPtr info, unsigned int flags); =20 -/* Flags for use with virDomainBlockJobSetSpeed */ +/** + * virDomainBlockJobSetSpeedFlags: + * + * Flags for use with virDomainBlockJobSetSpeed + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in= bytes/s instead of MiB= /s (Since: v1.2.9) */ @@ -2978,8 +3311,15 @@ typedef enum { int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, unsigned long bandwidth, unsigned int flags); =20 -/* Flags for use with virDomainBlockPull (values chosen to be a subset - * of the flags for virDomainBlockRebase) */ +/** + * virDomainBlockPullFlags: + * + * Flags for use with virDomainBlockPull (values chosen to be a subset of = the + * flags for virDomainBlockRebase) + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES =3D 1 << 6, /* bandwidth in byte= s/s instead of MiB/s (S= ince: v1.2.9) */ @@ -2992,6 +3332,9 @@ int virDomainBlockPull(virDomainPtr dom, const char *= disk, * virDomainBlockRebaseFlags: * * Flags available for virDomainBlockRebase(). + * + * Since: v0.9.12 + * */ typedef enum { VIR_DOMAIN_BLOCK_REBASE_SHALLOW =3D 1 << 0, /* Limit copy to top of = source @@ -3017,6 +3360,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) */ @@ -3094,6 +3440,9 @@ int virDomainBlockCopy(virDomainPtr dom, const char *= disk, * virDomainBlockCommitFlags: * * Flags available for virDomainBlockCommit(). + * + * Since: v0.10.2 + * */ typedef enum { VIR_DOMAIN_BLOCK_COMMIT_SHALLOW =3D 1 << 0, /* NULL base means next ba= cking @@ -3350,6 +3699,9 @@ virDomainGetBlockIoTune(virDomainPtr dom, * virDomainDiskErrorCode: * * Disk I/O error. + * + * Since: v0.9.10 + * */ typedef enum { VIR_DOMAIN_DISK_ERROR_NONE =3D 0, /* no error (Since: v0.9.10) */ @@ -3364,8 +3716,17 @@ typedef enum { /** * virDomainDiskError: * + * Since: v0.9.10 + * */ typedef struct _virDomainDiskError virDomainDiskError; + +/** + * virDomainDiskErrorPtr: + * + * Since: v0.9.10 + * + */ typedef virDomainDiskError *virDomainDiskErrorPtr; =20 struct _virDomainDiskError { @@ -3384,6 +3745,9 @@ int virDomainGetDiskErrors(virDomainPtr dom, * virKeycodeSet: * * Enum to specify which keycode mapping is in use for virDomainSendKey(). + * + * Since: v0.9.3 + * */ typedef enum { VIR_KEYCODE_SET_LINUX =3D 0, /* (Since: v0.9.3) */ @@ -3436,7 +3800,9 @@ int virDomainSendKey(virDomainPtr domain, int nkeycodes, unsigned int flags); =20 -/* +/** + * 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 @@ -3445,6 +3811,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 =3D 0, /* No constant in POSIX/L= inux (Since: v1.0.1) */ @@ -3545,6 +3914,9 @@ virDomainPtr virDomainCreateLinux (virC= onnectPtr conn, * virDomainEventType: * * a virDomainEventType is emitted during domain lifecycle events + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_DEFINED =3D 0, /* (Since: v0.5.0) */ @@ -3566,6 +3938,9 @@ typedef enum { * virDomainEventDefinedDetailType: * * Details on the cause of a 'defined' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_DEFINED_ADDED =3D 0, /* Newly created config file= (Since: v0.5.0) */ @@ -3582,6 +3957,9 @@ typedef enum { * virDomainEventUndefinedDetailType: * * Details on the cause of an 'undefined' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_UNDEFINED_REMOVED =3D 0, /* Deleted the config file (= Since: v0.5.0) */ @@ -3596,6 +3974,9 @@ typedef enum { * virDomainEventStartedDetailType: * * Details on the cause of a 'started' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_STARTED_BOOTED =3D 0, /* Normal startup from boot (= Since: v0.5.0) */ @@ -3613,6 +3994,9 @@ typedef enum { * virDomainEventSuspendedDetailType: * * Details on the cause of a 'suspended' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_SUSPENDED_PAUSED =3D 0, /* Normal suspend due to ad= min pause (Since: v0.5.0) */ @@ -3634,6 +4018,9 @@ typedef enum { * virDomainEventResumedDetailType: * * Details on the cause of a 'resumed' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_RESUMED_UNPAUSED =3D 0, /* Normal resume due to adm= in unpause (Since: v0.5.0) */ @@ -3651,6 +4038,9 @@ typedef enum { * virDomainEventStoppedDetailType: * * Details on the cause of a 'stopped' lifecycle event + * + * Since: v0.5.0 + * */ typedef enum { VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN =3D 0, /* Normal shutdown (Since: v= 0.5.0) */ @@ -3671,6 +4061,9 @@ typedef enum { * virDomainEventShutdownDetailType: * * Details on the cause of a 'shutdown' lifecycle event + * + * Since: v0.9.8 + * */ typedef enum { /* Guest finished shutdown sequence (Since: v0.9.8) */ @@ -3696,6 +4089,9 @@ typedef enum { * virDomainEventPMSuspendedDetailType: * * Details on the cause of a 'pmsuspended' lifecycle event + * + * Since: v0.10.2 + * */ typedef enum { VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY =3D 0, /* Guest was PM suspended t= o memory (Since: v0.10.2) */ @@ -3710,6 +4106,9 @@ typedef enum { * virDomainEventCrashedDetailType: * * Details on the cause of a 'crashed' lifecycle event + * + * Since: v1.1.1 + * */ typedef enum { VIR_DOMAIN_EVENT_CRASHED_PANICKED =3D 0, /* Guest was panicked (Since:= v1.1.1) */ @@ -3724,6 +4123,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) */ @@ -3742,6 +4144,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 @@ -3779,6 +4184,12 @@ typedef enum { } virDomainMemoryFailureActionType; =20 =20 +/** + * 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) */ @@ -3824,6 +4235,12 @@ int virDomainIsActive(virDomainPtr dom); int virDomainIsPersistent(virDomainPtr dom); int virDomainIsUpdated(virDomainPtr dom); =20 +/** + * virDomainJobType: + * + * Since: v0.7.7 + * + */ typedef enum { VIR_DOMAIN_JOB_NONE =3D 0, /* No job is active (Since: v0.7.7) */ VIR_DOMAIN_JOB_BOUNDED =3D 1, /* Job with a finite completion time (= Since: v0.7.7) */ @@ -3837,7 +4254,20 @@ typedef enum { # endif } virDomainJobType; =20 +/** + * virDomainJobInfo: + * + * Since: v0.7.7 + * + */ typedef struct _virDomainJobInfo virDomainJobInfo; + +/** + * virDomainJobInfoPtr: + * + * Since: v0.7.7 + * + */ typedef virDomainJobInfo *virDomainJobInfoPtr; struct _virDomainJobInfo { /* One of virDomainJobType */ @@ -3878,6 +4308,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 =3D 1 << 0, /* return stats of a recent= ly @@ -3895,6 +4328,12 @@ int virDomainGetJobStats(virDomainPtr domain, unsigned int flags); int virDomainAbortJob(virDomainPtr dom); =20 +/** + * virDomainJobOperation: + * + * Since: v3.3.0 + * + */ typedef enum { VIR_DOMAIN_JOB_OPERATION_UNKNOWN =3D 0, /* (Since: v3.3.0) */ VIR_DOMAIN_JOB_OPERATION_START =3D 1, /* (Since: v3.3.0) */ @@ -4386,6 +4825,9 @@ typedef void (*virConnectDomainEventRTCChangeCallback= )(virConnectPtr conn, * virDomainEventWatchdogAction: * * The action that is to be taken due to the watchdog device firing + * + * Since: v0.8.0 + * */ typedef enum { VIR_DOMAIN_EVENT_WATCHDOG_NONE =3D 0, /* No action, watchdog ignored (= Since: v0.8.0) */ @@ -4421,6 +4863,9 @@ typedef void (*virConnectDomainEventWatchdogCallback)= (virConnectPtr conn, * virDomainEventIOErrorAction: * * The action that is to be taken due to an IO error occurring + * + * Since: v0.8.0 + * */ typedef enum { VIR_DOMAIN_EVENT_IO_ERROR_NONE =3D 0, /* No action, IO error ignored = (Since: v0.8.0) */ @@ -4484,6 +4929,9 @@ typedef void (*virConnectDomainEventIOErrorReasonCall= back)(virConnectPtr conn, * virDomainEventGraphicsPhase: * * The phase of the graphics client connection + * + * Since: v0.8.0 + * */ typedef enum { VIR_DOMAIN_EVENT_GRAPHICS_CONNECT =3D 0, /* Initial socket connection= established (Since: v0.8.0) */ @@ -4499,6 +4947,9 @@ typedef enum { * virDomainEventGraphicsAddressType: * * The type of address for the connection + * + * Since: v0.8.0 + * */ typedef enum { VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: v0.8.= 0) */ @@ -4512,22 +4963,38 @@ typedef enum { =20 =20 /** - * virDomainEventGraphicsAddress: + * _virDomainEventGraphicsAddress: * * The data structure containing connection address details * + * Since: v1.0.0 + * */ struct _virDomainEventGraphicsAddress { int family; /* Address family, virDomainEventGraphicsAdd= ressType */ char *node; /* Address of node (eg IP address, or UNIX p= ath) */ char *service; /* Service name/number (eg TCP port, or NULL= ) */ }; + +/** + * virDomainEventGraphicsAddress: + * + * Since: v0.8.0 + * + */ typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddres= s; + +/** + * virDomainEventGraphicsAddressPtr: + * + * Since: v0.8.0 + * + */ typedef virDomainEventGraphicsAddress *virDomainEventGraphicsAddressPtr; =20 =20 /** - * virDomainEventGraphicsSubjectIdentity: + * _virDomainEventGraphicsSubjectIdentity: * * The data structure representing a single identity * @@ -4538,7 +5005,21 @@ struct _virDomainEventGraphicsSubjectIdentity { char *type; /* Type of identity */ char *name; /* Identity value */ }; + +/** + * virDomainEventGraphicsSubjectIdentity: + * + * Since: v0.8.0 + * + */ typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphi= csSubjectIdentity; + +/** + * virDomainEventGraphicsSubjectIdentityPtr: + * + * Since: v0.8.0 + * + */ typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubje= ctIdentityPtr; =20 =20 @@ -4549,12 +5030,29 @@ typedef virDomainEventGraphicsSubjectIdentity *virD= omainEventGraphicsSubjectIden * * A subject will have zero or more identities. The types of * identity differ according to the authentication scheme + * + * Since: v0.8.0 + * */ struct _virDomainEventGraphicsSubject { int nidentity; /* Number of identities = in array*/ virDomainEventGraphicsSubjectIdentityPtr identities; /* Array of ident= ities for subject */ }; + +/** + * virDomainEventGraphicsSubject: + * + * Since: v0.8.0 + * + */ typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubjec= t; + +/** + * virDomainEventGraphicsSubjectPtr: + * + * Since: v0.8.0 + * + */ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr; =20 =20 @@ -4586,6 +5084,9 @@ typedef void (*virConnectDomainEventGraphicsCallback)= (virConnectPtr conn, * * Tracks status of a virDomainBlockPull(), virDomainBlockRebase(), * virDomainBlockCopy(), or virDomainBlockCommit() operation + * + * Since: v0.9.4 + * */ typedef enum { VIR_DOMAIN_BLOCK_JOB_COMPLETED =3D 0, /* (Since: v0.9.4) */ @@ -4633,6 +5134,9 @@ typedef void (*virConnectDomainEventBlockJobCallback)= (virConnectPtr conn, * virConnectDomainEventDiskChangeReason: * * The reason describing why this callback is called + * + * Since: v0.9.7 + * */ typedef enum { /* Removable media changed to empty according to startup policy as sou= rce @@ -4685,6 +5189,9 @@ typedef void (*virConnectDomainEventDiskChangeCallbac= k)(virConnectPtr conn, * virDomainEventTrayChangeReason: * * The reason describing why the callback was called + * + * Since: v0.9.11 + * */ typedef enum { VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN =3D 0, /* (Since: v0.9.11) */ @@ -5302,6 +5809,12 @@ typedef void (*virConnectDomainEventTunableCallback)= (virConnectPtr conn, void *opaque); =20 =20 +/** + * virConnectDomainEventAgentLifecycleState: + * + * Since: v1.2.11 + * + */ typedef enum { VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED =3D 1, /* age= nt connected (Since: v1.2.11) */ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED =3D 2, /* = agent disconnected (Since: v1.2.11) */ @@ -5311,6 +5824,12 @@ typedef enum { # endif } virConnectDomainEventAgentLifecycleState; =20 +/** + * virConnectDomainEventAgentLifecycleReason: + * + * Since: v1.2.11 + * + */ typedef enum { VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN =3D 0, /* unkn= own state change reason (Since: v1.2.11) */ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED =3D 1, = /* state changed due to domain start (Since: v1.2.11) */ @@ -5438,6 +5957,9 @@ typedef void (*virConnectDomainEventMemoryDeviceSizeC= hangeCallback)(virConnectPt * An enumeration of supported eventId parameters for * virConnectDomainEventRegisterAny(). Each event id determines which * signature of callback function will be used. + * + * Since: v0.8.0 + * */ typedef enum { VIR_DOMAIN_EVENT_ID_LIFECYCLE =3D 0, /* virConnectDomainEventCal= lback (Since: v0.8.0) */ @@ -5494,9 +6016,10 @@ int virConnectDomainEventDeregisterAny(virConnectPtr= conn, =20 =20 /** - * virDomainConsoleFlags + * virDomainConsoleFlags: + * + * Since: v0.9.11 * - * Since 0.9.10 */ typedef enum { =20 @@ -5513,9 +6036,9 @@ int virDomainOpenConsole(virDomainPtr dom, unsigned int flags); =20 /** - * virDomainChannelFlags + * virDomainChannelFlags: * - * Since 1.0.2 + * Since: v1.0.2 */ typedef enum { VIR_DOMAIN_CHANNEL_FORCE =3D (1 << 0), /* abort a (possibly) active ch= annel @@ -5528,6 +6051,12 @@ int virDomainOpenChannel(virDomainPtr dom, virStreamPtr st, unsigned int flags); =20 +/** + * virDomainOpenGraphicsFlags: + * + * Since: v0.9.7 + * + */ typedef enum { VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH =3D (1 << 0), /* (Since: v0.9.7) */ } virDomainOpenGraphicsFlags; @@ -5563,9 +6092,20 @@ int virDomainFSThaw(virDomainPtr dom, * * The data structure containing mounted file systems within a guset * + * Since: v1.2.11 + * + * */ typedef struct _virDomainFSInfo virDomainFSInfo; + +/** + * virDomainFSInfoPtr: + * + * Since: v1.2.11 + * + */ typedef virDomainFSInfo *virDomainFSInfoPtr; + struct _virDomainFSInfo { char *mountpoint; /* path to mount point */ char *name; /* device name in the guest (e.g. "sda1") */ @@ -5584,7 +6124,12 @@ int virDomainGetTime(virDomainPtr dom, long long *seconds, unsigned int *nseconds, unsigned int flags); - +/** + * virDomainSetTimeFlags: + * + * Since: v1.2.5 + * + */ typedef enum { VIR_DOMAIN_TIME_SYNC =3D (1 << 0), /* Re-sync domain time from domain'= s RTC (Since: v1.2.5) */ } virDomainSetTimeFlags; @@ -5598,8 +6143,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.2.3 + * */ typedef enum { VIR_DOMAIN_SCHED_FIELD_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0.= 2.3) */ @@ -5637,7 +6184,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.9.2 + * Since: v0.2.3 * */ typedef struct _virTypedParameter virSchedParameter; @@ -5648,6 +6195,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: v0.2.3 + * */ typedef virSchedParameter *virSchedParameterPtr; =20 @@ -5655,8 +6205,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.0 + * */ typedef enum { VIR_DOMAIN_BLKIO_PARAM_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0.= 9.0) */ @@ -5694,7 +6246,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.9.2 + * Since: v0.9.0 * */ typedef struct _virTypedParameter virBlkioParameter; @@ -5704,7 +6256,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.0 + * */ typedef virBlkioParameter *virBlkioParameterPtr; =20 @@ -5712,8 +6267,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.8.5 + * */ typedef enum { VIR_DOMAIN_MEMORY_PARAM_INT =3D VIR_TYPED_PARAM_INT, /* (Since: v0= .8.5) */ @@ -5751,7 +6308,7 @@ typedef enum { * Provided for backwards compatibility; virTypedParameter is the * preferred alias. * - * Since: v0.9.2 + * Since: v0.8.5 * */ typedef struct _virTypedParameter virMemoryParameter; @@ -5761,10 +6318,19 @@ typedef struct _virTypedParameter virMemoryParamete= r; * * 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.8.5 + * */ typedef virMemoryParameter *virMemoryParameterPtr; =20 +/** + * virDomainInterfaceAddressesSource: + * + * Since: v1.2.14 + * + */ typedef enum { VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE =3D 0, /* Parse DHCP lease fi= le (Since: v1.2.14) */ VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT =3D 1, /* Query qemu guest ag= ent (Since: v1.2.14) */ @@ -5775,7 +6341,20 @@ typedef enum { # endif } virDomainInterfaceAddressesSource; =20 +/** + * virDomainIPAddress: + * + * Since: v1.2.14 + * + */ typedef struct _virDomainInterfaceIPAddress virDomainIPAddress; + +/** + * virDomainIPAddressPtr: + * + * Since: v1.2.14 + * + */ typedef virDomainIPAddress *virDomainIPAddressPtr; struct _virDomainInterfaceIPAddress { int type; /* virIPAddrType */ @@ -5783,7 +6362,20 @@ struct _virDomainInterfaceIPAddress { unsigned int prefix; /* IP address prefix */ }; =20 +/** + * virDomainInterface: + * + * Since: v1.2.14 + * + */ typedef struct _virDomainInterface virDomainInterface; + +/** + * virDomainInterfacePtr: + * + * Since: v1.2.14 + * + */ typedef virDomainInterface *virDomainInterfacePtr; struct _virDomainInterface { char *name; /* interface name */ @@ -5799,6 +6391,12 @@ int virDomainInterfaceAddresses(virDomainPtr dom, =20 void virDomainInterfaceFree(virDomainInterfacePtr iface); =20 +/** + * virDomainSetUserPasswordFlags: + * + * Since: v1.2.16 + * + */ typedef enum { VIR_DOMAIN_PASSWORD_ENCRYPTED =3D 1 << 0, /* the password is already e= ncrypted (Since: v1.2.16) */ } virDomainSetUserPasswordFlags; @@ -5832,6 +6430,12 @@ int virDomainSetBlockThreshold(virDomainPtr domain, unsigned long long threshold, unsigned int flags); =20 +/** + * virDomainLifecycle: + * + * Since: v3.9.0 + * + */ typedef enum { VIR_DOMAIN_LIFECYCLE_POWEROFF =3D 0, /* (Since: v3.9.0) */ VIR_DOMAIN_LIFECYCLE_REBOOT =3D 1, /* (Since: v3.9.0) */ @@ -5842,6 +6446,12 @@ typedef enum { # endif } virDomainLifecycle; =20 +/** + * virDomainLifecycleAction: + * + * Since: v3.9.0 + * + */ typedef enum { VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY =3D 0, /* (Since: v3.9.0) */ VIR_DOMAIN_LIFECYCLE_ACTION_RESTART =3D 1, /* (Since: v3.9.0) */ @@ -5969,6 +6579,12 @@ int virDomainSetLaunchSecurityState(virDomainPtr dom= ain, int nparams, unsigned int flags); =20 +/** + * virDomainGuestInfoTypes: + * + * Since: v5.7.0 + * + */ typedef enum { VIR_DOMAIN_GUEST_INFO_USERS =3D (1 << 0), /* return active users (Sinc= e: v5.7.0) */ VIR_DOMAIN_GUEST_INFO_OS =3D (1 << 1), /* return OS information (Since= : v5.7.0) */ @@ -5985,6 +6601,12 @@ int virDomainGetGuestInfo(virDomainPtr domain, int *nparams, unsigned int flags); =20 +/** + * virDomainAgentResponseTimeoutValues: + * + * Since: v5.10.0 + * + */ typedef enum { VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK =3D -2, /* (Since: v5.10.0) */ VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT =3D -1, /* (Since: v5.10.0) = */ @@ -5995,6 +6617,12 @@ int virDomainAgentSetResponseTimeout(virDomainPtr do= main, int timeout, unsigned int flags); =20 +/** + * virDomainBackupBeginFlags: + * + * Since: v6.0.0 + * + */ typedef enum { VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL =3D (1 << 0), /* reuse separate= ly provided images = (Since: v6.0.0) */ @@ -6013,6 +6641,12 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domai= n, char ***keys, unsigned int flags); =20 +/** + * virDomainAuthorizedSSHKeysSetFlags: + * + * Since: v6.10.0 + * + */ typedef enum { VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND =3D (1 << 0), /* don't trunc= ate file, just append (Since: v6.10.0) */ VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE =3D (1 << 1), /* remove keys= , instead of adding them (Since: v6.10.0) */ @@ -6025,6 +6659,12 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domai= n, unsigned int nkeys, unsigned int flags); =20 +/** + * virDomainMessageType: + * + * Since: v7.1.0 + * + */ typedef enum { VIR_DOMAIN_MESSAGE_DEPRECATION =3D (1 << 0), /* (Since: v7.1.0) */ VIR_DOMAIN_MESSAGE_TAINTING =3D (1 << 1), /* (Since: v7.1.0) */ @@ -6038,6 +6678,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 =3D 0, /* the dirtyrate calculation has @@ -6058,6 +6701,9 @@ typedef enum { * Flags OR'ed together to provide specific behaviour when calculating dir= ty page * rate for a Domain * + * + * Since: v8.1.0 + * */ typedef enum { VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING =3D 0, /* default mode = - page-sampling (Since: v8.1.0) */ diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-even= t.h index f86a55ecf6..fe2234913f 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 speci= fic * to libvirt. A client app must translate to, and from POLL events when u= sing * this construct. + * + * Since: v0.5.0 + * */ typedef enum { VIR_EVENT_HANDLE_READABLE =3D (1 << 0), /* (Since: v0.5.0) */ diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index de08dcc118..1996ea87c9 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: v0.0.1 + * */ typedef struct _virConnect virConnect; =20 @@ -41,6 +44,9 @@ typedef struct _virConnect virConnect; * * a virConnectPtr is pointer to a virConnect private structure, this is t= he * type used to reference a connection to the Hypervisor in the API. + * + * Since: v0.0.1 + * */ typedef virConnect *virConnectPtr; =20 @@ -49,6 +55,9 @@ typedef virConnect *virConnectPtr; * * Flags to indicate which system-wide sleep state the host must be * transitioned to. + * + * Since: v0.9.8 + * */ typedef enum { VIR_NODE_SUSPEND_TARGET_MEM =3D 0, /* (Since: v0.9.8) */ @@ -64,6 +73,9 @@ typedef enum { * virStream: * * a virStream is a private structure representing a data stream. + * + * Since: v0.7.2 + * */ typedef struct _virStream virStream; =20 @@ -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: v0.7.2 + * */ typedef virStream *virStreamPtr; =20 @@ -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: v0.6.1 + * */ typedef struct _virSecurityLabel virSecurityLabel; =20 @@ -104,6 +122,9 @@ struct _virSecurityLabel { * virSecurityLabelPtr: * * a virSecurityLabelPtr is a pointer to a virSecurityLabel. + * + * Since: v0.6.1 + * */ typedef virSecurityLabel *virSecurityLabelPtr; =20 @@ -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: v0.6.1 + * */ typedef struct _virSecurityModel virSecurityModel; =20 @@ -145,6 +169,9 @@ struct _virSecurityModel { * virSecurityModelPtr: * * a virSecurityModelPtr is a pointer to a virSecurityModel. + * + * Since: v0.6.1 + * */ typedef virSecurityModel *virSecurityModelPtr; =20 @@ -152,7 +179,7 @@ typedef virSecurityModel *virSecurityModelPtr; /* data types related to virNodePtr */ =20 /** - * 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: v0.1.0 */ - typedef struct _virNodeInfo virNodeInfo; =20 struct _virNodeInfo { @@ -192,9 +220,12 @@ struct _virNodeInfo { # define VIR_NODE_CPU_STATS_FIELD_LENGTH 80 =20 /** - * VIR_NODE_CPU_STATS_ALL_CPUS: + * virNodeGetCPUStatsAllCPUs: * * Value for specifying request for the total CPU time/utilization + * + * Since: v0.9.8 + * */ typedef enum { VIR_NODE_CPU_STATS_ALL_CPUS =3D -1, /* (Since: v0.9.3) */ @@ -272,6 +303,9 @@ typedef enum { * * a virNodeCPUStats is a structure filled by virNodeGetCPUStats() * providing information about the CPU stats of the node. + * + * Since: v0.9.3 + * */ typedef struct _virNodeCPUStats virNodeCPUStats; =20 @@ -291,9 +325,12 @@ struct _virNodeCPUStats { # define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80 =20 /** - * VIR_NODE_MEMORY_STATS_ALL_CELLS: + * virNodeGetMemoryStatsAllCells: * * Value for specifying request for the total memory of all cells. + * + * Since: v0.9.8 + * */ typedef enum { VIR_NODE_MEMORY_STATS_ALL_CELLS =3D -1, /* (Since: v0.9.3) */ @@ -349,6 +386,9 @@ typedef enum { * * a virNodeMemoryStats is a structure filled by virNodeGetMemoryStats() * providing information about the memory of the node. + * + * Since: v0.9.3 + * */ typedef struct _virNodeMemoryStats virNodeMemoryStats; =20 @@ -487,6 +527,9 @@ int virNodeGetCPUMap(virConnectPtr conn, * virNodeInfoPtr: * * a virNodeInfoPtr is a pointer to a virNodeInfo structure. + * + * Since: v0.1.0 + * */ =20 typedef virNodeInfo *virNodeInfoPtr; @@ -495,6 +538,9 @@ typedef virNodeInfo *virNodeInfoPtr; * virNodeCPUStatsPtr: * * a virNodeCPUStatsPtr is a pointer to a virNodeCPUStats structure. + * + * Since: v0.9.3 + * */ =20 typedef virNodeCPUStats *virNodeCPUStatsPtr; @@ -503,6 +549,9 @@ typedef virNodeCPUStats *virNodeCPUStatsPtr; * virNodeMemoryStatsPtr: * * a virNodeMemoryStatsPtr is a pointer to a virNodeMemoryStats structure. + * + * Since: v0.9.3 + * */ =20 typedef virNodeMemoryStats *virNodeMemoryStatsPtr; @@ -584,16 +633,24 @@ int virNodeGetSEVInfo (virConnectPtr conn, unsigned int flags); =20 /** - * virConnectFlags + * virConnectFlags: * * Flags when opening a connection to a hypervisor + * + * Since: v0.4.1 + * */ typedef enum { VIR_CONNECT_RO =3D (1 << 0), /* A readonly connection (Since:= v0.4.1) */ VIR_CONNECT_NO_ALIASES =3D (1 << 1), /* Don't try to resolve URI alia= ses (Since: v0.9.7) */ } virConnectFlags; =20 - +/** + * virConnectCredentialType: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_CRED_USERNAME =3D 1, /* Identity to act as (Since: v0.4.1) */ VIR_CRED_AUTHNAME =3D 2, /* Identify to authorize as (Since: v0.4.= 1) */ @@ -619,7 +676,20 @@ struct _virConnectCredential { unsigned int resultlen; /* Length of the result */ }; =20 +/** + * virConnectCredential: + * + * Since: v0.4.1 + * + */ typedef struct _virConnectCredential virConnectCredential; + +/** + * virConnectCredentialPtr: + * + * Since: v0.4.1 + * + */ typedef virConnectCredential *virConnectCredentialPtr; =20 =20 @@ -648,8 +718,20 @@ struct _virConnectAuth { void *cbdata; }; =20 - +/** + * virConnectAuth: + * + * Since: v0.4.1 + * + */ typedef struct _virConnectAuth virConnectAuth; + +/** + * virConnectAuthPtr: + * + * Since: v0.4.1 + * + */ typedef virConnectAuth *virConnectAuthPtr; =20 /* @@ -892,6 +974,12 @@ int virConnectIsAlive(virConnectPtr conn); * CPU specification API */ =20 +/** + * virCPUCompareResult: + * + * Since: v0.7.5 + * + */ typedef enum { VIR_CPU_COMPARE_ERROR =3D -1, /* (Since: v0.7.5) */ VIR_CPU_COMPARE_INCOMPATIBLE =3D 0, /* (Since: v0.7.5) */ @@ -903,6 +991,12 @@ typedef enum { # endif } virCPUCompareResult; =20 +/** + * virConnectCompareCPUFlags: + * + * Since: v1.2.6 + * + */ typedef enum { VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE =3D (1 << 0), /* treat incom= patible CPUs as failu= re (Since: v1.2.6) */ @@ -927,9 +1021,12 @@ int virConnectGetCPUModelNames(virConnectPtr conn, unsigned int flags); =20 /** - * virConnectBaselineCPUFlags + * virConnectBaselineCPUFlags: * * Flags when getting XML description of a computed CPU + * + * Since: v1.1.2 + * */ typedef enum { VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES =3D (1 << 0), /* show all f= eatures (Since: v1.1.2) */ @@ -957,7 +1054,12 @@ int virNodeGetFreePages(virConnectPtr conn, unsigned int cellcount, unsigned long long *counts, unsigned int flags); - +/** + * virNodeAllocPagesFlags: + * + * Since: v1.2.9 + * + */ typedef enum { VIR_NODE_ALLOC_PAGES_ADD =3D 0, /* Add @pageCounts to the pages pool. = This can be used only to size up the pool.= (Since: v1.2.9) */ diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-= interface.h index 64bcb08c94..b90bf67140 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: v0.6.4 + * */ typedef struct _virInterface virInterface; =20 @@ -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: v0.6.4 + * */ typedef virInterface *virInterfacePtr; =20 @@ -53,10 +59,13 @@ int virConnectNumOfDefinedInterface= s (virConnectPtr conn); int virConnectListDefinedInterfaces (virConnectPtr co= nn, char **const nam= es, int maxnames); -/* - * virConnectListAllInterfaces: +/** + * virConnectListAllInterfacesFlags: * * Flags used to filter the returned interfaces. + * + * Since: v0.10.2 + * */ typedef enum { VIR_CONNECT_LIST_INTERFACES_INACTIVE =3D 1 << 0, /* (Since: v0.10= .2) */ @@ -75,10 +84,22 @@ virInterfacePtr virInterfaceLookupByMACString (= virConnectPtr conn, const char* virInterfaceGetName (virInterfacePtr iface); const char* virInterfaceGetMACString (virInterfacePtr iface); =20 +/** + * virInterfaceXMLFlags: + * + * Since: v0.7.3 + * + */ typedef enum { VIR_INTERFACE_XML_INACTIVE =3D 1 << 0 /* dump inactive interface infor= mation (Since: v0.7.3) */ } virInterfaceXMLFlags; =20 +/** + * virInterfaceDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_INTERFACE_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document= against schema (Since: v7.7.0) */ } virInterfaceDefineFlags; diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-ne= twork.h index 161c61de28..d735611437 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -27,6 +27,12 @@ # error "Don't include this file directly, only use libvirt/libvirt.h" # endif =20 +/** + * virNetworkXMLFlags: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_NETWORK_XML_INACTIVE =3D (1 << 0), /* dump inactive network inform= ation (Since: v0.9.10) */ } virNetworkXMLFlags; @@ -35,6 +41,9 @@ typedef enum { * virNetwork: * * a virNetwork is a private structure representing a virtual network. + * + * Since: v0.2.0 + * */ typedef struct _virNetwork virNetwork; =20 @@ -43,6 +52,9 @@ typedef struct _virNetwork virNetwork; * * a virNetworkPtr is pointer to a virNetwork private structure, this is t= he * type used to reference a virtual network in the API. + * + * Since: v0.2.0 + * */ typedef virNetwork *virNetworkPtr; =20 @@ -51,6 +63,9 @@ typedef virNetwork *virNetworkPtr; * * a virNetworkPort is a private structure representing a virtual network * port + * + * Since: v5.5.0 + * */ typedef struct _virNetworkPort virNetworkPort; =20 @@ -59,6 +74,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; =20 @@ -82,11 +100,14 @@ int virConnectNumOfDefinedNetworks= (virConnectPtr conn); int virConnectListDefinedNetworks (virConnectPtr con= n, char **const name= s, int maxnames); -/* - * virConnectListAllNetworks: +/** + * virConnectListAllNetworksFlags: * * Flags used to filter the returned networks. Flags in each group * are exclusive attributes of a network. + * + * Since: v0.10.2 + * */ typedef enum { VIR_CONNECT_LIST_NETWORKS_INACTIVE =3D 1 << 0, /* (Since: v0.10.2= ) */ @@ -112,7 +133,12 @@ virNetworkPtr virNetworkLookupByUUID = (virConnectPtr conn, const unsigned ch= ar *uuid); virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr con= n, const char *uuid); - +/** + * virNetworkCreateFlags: + * + * Since: v7.8.0 + * + */ typedef enum { VIR_NETWORK_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.8.0) */ } virNetworkCreateFlags; @@ -125,7 +151,12 @@ virNetworkPtr virNetworkCreateXML (virCo= nnectPtr conn, virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags); - +/** + * virNetworkDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_NETWORK_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.7.0) */ } virNetworkDefineFlags; @@ -150,6 +181,8 @@ int virNetworkUndefine (virNet= workPtr network); * describes which type of update to perform on a <network> * definition. * + * Since: v0.10.2 + * */ typedef enum { VIR_NETWORK_UPDATE_COMMAND_NONE =3D 0, /* (invalid (Since: v0.10.= 2) */ @@ -168,6 +201,8 @@ typedef enum { * describes which section of a <network> definition the provided * xml should be applied to. * + * Since: v0.10.2 + * */ typedef enum { VIR_NETWORK_SECTION_NONE =3D 0, /* (invalid (Since: v0.1= 0.2) */ @@ -192,6 +227,9 @@ typedef enum { * virNetworkUpdateFlags: * * Flags to control options for virNetworkUpdate() + * + * Since: v0.10.2 + * */ typedef enum { VIR_NETWORK_UPDATE_AFFECT_CURRENT =3D 0, /* affect live if networ= k is active, @@ -246,6 +284,9 @@ int virNetworkIsPersistent(virNetworkPtr net); * virNetworkEventLifecycleType: * * a virNetworkEventLifecycleType is emitted during network lifecycle even= ts + * + * Since: v1.2.1 + * */ typedef enum { VIR_NETWORK_EVENT_DEFINED =3D 0, /* (Since: v1.2.1) */ @@ -295,6 +336,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 =3D 0, /* virConnectNetworkEventL= ifecycleCallback (Since: v1.2.1) */ @@ -311,6 +355,12 @@ typedef enum { # endif } virNetworkEventID; =20 +/** + * virIPAddrType: + * + * Since: v1.2.6 + * + */ typedef enum { VIR_IP_ADDR_TYPE_IPV4, /* (Since: v1.2.6) */ VIR_IP_ADDR_TYPE_IPV6, /* (Since: v1.2.6) */ @@ -320,7 +370,20 @@ typedef enum { # endif } virIPAddrType; =20 +/** + * virNetworkDHCPLease: + * + * Since: v1.2.6 + * + */ typedef struct _virNetworkDHCPLease virNetworkDHCPLease; + +/** + * virNetworkDHCPLeasePtr: + * + * Since: v1.2.6 + * + */ typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr; struct _virNetworkDHCPLease { char *iface; /* Network interface name */ @@ -377,6 +440,12 @@ virNetworkPortPtr virNetworkPortLookupByUUIDString(virNetworkPtr net, const char *uuidstr); =20 +/** + * virNetworkPortCreateFlags: + * + * Since: v5.5.0 + * + */ typedef enum { VIR_NETWORK_PORT_CREATE_RECLAIM =3D (1 << 0), /* reclaim existing used= resources (Since: v5.5.0) */ VIR_NETWORK_PORT_CREATE_VALIDATE =3D (1 << 1), /* Validate the XML doc= ument against schema (Since: v7.8.0) */ diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 8fdded2f34..1bec57fca4 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: v0.5.0 + * */ =20 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: v0.5.0 + * */ =20 typedef virNodeDevice *virNodeDevicePtr; @@ -57,11 +63,15 @@ int virNodeListDevices (virCon= nectPtr 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: v0.10.2 + * + */ typedef enum { VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM =3D 1 << 0, /* System= capability (Since: v0.10.2) */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV =3D 1 << 1, /* PCI de= vice (Since: v0.10.2) */ @@ -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 =3D 0, /* virConnectNodeDeviceEvent= LifecycleCallback (Since: v2.2.0) */ @@ -217,6 +230,9 @@ int virConnectNodeDeviceEventDeregisterAny(virConnectPt= r conn, * * a virNodeDeviceEventLifecycleType is emitted during node device * lifecycle events + * + * Since: v2.2.0 + * */ typedef enum { VIR_NODE_DEVICE_EVENT_CREATED =3D 0, /* (Since: v2.2.0) */ diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-n= wfilter.h index aa8872e156..18008426c2 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: v0.8.0 + * */ typedef struct _virNWFilter virNWFilter; =20 @@ -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: v0.8.0 + * */ typedef virNWFilter *virNWFilterPtr; =20 @@ -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; =20 @@ -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; =20 @@ -79,7 +91,12 @@ virNWFilterPtr virNWFilterLookupByUUID (v= irConnectPtr conn, const unsigned char= *uuid); virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn, const char *uuid); - +/** + * virNWFilterDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_NWFILTER_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document = against schema (Since: v7.7.0) */ } virNWFilterDefineFlags; @@ -108,6 +125,12 @@ int virNWFilterFree (virNW= FilterPtr nwfilter); * NWFilter information */ =20 +/** + * virNWFilterBindingCreateFlags: + * + * Since: v7.8.0 + * + */ typedef enum { VIR_NWFILTER_BINDING_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML d= ocument against schema (Since: v7.8.0) */ } virNWFilterBindingCreateFlags; diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-sec= ret.h index cee27155a3..92fd03f726 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -33,10 +33,26 @@ * * A virSecret stores a secret value (e.g. a passphrase or encryption key) * and associated metadata. + * + * Since: v0.7.1 + * */ typedef struct _virSecret virSecret; + +/** + * virSecretPtr: + * + * Since: v0.7.1 + * + */ typedef virSecret *virSecretPtr; =20 +/** + * virSecretUsageType: + * + * Since: v0.7.1 + * + */ typedef enum { VIR_SECRET_USAGE_TYPE_NONE =3D 0, /* (Since: v0.7.1) */ VIR_SECRET_USAGE_TYPE_VOLUME =3D 1, /* (Since: v0.7.1) */ @@ -63,11 +79,14 @@ int virConnectListSecrets (virCon= nectPtr conn, char **uuids, int maxuuids); =20 -/* - * virConnectListAllSecrets: +/** + * virConnectListAllSecretsFlags: * * Flags used to filter the returned secrets. Flags in each group * are exclusive attributes of a secret. + * + * Since: v0.10.2 + * */ typedef enum { VIR_CONNECT_LIST_SECRETS_EPHEMERAL =3D 1 << 0, /* kept in memory, n= ever @@ -90,7 +109,12 @@ virSecretPtr virSecretLookupByUUIDString(vir= ConnectPtr conn, virSecretPtr virSecretLookupByUsage(virConnectPtr conn, int usageType, const char *usageID); - +/** + * virSecretDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_SECRET_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document ag= ainst schema (Since: v7.7.0) */ } virSecretDefineFlags; @@ -134,6 +158,9 @@ int virSecretFree (virSec= retPtr 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 =3D 0, /* virConnectSecretEventLifecycle= Callback (Since: v3.0.0) */ @@ -183,6 +210,9 @@ int virConnectSecretEventDeregisterAny(virConnectPtr co= nn, * * a virSecretEventLifecycleType is emitted during secret * lifecycle events + * + * Since: v3.0.0 + * */ typedef enum { VIR_SECRET_EVENT_DEFINED =3D 0, /* (Since: v3.0.0) */ diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 9bd437bf66..0b27d5d99f 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: v0.4.1 + * */ typedef struct _virStoragePool virStoragePool; =20 @@ -40,10 +43,19 @@ typedef struct _virStoragePool virStoragePool; * * a virStoragePoolPtr is pointer to a virStoragePool private structure, t= his is the * type used to reference a storage pool in the API. + * + * Since: v0.4.1 + * */ typedef virStoragePool *virStoragePoolPtr; =20 =20 +/** + * virStoragePoolState: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_STORAGE_POOL_INACTIVE =3D 0, /* Not running (Since: v0.4.1) */ VIR_STORAGE_POOL_BUILDING =3D 1, /* Initializing pool, not available (= Since: v0.4.1) */ @@ -56,6 +68,12 @@ typedef enum { # endif } virStoragePoolState; =20 +/** + * virStoragePoolBuildFlags: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_STORAGE_POOL_BUILD_NEW =3D 0, /* Regular build from scratch (Si= nce: v0.4.1) */ VIR_STORAGE_POOL_BUILD_REPAIR =3D (1 << 0), /* Repair / reinitialize (= Since: v0.4.1) */ @@ -64,11 +82,23 @@ typedef enum { VIR_STORAGE_POOL_BUILD_OVERWRITE =3D (1 << 3), /* Overwrite data (Sin= ce: v0.9.5) */ } virStoragePoolBuildFlags; =20 +/** + * virStoragePoolDeleteFlags: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_STORAGE_POOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast= ) (Since: v0.4.1) */ VIR_STORAGE_POOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros= (slow) (Since: v0.4.1) */ } virStoragePoolDeleteFlags; =20 +/** + * 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 =3D 0, @@ -93,6 +123,12 @@ typedef enum { VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE =3D 1 << 2, } virStoragePoolCreateFlags; =20 +/** + * virStoragePoolInfo: + * + * Since: v0.4.1 + * + */ typedef struct _virStoragePoolInfo virStoragePoolInfo; =20 struct _virStoragePoolInfo { @@ -102,6 +138,12 @@ struct _virStoragePoolInfo { unsigned long long available; /* Remaining free space bytes */ }; =20 +/** + * virStoragePoolInfoPtr: + * + * Since: v0.4.1 + * + */ typedef virStoragePoolInfo *virStoragePoolInfoPtr; =20 =20 @@ -109,6 +151,9 @@ typedef virStoragePoolInfo *virStoragePoolInfoPtr; * virStorageVol: * * a virStorageVol is a private structure representing a storage volume + * + * Since: v0.4.1 + * */ typedef struct _virStorageVol virStorageVol; =20 @@ -117,10 +162,19 @@ typedef struct _virStorageVol virStorageVol; * * a virStorageVolPtr is pointer to a virStorageVol private structure, thi= s is the * type used to reference a storage volume in the API. + * + * Since: v0.4.1 + * */ typedef virStorageVol *virStorageVolPtr; =20 =20 +/** + * virStorageVolType: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_STORAGE_VOL_FILE =3D 0, /* Regular file based volumes (Since: = v0.4.1) */ VIR_STORAGE_VOL_BLOCK =3D 1, /* Block based volumes (Since: v0.4.1)= */ @@ -135,12 +189,24 @@ typedef enum { # endif } virStorageVolType; =20 +/** + * virStorageVolDeleteFlags: + * + * Since: v0.4.1 + * + */ typedef enum { VIR_STORAGE_VOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast)= (Since: v0.4.1) */ VIR_STORAGE_VOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros = (slow) (Since: v0.4.1) */ VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS =3D 1 << 1, /* Force removal of = volume, even if in use (Since: v1.2.21) */ } virStorageVolDeleteFlags; =20 +/** + * virStorageVolWipeAlgorithm: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_STORAGE_VOL_WIPE_ALG_ZERO =3D 0, /* 1-pass, all zeroes (Since: v0.= 9.10) */ VIR_STORAGE_VOL_WIPE_ALG_NNSA =3D 1, /* 4-pass NNSA Policy Letter @@ -175,6 +241,12 @@ typedef enum { # endif } virStorageVolWipeAlgorithm; =20 +/** + * virStorageVolInfoFlags: + * + * Since: v3.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_USE_ALLOCATION =3D 0, =20 @@ -183,6 +255,12 @@ typedef enum { =20 } virStorageVolInfoFlags; =20 +/** + * virStorageVolInfo: + * + * Since: v0.4.1 + * + */ typedef struct _virStorageVolInfo virStorageVolInfo; =20 struct _virStorageVolInfo { @@ -191,8 +269,21 @@ struct _virStorageVolInfo { unsigned long long allocation; /* Current allocation bytes */ }; =20 + +/** + * virStorageVolInfoPtr: + * + * Since: v0.4.1 + * + */ typedef virStorageVolInfo *virStorageVolInfoPtr; =20 +/** + * virStorageXMLFlags: + * + * Since: v0.9.13 + * + */ typedef enum { VIR_STORAGE_XML_INACTIVE =3D (1 << 0), /* dump inactive pool/volume= information (Since: v0.9.13) */ } virStorageXMLFlags; @@ -228,6 +319,9 @@ int virConnectListDefinedStoragePoo= ls(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 =3D 1 << 0, @@ -279,7 +373,12 @@ virStoragePoolPtr virStoragePoolLookupByUUIDStri= ng(virConnectPtr conn, virStoragePoolPtr virStoragePoolLookupByVolume (virStorageVolPtr = vol); virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr con= n, const char *path); - +/** + * virStoragePoolDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_STORAGE_POOL_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML docum= ent against schema (Since: v7.7.0) */ } virStoragePoolDefineFlags; @@ -353,6 +452,12 @@ virStorageVolPtr virStorageVolLookupByPath = (virConnectPtr conn, const char* virStorageVolGetName (virStorageVolPtr = vol); const char* virStorageVolGetKey (virStorageVolPtr = vol); =20 +/** + * virStorageVolCreateFlags: + * + * Since: v1.0.1 + * + */ typedef enum { VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA =3D 1 << 0, /* (Since: v1.0.1= ) */ VIR_STORAGE_VOL_CREATE_REFLINK =3D 1 << 1, /* perform a btrfs lightwei= ght copy (Since: v1.2.13) */ @@ -365,7 +470,12 @@ virStorageVolPtr virStorageVolCreateXMLFrom = (virStoragePoolPtr pool, const char *xmlde= sc, virStorageVolPtr = clonevol, unsigned int flag= s); - +/** + * virStorageVolDownloadFlags: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse strea= m (Since: v3.4.0) */ } virStorageVolDownloadFlags; @@ -375,6 +485,13 @@ int virStorageVolDownload = (virStorageVolPtr vol, unsigned long lon= g offset, unsigned long lon= g length, unsigned int flag= s); + +/** + * virStorageVolUploadFlags: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse stream= (Since: v3.4.0) */ } virStorageVolUploadFlags; @@ -404,6 +521,12 @@ char * virStorageVolGetXMLDesc = (virStorageVolPtr pool, =20 char * virStorageVolGetPath (virStorageVolPtr = vol); =20 +/** + * virStorageVolResizeFlags: + * + * Since: v0.9.10 + * + */ typedef enum { VIR_STORAGE_VOL_RESIZE_ALLOCATE =3D 1 << 0, /* force allocation of new= size (Since: v0.9.10) */ VIR_STORAGE_VOL_RESIZE_DELTA =3D 1 << 1, /* size is relative to cur= rent (Since: v0.9.10) */ @@ -434,6 +557,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 =3D 0, /* virConnectStoragePoolEve= ntLifecycleCallback (Since: v2.0.0) */ @@ -483,6 +609,9 @@ int virConnectStoragePoolEventDeregisterAny(virConnectP= tr conn, * * a virStoragePoolEventLifecycleType is emitted during storage pool * lifecycle events + * + * Since: v2.0.0 + * */ typedef enum { VIR_STORAGE_POOL_EVENT_DEFINED =3D 0, /* (Since: v2.0.0) */ diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-str= eam.h index d69131030b..caf6779cd6 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -28,6 +28,12 @@ # endif =20 =20 +/** + * virStreamFlags: + * + * Since: v0.7.2 + * + */ typedef enum { VIR_STREAM_NONBLOCK =3D (1 << 0), /* (Since: v0.7.2) */ } virStreamFlags; @@ -44,6 +50,12 @@ int virStreamRecv(virStreamPtr st, char *data, size_t nbytes); =20 +/** + * virStreamRecvFlagsValues: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STREAM_RECV_STOP_AT_HOLE =3D (1 << 0), /* (Since: v3.4.0) */ } virStreamRecvFlagsValues; @@ -229,6 +241,12 @@ int virStreamSparseRecvAll(virStreamPtr stream, virStreamSinkHoleFunc holeHandler, void *opaque); =20 +/** + * virStreamEventType: + * + * Since: v0.7.2 + * + */ typedef enum { VIR_STREAM_EVENT_READABLE =3D (1 << 0), /* (Since: v0.7.2) */ VIR_STREAM_EVENT_WRITABLE =3D (1 << 1), /* (Since: v0.7.2) */ diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 3c1b27a36f..6d15c12358 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: v0.1.0 + * */ typedef enum { VIR_ERR_NONE =3D 0, /* (Since: v0.1.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: v0.1.0 + * */ typedef enum { VIR_FROM_NONE =3D 0, /* (Since: v0.1.0) */ @@ -152,9 +158,19 @@ 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: v0.1.0 + * */ =20 typedef struct _virError virError; + +/** + * virErrorPtr: + * + * Since: v0.1.0 + * + */ typedef virError *virErrorPtr; struct _virError { int code; /* The error code, a virErrorNumber */ @@ -205,6 +221,9 @@ struct _virError { * break; * default: * } + * + * Since: v0.1.0 + * */ typedef enum { VIR_ERR_OK =3D 0, /* (Since: v0.1.0) */ --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481728; cv=none; d=zohomail.com; s=zohoarc; b=illviHD1qj7Wqmaf+G0zuGLIYmXrxCCb4VE2LAvkAwphISDSvFI7Rl1hju5vWEzBgRqkOe8HG6tE6bvOTfY3vdAhx0DnyW96HiIe+AqgKVXBIYa7g94nWf6Ry3DTbqsZS6PCcs1LU61GmT36BkwmRlISWcA5kCHFYkQlmw0bfSo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481728; 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=ArZml5eu6eEOCAugSO/ewIsh05rgNowwMpmzYxlZsD4=; b=mCDGq+/COzqHee2NQDakMRpryPXZQBSkMrq4TBhAocBiU6ulSl37pdqHMD793bZoR1hnuVJJFjfIXKBjGbuSet5ElcuHGTbsZq6H/dA9PdkqMhxDiNLz/j+o0Gg56B9u4K9FD+GtVROKkw57UGneN2zWKKBNEkBk/mPqE9Bft4g= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481728801858.5945225839621; Wed, 20 Apr 2022 12:08:48 -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-297--X9skEJDMrSN9pyQdPJabw-1; Wed, 20 Apr 2022 15:08:43 -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 B5CF886B8A5; Wed, 20 Apr 2022 19:08:37 +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 A36F7572353; Wed, 20 Apr 2022 19:08:37 +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 2A19A1940351; Wed, 20 Apr 2022 19:08:37 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 6AC471940352 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:33 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 3978B551E8A; Wed, 20 Apr 2022 19:08:33 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id A5287551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481727; 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=ArZml5eu6eEOCAugSO/ewIsh05rgNowwMpmzYxlZsD4=; b=gMmppoStfJa+wLx2YJRTcXJad8iwBaFbcjcF2M+CQbAyd1wIKB7Uar2ty2AY3c7exNO4C6 zAYcklTVIAJF/teg8UDD8Z2PD9ZAzkexKxZbQzozqIlalCujf3JOhYyhjEtMRnINyFYYWr gETGmUqDilI4cVWzZVpC7jnEB3bvzxQ= X-MC-Unique: -X9skEJDMrSN9pyQdPJabw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 11/30] docstring: typedef: qemu:: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:00 +0200 Message-Id: <20220420190819.3093205-12-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> 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: 1650481732178100003 Content-Type: text/plain; charset="utf-8" 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@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- include/libvirt/libvirt-qemu.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index a2569a9fbd..9697b54158 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -30,6 +30,12 @@ extern "C" { # endif =20 +/** + * virDomainQemuMonitorCommandFlags: + * + * Since: v0.8.8 + * + */ typedef enum { VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT =3D 0, /* (Since: v0.8.8) */ VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP =3D (1 << 0), /* cmd is in HMP= (Since: v0.8.8) */ @@ -50,6 +56,12 @@ virDomainPtr virDomainQemuAttach(virConnectPtr domain, unsigned int pid_value, unsigned int flags); =20 +/** + * virDomainQemuAgentCommandTimeoutValues: + * + * Since: v0.10.0 + * + */ typedef enum { VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN =3D VIR_DOMAIN_AGENT_RESPONSE_TIMEOU= T_BLOCK, /* (Since: v0.10.0) */ VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK =3D VIR_DOMAIN_AGENT_RESPONSE_TIME= OUT_BLOCK, /* (Since: v0.10.0) */ @@ -84,6 +96,12 @@ typedef void (*virConnectDomainQemuMonitorEventCallback)= (virConnectPtr conn, void *opaque); =20 =20 +/** + * virConnectDomainQemuMonitorEventRegisterFlags: + * + * Since: v1.2.3 + * + */ typedef enum { /* Event filter is a regex rather than a literal string (Since: v1.2.3= ) */ VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX =3D (1 << 0), --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481750; cv=none; d=zohomail.com; s=zohoarc; b=UhyVRDMGTK/gf5Hk/ZBPOMJs2TKhCzcx1tb+LV2egdZhE0F+q1iiJYIMxS+Rm6f2ea480ubq7esSss7tc1873DitE8Q2dGgsPtXwnezMJ1v8Xt/+IvOD3/56UinkKjTiCvJuW4VlwBGOg4CBsfmyeWp15cw8GX1PCZPkxJRTBTM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481750; 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=jhA3OC+iRq8vo2nyUyHebIA51qNjubAqbRATF/lX4bA=; b=OY4ouTUspo2yhIa2f0FDvXYCLdMHSP+rQsSiVz2PkyLIzrM0WxOrUqN5hI9SojxVgkLlGv6c2PXhVPXpHhgQNEmPBQR4titimgUimFak4g2LmR70Yzug5ZPCtxVuqAdUs+kJWrn0y5QRF7E8ORDMpKMKSy1GGjnVjwlHnT+kIjE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481750592968.277366381503; Wed, 20 Apr 2022 12:09:10 -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-557-TdOq1MpCP16fmn5G1m_pWg-1; Wed, 20 Apr 2022 15:08:47 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 9A28A8041B1; Wed, 20 Apr 2022 19:08:40 +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 4F8A6145BA64; Wed, 20 Apr 2022 19:08:40 +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 0FDBE194035A; Wed, 20 Apr 2022 19:08:40 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 5E05A1940351 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:34 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 35836551E89; Wed, 20 Apr 2022 19:08:34 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 92658551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481749; 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=jhA3OC+iRq8vo2nyUyHebIA51qNjubAqbRATF/lX4bA=; b=BNLhwCq3c76IlCInRQ620cJYmV3IrPszveytcESvjL+1mEX4OYKGC7tgdxM/TtGL9QjOyx BxPYkt/GfP/rMvZvnyOnRZ0Z55TKcW7N7moZ78YtLXNhnA2Q4LgZ0kRjDoUz0p6Qd/xgMv cacrvgETQ2HTQvvDkzD332QbVKk9MmU= X-MC-Unique: TdOq1MpCP16fmn5G1m_pWg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 12/30] docstring: typedef: admin:: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:01 +0200 Message-Id: <20220420190819.3093205-13-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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: 1650481752132100025 Content-Type: text/plain; charset="utf-8" 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@redhat.com> --- include/libvirt/libvirt-admin.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index defca505f8..c73cf6e7da 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -37,6 +37,9 @@ extern "C" { * * a virAdmConnect is a private structure representing a connection to * libvirt daemon. + * + * Since: v1.2.17 + * */ typedef struct _virAdmConnect virAdmConnect; =20 @@ -45,6 +48,9 @@ typedef struct _virAdmConnect virAdmConnect; * * a virAdmServer is a private structure and client-side representation of * a remote server object + * + * Since: v1.3.2 + * */ typedef struct _virAdmServer virAdmServer; =20 @@ -53,6 +59,9 @@ 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: v1.3.5 + * */ typedef struct _virAdmClient virAdmClient; =20 @@ -62,6 +71,9 @@ 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: v1.2.17 + * */ typedef virAdmConnect *virAdmConnectPtr; =20 @@ -71,6 +83,9 @@ 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: v1.3.2 + * */ typedef virAdmServer *virAdmServerPtr; =20 @@ -80,6 +95,9 @@ 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: v1.3.5 + * */ typedef virAdmClient *virAdmClientPtr; =20 @@ -222,6 +240,12 @@ long long virAdmClientGetTimestamp(virAdmClientPtr cli= ent); int virAdmClientGetTransport(virAdmClientPtr client); int virAdmClientFree(virAdmClientPtr client); =20 +/** + * virClientTransport: + * + * Since: v1.3.5 + * + */ typedef enum { VIR_CLIENT_TRANS_UNIX =3D 0, /* connection via UNIX socket (Since: v1.= 3.5) */ VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (S= ince: v1.3.5) */ --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481735; cv=none; d=zohomail.com; s=zohoarc; b=c3Hz9fQM12ns5jvwCoAhxbMMwwXkLWbUkYrV547/d5V7rOzZxpgSR20s+uZgk20fSRgMk2PrcJ8uJtVzRV+2e1UIM7Y3g8qgNoDsvcUzgImOs15HrfZHWSgUU+7m98U/Q5o6RgkV1IjhkiH8dALQAwrKWlqpP6R1goUxVxETVE8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481735; 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=jw7JH6PuU6men34lufssGiutbwb3oJk/b36CUE1P8G0=; b=NfgOP9JbPIcC8Va+D/efBNQ9yG5i1djJXP4p6k30Yiovuyufu6eqIYVRNST9dPnhz2TqqNTR8lBT0vzB5sBLK9D8kFVlQyv1FTeYfvZ0vSfNjoNcuJnKCR6oreC7jbxsnctKw0J00IpLS8Ny20G5S1VTedBIcGDDwQ3Aj4KMgtI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481735277824.6375516638302; Wed, 20 Apr 2022 12:08:55 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-589-kg0PSOHFNC25T8-4JDx8aA-1; Wed, 20 Apr 2022 15:08:50 -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 7D9DB3C0F093; Wed, 20 Apr 2022 19:08:41 +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 5A554572353; Wed, 20 Apr 2022 19:08:41 +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 AF7C61940367; Wed, 20 Apr 2022 19:08:40 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C79DC1940351 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:35 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id A15F1551E86; Wed, 20 Apr 2022 19:08:35 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 98295551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481733; 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=jw7JH6PuU6men34lufssGiutbwb3oJk/b36CUE1P8G0=; b=TmiMOrR+OdAS3cIX+isdHlgLO0+TjaHlfEELhtfx9+6ak9YQC3k+PGBUmqxtXLRNe3eDpl PlAScRCidplzJZ7J/+O7zum+BqgcgRbLWIo4D7+G4IxeWxO1SC5PnxP7PvaLo3deyYZc0p qFCpn1x5tVFjmIfWQ/usshcYcuXX+Vo= X-MC-Unique: kg0PSOHFNC25T8-4JDx8aA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 13/30] docstring: function: libvirt: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:02 +0200 Message-Id: <20220420190819.3093205-14-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> 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: 1650481736163100001 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 <victortoso@redhat.com> --- include/libvirt/libvirt-domain.h | 75 ++++ include/libvirt/libvirt-event.h | 24 ++ include/libvirt/libvirt-host.h | 6 + include/libvirt/libvirt-network.h | 6 + include/libvirt/libvirt-nodedev.h | 6 + include/libvirt/libvirt-secret.h | 6 + include/libvirt/libvirt-storage.h | 6 + include/libvirt/libvirt-stream.h | 18 + include/libvirt/virterror.h | 3 + src/libvirt-domain-checkpoint.c | 36 ++ src/libvirt-domain-snapshot.c | 63 ++++ src/libvirt-domain.c | 557 +++++++++++++++++++++++++++++- src/libvirt-host.c | 102 ++++++ src/libvirt-interface.c | 63 ++++ src/libvirt-network.c | 135 ++++++++ src/libvirt-nodedev.c | 81 +++++ src/libvirt-nwfilter.c | 72 ++++ src/libvirt-secret.c | 60 ++++ src/libvirt-storage.c | 171 +++++++++ src/libvirt-stream.c | 51 +++ src/libvirt.c | 18 + src/util/virerror.c | 45 +++ src/util/virevent.c | 27 ++ 23 files changed, 1630 insertions(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 5654a50c7e..9199cc9ad3 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -4215,6 +4215,9 @@ typedef enum { * A callback function to be registered, and called when a domain event oc= curs * * Returns 0 (the return value is currently ignored) + * + * Since: v0.5.0 + * */ typedef int (*virConnectDomainEventCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4801,6 +4804,9 @@ typedef enum { * have a customization with extra parameters, often with @opaque being * passed in a different parameter position; use VIR_DOMAIN_EVENT_CALLBACK= () * when registering an appropriate handler. + * + * Since: v0.8.0 + * */ typedef void (*virConnectDomainEventGenericCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4815,6 +4821,9 @@ 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 + * */ typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4853,6 +4862,9 @@ 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 + * + * */ typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4889,6 +4901,9 @@ 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 + * */ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn, virDomainPtr dom, @@ -4916,6 +4931,9 @@ 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 + * + * */ typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr c= onn, virDomainPtr do= m, @@ -5069,6 +5087,9 @@ typedef virDomainEventGraphicsSubject *virDomainEvent= GraphicsSubjectPtr; * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_GRAPHICS with virConnectDomainEventRegisterAny() + * + * Since: v0.8.0 + * */ typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5122,6 +5143,9 @@ typedef enum { * was registered using the newer type of VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2, * then @disk will contain the device target shorthand (the <target * dev=3D'...'/> sub-element, such as "vda"). + * + * Since: v0.9.4 + * */ typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5176,6 +5200,9 @@ 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 + * */ typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5214,6 +5241,9 @@ 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 + * */ typedef void (*virConnectDomainEventTrayChangeCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5233,6 +5263,9 @@ typedef void (*virConnectDomainEventTrayChangeCallbac= k)(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 + * */ typedef void (*virConnectDomainEventPMWakeupCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5251,6 +5284,9 @@ 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 + * */ typedef void (*virConnectDomainEventPMSuspendCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5267,6 +5303,9 @@ typedef void (*virConnectDomainEventPMSuspendCallback= )(virConnectPtr conn, * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE with virConnectDomainEventRegisterAn= y() + * + * Since: v0.10.0 + * */ typedef void (*virConnectDomainEventBalloonChangeCallback)(virConnectPtr c= onn, virDomainPtr do= m, @@ -5285,6 +5324,9 @@ typedef void (*virConnectDomainEventBalloonChangeCall= back)(virConnectPtr conn, * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK with virConnectDomainEventRegisterAn= y() + * + * Since: v1.0.0 + * */ typedef void (*virConnectDomainEventPMSuspendDiskCallback)(virConnectPtr c= onn, virDomainPtr do= m, @@ -5302,6 +5344,9 @@ typedef void (*virConnectDomainEventPMSuspendDiskCall= back)(virConnectPtr conn, * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED with virConnectDomainEventRegisterAn= y() + * + * Since: v1.1.1 + * */ typedef void (*virConnectDomainEventDeviceRemovedCallback)(virConnectPtr c= onn, virDomainPtr do= m, @@ -5319,6 +5364,9 @@ typedef void (*virConnectDomainEventDeviceRemovedCall= back)(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 + * */ typedef void (*virConnectDomainEventDeviceAddedCallback)(virConnectPtr con= n, virDomainPtr dom, @@ -5338,6 +5386,9 @@ typedef void (*virConnectDomainEventDeviceAddedCallba= ck)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED with * virConnectDomainEventRegisterAny(). + * + * Since: v1.3.4 + * */ typedef void (*virConnectDomainEventDeviceRemovalFailedCallback)(virConnec= tPtr conn, virDomain= Ptr dom, @@ -5356,6 +5407,9 @@ typedef void (*virConnectDomainEventDeviceRemovalFail= edCallback)(virConnectPtr c * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_METADATA_CHANGE with virConnectDomainEventRegisterA= ny(). + * + * Since: v3.0.0 + * */ typedef void (*virConnectDomainEventMetadataChangeCallback)(virConnectPtr = conn, virDomainPtr d= om, @@ -5379,6 +5433,9 @@ typedef void (*virConnectDomainEventMetadataChangeCal= lback)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION with * virConnectDomainEventRegisterAny(). + * + * Since: v1.3.2 + * */ typedef void (*virConnectDomainEventMigrationIterationCallback)(virConnect= Ptr conn, virDomainP= tr dom, @@ -5403,6 +5460,9 @@ typedef void (*virConnectDomainEventMigrationIteratio= nCallback)(virConnectPtr co * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_JOB_COMPLETED with * virConnectDomainEventRegisterAny(). + * + * Since: v1.3.3 + * */ typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr co= nn, virDomainPtr dom, @@ -5801,6 +5861,9 @@ typedef void (*virConnectDomainEventJobCompletedCallb= ack)(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 + * */ typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn, virDomainPtr dom, @@ -5853,6 +5916,9 @@ typedef enum { * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE with virConnectDomainEventRegisterA= ny() + * + * Since: v1.2.11 + * */ typedef void (*virConnectDomainEventAgentLifecycleCallback)(virConnectPtr = conn, virDomainPtr d= om, @@ -5882,6 +5948,9 @@ typedef void (*virConnectDomainEventAgentLifecycleCal= lback)(virConnectPtr conn, * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD with virConnectDomainEventRegisterA= ny() + * + * Since: v3.2.0 + * */ typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr = conn, virDomainPtr d= om, @@ -5907,6 +5976,9 @@ typedef void (*virConnectDomainEventBlockThresholdCal= lback)(virConnectPtr conn, * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE with virConnectDomainEventRegisterAn= y() + * + * Since: v6.9.0 + * */ typedef void (*virConnectDomainEventMemoryFailureCallback)(virConnectPtr c= onn, virDomainPtr do= m, @@ -5931,6 +6003,9 @@ typedef void (*virConnectDomainEventMemoryFailureCall= back)(virConnectPtr conn, * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE with * virConnectDomainEventRegisterAny(). + * + * Since: v7.9.0 + * */ typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virCon= nectPtr conn, virDom= ainPtr dom, diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-even= t.h index fe2234913f..7a6483fb8d 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -55,6 +55,9 @@ typedef enum { * * Callback for receiving file handle events. The callback will * be invoked once for each event which is pending. + * + * Since: v0.5.0 + * */ typedef void (*virEventHandleCallback)(int watch, int fd, int events, void= *opaque); =20 @@ -82,6 +85,9 @@ 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 + * */ typedef int (*virEventAddHandleFunc)(int fd, int event, virEventHandleCallback cb, @@ -95,6 +101,9 @@ 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 + * */ typedef void (*virEventUpdateHandleFunc)(int watch, int event); =20 @@ -110,6 +119,9 @@ typedef void (*virEventUpdateHandleFunc)(int watch, int= event); * function call, when it is safe to release the user data. * * Returns -1 if the file handle was not registered, 0 upon success + * + * Since: v0.5.0 + * */ typedef int (*virEventRemoveHandleFunc)(int watch); =20 @@ -120,6 +132,9 @@ typedef int (*virEventRemoveHandleFunc)(int watch); * @opaque: user data registered with handle * * callback for receiving timer events + * + * Since: v0.5.0 + * */ typedef void (*virEventTimeoutCallback)(int timer, void *opaque); =20 @@ -138,6 +153,9 @@ typedef void (*virEventTimeoutCallback)(int timer, void= *opaque); * this purpose. * * Returns a timer value + * + * Since: v0.5.0 + * */ typedef int (*virEventAddTimeoutFunc)(int timeout, virEventTimeoutCallback cb, @@ -151,6 +169,9 @@ typedef int (*virEventAddTimeoutFunc)(int timeout, * * Part of the EventImpl, this user-defined callback updates an * event timeout. + * + * Since: v0.5.0 + * */ typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout); =20 @@ -165,6 +186,9 @@ typedef void (*virEventUpdateTimeoutFunc)(int timer, in= t timeout); * function call, when it is safe to release the user data. * * Returns 0 on success, -1 on failure + * + * Since: v0.5.0 + * */ typedef int (*virEventRemoveTimeoutFunc)(int timer); =20 diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 1996ea87c9..7c0f487708 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -705,6 +705,9 @@ typedef virConnectCredential *virConnectCredentialPtr; * If an interaction cannot be filled, fill in NULL and 0. * * Returns 0 if all interactions were filled, or -1 upon error + * + * Since: v0.4.1 + * */ typedef int (*virConnectAuthCallbackPtr)(virConnectCredentialPtr cred, unsigned int ncred, @@ -912,6 +915,9 @@ int virConnectSetKeepAlive(virConnectPtr conn, * * A callback function to be registered, and called when the connection * is closed. + * + * Since: v0.10.0 + * */ typedef void (*virConnectCloseFunc)(virConnectPtr conn, int reason, diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-ne= twork.h index d735611437..6957b60ef1 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -312,6 +312,9 @@ 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 + * */ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn, virNetworkPtr net, @@ -415,6 +418,9 @@ int virNetworkGetDHCPLeases(virNetworkPtr network, * have a customization with extra parameters, often with @opaque being * passed in a different parameter position; use VIR_NETWORK_EVENT_CALLBAC= K() * when registering an appropriate handler. + * + * Since: v1.2.1 + * */ typedef void (*virConnectNetworkEventGenericCallback)(virConnectPtr conn, virNetworkPtr net, diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 1bec57fca4..12ea115514 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -209,6 +209,9 @@ typedef enum { * have a customization with extra parameters, often with @opaque being * passed in a different parameter position; use * VIR_NODE_DEVICE_EVENT_CALLBACK() when registering an appropriate handle= r. + * + * Since: v2.2.0 + * */ typedef void (*virConnectNodeDeviceEventGenericCallback)(virConnectPtr con= n, virNodeDevicePtr = dev, @@ -259,6 +262,9 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE with * virConnectNodeDeviceEventRegisterAny() + * + * Since: v2.2.0 + * */ typedef void (*virConnectNodeDeviceEventLifecycleCallback)(virConnectPtr c= onn, virNodeDevicePt= r dev, diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-sec= ret.h index 92fd03f726..e0023f551b 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -189,6 +189,9 @@ typedef enum { * have a customization with extra parameters, often with @opaque being * passed in a different parameter position; use * VIR_SECRET_EVENT_CALLBACK() when registering an appropriate handler. + * + * Since: v3.0.0 + * */ typedef void (*virConnectSecretEventGenericCallback)(virConnectPtr conn, virSecretPtr secret, @@ -237,6 +240,9 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_SECRET_EVENT_ID_LIFECYCLE with * virConnectSecretEventRegisterAny() + * + * Since: v3.0.0 + * */ typedef void (*virConnectSecretEventLifecycleCallback)(virConnectPtr conn, virSecretPtr secret, diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 0b27d5d99f..434454f455 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -588,6 +588,9 @@ typedef enum { * have a customization with extra parameters, often with @opaque being * passed in a different parameter position; use * VIR_STORAGE_POOL_EVENT_CALLBACK() when registering an appropriate handl= er. + * + * Since: v2.0.0 + * */ typedef void (*virConnectStoragePoolEventGenericCallback)(virConnectPtr co= nn, virStoragePoolPt= r pool, @@ -640,6 +643,9 @@ typedef enum { * The callback signature to use when registering for an event of type * VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE with * virConnectStoragePoolEventRegisterAny() + * + * Since: v2.0.0 + * */ typedef void (*virConnectStoragePoolEventLifecycleCallback)(virConnectPtr = conn, virStoragePool= Ptr pool, diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-str= eam.h index caf6779cd6..06f771b40b 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -100,6 +100,9 @@ int virStreamRecvHole(virStreamPtr, * * Returns the number of bytes filled, 0 upon end * of file, or -1 upon error + * + * Since: v0.7.2 + * */ typedef int (*virStreamSourceFunc)(virStreamPtr st, char *data, @@ -138,6 +141,9 @@ int virStreamSendAll(virStreamPtr st, * * Returns 0 on success, * -1 upon error + * + * Since: v3.4.0 + * */ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, int *inData, @@ -164,6 +170,9 @@ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, * * Returns 0 on success, * -1 upon error. + * + * Since: v3.4.0 + * */ typedef int (*virStreamSourceSkipFunc)(virStreamPtr st, long long length, @@ -201,6 +210,9 @@ int virStreamSparseSendAll(virStreamPtr st, * * Returns the number of bytes consumed or -1 upon * error + * + * Since: v0.7.2 + * */ typedef int (*virStreamSinkFunc)(virStreamPtr st, const char *data, @@ -231,6 +243,9 @@ int virStreamRecvAll(virStreamPtr st, * * Returns 0 on success, * -1 upon error + * + * Since: v3.4.0 + * */ typedef int (*virStreamSinkHoleFunc)(virStreamPtr st, long long length, @@ -264,6 +279,9 @@ typedef enum { * * Callback for receiving stream events. The callback will * be invoked once for each event which is pending. + * + * Since: v0.7.2 + * */ typedef void (*virStreamEventCallback)(virStreamPtr stream, int events, vo= id *opaque); =20 diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 6d15c12358..3ae95cb980 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -366,6 +366,9 @@ typedef enum { * @error: the error being raised. * * Signature of a function to use when there is an error raised by the lib= rary. + * + * Since: v0.1.0 + * */ typedef void (*virErrorFunc) (void *userData, virErrorPtr error); =20 diff --git a/src/libvirt-domain-checkpoint.c b/src/libvirt-domain-checkpoin= t.c index 58ee26857d..37a895e771 100644 --- a/src/libvirt-domain-checkpoint.c +++ b/src/libvirt-domain-checkpoint.c @@ -35,6 +35,9 @@ VIR_LOG_INIT("libvirt.domain-checkpoint"); * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * as its lifetime will be the same as the checkpoint object. + * + * Since: v5.6.0 + * */ const char * virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint) @@ -58,6 +61,9 @@ virDomainCheckpointGetName(virDomainCheckpointPtr checkpo= int) * call. * * Returns the domain or NULL. + * + * Since: v5.6.0 + * */ virDomainPtr virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint) @@ -81,6 +87,9 @@ virDomainCheckpointGetDomain(virDomainCheckpointPtr check= point) * call. * * Returns the connection or NULL. + * + * Since: v5.6.0 + * */ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint) @@ -138,6 +147,9 @@ virDomainCheckpointGetConnect(virDomainCheckpointPtr ch= eckpoint) * * Returns an (opaque) new virDomainCheckpointPtr on success or NULL * on failure. + * + * Since: v5.6.0 + * */ virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, @@ -207,6 +219,9 @@ 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 + * */ char * virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint, @@ -281,6 +296,9 @@ virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr ch= eckpoint, * included in the return count, to make iteration easier. The caller is * responsible for calling virDomainCheckpointFree() on each array element, * then calling free() on @checkpoints. + * + * Since: v5.6.0 + * */ int virDomainListAllCheckpoints(virDomainPtr domain, @@ -348,6 +366,9 @@ virDomainListAllCheckpoints(virDomainPtr domain, * in the return count, to make iteration easier. The caller is responsib= le * for calling virDomainCheckpointFree() on each array element, then calli= ng * free() on @children. + * + * Since: v5.6.0 + * */ int virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint, @@ -394,6 +415,9 @@ virDomainCheckpointListAllChildren(virDomainCheckpointP= tr checkpoint, * Returns a domain checkpoint object or NULL in case of failure. If the * domain checkpoint cannot be found, then the VIR_ERR_NO_DOMAIN_CHECKPOINT * error is raised. + * + * Since: v5.6.0 + * */ virDomainCheckpointPtr virDomainCheckpointLookupByName(virDomainPtr domain, @@ -440,6 +464,9 @@ virDomainCheckpointLookupByName(virDomainPtr domain, * Returns a domain checkpoint object or NULL in case of failure. If the * given checkpoint is a root (no parent), then the VIR_ERR_NO_DOMAIN_CHEC= KPOINT * error is raised. + * + * Since: v5.6.0 + * */ virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint, @@ -493,6 +520,9 @@ virDomainCheckpointGetParent(virDomainCheckpointPtr che= ckpoint, * silently ignored. * * Returns 0 on success, -1 on error. + * + * Since: v5.6.0 + * */ int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, @@ -543,6 +573,9 @@ virDomainCheckpointDelete(virDomainCheckpointPtr checkp= oint, * increment the reference count. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v5.6.0 + * */ int virDomainCheckpointRef(virDomainCheckpointPtr checkpoint) @@ -566,6 +599,9 @@ virDomainCheckpointRef(virDomainCheckpointPtr checkpoin= t) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v5.6.0 + * */ int virDomainCheckpointFree(virDomainCheckpointPtr checkpoint) diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c index 69845918a2..f9fc1d4f2b 100644 --- a/src/libvirt-domain-snapshot.c +++ b/src/libvirt-domain-snapshot.c @@ -35,6 +35,9 @@ VIR_LOG_INIT("libvirt.domain-snapshot"); * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * as its lifetime will be the same as the snapshot object. + * + * Since: v0.9.5 + * */ const char * virDomainSnapshotGetName(virDomainSnapshotPtr snapshot) @@ -58,6 +61,9 @@ virDomainSnapshotGetName(virDomainSnapshotPtr snapshot) * call. * * Returns the domain or NULL. + * + * Since: v0.9.5 + * */ virDomainPtr virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) @@ -81,6 +87,9 @@ virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) * call. * * Returns the connection or NULL. + * + * Since: v0.9.5 + * */ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot) @@ -213,6 +222,9 @@ virDomainSnapshotGetConnect(virDomainSnapshotPtr snapsh= ot) * * Returns an (opaque) new virDomainSnapshotPtr on success or NULL on * failure. + * + * Since: v0.8.0 + * */ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, @@ -271,6 +283,9 @@ 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 + * */ char * virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot, @@ -324,6 +339,9 @@ virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapsh= ot, * virDomainListAllSnapshots(). * * Returns the number of domain snapshots found or -1 in case of error. + * + * Since: v0.8.0 + * */ int virDomainSnapshotNum(virDomainPtr domain, unsigned int flags) @@ -388,6 +406,9 @@ 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 + * */ int virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen, @@ -476,6 +497,9 @@ virDomainSnapshotListNames(virDomainPtr domain, char **= names, int nameslen, * in the return count, to make iteration easier. The caller is responsib= le * for calling virDomainSnapshotFree() on each array element, then calling * free() on @snaps. + * + * Since: v0.9.13 + * */ int virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snap= s, @@ -525,6 +549,9 @@ virDomainListAllSnapshots(virDomainPtr domain, virDomai= nSnapshotPtr **snaps, * virDomainSnapshotListAllChildren(). * * Returns the number of domain snapshots found or -1 in case of error. + * + * Since: v0.9.7 + * */ int virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int f= lags) @@ -591,6 +618,9 @@ virDomainSnapshotNumChildren(virDomainSnapshotPtr snaps= hot, 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 + * */ int virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot, @@ -662,6 +692,9 @@ virDomainSnapshotListChildrenNames(virDomainSnapshotPtr= snapshot, * in the return count, to make iteration easier. The caller is responsib= le * for calling virDomainSnapshotFree() on each array element, then calling * free() on @snaps. + * + * Since: v0.9.13 + * */ int virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot, @@ -706,6 +739,9 @@ virDomainSnapshotListAllChildren(virDomainSnapshotPtr s= napshot, * Returns a domain snapshot object or NULL in case of failure. If the * domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT * error is raised. + * + * Since: v0.8.0 + * */ virDomainSnapshotPtr virDomainSnapshotLookupByName(virDomainPtr domain, @@ -746,6 +782,9 @@ virDomainSnapshotLookupByName(virDomainPtr domain, * Determine if the domain has a current snapshot. * * Returns 1 if such snapshot exists, 0 if it doesn't, -1 on error. + * + * Since: v0.8.0 + * */ int virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags) @@ -786,6 +825,9 @@ virDomainHasCurrentSnapshot(virDomainPtr domain, unsign= ed int flags) * Returns a domain snapshot object or NULL in case of failure. If the * current domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNA= PSHOT * error is raised. + * + * Since: v0.8.0 + * */ virDomainSnapshotPtr virDomainSnapshotCurrent(virDomainPtr domain, @@ -828,6 +870,9 @@ virDomainSnapshotCurrent(virDomainPtr domain, * Returns a domain snapshot object or NULL in case of failure. If the * given snapshot is a root (no parent), then the VIR_ERR_NO_DOMAIN_SNAPSH= OT * error is raised. + * + * Since: v0.9.7 + * */ virDomainSnapshotPtr virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot, @@ -866,6 +911,9 @@ virDomainSnapshotGetParent(virDomainSnapshotPtr snapsho= t, * also virDomainHasCurrentSnapshot(). * * Returns 1 if current, 0 if not current, or -1 on error. + * + * Since: v0.9.13 + * */ int virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot, @@ -905,6 +953,9 @@ virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapsho= t, * * Returns 1 if the snapshot has metadata, 0 if the snapshot exists without * help from libvirt, or -1 on error. + * + * Since: v0.9.13 + * */ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot, @@ -984,6 +1035,9 @@ virDomainSnapshotHasMetadata(virDomainSnapshotPtr snap= shot, * NVRAM from the pristine template. * * Returns 0 if the creation is successful, -1 on error. + * + * Since: v0.8.0 + * */ int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, @@ -1041,6 +1095,9 @@ virDomainRevertToSnapshot(virDomainSnapshotPtr snapsh= ot, * * Returns 0 if the selected snapshot(s) were successfully deleted, * -1 on error. + * + * Since: v0.8.0 + * */ int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, @@ -1091,6 +1148,9 @@ virDomainSnapshotDelete(virDomainSnapshotPtr snapshot, * increment the reference count. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.13 + * */ int virDomainSnapshotRef(virDomainSnapshotPtr snapshot) @@ -1114,6 +1174,9 @@ virDomainSnapshotRef(virDomainSnapshotPtr snapshot) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.8.0 + * */ int virDomainSnapshotFree(virDomainSnapshotPtr snapshot) diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index cbd7902d2d..cb7fa7471b 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -49,6 +49,9 @@ VIR_LOG_INIT("libvirt.domain"); * call to virConnectNumOfDomains() and this call; you are only guaranteed * that all currently active domains were listed if the return is less * than @maxids. + * + * Since: v0.0.1 + * */ int virConnectListDomains(virConnectPtr conn, int *ids, int maxids) @@ -82,6 +85,9 @@ virConnectListDomains(virConnectPtr conn, int *ids, int m= axids) * Provides the number of active domains. * * Returns the number of domain found or -1 in case of error + * + * Since: v0.0.1 + * */ int virConnectNumOfDomains(virConnectPtr conn) @@ -115,6 +121,9 @@ virConnectNumOfDomains(virConnectPtr conn) * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.3.0 + * */ virConnectPtr virDomainGetConnect(virDomainPtr dom) @@ -162,6 +171,9 @@ virDomainGetConnect(virDomainPtr dom) * domain object is no longer needed. * * Returns a new domain object or NULL in case of failure + * + * Since: v0.5.0 + * */ virDomainPtr virDomainCreateXML(virConnectPtr conn, const char *xmlDesc, @@ -228,6 +240,9 @@ virDomainCreateXML(virConnectPtr conn, const char *xmlD= esc, * domain object is no longer needed. * * Returns a new domain object or NULL in case of failure + * + * Since: v1.1.1 + * */ virDomainPtr virDomainCreateXMLWithFiles(virConnectPtr conn, const char *xmlDesc, @@ -284,6 +299,9 @@ virDomainCreateXMLWithFiles(virConnectPtr conn, const c= har *xmlDesc, * This existing name will be left indefinitely for API compatibility. * * Returns a new domain object or NULL in case of failure + * + * Since: v0.0.1 + * */ virDomainPtr virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc, @@ -307,6 +325,9 @@ virDomainCreateLinux(virConnectPtr conn, const char *xm= lDesc, * * 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.1 + * */ virDomainPtr virDomainLookupByID(virConnectPtr conn, int id) @@ -346,6 +367,9 @@ 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 + * */ virDomainPtr virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -385,6 +409,9 @@ virDomainLookupByUUID(virConnectPtr conn, const unsigne= d 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 + * */ virDomainPtr virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -422,6 +449,9 @@ virDomainLookupByUUIDString(virConnectPtr conn, const c= har *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.1 + * */ virDomainPtr virDomainLookupByName(virConnectPtr conn, const char *name) @@ -472,6 +502,9 @@ virDomainLookupByName(virConnectPtr conn, const char *n= ame) * be deleted when the domain quits. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainDestroy(virDomainPtr domain) @@ -537,6 +570,9 @@ virDomainDestroy(virDomainPtr domain) * * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.4 + * */ int virDomainDestroyFlags(virDomainPtr domain, @@ -577,6 +613,9 @@ virDomainDestroyFlags(virDomainPtr domain, * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainFree(virDomainPtr domain) @@ -608,6 +647,9 @@ virDomainFree(virDomainPtr domain) * the reference count. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.6.0 + * */ int virDomainRef(virDomainPtr domain) @@ -636,6 +678,9 @@ virDomainRef(virDomainPtr domain) * special state like VIR_DOMAIN_PMSUSPENDED. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainSuspend(virDomainPtr domain) @@ -678,6 +723,9 @@ virDomainSuspend(virDomainPtr domain) * special state like VIR_DOMAIN_PMSUSPENDED. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainResume(virDomainPtr domain) @@ -734,6 +782,9 @@ virDomainResume(virDomainPtr domain) * * Returns: 0 on success, * -1 on failure. + * + * Since: v0.9.10 + * */ int virDomainPMSuspendForDuration(virDomainPtr dom, @@ -781,6 +832,9 @@ virDomainPMSuspendForDuration(virDomainPtr dom, * * Returns: 0 on success, * -1 on failure. + * + * Since: v0.9.11 + * */ int virDomainPMWakeup(virDomainPtr dom, @@ -828,6 +882,9 @@ virDomainPMWakeup(virDomainPtr dom, * and virDomainSaveImageDefineXML(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.2 + * */ int virDomainSave(virDomainPtr domain, const char *to) @@ -910,6 +967,9 @@ virDomainSave(virDomainPtr domain, const char *to) * to stop the block job first. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.4 + * */ int virDomainSaveFlags(virDomainPtr domain, const char *to, @@ -970,6 +1030,9 @@ virDomainSaveFlags(virDomainPtr domain, const char *to, * See virDomainRestoreFlags() for more control. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.2 + * */ int virDomainRestore(virConnectPtr conn, const char *from) @@ -1042,6 +1105,9 @@ virDomainRestore(virConnectPtr conn, const char *from) * pristine template. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.4 + * */ int virDomainRestoreFlags(virConnectPtr conn, const char *from, const char *dx= ml, @@ -1104,6 +1170,9 @@ 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 + * */ char * virDomainSaveImageGetXMLDesc(virConnectPtr conn, const char *file, @@ -1172,6 +1241,9 @@ virDomainSaveImageGetXMLDesc(virConnectPtr conn, cons= t char *file, * exclusive. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.4 + * */ int virDomainSaveImageDefineXML(virConnectPtr conn, const char *file, @@ -1246,6 +1318,9 @@ virDomainSaveImageDefineXML(virConnectPtr conn, const= char *file, * For more control over the output format, see virDomainCoreDumpWithForma= t(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.1.9 + * */ int virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags) @@ -1322,6 +1397,9 @@ virDomainCoreDump(virDomainPtr domain, const char *to= , unsigned int flags) * pressure on file system cache, but also risks slowing saves to NFS. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v1.2.3 + * */ int virDomainCoreDumpWithFormat(virDomainPtr domain, const char *to, @@ -1401,6 +1479,9 @@ virDomainCoreDumpWithFormat(virDomainPtr domain, cons= t 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 + * */ char * virDomainScreenshot(virDomainPtr domain, @@ -1460,6 +1541,9 @@ virDomainScreenshot(virDomainPtr domain, * be deleted when the domain quits. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainShutdown(virDomainPtr domain) @@ -1520,6 +1604,9 @@ virDomainShutdown(virDomainPtr domain) * must have <channel> configured. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.10 + * */ int virDomainShutdownFlags(virDomainPtr domain, unsigned int flags) @@ -1578,6 +1665,9 @@ virDomainShutdownFlags(virDomainPtr domain, unsigned = int flags) * to a plain shutdown on the destination. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.1.0 + * */ int virDomainReboot(virDomainPtr domain, unsigned int flags) @@ -1622,6 +1712,9 @@ virDomainReboot(virDomainPtr domain, unsigned int fla= gs) * guest OS shutdown. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.7 + * */ int virDomainReset(virDomainPtr domain, unsigned int flags) @@ -1661,6 +1754,9 @@ virDomainReset(virDomainPtr domain, unsigned int flag= s) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the domain object. + * + * Since: v0.0.1 + * */ const char * virDomainGetName(virDomainPtr domain) @@ -1683,6 +1779,9 @@ virDomainGetName(virDomainPtr domain) * Get the UUID for a domain * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.0.5 + * */ int virDomainGetUUID(virDomainPtr domain, unsigned char *uuid) @@ -1713,6 +1812,9 @@ virDomainGetUUID(virDomainPtr domain, unsigned char *= uuid) * UUID see RFC4122. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.1.1 + * */ int virDomainGetUUIDString(virDomainPtr domain, char *buf) @@ -1740,6 +1842,9 @@ virDomainGetUUIDString(virDomainPtr domain, char *buf) * Get the hypervisor ID number for the domain * * Returns the domain ID number or (unsigned int) -1 in case of error + * + * Since: v0.0.1 + * */ unsigned int virDomainGetID(virDomainPtr domain) @@ -1762,6 +1867,9 @@ virDomainGetID(virDomainPtr domain) * * Returns the new string or NULL in case of error, the string must be * freed by the caller. + * + * Since: v0.0.1 + * */ char * virDomainGetOSType(virDomainPtr domain) @@ -1801,6 +1909,9 @@ virDomainGetOSType(virDomainPtr domain) * * Returns the memory size in kibibytes (blocks of 1024 bytes), or 0 in * case of error. + * + * Since: v0.0.1 + * */ unsigned long virDomainGetMaxMemory(virDomainPtr domain) @@ -1850,6 +1961,9 @@ virDomainGetMaxMemory(virDomainPtr domain) * virDomainSetMemoryFlags(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory) @@ -1903,6 +2017,9 @@ virDomainSetMaxMemory(virDomainPtr domain, unsigned l= ong memory) * virDomainSetMemoryFlags(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.1.1 + * */ int virDomainSetMemory(virDomainPtr domain, unsigned long memory) @@ -1965,6 +2082,9 @@ virDomainSetMemory(virDomainPtr domain, unsigned long= memory) * Not all hypervisors can support all flag combinations. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.9.0 + * */ int virDomainSetMemoryFlags(virDomainPtr domain, unsigned long memory, @@ -2025,6 +2145,9 @@ virDomainSetMemoryFlags(virDomainPtr domain, unsigned= long memory, * Not all hypervisors can support all flag combinations. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.1.1 + * */ int virDomainSetMemoryStatsPeriod(virDomainPtr domain, int period, @@ -2075,6 +2198,9 @@ virDomainSetMemoryStatsPeriod(virDomainPtr domain, in= t period, * VIR_DOMAIN_MEMORY_PARAM_UNLIMITED. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.8.5 + * */ int virDomainSetMemoryParameters(virDomainPtr domain, @@ -2149,6 +2275,9 @@ virDomainSetMemoryParameters(virDomainPtr domain, * expects the caller to allocate the @params. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.8.5 + * */ int virDomainGetMemoryParameters(virDomainPtr domain, @@ -2216,6 +2345,9 @@ virDomainGetMemoryParameters(virDomainPtr domain, * Changing persistent configuration does not pose such limitations. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.9 + * */ int virDomainSetNumaParameters(virDomainPtr domain, @@ -2281,6 +2413,9 @@ virDomainSetNumaParameters(virDomainPtr domain, * expects the caller to allocate the @params. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.9 + * */ int virDomainGetNumaParameters(virDomainPtr domain, @@ -2338,6 +2473,9 @@ virDomainGetNumaParameters(virDomainPtr domain, * This function may require privileged access to the hypervisor. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.0 + * */ int virDomainSetBlkioParameters(virDomainPtr domain, @@ -2403,6 +2541,9 @@ virDomainSetBlkioParameters(virDomainPtr domain, * expects the caller to allocate the @params. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.0 + * */ int virDomainGetBlkioParameters(virDomainPtr domain, @@ -2461,6 +2602,9 @@ virDomainGetBlkioParameters(virDomainPtr domain, * can be extracted. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.1 + * */ int virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info) @@ -2507,6 +2651,9 @@ virDomainGetInfo(virDomainPtr domain, virDomainInfoPt= r info) * which led to the state. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.2 + * */ int virDomainGetState(virDomainPtr domain, @@ -2550,6 +2697,9 @@ virDomainGetState(virDomainPtr domain, * Extract details about current state of control interface to a domain. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.3 + * */ int virDomainGetControlInfo(virDomainPtr domain, @@ -2611,6 +2761,9 @@ 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.1 + * */ char * virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags) @@ -2660,6 +2813,9 @@ 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 + * */ char * virConnectDomainXMLFromNative(virConnectPtr conn, @@ -2710,6 +2866,9 @@ 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 + * */ char * virConnectDomainXMLToNative(virConnectPtr conn, @@ -3563,6 +3722,9 @@ virDomainMigrateUnmanaged(virDomainPtr domain, * Returns the new domain object if the migration was successful, * 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 + * */ virDomainPtr virDomainMigrate(virDomainPtr domain, @@ -3759,6 +3921,9 @@ virDomainMigrate(virDomainPtr domain, * Returns the new domain object if the migration was successful, * 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 + * */ virDomainPtr virDomainMigrate2(virDomainPtr domain, @@ -3968,6 +4133,9 @@ virDomainMigrate2(virDomainPtr domain, * Returns the new domain object if the migration was successful, * 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 + * */ virDomainPtr virDomainMigrate3(virDomainPtr domain, @@ -4256,6 +4424,9 @@ int virDomainMigrateUnmanagedCheckCompat(virDomainPtr= domain, * corresponds to VIR_MIGRATE_PARAM_URI of virDomainMigrateToURI3. * * Returns 0 if the migration succeeded, -1 upon error. + * + * Since: v0.7.2 + * */ int virDomainMigrateToURI(virDomainPtr domain, @@ -4332,6 +4503,9 @@ virDomainMigrateToURI(virDomainPtr domain, * virDomainMigrateToURI3. * * Returns 0 if the migration succeeded, -1 upon error. + * + * Since: v0.9.2 + * */ int virDomainMigrateToURI2(virDomainPtr domain, @@ -4412,6 +4586,9 @@ virDomainMigrateToURI2(virDomainPtr domain, * different types of hypervisor. * * Returns 0 if the migration succeeded, -1 upon error. + * + * Since: v1.1.0 + * */ int virDomainMigrateToURI3(virDomainPtr domain, @@ -5281,6 +5458,9 @@ virDomainMigrateConfirm3Params(virDomainPtr domain, * Get the scheduler type and the number of scheduler parameters. * * Returns NULL in case of error. The caller must free the returned string. + * + * Since: v0.2.3 + * */ char * virDomainGetSchedulerType(virDomainPtr domain, int *nparams) @@ -5329,6 +5509,9 @@ virDomainGetSchedulerType(virDomainPtr domain, int *n= params) * virDomainGetSchedulerParametersFlags(). * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.2.3 + * */ int virDomainGetSchedulerParameters(virDomainPtr domain, @@ -5394,6 +5577,9 @@ virDomainGetSchedulerParameters(virDomainPtr domain, * } * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.2 + * */ int virDomainGetSchedulerParametersFlags(virDomainPtr domain, @@ -5458,6 +5644,9 @@ virDomainGetSchedulerParametersFlags(virDomainPtr dom= ain, * virDomainSetSchedulerParametersFlags. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.2.3 + * */ int virDomainSetSchedulerParameters(virDomainPtr domain, @@ -5512,6 +5701,9 @@ virDomainSetSchedulerParameters(virDomainPtr domain, * flags are supported. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.2 + * */ int virDomainSetSchedulerParametersFlags(virDomainPtr domain, @@ -5583,6 +5775,9 @@ virDomainSetSchedulerParametersFlags(virDomainPtr dom= ain, * that particular statistic. * * Returns: 0 in case of success or -1 in case of failure. + * + * Since: v0.3.2 + * */ int virDomainBlockStats(virDomainPtr dom, const char *disk, @@ -5660,6 +5855,9 @@ virDomainBlockStats(virDomainPtr dom, const char *dis= k, * again. See virDomainGetMemoryParameters() for more details. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.5 + * */ int virDomainBlockStatsFlags(virDomainPtr dom, @@ -5729,6 +5927,9 @@ virDomainBlockStatsFlags(virDomainPtr dom, * The returned stats are from domain's point of view. * * Returns: 0 in case of success or -1 in case of failure. + * + * Since: v0.3.2 + * */ int virDomainInterfaceStats(virDomainPtr dom, const char *device, @@ -5789,6 +5990,9 @@ virDomainInterfaceStats(virDomainPtr dom, const char = *device, * This function may require privileged access to the hypervisor. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.9 + * */ int virDomainSetInterfaceParameters(virDomainPtr domain, @@ -5857,6 +6061,9 @@ virDomainSetInterfaceParameters(virDomainPtr domain, * expects the caller to allocate the @params. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.9 + * */ int virDomainGetInterfaceParameters(virDomainPtr domain, @@ -5947,6 +6154,9 @@ virDomainGetInterfaceParameters(virDomainPtr domain, * The number of failed huge page allocations from inside the domain * * Returns: The number of stats provided or -1 in case of failure. + * + * Since: v0.7.5 + * */ int virDomainMemoryStats(virDomainPtr dom, virDomainMemoryStatPtr stats, @@ -6026,6 +6236,9 @@ virDomainMemoryStats(virDomainPtr dom, virDomainMemor= yStatPtr stats, * Now large requests up to 16M byte are supported. * * Returns: 0 in case of success or -1 in case of failure. + * + * Since: v0.4.4 + * */ int virDomainBlockPeek(virDomainPtr dom, @@ -6095,6 +6308,9 @@ virDomainBlockPeek(virDomainPtr dom, * hypervisor. * * Returns: 0 in case of success or -1 in case of failure. + * + * Since: v0.9.8 + * */ int virDomainBlockResize(virDomainPtr dom, @@ -6163,6 +6379,9 @@ virDomainBlockResize(virDomainPtr dom, * Now large requests up to 16M byte are supported. * * Returns: 0 in case of success or -1 in case of failure. + * + * Since: v0.4.4 + * */ int virDomainMemoryPeek(virDomainPtr dom, @@ -6299,6 +6518,9 @@ virDomainMemoryPeek(virDomainPtr dom, * ... * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.8.1 + * */ int virDomainGetBlockInfo(virDomainPtr domain, const char *disk, @@ -6349,6 +6571,9 @@ virDomainGetBlockInfo(virDomainPtr domain, const char= *disk, * domain object is no longer needed. * * Returns NULL in case of error, a pointer to the domain otherwise + * + * Since: v0.1.1 + * */ virDomainPtr virDomainDefineXML(virConnectPtr conn, const char *xml) @@ -6392,6 +6617,9 @@ virDomainDefineXML(virConnectPtr conn, const char *xm= l) * domain object is no longer needed. * * Returns NULL in case of error, a pointer to the domain otherwise + * + * Since: v1.2.12 + * */ virDomainPtr virDomainDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int = flags) @@ -6435,6 +6663,9 @@ virDomainDefineXMLFlags(virConnectPtr conn, const cha= r *xml, unsigned int flags) * will fail. See virDomainUndefineFlags() for more control. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.1.1 + * */ int virDomainUndefine(virDomainPtr domain) @@ -6504,6 +6735,9 @@ virDomainUndefine(virDomainPtr domain) * VIR_DOMAIN_UNDEFINE_NVRAM is specified to remove the nvram file. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.9.4 + * */ int virDomainUndefineFlags(virDomainPtr domain, @@ -6543,6 +6777,9 @@ virDomainUndefineFlags(virDomainPtr domain, * Provides the number of defined but inactive domains. * * Returns the number of domain found or -1 in case of error + * + * Since: v0.1.6 + * */ int virConnectNumOfDefinedDomains(virConnectPtr conn) @@ -6586,6 +6823,9 @@ virConnectNumOfDefinedDomains(virConnectPtr conn) * a call to virConnectNumOfDefinedDomains() and this call; you are only * guaranteed that all currently defined domains were listed if the return * is less than @maxids. The client must call free() on each returned nam= e. + * + * Since: v0.1.1 + * */ int virConnectListDefinedDomains(virConnectPtr conn, char **const names, @@ -6685,6 +6925,9 @@ virConnectListDefinedDomains(virConnectPtr conn, char= **const names, * extra allocated element set to NULL but not included in the return coun= t, to * make iteration easier. The caller is responsible for calling virDomainF= ree() * on each array element, then calling free() on @domains. + * + * Since: v0.9.13 + * */ int virConnectListAllDomains(virConnectPtr conn, @@ -6726,6 +6969,9 @@ virConnectListAllDomains(virConnectPtr conn, * control, see virDomainCreateWithFlags(). * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.1.1 + * */ int virDomainCreate(virDomainPtr domain) @@ -6794,6 +7040,9 @@ virDomainCreate(virDomainPtr domain) * pristine template. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.8.2 + * */ int virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) @@ -6870,6 +7119,9 @@ virDomainCreateWithFlags(virDomainPtr domain, unsigne= d int flags) * pristine template. * * Returns 0 in case of success, -1 in case of error + * + * Since: v1.1.1 + * */ int virDomainCreateWithFiles(virDomainPtr domain, unsigned int nfiles, @@ -6927,6 +7179,9 @@ virDomainCreateWithFiles(virDomainPtr domain, unsigne= d int nfiles, * machine boots. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.1 + * */ int virDomainGetAutostart(virDomainPtr domain, @@ -6968,6 +7223,9 @@ virDomainGetAutostart(virDomainPtr domain, * when the host machine boots. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.1 + * */ int virDomainSetAutostart(virDomainPtr domain, @@ -7008,6 +7266,9 @@ virDomainSetAutostart(virDomainPtr domain, * Send NMI to the guest * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.9.2 + * */ int virDomainInjectNMI(virDomainPtr domain, unsigned int flags) @@ -7050,6 +7311,9 @@ virDomainInjectNMI(virDomainPtr domain, unsigned int = flags) * Send key(s) to the guest. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.9.3 + * */ int virDomainSendKey(virDomainPtr domain, @@ -7135,6 +7399,9 @@ virDomainSendKey(virDomainPtr domain, * the container/guest. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.0.1 + * */ int virDomainSendProcessSignal(virDomainPtr domain, @@ -7192,6 +7459,9 @@ virDomainSendProcessSignal(virDomainPtr domain, * use virDomainSetVcpusFlags(). * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.1.4 + * */ int virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus) @@ -7263,6 +7533,9 @@ virDomainSetVcpus(virDomainPtr domain, unsigned int n= vcpus) * Not all hypervisors can support all flag combinations. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.8.5 + * */ int virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus, @@ -7332,6 +7605,9 @@ virDomainSetVcpusFlags(virDomainPtr domain, unsigned = int nvcpus, * on live domains. Guest agent may be needed for this flag to be availabl= e. * * Returns the number of vCPUs in case of success, -1 in case of failure. + * + * Since: v0.8.5 + * */ int virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags) @@ -7388,6 +7664,9 @@ virDomainGetVcpusFlags(virDomainPtr domain, unsigned = int flags) * so can only be called on an active domain. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.1.4 + * */ int virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu, @@ -7455,6 +7734,9 @@ virDomainPinVcpu(virDomainPtr domain, unsigned int vc= pu, * * Returns 0 in case of success, -1 in case of failure. * + * Since: v0.9.3 + * + * */ int virDomainPinVcpuFlags(virDomainPtr domain, unsigned int vcpu, @@ -7513,6 +7795,9 @@ virDomainPinVcpuFlags(virDomainPtr domain, unsigned i= nt vcpu, * * Returns the number of virtual CPUs in case of success, * -1 in case of failure. + * + * Since: v0.9.3 + * */ int virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpumaps, @@ -7590,6 +7875,9 @@ virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpu= maps, * * Returns 0 in case of success, -1 in case of failure. * + * Since: v0.10.0 + * + * */ int virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap, @@ -7645,6 +7933,9 @@ virDomainPinEmulator(virDomainPtr domain, unsigned ch= ar *cpumap, * Returns 1 in case of success, * 0 in case of no emulator threads are pined to pcpus, * -1 in case of failure. + * + * Since: v0.10.0 + * */ int virDomainGetEmulatorPinInfo(virDomainPtr domain, unsigned char *cpumap, @@ -7710,6 +8001,9 @@ virDomainGetEmulatorPinInfo(virDomainPtr domain, unsi= gned char *cpumap, * an inactive domain. * * Returns the number of info filled in case of success, -1 in case of fai= lure. + * + * Since: v0.1.4 + * */ int virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo, @@ -7769,6 +8063,9 @@ virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr= info, int maxinfo, * guest was booted with. For more details, see virDomainGetVcpusFlags(). * * Returns the maximum of virtual CPU or -1 in case of error. + * + * Since: v0.2.1 + * */ int virDomainGetMaxVcpus(virDomainPtr domain) @@ -7813,6 +8110,9 @@ virDomainGetMaxVcpus(virDomainPtr domain) * On success, the array of information is stored into @info. The caller is * responsible for calling virDomainIOThreadInfoFree() on each array eleme= nt, * then calling free() on @info. On error, @info is set to NULL. + * + * Since: v1.2.14 + * */ int virDomainGetIOThreadInfo(virDomainPtr dom, @@ -7852,6 +8152,9 @@ virDomainGetIOThreadInfo(virDomainPtr dom, * @info: pointer to a virDomainIOThreadInfo object * * Frees the memory used by @info. + * + * Since: v1.2.14 + * */ void virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr info) @@ -7895,6 +8198,9 @@ virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr in= fo) * See also virDomainGetIOThreadInfo for querying this information. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.2.14 + * */ int virDomainPinIOThread(virDomainPtr domain, @@ -7959,6 +8265,9 @@ virDomainPinIOThread(virDomainPtr domain, * just live or both live and persistent state is changed. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.2.15 + * */ int virDomainAddIOThread(virDomainPtr domain, @@ -8018,6 +8327,9 @@ virDomainAddIOThread(virDomainPtr domain, * just live or both live and persistent state is changed. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.2.15 + * */ int virDomainDelIOThread(virDomainPtr domain, @@ -8079,6 +8391,9 @@ virDomainDelIOThread(virDomainPtr domain, * This function requires privileged access to the hypervisor. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v4.10.0 + * */ int virDomainSetIOThreadParams(virDomainPtr domain, @@ -8132,6 +8447,9 @@ virDomainSetIOThreadParams(virDomainPtr domain, * string if the domain is not running under a security model. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v0.6.1 + * */ int virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabe= l) @@ -8174,6 +8492,9 @@ virDomainGetSecurityLabel(virDomainPtr domain, virSec= urityLabelPtr seclabel) * string if the domain is not running under a security model. * * Returns number of elements in @seclabels on success, -1 in case of fail= ure. + * + * Since: v0.10.0 + * */ int virDomainGetSecurityLabelList(virDomainPtr domain, @@ -8236,6 +8557,9 @@ virDomainGetSecurityLabelList(virDomainPtr domain, * or both will be modified. * * Returns 0 on success, -1 in case of failure. + * + * Since: v0.9.10 + * */ int virDomainSetMetadata(virDomainPtr domain, @@ -8321,6 +8645,9 @@ virDomainSetMetadata(virDomainPtr domain, * * Returns the metadata string on success (caller must free), * or NULL in case of failure. + * + * Since: v0.9.10 + * */ char * virDomainGetMetadata(virDomainPtr domain, @@ -8388,6 +8715,9 @@ virDomainGetMetadata(virDomainPtr domain, * persistent domain definition. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.1.9 + * */ int virDomainAttachDevice(virDomainPtr domain, const char *xml) @@ -8447,6 +8777,9 @@ virDomainAttachDevice(virDomainPtr domain, const char= *xml) * persistent domain definition. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.7.7 + * */ int virDomainAttachDeviceFlags(virDomainPtr domain, @@ -8491,6 +8824,9 @@ virDomainAttachDeviceFlags(virDomainPtr domain, * See virDomainDetachDeviceFlags() for more details. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.1.9 + * */ int virDomainDetachDevice(virDomainPtr domain, const char *xml) @@ -8573,6 +8909,9 @@ virDomainDetachDevice(virDomainPtr domain, const char= *xml) * may lead to unexpected results. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.7.7 + * */ int virDomainDetachDeviceFlags(virDomainPtr domain, @@ -8637,6 +8976,9 @@ virDomainDetachDeviceFlags(virDomainPtr domain, * domain XML with only the disk path changed. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.8.0 + * */ int virDomainUpdateDeviceFlags(virDomainPtr domain, @@ -8691,6 +9033,9 @@ virDomainUpdateDeviceFlags(virDomainPtr domain, * device removal. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v4.4.0 + * */ int virDomainDetachDeviceAlias(virDomainPtr domain, @@ -8751,6 +9096,9 @@ virDomainDetachDeviceAlias(virDomainPtr domain, * Returns 0 on success, -1 on failure. Older versions of some hypervisors * sometimes returned a positive number on success, but without any reliab= le * semantics on what that number represents. + * + * Since: v0.5.0 + * */ int virConnectDomainEventRegister(virConnectPtr conn, @@ -8794,6 +9142,9 @@ virConnectDomainEventRegister(virConnectPtr conn, * Returns 0 on success, -1 on failure. Older versions of some hypervisors * sometimes returned a positive number on success, but without any reliab= le * semantics on what that number represents. + * + * Since: v0.5.0 + * */ int virConnectDomainEventDeregister(virConnectPtr conn, @@ -8828,6 +9179,9 @@ virConnectDomainEventDeregister(virConnectPtr conn, * Determine if the domain is currently running * * Returns 1 if running, 0 if inactive, -1 on error + * + * Since: v0.7.3 + * */ int virDomainIsActive(virDomainPtr dom) @@ -8861,6 +9215,9 @@ virDomainIsActive(virDomainPtr dom) * which means it will still exist after shutting down * * Returns 1 if persistent, 0 if transient, -1 on error + * + * Since: v0.7.3 + * */ int virDomainIsPersistent(virDomainPtr dom) @@ -8901,6 +9258,9 @@ virDomainIsPersistent(virDomainPtr dom) * advised to change these after the rename was successful. * * Returns 0 if successfully renamed, -1 on error + * + * Since: v1.2.19 + * */ int virDomainRename(virDomainPtr dom, @@ -8934,6 +9294,9 @@ virDomainRename(virDomainPtr dom, * Determine if the domain has been updated. * * Returns 1 if updated, 0 if not, -1 on error + * + * Since: v0.8.6 + * */ int virDomainIsUpdated(virDomainPtr dom) @@ -8971,6 +9334,9 @@ virDomainIsUpdated(virDomainPtr dom) * to virDomainGetJobStats(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.7.7 + * */ int virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info) @@ -9035,6 +9401,9 @@ virDomainGetJobInfo(virDomainPtr domain, virDomainJob= InfoPtr info) * source host in case of a migration job). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v1.0.3 + * */ int virDomainGetJobStats(virDomainPtr domain, @@ -9087,6 +9456,9 @@ virDomainGetJobStats(virDomainPtr domain, * for more details). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.7.7 + * */ int virDomainAbortJob(virDomainPtr domain) @@ -9129,6 +9501,9 @@ virDomainAbortJob(virDomainPtr domain) * being live-migrated as a reaction to migration progress. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v0.8.0 + * */ int virDomainMigrateSetMaxDowntime(virDomainPtr domain, @@ -9170,6 +9545,9 @@ virDomainMigrateSetMaxDowntime(virDomainPtr domain, * at the end of live migration. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v3.7.0 + * */ int virDomainMigrateGetMaxDowntime(virDomainPtr domain, @@ -9210,6 +9588,9 @@ virDomainMigrateGetMaxDowntime(virDomainPtr domain, * transferred memory pages during live migration. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v1.0.3 + * */ int virDomainMigrateGetCompressionCache(virDomainPtr domain, @@ -9254,6 +9635,9 @@ virDomainMigrateGetCompressionCache(virDomainPtr doma= in, * virDomainGetJobStats. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v1.0.3 + * */ int virDomainMigrateSetCompressionCache(virDomainPtr domain, @@ -9298,6 +9682,9 @@ virDomainMigrateSetCompressionCache(virDomainPtr doma= in, * phase of the migration. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v0.9.0 + * */ int virDomainMigrateSetMaxSpeed(virDomainPtr domain, @@ -9341,6 +9728,9 @@ virDomainMigrateSetMaxSpeed(virDomainPtr domain, * migration. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v0.9.5 + * */ int virDomainMigrateGetMaxSpeed(virDomainPtr domain, @@ -9434,6 +9824,9 @@ virDomainMigrateGetMaxSpeed(virDomainPtr domain, * migration and there's no domain to run virDomainGetJobStats on). * * Returns 0 in case of success, -1 otherwise. + * + * Since: v1.3.3 + * */ int virDomainMigrateStartPostCopy(virDomainPtr domain, @@ -9497,6 +9890,9 @@ virDomainMigrateStartPostCopy(virDomainPtr domain, * be passed to the virConnectDomainEventDeregisterAny() method. * * Returns a callback identifier on success, -1 on failure. + * + * Since: v0.8.0 + * */ int virConnectDomainEventRegisterAny(virConnectPtr conn, @@ -9555,7 +9951,10 @@ virConnectDomainEventRegisterAny(virConnectPtr conn, * * Returns 0 on success, -1 on failure. Older versions of some hypervisors * sometimes returned a positive number on success, but without any reliab= le - * semantics on what that number represents. */ + * semantics on what that number represents. + * + * Since: v0.8.0 + * */ int virConnectDomainEventDeregisterAny(virConnectPtr conn, int callbackID) @@ -9610,6 +10009,9 @@ virConnectDomainEventDeregisterAny(virConnectPtr con= n, * flags are mutually exclusive. * * Returns 0 in case of success or -1 in case of failure + * + * Since: v0.8.0 + * */ int virDomainManagedSave(virDomainPtr dom, unsigned int flags) @@ -9657,6 +10059,9 @@ 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 + * */ int virDomainHasManagedSaveImage(virDomainPtr dom, unsigned int flags) @@ -9695,6 +10100,9 @@ virDomainHasManagedSaveImage(virDomainPtr dom, unsig= ned int flags) * Remove any managed save image for this domain. * * Returns 0 in case of success, and -1 in case of error + * + * Since: v0.8.0 + * */ int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags) @@ -9741,6 +10149,9 @@ virDomainManagedSaveRemove(virDomainPtr dom, unsigne= d 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 + * */ char * virDomainManagedSaveGetXMLDesc(virDomainPtr domain, unsigned int flags) @@ -9799,6 +10210,9 @@ virDomainManagedSaveGetXMLDesc(virDomainPtr domain, = unsigned int flags) * exclusive. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v3.7.0 + * */ int virDomainManagedSaveDefineXML(virDomainPtr domain, const char *dxml, @@ -9864,6 +10278,9 @@ virDomainManagedSaveDefineXML(virDomainPtr domain, c= onst char *dxml, * versions, it is up to the client to ensure mutual exclusion. * * Returns 0 if the console was opened, -1 on error + * + * Since: v0.8.6 + * */ int virDomainOpenConsole(virDomainPtr dom, @@ -9928,6 +10345,9 @@ virDomainOpenConsole(virDomainPtr dom, * other client prior to opening this channel. * * Returns 0 if the channel was opened, -1 on error + * + * Since: v1.0.2 + * */ int virDomainOpenChannel(virDomainPtr dom, @@ -9985,6 +10405,9 @@ virDomainOpenChannel(virDomainPtr dom, * Linux perf events are performance analyzing tool in Linux. * * Returns -1 in case of failure, 0 in case of success. + * + * Since: v1.3.3 + * */ int virDomainGetPerfEvents(virDomainPtr domain, virTypedParameterPtr *params, @@ -10035,6 +10458,9 @@ int virDomainGetPerfEvents(virDomainPtr domain, * Linux perf events are performance analyzing tool in Linux. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v1.3.3 + * */ int virDomainSetPerfEvents(virDomainPtr domain, virTypedParameterPtr params, @@ -10118,6 +10544,9 @@ int virDomainSetPerfEvents(virDomainPtr domain, * beginning of the first phase. * * Returns -1 in case of failure, 0 when successful. + * + * Since: v0.9.4 + * */ int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, @@ -10195,6 +10624,9 @@ virDomainBlockJobAbort(virDomainPtr dom, const char= *disk, * space required for the backup. * * Returns -1 in case of failure, 0 when nothing found, 1 when info was fo= und. + * + * Since: v0.9.4 + * */ int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk, @@ -10258,6 +10690,9 @@ virDomainGetBlockJobInfo(virDomainPtr dom, const ch= ar *disk, * elements within //domain/devices/disk. * * Returns -1 in case of failure, 0 when successful. + * + * Since: v0.9.4 + * */ int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, @@ -10332,6 +10767,9 @@ virDomainBlockJobSetSpeed(virDomainPtr dom, const c= har *disk, * This is shorthand for virDomainBlockRebase() with a NULL base. * * Returns 0 if the operation has started, -1 on failure. + * + * Since: v0.9.4 + * */ int virDomainBlockPull(virDomainPtr dom, const char *disk, @@ -10476,6 +10914,9 @@ virDomainBlockPull(virDomainPtr dom, const char *di= sk, * to the source format or probed from the reused file. * * Returns 0 if the operation has started, -1 on failure. + * + * Since: v0.9.10 + * */ int virDomainBlockRebase(virDomainPtr dom, const char *disk, @@ -10606,6 +11047,9 @@ virDomainBlockRebase(virDomainPtr dom, const char *= disk, * is not a local file, and the possibility of additional tuning parameter= s. * * Returns 0 if the operation has started, -1 on failure. + * + * Since: v1.2.8 + * */ int virDomainBlockCopy(virDomainPtr dom, const char *disk, @@ -10752,6 +11196,9 @@ virDomainBlockCopy(virDomainPtr dom, const char *di= sk, * virDomainGetBlockJobInfo(). * * Returns 0 if the operation has started, -1 on failure. + * + * Since: v0.10.2 + * */ int virDomainBlockCommit(virDomainPtr dom, const char *disk, @@ -10811,6 +11258,9 @@ virDomainBlockCommit(virDomainPtr dom, const char *= disk, * to use this method over a TCP connection will always fail * * Returns 0 on success, -1 on failure + * + * Since: v0.9.7 + * */ int virDomainOpenGraphics(virDomainPtr dom, @@ -10891,6 +11341,9 @@ virDomainOpenGraphics(virDomainPtr dom, * to use this method over a TCP connection will always fail. * * Returns an fd on success, -1 on failure + * + * Since: v1.2.8 + * */ int virDomainOpenGraphicsFD(virDomainPtr dom, @@ -10952,6 +11405,9 @@ virDomainOpenGraphicsFD(virDomainPtr dom, * within //domain/devices/disk. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.8 + * */ int virDomainSetBlockIoTune(virDomainPtr dom, @@ -11027,6 +11483,9 @@ virDomainSetBlockIoTune(virDomainPtr dom, * unless @nparams is 0 on input. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.8 + * */ int virDomainGetBlockIoTune(virDomainPtr dom, @@ -11156,6 +11615,9 @@ virDomainGetBlockIoTune(virDomainPtr dom, * skipped elements if @nparams is too large, and tail elements if * @ncpus is too large). The caller is responsible for freeing any * returned string parameters. + * + * Since: v0.9.10 + * */ int virDomainGetCPUStats(virDomainPtr domain, @@ -11256,6 +11718,9 @@ virDomainGetCPUStats(virDomainPtr domain, * * Returns number of disks with errors filled in the @errors array or -1 on * error. + * + * Since: v0.9.10 + * */ int virDomainGetDiskErrors(virDomainPtr dom, @@ -11301,6 +11766,9 @@ virDomainGetDiskErrors(virDomainPtr dom, * * Returns the hostname which must be freed by the caller, or * NULL if there was an error. + * + * Since: v0.10.0 + * */ char * virDomainGetHostname(virDomainPtr domain, unsigned int flags) @@ -11350,6 +11818,9 @@ virDomainGetHostname(virDomainPtr domain, unsigned = int flags) * If @minimum is not zero, the command may fail. * * Returns 0 on success, -1 otherwise. + * + * Since: v1.0.1 + * */ int virDomainFSTrim(virDomainPtr dom, @@ -11394,6 +11865,9 @@ virDomainFSTrim(virDomainPtr dom, * support mountpoints argument), @mountpoints may need to be NULL. * * Returns the number of frozen filesystems on success, -1 otherwise. + * + * Since: v1.2.5 + * */ int virDomainFSFreeze(virDomainPtr dom, @@ -11437,6 +11911,9 @@ virDomainFSFreeze(virDomainPtr dom, * In some drivers (e.g. QEMU driver), @mountpoints may need to be NULL. * * Returns the number of thawed filesystems on success, -1 otherwise. + * + * Since: v1.2.5 + * */ int virDomainFSThaw(virDomainPtr dom, @@ -11482,6 +11959,9 @@ virDomainFSThaw(virDomainPtr dom, * be configured and running in order to run this API. * * Returns 0 on success, -1 otherwise. + * + * Since: v1.2.5 + * */ int virDomainGetTime(virDomainPtr dom, @@ -11532,6 +12012,9 @@ virDomainGetTime(virDomainPtr dom, * be configured and running in order to be able to run this API. * * Returns 0 on success, -1 otherwise. + * + * Since: v1.2.5 + * */ int virDomainSetTime(virDomainPtr dom, @@ -11578,6 +12061,9 @@ virDomainSetTime(virDomainPtr dom, * be configured and running in order to be able to run this API. * * Returns 0 on success, -1 otherwise. + * + * Since: v1.2.16 + * */ int virDomainSetUserPassword(virDomainPtr dom, @@ -11628,6 +12114,9 @@ virDomainSetUserPassword(virDomainPtr dom, * * Returns NULL in case of error or an XML string * defining the capabilities. + * + * Since: v1.2.7 + * */ char * virConnectGetDomainCapabilities(virConnectPtr conn, @@ -12034,6 +12523,9 @@ virConnectGetDomainCapabilities(virConnectPtr conn, * Returns the count of returned statistics structures on success, -1 on e= rror. * The requested data are returned in the @retStats parameter. The returned * array should be freed by the caller. See virDomainStatsRecordListFree. + * + * Since: v1.2.8 + * */ int virConnectGetAllDomainStats(virConnectPtr conn, @@ -12113,6 +12605,9 @@ virConnectGetAllDomainStats(virConnectPtr conn, * array should be freed by the caller. See virDomainStatsRecordListFree. * Note that the count of returned stats may be less than the domain count * provided via @doms. + * + * Since: v1.2.8 + * */ int virDomainListGetStats(virDomainPtr *doms, @@ -12180,6 +12675,9 @@ virDomainListGetStats(virDomainPtr *doms, * * Convenience function to free a list of domain stats returned by * virDomainListGetStats and virConnectGetAllDomainStats. + * + * Since: v1.2.8 + * */ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats) @@ -12212,6 +12710,9 @@ virDomainStatsRecordListFree(virDomainStatsRecordPt= r *stats) * On success, the array of the information is stored into @info. The call= er is * responsible for calling virDomainFSInfoFree() on each array element, th= en * calling free() on @info. On error, @info is set to NULL. + * + * Since: v1.2.11 + * */ int virDomainGetFSInfo(virDomainPtr dom, @@ -12247,6 +12748,9 @@ virDomainGetFSInfo(virDomainPtr dom, * @info: pointer to a FSInfo object * * Frees all the memory occupied by @info. + * + * Since: v1.2.11 + * */ void virDomainFSInfoFree(virDomainFSInfoPtr info) @@ -12339,6 +12843,9 @@ virDomainFSInfoFree(virDomainFSInfoPtr info) * free(ifaces); * * Returns the number of interfaces on success, -1 in case of error. + * + * Since: v1.2.14 + * */ int virDomainInterfaceAddresses(virDomainPtr dom, @@ -12380,6 +12887,9 @@ virDomainInterfaceAddresses(virDomainPtr dom, * Free the interface object. The data structure is * freed and should not be used thereafter. If @iface * is NULL, then this method has no effect. + * + * Since: v1.2.14 + * */ void virDomainInterfaceFree(virDomainInterfacePtr iface) @@ -12423,6 +12933,9 @@ virDomainInterfaceFree(virDomainInterfacePtr iface) * virTypedParamsFree to free memory returned in @params. * * Returns 0 on success, -1 on error. + * + * Since: v2.0.0 + * */ int virDomainGetGuestVcpus(virDomainPtr domain, @@ -12481,6 +12994,9 @@ virDomainGetGuestVcpus(virDomainPtr domain, * low-level features a S3 sleep. * * Returns 0 on success, -1 on error. + * + * Since: v2.0.0 + * */ int virDomainSetGuestVcpus(virDomainPtr domain, @@ -12530,6 +13046,9 @@ virDomainSetGuestVcpus(virDomainPtr domain, * Note that OSes and hypervisors may require vCPU 0 to stay online. * * Returns 0 on success, -1 on error. + * + * Since: v3.1.0 + * */ int virDomainSetVcpu(virDomainPtr domain, @@ -12682,6 +13201,9 @@ virDomainSetVcpu(virDomainPtr domain, * virTypedParamsFree to free memory returned in @params. * * Returns 0 on success, -1 on error. + * + * Since: v5.7.0 + * */ int virDomainGetGuestInfo(virDomainPtr domain, unsigned int types, @@ -12756,6 +13278,9 @@ int virDomainGetGuestInfo(virDomainPtr domain, * tools to grow it without the need for polling of the data. * * Returns 0 if the operation has started, -1 on failure. + * + * Since: v3.2.0 + * */ int virDomainSetBlockThreshold(virDomainPtr domain, @@ -12805,6 +13330,9 @@ virDomainSetBlockThreshold(virDomainPtr domain, * any action for running domain. * * Returns 0 on success, -1 on failure. + * + * Since: v3.9.0 + * */ int virDomainSetLifecycleAction(virDomainPtr domain, unsigned int type, @@ -12860,6 +13388,9 @@ int virDomainSetLifecycleAction(virDomainPtr domain, * return the launch measurement. * * Returns -1 in case of failure, 0 in case of success. + * + * Since: v4.5.0 + * */ int virDomainGetLaunchSecurityInfo(virDomainPtr domain, virTypedParameterPtr *params, @@ -12926,6 +13457,9 @@ int virDomainGetLaunchSecurityInfo(virDomainPtr dom= ain, * launch security parameters. * * Returns -1 in case of failure, 0 in case of success. + * + * Since: v8.0.0 + * */ int virDomainSetLaunchSecurityState(virDomainPtr domain, virTypedParameterPtr params, @@ -12983,6 +13517,9 @@ int virDomainSetLaunchSecurityState(virDomainPtr do= main, * positive value: wait for @timeout seconds * * Returns 0 on success, -1 on failure + * + * Since: v5.10.0 + * */ int virDomainAgentSetResponseTimeout(virDomainPtr domain, @@ -13079,6 +13616,9 @@ virDomainAgentSetResponseTimeout(virDomainPtr domai= n, * formats if checkpoints are not involved. * * Returns 0 on success or -1 on failure. + * + * Since: v6.0.0 + * */ int virDomainBackupBegin(virDomainPtr domain, @@ -13129,6 +13669,9 @@ 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 + * */ char * virDomainBackupGetXMLDesc(virDomainPtr domain, @@ -13178,6 +13721,9 @@ virDomainBackupGetXMLDesc(virDomainPtr domain, * * Returns: number of keys stored in @keys, * -1 otherwise. + * + * Since: v6.10.0 + * */ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, @@ -13246,6 +13792,9 @@ virDomainAuthorizedSSHKeysGet(virDomainPtr domain, * * Returns: 0 on success, * -1 otherwise. + * + * Since: v6.10.0 + * */ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, @@ -13314,6 +13863,9 @@ virDomainAuthorizedSSHKeysSet(virDomainPtr domain, * * Returns: number of messages stored in @msgs, * -1 otherwise. + * + * Since: v7.1.0 + * */ int virDomainGetMessages(virDomainPtr domain, @@ -13356,6 +13908,9 @@ virDomainGetMessages(virDomainPtr domain, * virConnectGetAllDomainStats. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v7.2.0 + * */ int virDomainStartDirtyRateCalc(virDomainPtr domain, diff --git a/src/libvirt-host.c b/src/libvirt-host.c index 8e680cb9f9..6ba2c9e0bd 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -47,6 +47,9 @@ VIR_LOG_INIT("libvirt.host"); * the reference count. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v0.6.0 + * */ int virConnectRef(virConnectPtr conn) @@ -85,6 +88,9 @@ virConnectRef(virConnectPtr conn) * on a connection if the application is not trustworthy. * * Returns: 0 if the identity change was accepted, -1 on error + * + * Since: v5.8.0 + * */ int virConnectSetIdentity(virConnectPtr conn, @@ -149,6 +155,9 @@ virConnectSupportsFeature(virConnectPtr conn, int featu= re) * hypervisor, use virConnectGetCapabilities(). * * Returns NULL in case of error, a static zero terminated string otherwis= e. + * + * Since: v0.0.1 + * */ const char * virConnectGetType(virConnectPtr conn) @@ -180,6 +189,9 @@ virConnectGetType(virConnectPtr conn) * Returns -1 in case of error, 0 otherwise. if the version can't be * 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.1 + * */ int virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer) @@ -216,6 +228,9 @@ 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 + * */ int virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer) @@ -256,6 +271,9 @@ virConnectGetLibVersion(virConnectPtr conn, unsigned lo= ng *libVer) * * Returns the hostname which must be freed by the caller, or * NULL if there was an error. + * + * Since: v0.3.0 + * */ char * virConnectGetHostname(virConnectPtr conn) @@ -295,6 +313,9 @@ 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 + * */ char * virConnectGetURI(virConnectPtr conn) @@ -329,6 +350,9 @@ 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 + * */ char * virConnectGetSysinfo(virConnectPtr conn, unsigned int flags) @@ -367,6 +391,9 @@ virConnectGetSysinfo(virConnectPtr conn, unsigned int f= lags) * for "<vcpu max=3D'...'>" in its output instead. * * Returns the maximum of virtual CPU or -1 in case of error. + * + * Since: v0.2.1 + * */ int virConnectGetMaxVcpus(virConnectPtr conn, @@ -416,6 +443,9 @@ virConnectGetMaxVcpus(virConnectPtr conn, * in a more accurate representation. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.1.0 + * */ int virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info) @@ -452,6 +482,9 @@ virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info) * Returns NULL in case of error, or an XML string * defining the capabilities. * The client must free the returned string after use. + * + * Since: v0.2.1 + * */ char * virConnectGetCapabilities(virConnectPtr conn) @@ -532,6 +565,9 @@ virConnectGetCapabilities(virConnectPtr conn) * represents all CPUs on the server. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.3 + * */ int virNodeGetCPUStats(virConnectPtr conn, @@ -619,6 +655,9 @@ virNodeGetCPUStats(virConnectPtr conn, * The cached memory usage.(KB) * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.3 + * */ int virNodeGetMemoryStats(virConnectPtr conn, @@ -666,6 +705,9 @@ virNodeGetMemoryStats(virConnectPtr conn, * function the returned value is in bytes. Divide by 1024 as necessary. * * Returns the available free memory in bytes or 0 in case of error + * + * Since: v0.3.3 + * */ unsigned long long virNodeGetFreeMemory(virConnectPtr conn) @@ -712,6 +754,9 @@ virNodeGetFreeMemory(virConnectPtr conn) * Returns 0 on success (i.e., the node will be suspended after a short * delay), -1 on failure (the operation is not supported, or an attempted * suspend is already underway). + * + * Since: v0.9.8 + * */ int virNodeSuspendForDuration(virConnectPtr conn, @@ -765,6 +810,9 @@ virNodeSuspendForDuration(virConnectPtr conn, * example. * * Returns 0 in case of success, and -1 in case of failure. + * + * Since: v0.10.2 + * */ int virNodeGetMemoryParameters(virConnectPtr conn, @@ -829,6 +877,9 @@ virNodeGetMemoryParameters(virConnectPtr conn, * This function may require privileged access to the hypervisor. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.10.2 + * */ int virNodeSetMemoryParameters(virConnectPtr conn, @@ -877,6 +928,9 @@ virNodeSetMemoryParameters(virConnectPtr conn, * string if the driver has not activated a security model. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v0.6.1 + * */ int virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel) @@ -920,6 +974,9 @@ virNodeGetSecurityModel(virConnectPtr conn, virSecurity= ModelPtr secmodel) * whichever is smaller. * * Returns the number of entries filled in freeMems, or -1 in case of erro= r. + * + * Since: v0.3.3 + * */ int virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems, @@ -958,6 +1015,9 @@ virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned= long long *freeMems, * Determine if the connection to the hypervisor is encrypted * * Returns 1 if encrypted, 0 if not encrypted, -1 on error + * + * Since: v0.7.3 + * */ int virConnectIsEncrypted(virConnectPtr conn) @@ -993,6 +1053,9 @@ virConnectIsEncrypted(virConnectPtr conn) * to eavesdropping (eg a UNIX domain socket, or pipe) * * Returns 1 if secure, 0 if not secure, -1 on error + * + * Since: v0.7.3 + * */ int virConnectIsSecure(virConnectPtr conn) @@ -1035,6 +1098,9 @@ virConnectIsSecure(virConnectPtr conn) * (instead of VIR_CPU_COMPARE_INCOMPATIBLE) and the error will use the * VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details abo= ut * the incompatibility. + * + * Since: v0.7.5 + * */ int virConnectCompareCPU(virConnectPtr conn, @@ -1091,6 +1157,9 @@ virConnectCompareCPU(virConnectPtr conn, * VIR_CPU_COMPARE_INCOMPATIBLE) and the error will use the * VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details abo= ut * the incompatibility. + * + * Since: v4.4.0 + * */ int virConnectCompareHypervisorCPU(virConnectPtr conn, @@ -1153,6 +1222,9 @@ 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 + * */ int virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***m= odels, @@ -1209,6 +1281,9 @@ virConnectGetCPUModelNames(virConnectPtr conn, const = char *arch, char ***models, * CPU will not include features that block migration. * * Returns XML description of the computed CPU (caller frees) or NULL on e= rror. + * + * Since: v0.7.7 + * */ char * virConnectBaselineCPU(virConnectPtr conn, @@ -1278,6 +1353,9 @@ virConnectBaselineCPU(virConnectPtr conn, * CPU will not include features that block migration. * * Returns XML description of the computed CPU (caller frees) or NULL on e= rror. + * + * Since: v4.4.0 + * */ char * virConnectBaselineHypervisorCPU(virConnectPtr conn, @@ -1351,6 +1429,9 @@ virConnectBaselineHypervisorCPU(virConnectPtr conn, * * Returns -1 on error, 0 on success, 1 when remote party doesn't support * keepalive messages. + * + * Since: v0.9.8 + * */ int virConnectSetKeepAlive(virConnectPtr conn, @@ -1388,6 +1469,9 @@ virConnectSetKeepAlive(virConnectPtr conn, * over a channel (TCP or UNIX socket) which is not closed. * * Returns 1 if alive, 0 if dead, -1 on error + * + * Since: v0.9.8 + * */ int virConnectIsAlive(virConnectPtr conn) @@ -1434,6 +1518,9 @@ virConnectIsAlive(virConnectPtr conn) * context. * * Returns 0 on success, -1 on error + * + * Since: v0.10.0 + * */ int virConnectRegisterCloseCallback(virConnectPtr conn, @@ -1471,6 +1558,9 @@ virConnectRegisterCloseCallback(virConnectPtr conn, * registration, it will be invoked * * Returns 0 on success, -1 on error + * + * Since: v0.10.0 + * */ int virConnectUnregisterCloseCallback(virConnectPtr conn, @@ -1513,6 +1603,9 @@ virConnectUnregisterCloseCallback(virConnectPtr conn, * * Returns number of CPUs present on the host node, * or -1 if there was an error. + * + * Since: v1.0.0 + * */ int virNodeGetCPUMap(virConnectPtr conn, @@ -1599,6 +1692,9 @@ virNodeGetCPUMap(virConnectPtr conn, * Page size=3D1073741824 count=3D0 bytes=3D0 * * Returns: the number of entries filled in @counts or -1 in case of error. + * + * Since: v1.2.6 + * */ int virNodeGetFreePages(virConnectPtr conn, @@ -1669,6 +1765,9 @@ virNodeGetFreePages(virConnectPtr conn, * * Returns: the number of nodes successfully adjusted or -1 in * case of an error. + * + * Since: v1.2.9 + * */ int virNodeAllocPages(virConnectPtr conn, @@ -1722,6 +1821,9 @@ virNodeAllocPages(virConnectPtr conn, * responsible for freeing @params. * * Returns 0 in case of success, and -1 in case of failure. + * + * Since: v4.5.0 + * */ int virNodeGetSEVInfo(virConnectPtr conn, diff --git a/src/libvirt-interface.c b/src/libvirt-interface.c index e4e8178ba9..67dcb76efb 100644 --- a/src/libvirt-interface.c +++ b/src/libvirt-interface.c @@ -36,6 +36,9 @@ VIR_LOG_INIT("libvirt.interface"); * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.6.4 + * */ virConnectPtr virInterfaceGetConnect(virInterfacePtr iface) @@ -76,6 +79,9 @@ virInterfaceGetConnect(virInterfacePtr iface) * extra allocated element set to NULL but not included in the return coun= t, * to make iteration easier. The caller is responsible for calling * virStorageInterfaceFree() on each array element, then calling free() on= @ifaces. + * + * Since: v0.10.2 + * */ int virConnectListAllInterfaces(virConnectPtr conn, @@ -115,6 +121,9 @@ virConnectListAllInterfaces(virConnectPtr conn, * Provides the number of active interfaces on the physical host. * * Returns the number of active interfaces found or -1 in case of error + * + * Since: v0.6.4 + * */ int virConnectNumOfInterfaces(virConnectPtr conn) @@ -158,6 +167,9 @@ virConnectNumOfInterfaces(virConnectPtr conn) * to virConnectNumOfInterfaces() and this call; you are only guaranteed t= hat * 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 + * */ int virConnectListInterfaces(virConnectPtr conn, char **const names, int maxna= mes) @@ -193,6 +205,9 @@ virConnectListInterfaces(virConnectPtr conn, char **con= st names, int maxnames) * Provides the number of defined (inactive) interfaces on the physical ho= st. * * Returns the number of defined interface found or -1 in case of error + * + * Since: v0.7.0 + * */ int virConnectNumOfDefinedInterfaces(virConnectPtr conn) @@ -236,6 +251,9 @@ virConnectNumOfDefinedInterfaces(virConnectPtr conn) * a call to virConnectNumOfDefinedInterfaces() and this call; you are only * guaranteed that all currently defined interfaces were listed if the ret= urn * is less than @maxnames. The client must call free() on each returned n= ame. + * + * Since: v0.7.0 + * */ int virConnectListDefinedInterfaces(virConnectPtr conn, @@ -278,6 +296,9 @@ 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 + * */ virInterfacePtr virInterfaceLookupByName(virConnectPtr conn, const char *name) @@ -317,6 +338,9 @@ 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 + * */ virInterfacePtr virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr) @@ -352,6 +376,9 @@ virInterfaceLookupByMACString(virConnectPtr conn, const= char *macstr) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the interface object. + * + * Since: v0.6.4 + * */ const char * virInterfaceGetName(virInterfacePtr iface) @@ -376,6 +403,9 @@ virInterfaceGetName(virInterfacePtr iface) * Returns a pointer to the MAC address (in null-terminated ASCII * format) or NULL, the string need not be deallocated its lifetime * will be the same as the interface object. + * + * Since: v0.6.4 + * */ const char * virInterfaceGetMACString(virInterfacePtr iface) @@ -407,6 +437,9 @@ 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 + * */ char * virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags) @@ -458,6 +491,9 @@ virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned = int flags) * interface object is no longer needed. * * Returns NULL in case of error, a pointer to the interface otherwise + * + * Since: v0.6.4 + * */ virInterfacePtr virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int fl= ags) @@ -504,6 +540,9 @@ virInterfaceDefineXML(virConnectPtr conn, const char *x= ml, unsigned int flags) * during the next reboot of the system running libvirtd. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.6.4 + * */ int virInterfaceUndefine(virInterfacePtr iface) @@ -547,6 +586,9 @@ virInterfaceUndefine(virInterfacePtr iface) * undefined) if virInterfaceChangeRollback() is called. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.6.4 + * */ int virInterfaceCreate(virInterfacePtr iface, unsigned int flags) @@ -594,6 +636,9 @@ virInterfaceCreate(virInterfacePtr iface, unsigned int = flags) * interface definition will also bring the interface back up. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.6.4 + * */ int virInterfaceDestroy(virInterfacePtr iface, unsigned int flags) @@ -640,6 +685,9 @@ virInterfaceDestroy(virInterfacePtr iface, unsigned int= flags) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.4 + * */ int virInterfaceRef(virInterfacePtr iface) @@ -663,6 +711,9 @@ virInterfaceRef(virInterfacePtr iface) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.6.4 + * */ int virInterfaceFree(virInterfacePtr iface) @@ -694,6 +745,9 @@ virInterfaceFree(virInterfacePtr iface) * VIR_ERR_INVALID_OPERATION will be logged. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.2 + * */ int virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags) @@ -734,6 +788,9 @@ virInterfaceChangeBegin(virConnectPtr conn, unsigned in= t flags) * will be logged. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.2 + * */ int virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags) @@ -774,6 +831,9 @@ virInterfaceChangeCommit(virConnectPtr conn, unsigned i= nt flags) * will be logged. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.9.2 + * */ int virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags) @@ -809,6 +869,9 @@ virInterfaceChangeRollback(virConnectPtr conn, unsigned= int flags) * Determine if the interface is currently running * * Returns 1 if running, 0 if inactive, -1 on error + * + * Since: v0.7.3 + * */ int virInterfaceIsActive(virInterfacePtr iface) diff --git a/src/libvirt-network.c b/src/libvirt-network.c index 883dd40f6b..c3713dfad5 100644 --- a/src/libvirt-network.c +++ b/src/libvirt-network.c @@ -38,6 +38,9 @@ VIR_LOG_INIT("libvirt.network"); * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.3.0 + * */ virConnectPtr virNetworkGetConnect(virNetworkPtr net) @@ -86,6 +89,9 @@ virNetworkGetConnect(virNetworkPtr net) * extra allocated element set to NULL but not included in the return coun= t, * to make iteration easier. The caller is responsible for calling * virNetworkFree() on each array element, then calling free() on @nets. + * + * Since: v0.10.2 + * */ int virConnectListAllNetworks(virConnectPtr conn, @@ -125,6 +131,9 @@ virConnectListAllNetworks(virConnectPtr conn, * Provides the number of active networks. * * Returns the number of network found or -1 in case of error + * + * Since: v0.2.0 + * */ int virConnectNumOfNetworks(virConnectPtr conn) @@ -167,6 +176,9 @@ virConnectNumOfNetworks(virConnectPtr conn) * to virConnectNumOfNetworks() and this call; you are only guaranteed that * 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 + * */ int virConnectListNetworks(virConnectPtr conn, char **const names, int maxname= s) @@ -202,6 +214,9 @@ virConnectListNetworks(virConnectPtr conn, char **const= names, int maxnames) * Provides the number of inactive networks. * * Returns the number of networks found or -1 in case of error + * + * Since: v0.2.0 + * */ int virConnectNumOfDefinedNetworks(virConnectPtr conn) @@ -244,6 +259,9 @@ virConnectNumOfDefinedNetworks(virConnectPtr conn) * a call to virConnectNumOfDefinedNetworks() and this call; you are only * guaranteed that all currently defined networks were listed if the return * is less than @maxnames. The client must call free() on each returned n= ame. + * + * Since: v0.2.0 + * */ int virConnectListDefinedNetworks(virConnectPtr conn, char **const names, @@ -285,6 +303,9 @@ 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 + * */ virNetworkPtr virNetworkLookupByName(virConnectPtr conn, const char *name) @@ -324,6 +345,9 @@ 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 + * */ virNetworkPtr virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -360,6 +384,9 @@ virNetworkLookupByUUID(virConnectPtr conn, const unsign= ed 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 + * */ virNetworkPtr virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -399,6 +426,9 @@ virNetworkLookupByUUIDString(virConnectPtr conn, const = char *uuidstr) * network object is no longer needed. * * Returns a new network object or NULL in case of failure + * + * Since: v0.2.0 + * */ virNetworkPtr virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc) @@ -440,6 +470,9 @@ virNetworkCreateXML(virConnectPtr conn, const char *xml= Desc) * network object is no longer needed. * * Returns a new network object or NULL in case of failure + * + * Since: v7.8.0 + * */ virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned= int flags) @@ -480,6 +513,9 @@ virNetworkCreateXMLFlags(virConnectPtr conn, const char= *xmlDesc, unsigned int f * network object is no longer needed. * * Returns NULL in case of error, a pointer to the network otherwise + * + * Since: v0.2.0 + * */ virNetworkPtr virNetworkDefineXML(virConnectPtr conn, const char *xml) @@ -521,6 +557,9 @@ virNetworkDefineXML(virConnectPtr conn, const char *xml) * network object is no longer needed. * * Returns NULL in case of error, a pointer to the network otherwise + * + * Since: v7.7.0 + * */ virNetworkPtr virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int= flags) @@ -556,6 +595,9 @@ virNetworkDefineXMLFlags(virConnectPtr conn, const char= *xml, unsigned int flags * Undefine a network but does not stop it if it is running * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.2.0 + * */ int virNetworkUndefine(virNetworkPtr network) @@ -604,6 +646,9 @@ virNetworkUndefine(virNetworkPtr network) * running state, its persistent configuration, or both. * * Returns 0 in case of success, -1 in case of error + * + * Since: v1.0.0 + * */ int virNetworkUpdate(virNetworkPtr network, @@ -670,6 +715,9 @@ virNetworkUpdate(virNetworkPtr network, * moves from the defined to the running networks pools. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.2.0 + * */ int virNetworkCreate(virNetworkPtr network) @@ -710,6 +758,9 @@ virNetworkCreate(virNetworkPtr network) * This function may require privileged access * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.2.0 + * */ int virNetworkDestroy(virNetworkPtr network) @@ -748,6 +799,9 @@ virNetworkDestroy(virNetworkPtr network) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.2.0 + * */ int virNetworkFree(virNetworkPtr network) @@ -779,6 +833,9 @@ virNetworkFree(virNetworkPtr network) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.0 + * */ int virNetworkRef(virNetworkPtr network) @@ -802,6 +859,9 @@ virNetworkRef(virNetworkPtr network) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the network object. + * + * Since: v0.2.0 + * */ const char * virNetworkGetName(virNetworkPtr network) @@ -824,6 +884,9 @@ virNetworkGetName(virNetworkPtr network) * Get the UUID for a network * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.0 + * */ int virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid) @@ -854,6 +917,9 @@ virNetworkGetUUID(virNetworkPtr network, unsigned char = *uuid) * UUID see RFC4122. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.0 + * */ int virNetworkGetUUIDString(virNetworkPtr network, char *buf) @@ -889,6 +955,9 @@ virNetworkGetUUIDString(virNetworkPtr network, char *bu= f) * * 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 + * */ char * virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags) @@ -926,6 +995,9 @@ virNetworkGetXMLDesc(virNetworkPtr network, unsigned in= t flags) * * Returns a 0 terminated interface name, or NULL in case of * error. The caller must free() the returned value. + * + * Since: v0.2.0 + * */ char * virNetworkGetBridgeName(virNetworkPtr network) @@ -964,6 +1036,9 @@ virNetworkGetBridgeName(virNetworkPtr network) * machine boots. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.1 + * */ int virNetworkGetAutostart(virNetworkPtr network, @@ -1004,6 +1079,9 @@ virNetworkGetAutostart(virNetworkPtr network, * when the host machine boots. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.2.1 + * */ int virNetworkSetAutostart(virNetworkPtr network, @@ -1042,6 +1120,9 @@ virNetworkSetAutostart(virNetworkPtr network, * Determine if the network is currently running * * Returns 1 if running, 0 if inactive, -1 on error + * + * Since: v0.7.3 + * */ int virNetworkIsActive(virNetworkPtr net) @@ -1075,6 +1156,9 @@ virNetworkIsActive(virNetworkPtr net) * which means it will still exist after shutting down * * Returns 1 if persistent, 0 if transient, -1 on error + * + * Since: v0.7.3 + * */ int virNetworkIsPersistent(virNetworkPtr net) @@ -1134,6 +1218,9 @@ virNetworkIsPersistent(virNetworkPtr net) * be passed to the virConnectNetworkEventDeregisterAny() method. * * Returns a callback identifier on success, -1 on failure. + * + * Since: v1.2.1 + * */ int virConnectNetworkEventRegisterAny(virConnectPtr conn, @@ -1195,6 +1282,9 @@ virConnectNetworkEventRegisterAny(virConnectPtr conn, * value obtained from a previous virConnectNetworkEventRegisterAny() meth= od. * * Returns 0 on success, -1 on failure + * + * Since: v1.2.1 + * */ int virConnectNetworkEventDeregisterAny(virConnectPtr conn, @@ -1297,6 +1387,9 @@ virConnectNetworkEventDeregisterAny(virConnectPtr con= n, * Returns the number of leases found or -1 and sets @leases to NULL in * case of error. * + * Since: v1.2.6 + * + * */ int virNetworkGetDHCPLeases(virNetworkPtr network, @@ -1338,6 +1431,9 @@ virNetworkGetDHCPLeases(virNetworkPtr network, * @lease: pointer to a leases object * * Frees all the memory occupied by @lease. + * + * Since: v1.2.6 + * */ void virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease) @@ -1366,6 +1462,9 @@ 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 rai= sed. + * + * Since: v5.5.0 + * */ virNetworkPortPtr virNetworkPortLookupByUUID(virNetworkPtr net, @@ -1403,6 +1502,9 @@ 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 rai= sed. + * + * Since: v5.5.0 + * */ virNetworkPortPtr virNetworkPortLookupByUUIDString(virNetworkPtr net, @@ -1443,6 +1545,9 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, * includes bandwidth parameters. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v5.5.0 + * */ int virNetworkPortSetParameters(virNetworkPortPtr port, @@ -1491,6 +1596,9 @@ virNetworkPortSetParameters(virNetworkPortPtr port, * on success. * * Returns -1 in case of error, 0 in case of success. + * + * Since: v5.5.0 + * */ int virNetworkPortGetParameters(virNetworkPortPtr port, @@ -1535,6 +1643,9 @@ virNetworkPortGetParameters(virNetworkPortPtr port, * network port object is no longer needed. * * Returns a new network port object or NULL in case of failure + * + * Since: v5.5.0 + * */ virNetworkPortPtr virNetworkPortCreateXML(virNetworkPtr net, @@ -1573,6 +1684,9 @@ virNetworkPortCreateXML(virNetworkPtr net, * call. * * Returns the virNetworkPtr or NULL in case of failure. + * + * Since: v5.5.0 + * */ virNetworkPtr virNetworkPortGetNetwork(virNetworkPortPtr port) @@ -1597,6 +1711,9 @@ virNetworkPortGetNetwork(virNetworkPortPtr port) * * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of e= rror. * the caller must free() the returned value. + * + * Since: v5.5.0 + * */ char * virNetworkPortGetXMLDesc(virNetworkPortPtr port, @@ -1634,6 +1751,9 @@ virNetworkPortGetXMLDesc(virNetworkPortPtr port, * Get the UUID for a network port * * Returns -1 in case of error, 0 in case of success + * + * Since: v5.5.0 + * */ int virNetworkPortGetUUID(virNetworkPortPtr port, @@ -1665,6 +1785,9 @@ virNetworkPortGetUUID(virNetworkPortPtr port, * UUID see RFC4122. * * Returns -1 in case of error, 0 in case of success + * + * Since: v5.5.0 + * */ int virNetworkPortGetUUIDString(virNetworkPortPtr port, @@ -1697,6 +1820,9 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port, * port. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v5.5.0 + * */ int virNetworkPortDelete(virNetworkPortPtr port, @@ -1745,6 +1871,9 @@ virNetworkPortDelete(virNetworkPortPtr port, * in the return count, to make iteration easier. The caller is responsib= le * for calling virNetworkPortFree() on each array element, then calling * free() on @ports. + * + * Since: v5.5.0 + * */ int virNetworkListAllPorts(virNetworkPtr network, @@ -1782,6 +1911,9 @@ virNetworkListAllPorts(virNetworkPtr network, * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v5.5.0 + * */ int virNetworkPortFree(virNetworkPortPtr port) @@ -1813,6 +1945,9 @@ virNetworkPortFree(virNetworkPortPtr port) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v5.5.0 + * */ int virNetworkPortRef(virNetworkPortPtr port) diff --git a/src/libvirt-nodedev.c b/src/libvirt-nodedev.c index 3695b39270..3f23267b7a 100644 --- a/src/libvirt-nodedev.c +++ b/src/libvirt-nodedev.c @@ -40,6 +40,9 @@ VIR_LOG_INIT("libvirt.nodedev"); * will be restricted to devices with the specified capability * * Returns the number of node devices or -1 in case of error + * + * Since: v0.5.0 + * */ int virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flag= s) @@ -86,6 +89,9 @@ virNodeNumOfDevices(virConnectPtr conn, const char *cap, = unsigned int flags) * count, to make iteration easier. The caller is responsible for calling * virNodeDeviceFree() on each array element, then calling free() on * @devices. + * + * Since: v0.10.2 + * */ int virConnectListAllNodeDevices(virConnectPtr conn, @@ -135,6 +141,9 @@ virConnectListAllNodeDevices(virConnectPtr conn, * will be restricted to devices with the specified capability * * Returns the number of node devices found or -1 in case of error + * + * Since: v0.5.0 + * */ int virNodeListDevices(virConnectPtr conn, @@ -178,6 +187,9 @@ virNodeListDevices(virConnectPtr conn, * node device object is no longer needed. * * Returns a virNodeDevicePtr if found, NULL otherwise. + * + * Since: v0.5.0 + * */ virNodeDevicePtr virNodeDeviceLookupByName(virConnectPtr conn, const char *name) @@ -218,6 +230,9 @@ virNodeDeviceLookupByName(virConnectPtr conn, const cha= r *name) * node device object is no longer needed. * * Returns a virNodeDevicePtr if found, NULL otherwise. + * + * Since: v1.0.3 + * */ virNodeDevicePtr virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn, @@ -260,6 +275,9 @@ virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn, * the device. * * Returns the XML document, or NULL on error + * + * Since: v0.5.0 + * */ char * virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags) @@ -293,6 +311,9 @@ virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned = int flags) * Just return the device name * * Returns the device name or NULL in case of error + * + * Since: v0.5.0 + * */ const char * virNodeDeviceGetName(virNodeDevicePtr dev) @@ -315,6 +336,9 @@ 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 + * */ const char * virNodeDeviceGetParent(virNodeDevicePtr dev) @@ -346,6 +370,9 @@ virNodeDeviceGetParent(virNodeDevicePtr dev) * * Returns the number of capabilities supported by the device or -1 * in case of error. + * + * Since: v0.5.0 + * */ int virNodeDeviceNumOfCaps(virNodeDevicePtr dev) @@ -382,6 +409,9 @@ virNodeDeviceNumOfCaps(virNodeDevicePtr dev) * * Returns the number of capability names listed in @names or -1 * in case of error. + * + * Since: v0.5.0 + * */ int virNodeDeviceListCaps(virNodeDevicePtr dev, @@ -421,6 +451,9 @@ virNodeDeviceListCaps(virNodeDevicePtr dev, * this was the last reference. * * Returns the 0 for success, -1 for error. + * + * Since: v0.5.0 + * */ int virNodeDeviceFree(virNodeDevicePtr dev) @@ -452,6 +485,9 @@ virNodeDeviceFree(virNodeDevicePtr dev) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.0 + * */ int virNodeDeviceRef(virNodeDevicePtr dev) @@ -490,6 +526,9 @@ virNodeDeviceRef(virNodeDevicePtr dev) * API should be used instead. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.1 + * */ int virNodeDeviceDettach(virNodeDevicePtr dev) @@ -543,6 +582,9 @@ virNodeDeviceDettach(virNodeDevicePtr dev) * to the node using the virNodeDeviceReAttach() method. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v1.0.5 + * */ int virNodeDeviceDetachFlags(virNodeDevicePtr dev, @@ -588,6 +630,9 @@ virNodeDeviceDetachFlags(virNodeDevicePtr dev, * If the device is currently in use by a guest, this method may fail. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.1 + * */ int virNodeDeviceReAttach(virNodeDevicePtr dev) @@ -631,6 +676,9 @@ virNodeDeviceReAttach(virNodeDevicePtr dev) * this function may fail. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.1 + * */ int virNodeDeviceReset(virNodeDevicePtr dev) @@ -671,6 +719,9 @@ virNodeDeviceReset(virNodeDevicePtr dev) * node device object is no longer needed. * * Returns a node device object if successful, NULL in case of failure + * + * Since: v0.6.3 + * */ virNodeDevicePtr virNodeDeviceCreateXML(virConnectPtr conn, @@ -710,6 +761,9 @@ virNodeDeviceCreateXML(virConnectPtr conn, * may require privileged access. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.6.3 + * */ int virNodeDeviceDestroy(virNodeDevicePtr dev) @@ -750,6 +804,9 @@ virNodeDeviceDestroy(virNodeDevicePtr dev) * node device object is no longer needed. * * Returns a node device object if successful, NULL in case of failure + * + * Since: v7.3.0 + * */ virNodeDevicePtr virNodeDeviceDefineXML(virConnectPtr conn, @@ -789,6 +846,9 @@ virNodeDeviceDefineXML(virConnectPtr conn, * operating system. This function may require privileged access. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v7.3.0 + * */ int virNodeDeviceUndefine(virNodeDevicePtr dev, @@ -826,6 +886,9 @@ virNodeDeviceUndefine(virNodeDevicePtr dev, * Start a defined node device: * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.5.0 + * */ int virNodeDeviceCreate(virNodeDevicePtr dev, @@ -889,6 +952,9 @@ virNodeDeviceCreate(virNodeDevicePtr dev, * be passed to the virConnectNodeDeviceEventDeregisterAny() method. * * Returns a callback identifier on success, -1 on failure. + * + * Since: v2.2.0 + * */ int virConnectNodeDeviceEventRegisterAny(virConnectPtr conn, @@ -953,6 +1019,9 @@ virConnectNodeDeviceEventRegisterAny(virConnectPtr con= n, * value obtained from a previous virConnectNodeDeviceEventRegisterAny() m= ethod. * * Returns 0 on success, -1 on failure. + * + * Since: v2.2.0 + * */ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn, @@ -990,6 +1059,9 @@ virConnectNodeDeviceEventDeregisterAny(virConnectPtr c= onn, * boots or the parent device becomes available. * * Returns -1 in case of error, 0 in case of success + * + * Since: v7.8.0 + * */ int virNodeDeviceSetAutostart(virNodeDevicePtr dev, @@ -1029,6 +1101,9 @@ virNodeDeviceSetAutostart(virNodeDevicePtr dev, * becomes available. * * Returns -1 in case of error, 0 in case of success + * + * Since: v7.8.0 + * */ int virNodeDeviceGetAutostart(virNodeDevicePtr dev, @@ -1065,6 +1140,9 @@ virNodeDeviceGetAutostart(virNodeDevicePtr dev, * which means it will still exist after shutting down * * Returns 1 if persistent, 0 if transient, -1 on error + * + * Since: v7.8.0 + * */ int virNodeDeviceIsPersistent(virNodeDevicePtr dev) @@ -1098,6 +1176,9 @@ virNodeDeviceIsPersistent(virNodeDevicePtr dev) * Determine if the node device is currently active * * Returns 1 if active, 0 if inactive, -1 on error + * + * Since: v7.8.0 + * */ int virNodeDeviceIsActive(virNodeDevicePtr dev) { diff --git a/src/libvirt-nwfilter.c b/src/libvirt-nwfilter.c index 73b061152e..e3d4375bad 100644 --- a/src/libvirt-nwfilter.c +++ b/src/libvirt-nwfilter.c @@ -35,6 +35,9 @@ VIR_LOG_INIT("libvirt.nwfilter"); * Provides the number of nwfilters. * * Returns the number of nwfilters found or -1 in case of error + * + * Since: v0.8.0 + * */ int virConnectNumOfNWFilters(virConnectPtr conn) @@ -77,6 +80,9 @@ virConnectNumOfNWFilters(virConnectPtr conn) * have an extra allocated element set to NULL but not included in the ret= urn count, * to make iteration easier. The caller is responsible for calling * virNWFilterFree() on each array element, then calling free() on @filter= s. + * + * Since: v0.10.2 + * */ int virConnectListAllNWFilters(virConnectPtr conn, @@ -121,6 +127,9 @@ virConnectListAllNWFilters(virConnectPtr conn, * virConnectListAllNWFilters(). * * Returns the number of network filters found or -1 in case of error + * + * Since: v0.8.0 + * */ int virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnam= es) @@ -161,6 +170,9 @@ virConnectListNWFilters(virConnectPtr conn, char **cons= t 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 raise= d. + * + * Since: v0.8.0 + * */ virNWFilterPtr virNWFilterLookupByName(virConnectPtr conn, const char *name) @@ -200,6 +212,9 @@ 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 + * */ virNWFilterPtr virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -239,6 +254,9 @@ virNWFilterLookupByUUID(virConnectPtr conn, const unsig= ned 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 + * */ virNWFilterPtr virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -274,6 +292,9 @@ virNWFilterLookupByUUIDString(virConnectPtr conn, const= char *uuidstr) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.8.0 + * */ int virNWFilterFree(virNWFilterPtr nwfilter) @@ -297,6 +318,9 @@ virNWFilterFree(virNWFilterPtr nwfilter) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the nwfilter object. + * + * Since: v0.8.0 + * */ const char * virNWFilterGetName(virNWFilterPtr nwfilter) @@ -319,6 +343,9 @@ virNWFilterGetName(virNWFilterPtr nwfilter) * Get the UUID for a network filter * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.8.0 + * */ int virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid) @@ -349,6 +376,9 @@ virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned ch= ar *uuid) * UUID see RFC4122. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.8.0 + * */ int virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf) @@ -381,6 +411,9 @@ virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char = *buf) * nwfilter object is no longer needed. * * Returns a new nwfilter object or NULL in case of failure + * + * Since: v0.8.0 + * */ virNWFilterPtr virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc) @@ -422,6 +455,9 @@ virNWFilterDefineXML(virConnectPtr conn, const char *xm= lDesc) * nwfilter object is no longer needed. * * Returns a new nwfilter object or NULL in case of failure + * + * Since: v7.7.0 + * */ virNWFilterPtr virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigne= d int flags) @@ -459,6 +495,9 @@ virNWFilterDefineXMLFlags(virConnectPtr conn, const cha= r *xmlDesc, unsigned int * associated virNWFilterPtr object. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.8.0 + * */ int virNWFilterUndefine(virNWFilterPtr nwfilter) @@ -499,6 +538,9 @@ 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 + * */ char * virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags) @@ -543,6 +585,9 @@ virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned= int flags) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.8.0 + * */ int virNWFilterRef(virNWFilterPtr nwfilter) @@ -574,6 +619,9 @@ virNWFilterRef(virNWFilterPtr nwfilter) * have an extra allocated element set to NULL but not included in the ret= urn count, * to make iteration easier. The caller is responsible for calling * virNWFilterFree() on each array element, then calling free() on @filter= s. + * + * Since: v4.5.0 + * */ int virConnectListAllNWFilterBindings(virConnectPtr conn, @@ -620,6 +668,9 @@ virConnectListAllNWFilterBindings(virConnectPtr conn, * Returns a new binding object or NULL in case of failure. If the * network filter cannot be found, then VIR_ERR_NO_NWFILTER_BINDING * error is raised. + * + * Since: v4.5.0 + * */ virNWFilterBindingPtr virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev) @@ -655,6 +706,9 @@ virNWFilterBindingLookupByPortDev(virConnectPtr conn, c= onst char *portdev) * The data structure is freed and should not be used thereafter. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v4.5.0 + * */ int virNWFilterBindingFree(virNWFilterBindingPtr binding) @@ -678,6 +732,9 @@ virNWFilterBindingFree(virNWFilterBindingPtr binding) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the binding object. + * + * Since: v4.5.0 + * */ const char * virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding) @@ -700,6 +757,9 @@ virNWFilterBindingGetPortDev(virNWFilterBindingPtr bind= ing) * * Returns a pointer to the name or NULL, the string need not be deallocat= ed * its lifetime will be the same as the binding object. + * + * Since: v4.5.0 + * */ const char * virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding) @@ -734,6 +794,9 @@ virNWFilterBindingGetFilterName(virNWFilterBindingPtr b= inding) * binding object is no longer needed. * * Returns a new binding object or NULL in case of failure + * + * Since: v4.5.0 + * */ virNWFilterBindingPtr virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned = int flags) @@ -775,6 +838,9 @@ virNWFilterBindingCreateXML(virConnectPtr conn, const c= har *xml, unsigned int fl * would be accomplished by using virNWFilterBindingCreateXML. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v4.5.0 + * */ int virNWFilterBindingDelete(virNWFilterBindingPtr binding) @@ -815,6 +881,9 @@ 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 + * */ char * virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int f= lags) @@ -859,6 +928,9 @@ virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr bind= ing, unsigned int flags) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v4.5.0 + * */ int virNWFilterBindingRef(virNWFilterBindingPtr binding) diff --git a/src/libvirt-secret.c b/src/libvirt-secret.c index d2a3a4bd9d..e0d14f6e4d 100644 --- a/src/libvirt-secret.c +++ b/src/libvirt-secret.c @@ -35,6 +35,9 @@ VIR_LOG_INIT("libvirt.secret"); * counter on the connection is not increased by this call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.7.1 + * */ virConnectPtr virSecretGetConnect(virSecretPtr secret) @@ -56,6 +59,9 @@ virSecretGetConnect(virSecretPtr secret) * Fetch number of currently defined secrets. * * Returns the number currently defined secrets. + * + * Since: v0.7.1 + * */ int virConnectNumOfSecrets(virConnectPtr conn) @@ -116,6 +122,9 @@ virConnectNumOfSecrets(virConnectPtr conn) * have an extra allocated element set to NULL but not included in the ret= urn count, * to make iteration easier. The caller is responsible for calling * virSecretFree() on each array element, then calling free() on @secrets. + * + * Since: v0.10.2 + * */ int virConnectListAllSecrets(virConnectPtr conn, @@ -160,6 +169,9 @@ virConnectListAllSecrets(virConnectPtr conn, * virConnectListAllSecrets(). * * Returns the number of UUIDs provided in the array, or -1 on failure. + * + * Since: v0.7.1 + * */ int virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids) @@ -202,6 +214,9 @@ 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 + * */ virSecretPtr virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid) @@ -243,6 +258,9 @@ virSecretLookupByUUID(virConnectPtr conn, const unsigne= d 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 + * */ virSecretPtr virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr) @@ -285,6 +303,9 @@ virSecretLookupByUUIDString(virConnectPtr conn, const c= har *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 + * */ virSecretPtr virSecretLookupByUsage(virConnectPtr conn, @@ -332,6 +353,9 @@ virSecretLookupByUsage(virConnectPtr conn, * secret object is no longer needed. * * Returns a secret on success, NULL on failure. + * + * Since: v0.7.1 + * */ virSecretPtr virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags) @@ -370,6 +394,9 @@ 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 + * */ int virSecretGetUUID(virSecretPtr secret, unsigned char *uuid) @@ -400,6 +427,9 @@ virSecretGetUUID(virSecretPtr secret, unsigned char *uu= id) * UUID see RFC4122. * * Returns -1 in case of error, 0 in case of success + * + * Since: v0.7.1 + * */ int virSecretGetUUIDString(virSecretPtr secret, char *buf) @@ -432,6 +462,9 @@ virSecretGetUUIDString(virSecretPtr secret, char *buf) * * Returns a positive integer identifying the type of object, * or -1 upon error. + * + * Since: v0.7.1 + * */ int virSecretGetUsageType(virSecretPtr secret) @@ -461,6 +494,9 @@ virSecretGetUsageType(virSecretPtr secret) * * Returns a string identifying the object using the secret, * or NULL upon error + * + * Since: v0.7.1 + * */ const char * virSecretGetUsageID(virSecretPtr secret) @@ -484,6 +520,9 @@ virSecretGetUsageID(virSecretPtr secret) * * Returns the XML document on success, NULL on failure. The caller must * free() the XML. + * + * Since: v0.7.1 + * */ char * virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags) @@ -524,6 +563,9 @@ virSecretGetXMLDesc(virSecretPtr secret, unsigned int f= lags) * Sets the value of a secret. * * Returns 0 on success, -1 on failure. + * + * Since: v0.7.1 + * */ int virSecretSetValue(virSecretPtr secret, const unsigned char *value, @@ -569,6 +611,9 @@ virSecretSetValue(virSecretPtr secret, const unsigned c= har *value, * * Returns the secret value on success, NULL on failure. The caller must * free() the secret value. + * + * Since: v0.7.1 + * */ unsigned char * virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int fl= ags) @@ -610,6 +655,9 @@ virSecretGetValue(virSecretPtr secret, size_t *value_si= ze, unsigned int flags) * virSecretPtr object. * * Returns 0 on success, -1 on failure. + * + * Since: v0.7.1 + * */ int virSecretUndefine(virSecretPtr secret) @@ -657,6 +705,9 @@ virSecretUndefine(virSecretPtr secret) * increment the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.7.1 + * */ int virSecretRef(virSecretPtr secret) @@ -679,6 +730,9 @@ virSecretRef(virSecretPtr secret) * Release the secret handle. The underlying secret continues to exist. * * Returns 0 on success, or -1 on error + * + * Since: v0.7.1 + * */ int virSecretFree(virSecretPtr secret) @@ -728,6 +782,9 @@ virSecretFree(virSecretPtr secret) * be passed to the virConnectSecretEventDeregisterAny() method. * * Returns a callback identifier on success, -1 on failure. + * + * Since: v3.0.0 + * */ int virConnectSecretEventRegisterAny(virConnectPtr conn, @@ -794,6 +851,9 @@ virConnectSecretEventRegisterAny(virConnectPtr conn, * value obtained from a previous virConnectSecretEventRegisterAny() metho= d. * * Returns 0 on success, -1 on failure. + * + * Since: v3.0.0 + * */ int virConnectSecretEventDeregisterAny(virConnectPtr conn, diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c index cbc522b300..61d062f847 100644 --- a/src/libvirt-storage.c +++ b/src/libvirt-storage.c @@ -37,6 +37,9 @@ VIR_LOG_INIT("libvirt.storage"); * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.4.1 + * */ virConnectPtr virStoragePoolGetConnect(virStoragePoolPtr pool) @@ -104,6 +107,9 @@ virStoragePoolGetConnect(virStoragePoolPtr pool) * in the return count, to make iteration easier. The caller is responsib= le * for calling virStoragePoolFree() on each array element, then calling * free() on @pools. + * + * Since: v0.10.2 + * */ int virConnectListAllStoragePools(virConnectPtr conn, @@ -143,6 +149,9 @@ virConnectListAllStoragePools(virConnectPtr conn, * Provides the number of active storage pools * * Returns the number of pools found, or -1 on error + * + * Since: v0.4.1 + * */ int virConnectNumOfStoragePools(virConnectPtr conn) @@ -187,6 +196,9 @@ virConnectNumOfStoragePools(virConnectPtr conn) * virConnectNumOfStoragePools() and this call; you are only guaranteed * 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 + * */ int virConnectListStoragePools(virConnectPtr conn, @@ -224,6 +236,9 @@ virConnectListStoragePools(virConnectPtr conn, * Provides the number of inactive storage pools * * Returns the number of pools found, or -1 on error + * + * Since: v0.4.1 + * */ int virConnectNumOfDefinedStoragePools(virConnectPtr conn) @@ -268,6 +283,9 @@ virConnectNumOfDefinedStoragePools(virConnectPtr conn) * a call to virConnectNumOfDefinedStoragePools() and this call; you are o= nly * guaranteed that all currently defined pools were listed if the return * is less than @maxnames. The client must call free() on each returned n= ame. + * + * Since: v0.4.1 + * */ int virConnectListDefinedStoragePools(virConnectPtr conn, @@ -318,6 +336,9 @@ virConnectListDefinedStoragePools(virConnectPtr conn, * Returns an xml document consisting of a SourceList element * containing a source document appropriate to the given pool * type for each discovered source. + * + * Since: v0.4.6 + * */ char * virConnectFindStoragePoolSources(virConnectPtr conn, @@ -361,6 +382,9 @@ virConnectFindStoragePoolSources(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolLookupByName(virConnectPtr conn, @@ -400,6 +424,9 @@ virStoragePoolLookupByName(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolLookupByUUID(virConnectPtr conn, @@ -439,6 +466,9 @@ virStoragePoolLookupByUUID(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolLookupByUUIDString(virConnectPtr conn, @@ -477,6 +507,9 @@ virStoragePoolLookupByUUIDString(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolLookupByVolume(virStorageVolPtr vol) @@ -516,6 +549,9 @@ virStoragePoolLookupByVolume(virStorageVolPtr vol) * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if no matching pool is found + * + * Since: v4.1.0 + * */ virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn, @@ -557,6 +593,9 @@ virStoragePoolLookupByTargetPath(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if creation failed + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolCreateXML(virConnectPtr conn, @@ -600,6 +639,9 @@ virStoragePoolCreateXML(virConnectPtr conn, * storage pool object is no longer needed. * * Returns a virStoragePoolPtr object, or NULL if creation failed + * + * Since: v0.4.1 + * */ virStoragePoolPtr virStoragePoolDefineXML(virConnectPtr conn, @@ -641,6 +683,9 @@ virStoragePoolDefineXML(virConnectPtr conn, * Build the underlying storage pool * * Returns 0 on success, or -1 upon failure + * + * Since: v0.4.1 + * */ int virStoragePoolBuild(virStoragePoolPtr pool, @@ -679,6 +724,9 @@ virStoragePoolBuild(virStoragePoolPtr pool, * Undefine an inactive storage pool * * Returns 0 on success, -1 on failure + * + * Since: v0.4.1 + * */ int virStoragePoolUndefine(virStoragePoolPtr pool) @@ -717,6 +765,9 @@ virStoragePoolUndefine(virStoragePoolPtr pool) * Starts an inactive storage pool * * Returns 0 on success, or -1 if it could not be started + * + * Since: v0.4.1 + * */ int virStoragePoolCreate(virStoragePoolPtr pool, @@ -759,6 +810,9 @@ virStoragePoolCreate(virStoragePoolPtr pool, * the associated virStoragePoolPtr object. * * Returns 0 on success, or -1 if it could not be destroyed + * + * Since: v0.4.1 + * */ int virStoragePoolDestroy(virStoragePoolPtr pool) @@ -799,6 +853,9 @@ virStoragePoolDestroy(virStoragePoolPtr pool) * itself is not free'd. * * Returns 0 on success, or -1 if it could not be obliterate + * + * Since: v0.4.1 + * */ int virStoragePoolDelete(virStoragePoolPtr pool, @@ -838,6 +895,9 @@ virStoragePoolDelete(virStoragePoolPtr pool, * it. Does not change the state of the pool on the host. * * Returns 0 on success, or -1 if it could not be free'd. + * + * Since: v0.4.1 + * */ int virStoragePoolFree(virStoragePoolPtr pool) @@ -870,6 +930,9 @@ virStoragePoolFree(virStoragePoolPtr pool) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.0 + * */ int virStoragePoolRef(virStoragePoolPtr pool) @@ -895,6 +958,9 @@ virStoragePoolRef(virStoragePoolPtr pool) * new devices at the OS layer * * Returns 0 if the volume list was refreshed, -1 on failure + * + * Since: v0.4.1 + * */ int virStoragePoolRefresh(virStoragePoolPtr pool, @@ -933,6 +999,9 @@ virStoragePoolRefresh(virStoragePoolPtr pool, * Fetch the locally unique name of the storage pool * * Returns the name of the pool, or NULL on error + * + * Since: v0.4.1 + * */ const char* virStoragePoolGetName(virStoragePoolPtr pool) @@ -955,6 +1024,9 @@ virStoragePoolGetName(virStoragePoolPtr pool) * Fetch the globally unique ID of the storage pool * * Returns 0 on success, or -1 on error; + * + * Since: v0.4.1 + * */ int virStoragePoolGetUUID(virStoragePoolPtr pool, @@ -985,6 +1057,9 @@ virStoragePoolGetUUID(virStoragePoolPtr pool, * Fetch the globally unique ID of the storage pool as a string * * Returns 0 on success, or -1 on error; + * + * Since: v0.4.1 + * */ int virStoragePoolGetUUIDString(virStoragePoolPtr pool, @@ -1015,6 +1090,9 @@ virStoragePoolGetUUIDString(virStoragePoolPtr pool, * such as free space / usage summary * * Returns 0 on success, or -1 on failure. + * + * Since: v0.4.1 + * */ int virStoragePoolGetInfo(virStoragePoolPtr pool, @@ -1059,6 +1137,9 @@ virStoragePoolGetInfo(virStoragePoolPtr pool, * into the virStoragePoolCreateXML method. * * Returns a XML document (caller frees), or NULL on error + * + * Since: v0.4.1 + * */ char * virStoragePoolGetXMLDesc(virStoragePoolPtr pool, @@ -1097,6 +1178,9 @@ virStoragePoolGetXMLDesc(virStoragePoolPtr pool, * whether the pool is automatically started at boot time * * Returns 0 on success, -1 on failure + * + * Since: v0.4.1 + * */ int virStoragePoolGetAutostart(virStoragePoolPtr pool, @@ -1137,6 +1221,9 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool, * when the host machine boots. * * Returns 0 on success, -1 on failure + * + * Since: v0.4.1 + * */ int virStoragePoolSetAutostart(virStoragePoolPtr pool, @@ -1185,6 +1272,9 @@ virStoragePoolSetAutostart(virStoragePoolPtr pool, * in the return count, to make iteration easier. The caller is responsib= le * for calling virStorageVolFree() on each array element, then calling * free() on @vols. + * + * Since: v0.10.2 + * */ int virStoragePoolListAllVolumes(virStoragePoolPtr pool, @@ -1221,6 +1311,9 @@ virStoragePoolListAllVolumes(virStoragePoolPtr pool, * Fetch the number of storage volumes within a pool * * Returns the number of storage pools, or -1 on failure + * + * Since: v0.4.1 + * */ int virStoragePoolNumOfVolumes(virStoragePoolPtr pool) @@ -1260,6 +1353,9 @@ virStoragePoolNumOfVolumes(virStoragePoolPtr pool) * virStoragePoolListAllVolumes(). * * Returns the number of names fetched, or -1 on error + * + * Since: v0.4.1 + * */ int virStoragePoolListVolumes(virStoragePoolPtr pool, @@ -1299,6 +1395,9 @@ virStoragePoolListVolumes(virStoragePoolPtr pool, * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.4.1 + * */ virConnectPtr virStorageVolGetConnect(virStorageVolPtr vol) @@ -1325,6 +1424,9 @@ virStorageVolGetConnect(virStorageVolPtr vol) * storage volume object is no longer needed. * * Returns a storage volume, or NULL if not found / error + * + * Since: v0.4.1 + * */ virStorageVolPtr virStorageVolLookupByName(virStoragePoolPtr pool, @@ -1365,6 +1467,9 @@ virStorageVolLookupByName(virStoragePoolPtr pool, * storage volume object is no longer needed. * * Returns a storage volume, or NULL if not found / error + * + * Since: v0.4.1 + * */ virStorageVolPtr virStorageVolLookupByKey(virConnectPtr conn, @@ -1405,6 +1510,9 @@ virStorageVolLookupByKey(virConnectPtr conn, * storage volume object is no longer needed. * * Returns a storage volume, or NULL if not found / error + * + * Since: v0.4.1 + * */ virStorageVolPtr virStorageVolLookupByPath(virConnectPtr conn, @@ -1441,6 +1549,9 @@ virStorageVolLookupByPath(virConnectPtr conn, * within the scope of a pool * * Returns the volume name, or NULL on error + * + * Since: v0.4.1 + * */ const char* virStorageVolGetName(virStorageVolPtr vol) @@ -1464,6 +1575,9 @@ virStorageVolGetName(virStorageVolPtr vol) * key no matter what host it is accessed from * * Returns the volume key, or NULL on error + * + * Since: v0.4.1 + * */ const char* virStorageVolGetKey(virStorageVolPtr vol) @@ -1497,6 +1611,9 @@ virStorageVolGetKey(virStorageVolPtr vol) * storage volume object is no longer needed. * * Returns the storage volume, or NULL on error + * + * Since: v0.4.1 + * */ virStorageVolPtr virStorageVolCreateXML(virStoragePoolPtr pool, @@ -1548,6 +1665,9 @@ virStorageVolCreateXML(virStoragePoolPtr pool, * storage volume object is no longer needed. * * Returns the storage volume, or NULL on error + * + * Since: v0.6.4 + * */ virStorageVolPtr virStorageVolCreateXMLFrom(virStoragePoolPtr pool, @@ -1612,6 +1732,9 @@ virStorageVolCreateXMLFrom(virStoragePoolPtr pool, * another active stream is writing to the storage volume. * * Returns 0, or -1 upon error. + * + * Since: v0.9.0 + * */ int virStorageVolDownload(virStorageVolPtr vol, @@ -1695,6 +1818,9 @@ virStorageVolDownload(virStorageVolPtr vol, * capacity, and allocation. * * Returns 0, or -1 upon error. + * + * Since: v0.9.0 + * */ int virStorageVolUpload(virStorageVolPtr vol, @@ -1748,6 +1874,9 @@ virStorageVolUpload(virStorageVolPtr vol, * Delete the storage volume from the pool * * Returns 0 on success, or -1 on error + * + * Since: v0.4.1 + * */ int virStorageVolDelete(virStorageVolPtr vol, @@ -1797,6 +1926,9 @@ virStorageVolDelete(virStorageVolPtr vol, * network file systems are known to be problematic. * * Returns 0 on success, or -1 on error + * + * Since: v0.8.0 + * */ int virStorageVolWipe(virStorageVolPtr vol, @@ -1843,6 +1975,9 @@ virStorageVolWipe(virStorageVolPtr vol, * problematic. * * Returns 0 on success, or -1 on error. + * + * Since: v0.9.10 + * */ int virStorageVolWipePattern(virStorageVolPtr vol, @@ -1883,6 +2018,9 @@ virStorageVolWipePattern(virStorageVolPtr vol, * storage volume continues to exist. * * Returns 0 on success, or -1 on error + * + * Since: v0.4.1 + * */ int virStorageVolFree(virStorageVolPtr vol) @@ -1914,6 +2052,9 @@ virStorageVolFree(virStorageVolPtr vol) * the reference count. * * Returns 0 in case of success, -1 in case of failure. + * + * Since: v0.6.0 + * */ int virStorageVolRef(virStorageVolPtr vol) @@ -1938,6 +2079,9 @@ virStorageVolRef(virStorageVolPtr vol) * volume such as its current allocation * * Returns 0 on success, or -1 on failure + * + * Since: v0.4.1 + * */ int virStorageVolGetInfo(virStorageVolPtr vol, @@ -1988,6 +2132,9 @@ virStorageVolGetInfo(virStorageVolPtr vol, * as is the case with qcow2 files. * * Returns 0 on success, or -1 on failure + * + * Since: v3.0.0 + * */ int virStorageVolGetInfoFlags(virStorageVolPtr vol, @@ -2032,6 +2179,9 @@ virStorageVolGetInfoFlags(virStorageVolPtr vol, * the storage volume * * Returns the XML document, or NULL on error + * + * Since: v0.4.1 + * */ char * virStorageVolGetXMLDesc(virStorageVolPtr vol, @@ -2073,6 +2223,9 @@ 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 + * */ char * virStorageVolGetPath(virStorageVolPtr vol) @@ -2134,6 +2287,9 @@ virStorageVolGetPath(virStorageVolPtr vol) * than the current size. * * Returns 0 on success, or -1 on error. + * + * Since: v0.9.10 + * */ int virStorageVolResize(virStorageVolPtr vol, @@ -2183,6 +2339,9 @@ virStorageVolResize(virStorageVolPtr vol, * Determine if the storage pool is currently running * * Returns 1 if running, 0 if inactive, -1 on error + * + * Since: v0.7.3 + * */ int virStoragePoolIsActive(virStoragePoolPtr pool) @@ -2216,6 +2375,9 @@ virStoragePoolIsActive(virStoragePoolPtr pool) * which means it will still exist after shutting down * * Returns 1 if persistent, 0 if transient, -1 on error + * + * Since: v0.7.3 + * */ int virStoragePoolIsPersistent(virStoragePoolPtr pool) @@ -2274,6 +2436,9 @@ virStoragePoolIsPersistent(virStoragePoolPtr pool) * be passed to the virConnectStoragePoolEventDeregisterAny() method. * * Returns a callback identifier on success, -1 on failure. + * + * Since: v2.0.0 + * */ int virConnectStoragePoolEventRegisterAny(virConnectPtr conn, @@ -2337,6 +2502,9 @@ virConnectStoragePoolEventRegisterAny(virConnectPtr c= onn, * value obtained from a previous virConnectStoragePoolEventRegisterAny() = method. * * Returns 0 on success, -1 on failure + * + * Since: v2.0.0 + * */ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn, @@ -2376,6 +2544,9 @@ virConnectStoragePoolEventDeregisterAny(virConnectPtr= conn, * are supported along with the file/disk formats for each pool. * * Returns NULL in case of error or an XML string defining the capabilitie= s. + * + * Since: v5.2.0 + * */ char * virConnectGetStoragePoolCapabilities(virConnectPtr conn, diff --git a/src/libvirt-stream.c b/src/libvirt-stream.c index 80dbc83a59..35beb67a10 100644 --- a/src/libvirt-stream.c +++ b/src/libvirt-stream.c @@ -52,6 +52,9 @@ VIR_LOG_INIT("libvirt.stream"); * VIR_STREAM_NONBLOCK for flags, otherwise pass 0. * * Returns the new stream, or NULL upon error + * + * Since: v0.7.2 + * */ virStreamPtr virStreamNew(virConnectPtr conn, @@ -85,6 +88,9 @@ virStreamNew(virConnectPtr conn, * the caller no longer needs the reference to this object. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v0.7.2 + * */ int virStreamRef(virStreamPtr stream) @@ -163,6 +169,9 @@ virStreamRef(virStreamPtr stream) * * Returns -2 if the outgoing transmit buffers are full & * the stream is marked as non-blocking. + * + * Since: v0.7.2 + * */ int virStreamSend(virStreamPtr stream, @@ -258,6 +267,9 @@ 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 + * */ int virStreamRecv(virStreamPtr stream, @@ -345,6 +357,9 @@ virStreamRecv(virStreamPtr stream, * * Returns -3 if there is a hole in stream and caller requested * to stop at a hole. + * + * Since: v3.4.0 + * */ int virStreamRecvFlags(virStreamPtr stream, @@ -412,6 +427,9 @@ virStreamRecvFlags(virStreamPtr stream, * * Returns 0 on success, * -1 error + * + * Since: v3.4.0 + * */ int virStreamSendHole(virStreamPtr stream, @@ -455,6 +473,9 @@ virStreamSendHole(virStreamPtr stream, * * Returns 0 on success, * -1 on error or when there's currently no hole in the stream + * + * Since: v3.4.0 + * */ int virStreamRecvHole(virStreamPtr stream, @@ -577,6 +598,9 @@ virStreamInData(virStreamPtr stream, * Returns -1 upon any error, with virStreamAbort() already * having been called, so the caller need only call * virStreamFree(). + * + * Since: v0.7.2 + * */ int virStreamSendAll(virStreamPtr stream, @@ -706,6 +730,9 @@ virStreamSendAll(virStreamPtr stream, * Returns -1 upon any error, with virStreamAbort() already * having been called, so the caller need only call * virStreamFree(). + * + * Since: v3.4.0 + * */ int virStreamSparseSendAll(virStreamPtr stream, virStreamSourceFunc handler, @@ -845,6 +872,9 @@ int virStreamSparseSendAll(virStreamPtr stream, * Returns -1 upon any error, with virStreamAbort() already * having been called, so the caller need only call * virStreamFree() + * + * Since: v0.7.2 + * */ int virStreamRecvAll(virStreamPtr stream, @@ -958,6 +988,9 @@ 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 + * */ int virStreamSparseRecvAll(virStreamPtr stream, @@ -1051,6 +1084,9 @@ virStreamSparseRecvAll(virStreamPtr stream, * to integrate into an event loop * * Returns 0 on success, -1 upon error + * + * Since: v0.7.2 + * */ int virStreamEventAddCallback(virStreamPtr stream, @@ -1094,6 +1130,9 @@ virStreamEventAddCallback(virStreamPtr stream, * is guaranteed to succeed if a callback is already registered * * Returns 0 on success, -1 if no callback is registered + * + * Since: v0.7.2 + * */ int virStreamEventUpdateCallback(virStreamPtr stream, @@ -1129,6 +1168,9 @@ virStreamEventUpdateCallback(virStreamPtr stream, * Remove an event callback from the stream * * Returns 0 on success, -1 on error + * + * Since: v0.7.2 + * */ int virStreamEventRemoveCallback(virStreamPtr stream) @@ -1173,6 +1215,9 @@ virStreamEventRemoveCallback(virStreamPtr stream) * beforehand. * * Returns 0 on success, -1 upon error + * + * Since: v0.7.2 + * */ int virStreamFinish(virStreamPtr stream) @@ -1215,6 +1260,9 @@ virStreamFinish(virStreamPtr stream) * beforehand. * * Returns 0 on success, -1 upon error + * + * Since: v0.7.2 + * */ int virStreamAbort(virStreamPtr stream) @@ -1259,6 +1307,9 @@ virStreamAbort(virStreamPtr stream) * the virStreamAbort function should be called first. * * Returns 0 upon success, or -1 on error + * + * Since: v0.7.2 + * */ int virStreamFree(virStreamPtr stream) diff --git a/src/libvirt.c b/src/libvirt.c index 6cda75d1ca..0c8e787920 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -296,6 +296,9 @@ virGlobalInit(void) * connection attempt. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.1.0 + * */ int virInitialize(void) @@ -797,6 +800,9 @@ 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 + rele= ase. + * + * Since: v0.0.1 + * */ int virGetVersion(unsigned long *libVer, const char *type G_GNUC_UNUSED, @@ -1185,6 +1191,9 @@ virConnectOpenInternal(const char *name, * is no longer needed. * * Returns a pointer to the hypervisor connection or NULL in case of error + * + * Since: v0.0.1 + * */ virConnectPtr virConnectOpen(const char *name) @@ -1218,6 +1227,9 @@ virConnectOpen(const char *name) * URIs are documented at https://libvirt.org/uri.html * * Returns a pointer to the hypervisor connection or NULL in case of error + * + * Since: v0.0.1 + * */ virConnectPtr virConnectOpenReadOnly(const char *name) @@ -1252,6 +1264,9 @@ virConnectOpenReadOnly(const char *name) * URIs are documented at https://libvirt.org/uri.html * * Returns a pointer to the hypervisor connection or NULL in case of error + * + * Since: v0.4.1 + * */ virConnectPtr virConnectOpenAuth(const char *name, @@ -1300,6 +1315,9 @@ virConnectOpenAuth(const char *name, * value if some other object still has a temporary reference to the * connection, but the application should not try to further use a * connection after the virConnectClose that matches the initial open. + * + * Since: v0.0.1 + * */ int virConnectClose(virConnectPtr conn) diff --git a/src/util/virerror.c b/src/util/virerror.c index e864a50fba..7d009d2298 100644 --- a/src/util/virerror.c +++ b/src/util/virerror.c @@ -254,6 +254,9 @@ virLastErrorObject(void) * threads can safely access this concurrently. * * Returns a pointer to the last error or NULL if none occurred. + * + * Since: v0.1.0 + * */ virErrorPtr virGetLastError(void) @@ -271,6 +274,9 @@ virGetLastError(void) * Get the most recent error code (enum virErrorNumber). * * Returns the most recent error code, or VIR_ERR_OK if none is set. + * + * Since: v4.5.0 + * */ int virGetLastErrorCode(void) @@ -289,6 +295,9 @@ virGetLastErrorCode(void) * * Returns a numerical value of the most recent error's origin, or VIR_FRO= M_NONE * if none is set. + * + * Since: v4.5.0 + * */ int virGetLastErrorDomain(void) @@ -307,6 +316,9 @@ virGetLastErrorDomain(void) * * Returns the most recent error message string in this * thread, or a generic message if none is set + * + * Since: v1.0.5.2 + * */ const char * virGetLastErrorMessage(void) @@ -361,6 +373,9 @@ virSetError(virErrorPtr newerr) * One will need to free the result with virResetError() * * Returns error code or -1 in case of parameter error. + * + * Since: v0.1.0 + * */ int virCopyLastError(virErrorPtr to) @@ -392,6 +407,9 @@ virCopyLastError(virErrorPtr to) * Returns a pointer to the copied error or NULL if allocation failed. * It is the caller's responsibility to free the error with * virFreeError(). + * + * Since: v0.6.1 + * */ virErrorPtr virSaveLastError(void) @@ -455,6 +473,9 @@ virErrorRestore(virErrorPtr *savederr) * @err: pointer to the virError to clean up * * Reset the error being pointed to + * + * Since: v0.1.0 + * */ void virResetError(virErrorPtr err) @@ -473,6 +494,9 @@ virResetError(virErrorPtr err) * @err: error to free * * Resets and frees the given error. + * + * Since: v0.6.1 + * */ void virFreeError(virErrorPtr err) @@ -489,6 +513,9 @@ virFreeError(virErrorPtr err) * The error object is kept in thread local storage, so separate * threads can safely access this concurrently, only resetting * their own error object. + * + * Since: v0.1.0 + * */ void virResetLastError(void) @@ -519,6 +546,9 @@ virResetLastError(void) * remains for backwards compatibility. * * Returns a pointer to the last error or NULL if none occurred. + * + * Since: v0.1.0 + * */ virErrorPtr virConnGetLastError(virConnectPtr conn) @@ -553,6 +583,9 @@ 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 + * */ int virConnCopyLastError(virConnectPtr conn, virErrorPtr to) @@ -579,6 +612,9 @@ virConnCopyLastError(virConnectPtr conn, virErrorPtr to) * threads can safely access this concurrently. * * Reset the last error caught on that connection + * + * Since: v0.1.0 + * */ void virConnResetLastError(virConnectPtr conn) @@ -598,6 +634,9 @@ virConnResetLastError(virConnectPtr conn) * Set a library global error handling function, if @handler is NULL, * 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 + * */ void virSetErrorFunc(void *userData, virErrorFunc handler) @@ -615,6 +654,9 @@ virSetErrorFunc(void *userData, virErrorFunc handler) * Set a connection error handling function, if @handler is NULL * it will reset to default which is to pass error back to the global * library handler. + * + * Since: v0.1.0 + * */ void virConnSetErrorFunc(virConnectPtr conn, void *userData, @@ -633,6 +675,9 @@ virConnSetErrorFunc(virConnectPtr conn, void *userData, * @err: pointer to the error. * * Default routine reporting an error to stderr. + * + * Since: v0.1.0 + * */ void virDefaultErrorFunc(virErrorPtr err) diff --git a/src/util/virevent.c b/src/util/virevent.c index f6eb806faf..6914901507 100644 --- a/src/util/virevent.c +++ b/src/util/virevent.c @@ -69,6 +69,9 @@ 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 + * */ int virEventAddHandle(int fd, @@ -94,6 +97,9 @@ virEventAddHandle(int fd, * virEventRegisterImpl() or virEventRegisterDefaultImpl(). * * Will not fail if fd exists. + * + * Since: v0.9.3 + * */ void virEventUpdateHandle(int watch, int events) @@ -112,6 +118,9 @@ virEventUpdateHandle(int watch, int events) * virEventRegisterImpl() or virEventRegisterDefaultImpl(). * * Returns -1 if the file handle was not registered, 0 upon success. + * + * Since: v0.9.3 + * */ int virEventRemoveHandle(int watch) @@ -139,6 +148,9 @@ virEventRemoveHandle(int watch) * * Returns -1 if the timer cannot be registered, a positive * integer timer id upon success. + * + * Since: v0.9.3 + * */ int virEventAddTimeout(int timeout, @@ -166,6 +178,9 @@ virEventAddTimeout(int timeout, * to zero will cause it to fire on every event loop iteration. * * Will not fail if timer exists. + * + * Since: v0.9.3 + * */ void virEventUpdateTimeout(int timer, int timeout) @@ -184,6 +199,9 @@ virEventUpdateTimeout(int timer, int timeout) * virEventRegisterImpl() or virEventRegisterDefaultImpl(). * * Returns -1 if the timer was not registered, 0 upon success. + * + * Since: v0.9.3 + * */ int virEventRemoveTimeout(int timer) @@ -232,6 +250,9 @@ virEventRemoveTimeout(int timer) * virConnectClose on all open connections, so it is not safe * to stop running the event loop immediately after closing * the connection. + * + * Since: v0.5.0 + * */ void virEventRegisterImpl(virEventAddHandleFunc addHandle, virEventUpdateHandleFunc updateHandle, @@ -300,6 +321,9 @@ int virEventRequireImpl(void) * virEventAddHandle() or virConnectDomainEventRegisterAny(). * * Returns 0 on success, -1 on failure. + * + * Since: v0.9.0 + * */ int virEventRegisterDefaultImpl(void) { @@ -335,6 +359,9 @@ int virEventRegisterDefaultImpl(void) * } * * Returns 0 on success, -1 on failure. + * + * Since: v0.9.0 + * */ int virEventRunDefaultImpl(void) { --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481807; cv=none; d=zohomail.com; s=zohoarc; b=kwbyhoJzu2IcWchns37PowNNWC/9i+lNYyjVrxZoUVj5aPtXMIzNXdrLgUla6dBAjjkkreFDnANd751V14sS6cxENK0ZN/6dLZioxqckkTGeO7qxsy7jxdvFzETgmVnoUozAS89GVKRc5wV3M1ey2VzSIs1muy1I6RXndOF77pw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481807; 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=RF43UgXya+dpGFuicRQMM3raJg+0qnuG8c3d21BulO4=; b=KPLaxWjjXxN+lhDJhfU3K0JNHW2AC0EaLm6E2sANB7K24tKb0AL5Azxa/5LEsFLegGv6UfFqt3maOK6xtBMyZc0gigHohwyWjV/c06/rUmCzAelgkEoXtEYGEWoheYg4/6D9bBNSfUZUk/OqyyEqdUUiPAfRMHMyQVFdJP3z/1M= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481807596508.2934117546205; Wed, 20 Apr 2022 12:10:07 -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-417-jfhC6eVZMxy9xdJg7fK1Tw-1; Wed, 20 Apr 2022 15:08:46 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 7D3FD8339A4; Wed, 20 Apr 2022 19:08:38 +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 5F17A551E89; Wed, 20 Apr 2022 19:08:38 +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 BBEE81940359; Wed, 20 Apr 2022 19:08:37 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id BF2091940352 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:36 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id A543F551E85; Wed, 20 Apr 2022 19:08:36 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0EDD4551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481806; 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=RF43UgXya+dpGFuicRQMM3raJg+0qnuG8c3d21BulO4=; b=DvR3FJmdYyS9GGZRzIoq3zznyE/QaWPNjYJbY5/blT3eK8Ju5HHRNL9WICSiRqGd9xax/9 8Z4LBHY1zPIPblBs3jL75k2sY91z688bagvLOzl9v4Es1Itrb8u0XypGlkTBWHaYGVXtBG aRfYYMkut9qUNx5P9wjUmZtJwRTURTs= X-MC-Unique: jfhC6eVZMxy9xdJg7fK1Tw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 14/30] docstring: function: qemu: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:03 +0200 Message-Id: <20220420190819.3093205-15-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481808647100003 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 <victortoso@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- include/libvirt/libvirt-qemu.h | 3 +++ src/libvirt-qemu.c | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index 9697b54158..fb422a3a21 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -86,6 +86,9 @@ char *virDomainQemuAgentCommand(virDomainPtr domain, cons= t char *cmd, * * The callback signature to use when registering for a qemu monitor * event with virConnectDomainQemuMonitorEventRegister(). + * + * Since: v1.2.3 + * */ typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr con= n, virDomainPtr dom, diff --git a/src/libvirt-qemu.c b/src/libvirt-qemu.c index 896aba2f0b..b80cd2b7ff 100644 --- a/src/libvirt-qemu.c +++ b/src/libvirt-qemu.c @@ -61,6 +61,9 @@ VIR_LOG_INIT("libvirt-qemu"); * * Returns 0 in case of success, -1 in case of failure * + * Since: v0.8.3 + * + * */ int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, @@ -131,6 +134,9 @@ virDomainQemuMonitorCommand(virDomainPtr domain, const = char *cmd, * @cmd, and the caller must free this string. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v8.2.0 + * */ int virDomainQemuMonitorCommandWithFiles(virDomainPtr domain, @@ -216,6 +222,9 @@ virDomainQemuMonitorCommandWithFiles(virDomainPtr domai= n, * normally (provided the above requirements were honored). * * Returns a new domain object on success, NULL otherwise + * + * Since: v0.9.4 + * */ virDomainPtr virDomainQemuAttach(virConnectPtr conn, @@ -272,6 +281,9 @@ virDomainQemuAttach(virConnectPtr conn, * positive value: wait for @timeout seconds * * Returns strings if success, NULL in failure. + * + * Since: v0.10.0 + * */ char * virDomainQemuAgentCommand(virDomainPtr domain, @@ -350,6 +362,9 @@ virDomainQemuAgentCommand(virDomainPtr domain, * be passed to the virConnectDomainQemuMonitorEventDeregister() method. * * Returns a callback identifier on success, -1 on failure + * + * Since: v1.2.3 + * */ int virConnectDomainQemuMonitorEventRegister(virConnectPtr conn, @@ -404,6 +419,9 @@ virConnectDomainQemuMonitorEventRegister(virConnectPtr = conn, * method. * * Returns 0 on success, -1 on failure + * + * Since: v1.2.3 + * */ int virConnectDomainQemuMonitorEventDeregister(virConnectPtr conn, --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481736; cv=none; d=zohomail.com; s=zohoarc; b=KDOxNdDtAfzUONYO3ThsE4OBCu3FoP0ANAqFoWCUtgPY6jhJ1xcCLS1tArIHHPODJv/j/UQWSwPlk2MiA7ELQMn0Uv2rPmy4cnwNSu7iN90ZHQTpCJ9MP79BvcRhs/F9SWbIGEBnr/qy6caPVecMvMZFR0cc37GyyL2dhL/5QLE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481736; 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=KHfU4WZ9Q9IYjuXj7adKzUW3RcD7hRd1EC0bC1GwU94=; b=Yw+P8k1zRRRQeDva+gLPu0uV4nJEMDeCi+fVN/VKNmv1RVXz9N1sE7RWODKjgFTFrtQpTvTMBPKzCBRc40jW2wK0Ic+MBY7nhUzBBZHqPoFOx65N5M7ubPM9PGI9ACUN3t9XPRxVVW3mI+NtoCL6kifYGew/5NpOQm8U7VsiapA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481736860556.0858431052354; Wed, 20 Apr 2022 12:08:56 -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-613-dnQhDxbEPNuR7bZqN2D6jA-1; Wed, 20 Apr 2022 15:08:46 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id BF1EC800B28; Wed, 20 Apr 2022 19:08:39 +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 A8C0040CFD0A; Wed, 20 Apr 2022 19:08:39 +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 555601940347; Wed, 20 Apr 2022 19:08:39 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id CAB281940361 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:37 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id AACB1551E86; Wed, 20 Apr 2022 19:08:37 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 13784551E85 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481735; 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=KHfU4WZ9Q9IYjuXj7adKzUW3RcD7hRd1EC0bC1GwU94=; b=Z5OZG1+8Ibs7dFu9j348PI9P78xZj4vShN3mM25z3rkSrlX7xN9wdHOIIeJpRbhxX+Lpb0 I7nVAaY+m38VtaN8gJ8rsHovx6m1DvkMtrmvJbsJKortKHgOB4DUZC83prtIu9fjL57QMs zN38gGXS2eEwT5RiZ1FXtzLWU3JP6Bc= X-MC-Unique: dnQhDxbEPNuR7bZqN2D6jA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 15/30] docstring: function: lxc: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:04 +0200 Message-Id: <20220420190819.3093205-16-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481738121100003 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 <victortoso@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- src/libvirt-lxc.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/libvirt-lxc.c b/src/libvirt-lxc.c index 2a271b74f0..14a2f2a6ec 100644 --- a/src/libvirt-lxc.c +++ b/src/libvirt-lxc.c @@ -59,6 +59,9 @@ VIR_LOG_INIT("libvirt-lxc"); * the setns() system call. * * Returns the number of opened file descriptors, or -1 on error + * + * Since: v1.0.2 + * */ int virDomainLxcOpenNamespace(virDomainPtr domain, @@ -115,6 +118,9 @@ virDomainLxcOpenNamespace(virDomainPtr domain, * the caller to switch back to its current namespace later * * Returns 0 on success, -1 on error + * + * Since: v1.0.2 + * */ int virDomainLxcEnterNamespace(virDomainPtr domain, @@ -182,6 +188,9 @@ virDomainLxcEnterNamespace(virDomainPtr domain, * exec() has yet been performed. * * Returns 0 on success, -1 on error + * + * Since: v1.0.4 + * */ int virDomainLxcEnterSecurityLabel(virSecurityModelPtr model, @@ -283,6 +292,9 @@ virDomainLxcEnterSecurityLabel(virSecurityModelPtr mode= l, * with the container @domain. * * Returns 0 on success, -1 on error + * + * Since: v2.0.0 + * */ int virDomainLxcEnterCGroup(virDomainPtr domain, unsigned int flags) --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481805; cv=none; d=zohomail.com; s=zohoarc; b=SamtOTObsulmGR18xf8qSSN8IjAiMEBLxacV0Y19f8kMWICD8PlzqlJBxMbIEScP92bAfko9KN+Di84qNnWEUpaFTo7x0ZoGfGvOqWVRdQ1H7BzK5HZV8uzJCHJPiD88esJZd2iOA/FcONGHnXkoLMyJDoeaVDQiT6s98RmiBR4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481805; 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=RvgPDvWGixJ/33sJD8rjZDdujxxlL/JVmPQ1qA/K+DA=; b=DqZcHUurH9riPzMJAAcu+eb8SF7MZOocf2D0U4boy1zLQ3W4xSo4GSi7bbf2Y1N2zFj/MP7TjtHlRznAM6ddC/g8zzNnqkd+tUIL10UoR1Cusdyk18RdVjzujuea/Xhyslis4eRhkXGKM1y0oiESzdOTt7jhrITUaasTr79usTs= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481805965789.6716019605819; Wed, 20 Apr 2022 12:10:05 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-37-iJp_wCFPO_SZsbwtUQaqBQ-1; Wed, 20 Apr 2022 15:08:50 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id F3A0C3C0F080; Wed, 20 Apr 2022 19:08:42 +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 D96C040D0169; Wed, 20 Apr 2022 19:08:42 +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 9612F1940347; Wed, 20 Apr 2022 19:08:42 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E6C9D194035A for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:38 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B2BF0551E82; Wed, 20 Apr 2022 19:08:38 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 19299551E85 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481804; 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=RvgPDvWGixJ/33sJD8rjZDdujxxlL/JVmPQ1qA/K+DA=; b=QX5/h+Rk3+W6nXx81aLxli8rQ/w+PpJaXoyqaEYsT4XTA6Z06Pf/xPw9BVzaLbHo5xl4k5 dwbvLWc7QgwvudQIYgWZSzCmQJx+E9FPpHHkqdocCKLobdZythApTDndusNGdOLyxGgwjC s2FStwB+czaYjYdytbL2WT/I9xs9hs0= X-MC-Unique: iJp_wCFPO_SZsbwtUQaqBQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 16/30] docstring: function: admin: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:05 +0200 Message-Id: <20220420190819.3093205-17-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481806654100001 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 <victortoso@redhat.com> --- include/libvirt/libvirt-admin.h | 3 ++ src/admin/libvirt-admin.c | 93 +++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index c73cf6e7da..5945fc172c 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -126,6 +126,9 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * @opaque: opaque client data * * A callback to be registered, in case a connection was closed. + * + * Since: v1.3.1 + * */ typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn, int reason, diff --git a/src/admin/libvirt-admin.c b/src/admin/libvirt-admin.c index 01546a7bc2..35470c866e 100644 --- a/src/admin/libvirt-admin.c +++ b/src/admin/libvirt-admin.c @@ -84,6 +84,9 @@ 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 +203,9 @@ virAdmGetDefaultURI(virConf *conf, char **uristr) * Opens connection to admin interface of the daemon. * * Returns @virAdmConnectPtr object or NULL on error + * + * Since: v1.2.17 + * */ virAdmConnectPtr virAdmConnectOpen(const char *name, unsigned int flags) @@ -284,6 +290,9 @@ 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: v1.2.17 + * */ int virAdmConnectClose(virAdmConnectPtr conn) @@ -319,6 +328,9 @@ virAdmConnectClose(virAdmConnectPtr conn) * would increment the reference count. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v1.2.17 + * */ int virAdmConnectRef(virAdmConnectPtr conn) @@ -346,6 +358,9 @@ virAdmConnectRef(virAdmConnectPtr conn) * instead. * * Returns 0 on success, -1 in case of an error. + * + * Since: v1.3.0 + * */ int virAdmGetVersion(unsigned long long *libVer) @@ -377,6 +392,9 @@ 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: v1.3.1 + * */ int virAdmConnectIsAlive(virAdmConnectPtr conn) @@ -411,6 +429,9 @@ 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: v1.3.1 + * */ char * virAdmConnectGetURI(virAdmConnectPtr conn) @@ -445,6 +466,9 @@ virAdmConnectGetURI(virAdmConnectPtr conn) * context. * * Returns 0 on success, -1 on error + * + * Since: v1.3.1 + * */ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb, @@ -498,6 +522,9 @@ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr= conn, * registration, it will be invoked. * * Returns 0 on success, -1 on error + * + * Since: v1.3.1 + * */ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb) @@ -528,6 +555,9 @@ 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: v1.3.1 + * */ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, unsigned long long *libVer) @@ -556,6 +586,9 @@ 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: v1.3.2 + * */ const char * virAdmServerGetName(virAdmServerPtr srv) @@ -576,6 +609,9 @@ virAdmServerGetName(virAdmServerPtr srv) * The data structure is freed and should not be used thereafter. * * Returns 0 on success, -1 on failure. + * + * Since: v1.3.2 + * */ int virAdmServerFree(virAdmServerPtr srv) { @@ -599,6 +635,9 @@ 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: v1.3.5 + * */ unsigned long long virAdmClientGetID(virAdmClientPtr client) @@ -622,6 +661,9 @@ 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: v1.3.5 + * */ long long virAdmClientGetTimestamp(virAdmClientPtr client) @@ -647,6 +689,9 @@ 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: v1.3.5 + * */ int virAdmClientGetTransport(virAdmClientPtr client) @@ -666,6 +711,9 @@ virAdmClientGetTransport(virAdmClientPtr client) * structure is freed and should not be used thereafter. * * Returns 0 in success, -1 on failure. + * + * Since: v1.3.5 + * */ int virAdmClientFree(virAdmClientPtr client) { @@ -697,6 +745,9 @@ 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: v1.3.2 + * */ int virAdmConnectListServers(virAdmConnectPtr conn, @@ -735,6 +786,9 @@ 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: v1.3.3 + * */ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, @@ -776,6 +830,9 @@ virAdmConnectLookupServer(virAdmConnectPtr conn, * VIR_THREADPOOL_WORKERS_CURRENT * * Returns 0 on success, -1 in case of an error. + * + * Since: v1.3.4 + * */ int virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, @@ -815,6 +872,9 @@ virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, * failure. * * Returns 0 on success, -1 in case of an error. + * + * Since: v1.3.4 + * */ int virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, @@ -856,6 +916,9 @@ 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: v1.3.5 + * */ int virAdmServerListClients(virAdmServerPtr srv, @@ -894,6 +957,9 @@ 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: v1.3.5 + * */ virAdmClientPtr virAdmServerLookupClient(virAdmServerPtr srv, @@ -940,6 +1006,9 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * Returns 0 if the information has been successfully retrieved or -1 in c= ase * of an error. + * + * Since: v1.3.5 + * */ int virAdmClientGetInfo(virAdmClientPtr client, @@ -974,6 +1043,9 @@ virAdmClientGetInfo(virAdmClientPtr client, * * Returns 0 if the daemon's connection with @client was closed successful= ly * or -1 in case of an error. + * + * Since: v1.3.5 + * */ int virAdmClientClose(virAdmClientPtr client, unsigned int flags) @@ -1011,6 +1083,9 @@ 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: v1.3.5 + * */ int virAdmServerGetClientLimits(virAdmServerPtr srv, @@ -1051,6 +1126,9 @@ virAdmServerGetClientLimits(virAdmServerPtr srv, * * Returns 0 if the limits have been changed successfully or -1 in case of= an * error. + * + * Since: v1.3.5 + * */ int virAdmServerSetClientLimits(virAdmServerPtr srv, @@ -1089,6 +1167,9 @@ 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 +1208,9 @@ 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 +1252,9 @@ 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 +1295,9 @@ 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 +1336,9 @@ 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 From nobody Sat May 18 17:16:09 2024 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=1650481741; cv=none; d=zohomail.com; s=zohoarc; b=K3mSVFQFcZjM17CCzZ1BZLu9Ozg9X/QGp7IW2QXD/vB4Zaf63RfTpzrGGv2ZnksDYr9vuhHvu+DlnvWnAL7VgyT7YTPKAJ/9Pwql4HkDqtep4Bs2BUSbOeoW8U6E3YK4XuEO74zFFkQIvtkYloB9XlmjkfskSLEwU9j2gtbnYg0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481741; 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=wSMvGXN4Fc5VWoxPkrI5qDUAKgnOJOrEv/qac8/+EvM=; b=j3e11K3KFLyMOLqcg2UKfZwY8TRdUO1JtRu9hjSfczKBYEcGHallZ5ZR3TWdbFHQ0hJ6MQMO7smCK2jSeyBpv6/f820pBrGr9v0TwUoisDPjgn8rVsev69rUsKtdQ5N8mr+UxStnpDotwZZQIbs6KbAErPDej0TDy6kiwqESixc= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481741573696.4630073039917; Wed, 20 Apr 2022 12:09:01 -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-20-WWgHxtUCMoqp88fS9oJWGA-1; Wed, 20 Apr 2022 15:08:52 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 21D81803789; Wed, 20 Apr 2022 19:08:44 +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 CFA5340D0169; Wed, 20 Apr 2022 19:08:43 +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 7AE251940359; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D44E8194035A for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:39 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B79BC551E85; Wed, 20 Apr 2022 19:08:39 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1FCDD551E8A for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481740; 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=wSMvGXN4Fc5VWoxPkrI5qDUAKgnOJOrEv/qac8/+EvM=; b=KpSgtHr6hQ52RQBnHehnnOEa3gfY75ziqE21yFiKXRO+hAQ6HZvRD1L7pwOuPmntuCUnHk 9634u3G73inrWSWUl2lLK9U8cfdA5FFeoFruVHl8DEklpzYr+7/IuxJYOZcqpZAtwt+i5H OVV/fT+wnhPg87NWsTZRyuGsDAHWuPo= X-MC-Unique: WWgHxtUCMoqp88fS9oJWGA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 17/30] docstring: libvirt-common: Add 'Since version' metadata Date: Wed, 20 Apr 2022 21:08:06 +0200 Message-Id: <20220420190819.3093205-18-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481742109100007 Content-Type: text/plain; charset="utf-8" Similarly to previous commits but with the targeting libvirt-common in a batch. Either create or append to existing docstring, the version (git tag) that a given typedef, enum value, macro or function was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-common.h.in | 54 ++++++++++++++++++++------- src/util/virtypedparam-public.c | 57 +++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 13 deletions(-) diff --git a/include/libvirt/libvirt-common.h.in b/include/libvirt/libvirt-= common.h.in index 4661ee9857..c2426809b6 100644 --- a/include/libvirt/libvirt-common.h.in +++ b/include/libvirt/libvirt-common.h.in @@ -70,6 +70,8 @@ extern "C" { * * Macro providing the version of the library as * version * 1,000,000 + minor * 1000 + micro + * + * Since: v0.0.1 */ =20 # define LIBVIR_VERSION_NUMBER @LIBVIRT_VERSION_NUMBER@ @@ -86,6 +88,8 @@ extern "C" { * #if LIBVIR_CHECK_VERSION(1,1,3) * // some code that only works in 1.1.3 and newer * #endif + * + * Since: v1.2.0 */ # define LIBVIR_CHECK_VERSION(major, minor, micro) \ ((major) * 1000000 + (minor) * 1000 + (micro) <=3D LIBVIR_VERSION_NUMB= ER) @@ -104,17 +108,26 @@ extern "C" { * from a context which is not re-entrant safe. Failure to * abide by this requirement may lead to application deadlocks * or crashes. + * + * Since: v0.5.0 + * */ typedef void (*virFreeCallback)(void *opaque); =20 +/** + * virConnectCloseReason: + * + * Since: v0.10.0 + * + */ typedef enum { - VIR_CONNECT_CLOSE_REASON_ERROR =3D 0, /* Misc I/O error */ - VIR_CONNECT_CLOSE_REASON_EOF =3D 1, /* End-of-file from server */ - VIR_CONNECT_CLOSE_REASON_KEEPALIVE =3D 2, /* Keepalive timer triggered= */ - VIR_CONNECT_CLOSE_REASON_CLIENT =3D 3, /* Client requested it */ + VIR_CONNECT_CLOSE_REASON_ERROR =3D 0, /* Misc I/O error (Since: v0= .10.0) */ + VIR_CONNECT_CLOSE_REASON_EOF =3D 1, /* End-of-file from server (= Since: v0.10.0) */ + VIR_CONNECT_CLOSE_REASON_KEEPALIVE =3D 2, /* Keepalive timer triggered= (Since: v0.10.0) */ + VIR_CONNECT_CLOSE_REASON_CLIENT =3D 3, /* Client requested it (Sinc= e: v0.10.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CONNECT_CLOSE_REASON_LAST + VIR_CONNECT_CLOSE_REASON_LAST /* (Since: v0.10.0) */ # endif } virConnectCloseReason; =20 @@ -122,18 +135,20 @@ typedef enum { * virTypedParameterType: * * Express the type of a virTypedParameter + * + * Since: v0.9.2 */ typedef enum { - VIR_TYPED_PARAM_INT =3D 1, /* integer case */ - VIR_TYPED_PARAM_UINT =3D 2, /* unsigned integer case */ - VIR_TYPED_PARAM_LLONG =3D 3, /* long long case */ - VIR_TYPED_PARAM_ULLONG =3D 4, /* unsigned long long case */ - VIR_TYPED_PARAM_DOUBLE =3D 5, /* double case */ - VIR_TYPED_PARAM_BOOLEAN =3D 6, /* boolean(character) case */ - VIR_TYPED_PARAM_STRING =3D 7, /* string case */ + VIR_TYPED_PARAM_INT =3D 1, /* integer case (Since: v0.9.2) */ + VIR_TYPED_PARAM_UINT =3D 2, /* unsigned integer case (Since: v0.9.2= ) */ + VIR_TYPED_PARAM_LLONG =3D 3, /* long long case (Since: v0.9.2) */ + VIR_TYPED_PARAM_ULLONG =3D 4, /* unsigned long long case (Since: v0.9= .2) */ + VIR_TYPED_PARAM_DOUBLE =3D 5, /* double case (Since: v0.9.2) */ + VIR_TYPED_PARAM_BOOLEAN =3D 6, /* boolean(character) case (Since: v0.9= .2) */ + VIR_TYPED_PARAM_STRING =3D 7, /* string case (Since: v0.9.8) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_TYPED_PARAM_LAST + VIR_TYPED_PARAM_LAST /* (Since: v0.9.10) */ # endif } virTypedParameterType; =20 @@ -143,6 +158,8 @@ typedef enum { * Flags related to libvirt APIs that use virTypedParameter. * * These enums should not conflict with those of virDomainModificationImpa= ct. + * + * Since: v0.9.8 */ typedef enum { /* 1 << 0 is reserved for virDomainModificationImpact */ @@ -157,6 +174,8 @@ typedef enum { * the user does not have to worry about it; however, manually * 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 */ VIR_TYPED_PARAM_STRING_OKAY =3D 1 << 2, =20 @@ -166,6 +185,9 @@ typedef enum { * VIR_TYPED_PARAM_FIELD_LENGTH: * * Macro providing the field length of virTypedParameter name + * + * Since: v0.9.2 + * */ # define VIR_TYPED_PARAM_FIELD_LENGTH 80 =20 @@ -177,6 +199,9 @@ typedef enum { * The types virSchedParameter, virBlkioParameter, and * virMemoryParameter are aliases of this type, for use when * targeting libvirt earlier than 0.9.2. + * + * Since: v0.9.2 + * */ typedef struct _virTypedParameter virTypedParameter; =20 @@ -198,6 +223,9 @@ struct _virTypedParameter { * virTypedParameterPtr: * * a pointer to a virTypedParameter structure. + * + * Since: v0.9.2 + * */ typedef virTypedParameter *virTypedParameterPtr; =20 diff --git a/src/util/virtypedparam-public.c b/src/util/virtypedparam-publi= c.c index 4cb54f7ab1..2e213f2ace 100644 --- a/src/util/virtypedparam-public.c +++ b/src/util/virtypedparam-public.c @@ -127,6 +127,9 @@ virTypedParameterAssignFromStr(virTypedParameterPtr par= am, * * Returns pointer to the parameter or NULL if it does not exist in @param= s. * This function does not raise an error, even when returning NULL. + * + * Since: v1.0.2 + * */ virTypedParameterPtr virTypedParamsGet(virTypedParameterPtr params, @@ -176,6 +179,9 @@ virTypedParamsGet(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetInt(virTypedParameterPtr params, @@ -212,6 +218,9 @@ virTypedParamsGetInt(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetUInt(virTypedParameterPtr params, @@ -248,6 +257,9 @@ virTypedParamsGetUInt(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetLLong(virTypedParameterPtr params, @@ -284,6 +296,9 @@ virTypedParamsGetLLong(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetULLong(virTypedParameterPtr params, @@ -320,6 +335,9 @@ virTypedParamsGetULLong(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetDouble(virTypedParameterPtr params, @@ -356,6 +374,9 @@ virTypedParamsGetDouble(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetBoolean(virTypedParameterPtr params, @@ -394,6 +415,9 @@ virTypedParamsGetBoolean(virTypedParameterPtr params, * * Returns 1 on success, 0 when the parameter does not exist in @params, or * -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsGetString(virTypedParameterPtr params, @@ -433,6 +457,9 @@ virTypedParamsGetString(virTypedParameterPtr params, * if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddInt(virTypedParameterPtr *params, @@ -479,6 +506,9 @@ virTypedParamsAddInt(virTypedParameterPtr *params, * error if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddUInt(virTypedParameterPtr *params, @@ -525,6 +555,9 @@ virTypedParamsAddUInt(virTypedParameterPtr *params, * error if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddLLong(virTypedParameterPtr *params, @@ -571,6 +604,9 @@ virTypedParamsAddLLong(virTypedParameterPtr *params, * error if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddULLong(virTypedParameterPtr *params, @@ -617,6 +653,9 @@ virTypedParamsAddULLong(virTypedParameterPtr *params, * error if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddDouble(virTypedParameterPtr *params, @@ -663,6 +702,9 @@ virTypedParamsAddDouble(virTypedParameterPtr *params, * error if the parameter already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddBoolean(virTypedParameterPtr *params, @@ -711,6 +753,9 @@ virTypedParamsAddBoolean(virTypedParameterPtr *params, * already exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddString(virTypedParameterPtr *params, @@ -757,6 +802,9 @@ virTypedParamsAddString(virTypedParameterPtr *params, * key @name. * * Returns 0 on success, -1 on error. + * + * Since: v1.2.17 + * */ int virTypedParamsAddStringList(virTypedParameterPtr *params, @@ -802,6 +850,9 @@ virTypedParamsAddStringList(virTypedParameterPtr *param= s, * exists in @params. * * Returns 0 on success, -1 on error. + * + * Since: v1.0.2 + * */ int virTypedParamsAddFromString(virTypedParameterPtr *params, @@ -840,6 +891,9 @@ virTypedParamsAddFromString(virTypedParameterPtr *param= s, * is not freed; use virTypedParamsFree if you want it to be freed too. * * Returns nothing. + * + * Since: v1.0.2 + * */ void virTypedParamsClear(virTypedParameterPtr params, @@ -866,6 +920,9 @@ virTypedParamsClear(virTypedParameterPtr params, * @params. * * Returns nothing. + * + * Since: v1.0.2 + * */ void virTypedParamsFree(virTypedParameterPtr params, --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481742; cv=none; d=zohomail.com; s=zohoarc; b=Roiyj4SwC0hqcm1oKoaEu07C9bMjzE4khh8IXxr/yrdHnSTsixY6r1J+UxF61Fx0HoVRwTgoW17yOmdTVo7fZ1wu3WZ0S12Cctu2GYAQcB1unh3Xmf6MCCutvELO0+v4uYxgrk3gSgZq74vzXUJ7PhsTvS43PDH+Rg6OpwCRB9E= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481742; 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=hwfOlVjCnEwV5bbAZZLCjgrDL7QMkIk0/o4KnQYRc7g=; b=i8znw/01Ab8tD4EhF8cGBlTIRvz9iaIrzMfdEt9t0gH2EgzmZkORYQyxqppioGM407GlxvZlPjC4eGmtPFhQvslPXhTaJqKkG7QjOvz6qtqw6XW2UnRdlctJPl49QNb80ypxxa4Hah8zfoad3DDB/xPCenyLFG0TfY4LXtKjtQs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481742358271.22925337950755; Wed, 20 Apr 2022 12:09:02 -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-85-r8NM2OfLNfOynr4JswZPAA-1; Wed, 20 Apr 2022 15:08:51 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 25A54899EC5; Wed, 20 Apr 2022 19:08:43 +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 0BA4540D0168; Wed, 20 Apr 2022 19:08:43 +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 B9A6419451EC; Wed, 20 Apr 2022 19:08:42 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C795A194036B for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:40 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B9C5F551E82; Wed, 20 Apr 2022 19:08:40 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2582B551E8A for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481740; 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=hwfOlVjCnEwV5bbAZZLCjgrDL7QMkIk0/o4KnQYRc7g=; b=OQetlg3JdrtwPHvxZP+5tHO7pxc05e0MZ9O6m5CPV1rQGHWon5mdoqM49/Y7Tad6N5J4tP KHOHDdyKJlAEKDedT67xhbCQl+8n0x7hGbjTeJXsyyv6Hdug0C6BpF6ZkvXxviBeV7UNiJ b/7hNBL7/eIoD8QzOM9iQKMFJzzTGz4= X-MC-Unique: r8NM2OfLNfOynr4JswZPAA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 18/30] docstring: Fix generated documentation of virStorageVolInfoFlags Date: Wed, 20 Apr 2022 21:08:07 +0200 Message-Id: <20220420190819.3093205-19-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481744104100010 Content-Type: text/plain; charset="utf-8" This commit is similar to "docs: Fix generated documentation of virConnectListAllNodeDeviceFlags", check it out for more info. Using git diff --word-diff to show the fixed output xml (redacted). <enum name=3D'VIR_STORAGE_VOL_GET_PHYSICAL' ... [-type=3D'virStorageVolInfoFlags'/>-] {+type=3D'virStorageVolInfoFlags' version=3D'3.0.0' info=3D'Return the = physical size in allocation'/>+} ... <enum name=3D'VIR_STORAGE_VOL_USE_ALLOCATION' ... type=3D'virStorageVolIn= foFlags' [-info=3D'Return the physical size in allocation'/>-] {+version=3D'3.0.0'/>+} Signed-off-by: Victor Toso <victortoso@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> --- include/libvirt/libvirt-storage.h | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 434454f455..8b57b1f2e8 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -248,11 +248,8 @@ typedef enum { * */ typedef enum { - VIR_STORAGE_VOL_USE_ALLOCATION =3D 0, - - /* Return the physical size in allocation */ - VIR_STORAGE_VOL_GET_PHYSICAL =3D 1 << 0, - + VIR_STORAGE_VOL_USE_ALLOCATION =3D 0, /* (Since: v3.0.0) */ + VIR_STORAGE_VOL_GET_PHYSICAL =3D 1 << 0, /* Return the physical size i= n allocation (Since: v3.0.0) */ } virStorageVolInfoFlags; =20 /** --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481739; cv=none; d=zohomail.com; s=zohoarc; b=Zw9yVqOdGuzP/Y3SdbbL1S5kkQYPAj6cBY6BrR5lWOQN28xLdyWJNJCT2rWiMfa6tfYrDmpYOeUc0e+ooKilETbphMMzl5COk8kkB/KQPeG10Ir5sJ60YMuSFyHOyG+oxY13dtUPmSA1JPcYE1XDFhFXWAf21elC2mxQQrN6sgk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481739; 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=ErIaIYh2HMU94cBu8uwJRTxsq33LLIhXH35kfW90dyE=; b=gi/Jza5JzXtlLBR4Ia2e6HOa+ke/9irqF4Q/ntDeLyQXwQV2GsLZnq0ZPUQDAyzMdRxGZ/tzxPCkcmQK3vuXpdI8tyKvYHDqc+7Gt1kVsxWdQOJ1GVLNQxQTY7He8EYQAJJypWf/VKQHqLlKuLW31eEtORCBYryU8iJ9pUNW850= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481739644798.004824713501; Wed, 20 Apr 2022 12:08:59 -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-609-fhkXLffIPd2w9wMLwHlvCw-1; Wed, 20 Apr 2022 15:08:51 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 6AC35180138F; Wed, 20 Apr 2022 19:08:44 +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 51CDB551E87; Wed, 20 Apr 2022 19:08:44 +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 E79EB1940352; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id F1C221940347 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:41 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C2D27551E8E; Wed, 20 Apr 2022 19:08:41 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2B69D551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481738; 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=ErIaIYh2HMU94cBu8uwJRTxsq33LLIhXH35kfW90dyE=; b=DBjjMTboqw6VAsIpwJZopbZoLfNZaGtUi0NDRhDlZLya/OR3wWO3/W71aukGFtRgs3LrlI HTiTHfhyyH9mnlW7ZeMd1ijAMMgb9FDMGonOD6i6gN8xlDPpNARCr2gjVb7R4WCRzL90UU UWjS+FHiP1iDn+S71UYE+0LmSfa5tRI= X-MC-Unique: fhkXLffIPd2w9wMLwHlvCw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 19/30] docstring: Fix and append Since to virConnectListAllStoragePoolsFlags Date: Wed, 20 Apr 2022 21:08:08 +0200 Message-Id: <20220420190819.3093205-20-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481740089100005 Content-Type: text/plain; charset="utf-8" This commit is similar to "docs: Fix generated documentation of virConnectListAllNodeDeviceFlags", check it out for more info. Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-storage.h | 49 +++++++++++++++---------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 8b57b1f2e8..e4980ae95f 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -317,34 +317,33 @@ int virConnectListDefinedStorageP= ools(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 =3D 1 << 0, - VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE =3D 1 << 1, - - VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT =3D 1 << 2, - VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT =3D 1 << 3, - - VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART =3D 1 << 4, - VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART =3D 1 << 5, - - /* List pools by type */ - VIR_CONNECT_LIST_STORAGE_POOLS_DIR =3D 1 << 6, - VIR_CONNECT_LIST_STORAGE_POOLS_FS =3D 1 << 7, - VIR_CONNECT_LIST_STORAGE_POOLS_NETFS =3D 1 << 8, - VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL =3D 1 << 9, - VIR_CONNECT_LIST_STORAGE_POOLS_DISK =3D 1 << 10, - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI =3D 1 << 11, - VIR_CONNECT_LIST_STORAGE_POOLS_SCSI =3D 1 << 12, - VIR_CONNECT_LIST_STORAGE_POOLS_MPATH =3D 1 << 13, - VIR_CONNECT_LIST_STORAGE_POOLS_RBD =3D 1 << 14, - VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG =3D 1 << 15, - VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER =3D 1 << 16, - VIR_CONNECT_LIST_STORAGE_POOLS_ZFS =3D 1 << 17, - VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE =3D 1 << 18, - VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT =3D 1 << 19, + VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE =3D 1 << 0, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE =3D 1 << 1, /* (Since: v0= .10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT =3D 1 << 2, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT =3D 1 << 3, /* (Since: v0= .10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART =3D 1 << 4, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART =3D 1 << 5, /* (Since: v0= .10.2) */ + + VIR_CONNECT_LIST_STORAGE_POOLS_DIR =3D 1 << 6, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_FS =3D 1 << 7, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_NETFS =3D 1 << 8, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL =3D 1 << 9, /* (Since: v0= .10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_DISK =3D 1 << 10, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI =3D 1 << 11, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SCSI =3D 1 << 12, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_MPATH =3D 1 << 13, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_RBD =3D 1 << 14, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG =3D 1 << 15, /* (Since: v= 0.10.2) */ + VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER =3D 1 << 16, /* (Since: v= 1.2.1) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ZFS =3D 1 << 17, /* (Since: v= 1.2.8) */ + VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE =3D 1 << 18, /* (Since: v= 3.1.0) */ + VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT =3D 1 << 19, /* (Since: v= 5.6.0) */ } virConnectListAllStoragePoolsFlags; =20 int virConnectListAllStoragePools(virConnectPtr conn, --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481830; cv=none; d=zohomail.com; s=zohoarc; b=dGh9V4Sk5ZdVEXvrr5lXi7H8FtyQL8YzzL5Few4KApDztFFnDPcVzJAu4P0GRyzoNpBCadOPbk4uFsNGz7CGQM2sV3HSI/7zGkEE96jwr+4gLeH7gZQSYeFFIapKx3psylrTr/R9liPVS5/yIg4qxEZUP/4Pw0b3nR9UwMbLp9s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481830; 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=X7Zy/dloZ2j8Dxd7q6oCY3ZsQPq3Og3kGFo8fdwf4GA=; b=B1ViPX3v13rrJ1g+366v+DBKxNqynFVa+D48XoIHW2GxsXZr10pCr8n8OUoRhY4TQH1Dnb2vW5bzBJ2Prv5ZmYpLw7SH+LlmjT7Gz8pUiZvkv8QTlwUWcv5VugDcAhfm0YglSd1mfSM5MX/LzLjB8qCc4XKQ0qHpMEWauogXrXc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481830894688.1958173690375; Wed, 20 Apr 2022 12:10:30 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-442-JlDbb_phMxalUdXJIfJ9sw-1; Wed, 20 Apr 2022 15:09:04 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id EDDA73811F30; Wed, 20 Apr 2022 19:08:47 +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 D7E71551E82; Wed, 20 Apr 2022 19:08:47 +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 95D121949763; Wed, 20 Apr 2022 19:08:47 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E95C71940361 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:42 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C7F17551E86; Wed, 20 Apr 2022 19:08:42 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 30BBB551E85 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481829; 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=X7Zy/dloZ2j8Dxd7q6oCY3ZsQPq3Og3kGFo8fdwf4GA=; b=CMYWzN0bKgn4PJ1BXtUu5tsMH0xFBQXG6KQhT612gKsK8ChIjuLvY8eX9LGj3LWjhcbY4z PptaGi96QWR96sFZEhO0zF2SCf0tkjJGdG/OI/TH46rK+1jIyvmnhc1w9WSh5ni0VBqCnU TOaLhjMuLo02Vf+o4Qt3TlgmMAH+vaI= X-MC-Unique: JlDbb_phMxalUdXJIfJ9sw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 20/30] docstring: Fix and append Since to virDomainDeviceModifyFlags Date: Wed, 20 Apr 2022 21:08:09 +0200 Message-Id: <20220420190819.3093205-21-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481832861100001 Content-Type: text/plain; charset="utf-8" This commit is similar to "docs: Fix generated documentation of virConnectListAllNodeDeviceFlags", check it out for more info. Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-domain.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 9199cc9ad3..27a680a907 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -2758,18 +2758,18 @@ int virDomainGetVcpus (vi= rDomainPtr domain, /** * virDomainDeviceModifyFlags: * - * Since: v1.0.0 + * These flags may be bitwise-OR'd in. + * + * Since: v0.7.7 * */ typedef enum { - /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ - VIR_DOMAIN_DEVICE_MODIFY_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_DEVICE_MODIFY_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_DEVICE_MODIFY_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, + VIR_DOMAIN_DEVICE_MODIFY_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, /* See= virDomainModificationImpact (Since: v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, /* (Since= : v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, /* (Sin= ce: v0.7.7) */ =20 - /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ VIR_DOMAIN_DEVICE_MODIFY_FORCE =3D (1 << 2), /* Forcibly modify device - (ex. force eject a cdrom= ) */ + (ex. force eject a cdrom= ) (Since: v0.8.6) */ } virDomainDeviceModifyFlags; =20 int virDomainAttachDevice(virDomainPtr domain, const char *xml); --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481742; cv=none; d=zohomail.com; s=zohoarc; b=TBu+AMvNuu2dcEDCffn6XBwTlCEReE+aqu+o9PeTn0hYKb9GsLbRSj3JfQHgHxjaytqN/HKmvlgLz5cejP31UTPS+oQaZtYK8laTAvfl3oRBFVJkLhYfR0YRYaOSp8sesiZ27NN21QxdH9uCjFMSSFNqLYGBAsfyZyvXbK8m1UU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481742; 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=TF8UFTt+ix0Vie/4DQB6Q4Eb5Hi88PtUH18uaPZ9sU8=; b=BFT0Y3w/S5jpYXlzvDtB5SOd8DsO9Se5PHgnzX0JT0G+367MlCW4FrbJ7oRWqFX93aTwBMupCH2OK4JvLMtQGZgU/Aizl7hAHUaLv0KEJuITBre/l5O0f7HxqGRhR1ZSL1Kr1VT7QfxR0aA9nuPMn4Lu6Vcn1DXW7/gtiovlg8Q= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481742528498.03230561942246; Wed, 20 Apr 2022 12:09:02 -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-626-nB5VRXjbMAOnQCCUNVI-fg-1; Wed, 20 Apr 2022 15:08:54 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3AB7389B848; Wed, 20 Apr 2022 19:08:46 +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 182EB551E8B; Wed, 20 Apr 2022 19:08:46 +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 C693D1940352; Wed, 20 Apr 2022 19:08:45 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E172E1940373 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id BA05D551E94; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 37FCC551E91 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481741; 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=TF8UFTt+ix0Vie/4DQB6Q4Eb5Hi88PtUH18uaPZ9sU8=; b=F3BxmyuMFt71ZluwndYR7sXcc9kVe96a7VXM6xQ4ojTTRRQeNmUYd8yOFK2BsY/FAWFv9e EPGZpGCj/eGXCr8AHxbBUZBU6eKbUT7sOL3ae6hotN1Oy06g5Kdy8v9E1EwvWMxhJs3feJ TEyChzlHE4bGwOOT2gBa2MqIqi8SBxc= X-MC-Unique: nB5VRXjbMAOnQCCUNVI-fg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 21/30] docstring: Fix and append Since to virDomainMemoryModFlags Date: Wed, 20 Apr 2022 21:08:10 +0200 Message-Id: <20220420190819.3093205-22-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481744100100009 Content-Type: text/plain; charset="utf-8" This commit is similar to "docs: Fix generated documentation of virConnectListAllNodeDeviceFlags", check it out for more info. Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-domain.h | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 27a680a907..67cbc0d08e 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1958,18 +1958,17 @@ int virDomainGetMemoryParameters(virDomainPtr d= omain, * virDomainMemoryModFlags: * * Memory size modification flags. + * These flags may be bitwise-OR'd in. * - * Since: v1.0.0 + * Since: v0.9.0 * */ typedef enum { - /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ - VIR_DOMAIN_MEM_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_MEM_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_MEM_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, + VIR_DOMAIN_MEM_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, /* See virDomain= ModificationImpact (Since: v0.9.1) */ + VIR_DOMAIN_MEM_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, /* See virDomainMod= ificationImpact (Since: v0.9.0) */ + VIR_DOMAIN_MEM_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainM= odificationImpact (Since: v0.9.0) */ =20 - /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ - VIR_DOMAIN_MEM_MAXIMUM =3D (1 << 2), /* affect Max rather than current= */ + VIR_DOMAIN_MEM_MAXIMUM =3D (1 << 2), /* affect Max rather than current= (Since: v0.9.1) */ } virDomainMemoryModFlags; =20 =20 --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481742; cv=none; d=zohomail.com; s=zohoarc; b=eOrd9RFwCboWS6G96MWVpP06nvuKwgjRaE1sEyJsLdYvi5f1jjlzI33XL4meVMyK3vSW0lo5mzvfw75cyEAYGxBLujDKVroqr2Mruf7Q9c1luqGQgHlnmeJpJnSf2EUAk0ieB4RRRqDd+yoQYKCSIm+LsD8uaS4A2ypd18QCvfQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481742; 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=qS29ovvgpDBndzhR7J24ltl9YP4w4thkIPB8U/XMQHo=; b=DEuh+8gMK1n56MWYhiPbsnOoqfLvoFo0azdP7CqI0r9b1QlUK6fT6cISb1OAVovr6z7stNVWhMDPLrw7UsKI7OmDdCPRirf/6tvk4yQMQWEZTgg+Jef1CaMgJ0K9q1mVLvGzrZME5K+hGeUivJmrSEBuDmgbiWYW3dG3bXCL+98= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481742317120.90529185995626; Wed, 20 Apr 2022 12:09:02 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-358-VZTxrj04NaCJifL8ohP9nQ-1; Wed, 20 Apr 2022 15:08:54 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3B3FD3811F31; Wed, 20 Apr 2022 19:08:46 +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 196C1551E8C; Wed, 20 Apr 2022 19:08:46 +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 BC6651949763; Wed, 20 Apr 2022 19:08:45 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C2C3A194035F for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:44 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B10BF551E8C; Wed, 20 Apr 2022 19:08:44 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 23CDA551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481741; 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=qS29ovvgpDBndzhR7J24ltl9YP4w4thkIPB8U/XMQHo=; b=ZCVswJZ+QrrcTGIaEls50nPdkXKGYRVkCZHW/FJ6qhvrCxnX9nUnlG+nVTobSOw/mRD03G YIGGaQZxgxtEsfrJ8VNMO+tUmOWtlPbbpWb1yXlKq++2I1krJWtinDzQ5ZHBifErO1/s3U g/GaadRqBjIThwiJJLkzN3H9xT+buQU= X-MC-Unique: VZTxrj04NaCJifL8ohP9nQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 22/30] docstring: Fix and append Since to virDomainVcpuFlags Date: Wed, 20 Apr 2022 21:08:11 +0200 Message-Id: <20220420190819.3093205-23-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 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: 1650481744108100011 Content-Type: text/plain; charset="utf-8" This commit is similar to "docs: Fix generated documentation of virConnectListAllNodeDeviceFlags", check it out for more info. Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-domain.h | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 67cbc0d08e..689a17a223 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -2491,20 +2491,19 @@ typedef virVcpuInfo *virVcpuInfoPtr; * virDomainVcpuFlags: * * Flags for controlling virtual CPU hot-plugging. + * These flags may be bitwise-OR'd in. * - * Since: v1.0.0 + * Since: v0.8.5 * */ typedef enum { - /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */ - VIR_DOMAIN_VCPU_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, - VIR_DOMAIN_VCPU_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, - VIR_DOMAIN_VCPU_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, - - /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) = */ - VIR_DOMAIN_VCPU_MAXIMUM =3D (1 << 2), /* Max rather than current count= (Since: v1.1.0) */ - VIR_DOMAIN_VCPU_GUEST =3D (1 << 3), /* Modify state of the cpu in th= e guest (Since: v2.4.0) */ - VIR_DOMAIN_VCPU_HOTPLUGGABLE =3D (1 << 4), /* Make vcpus added hot(un)= pluggable */ + VIR_DOMAIN_VCPU_CURRENT =3D VIR_DOMAIN_AFFECT_CURRENT, /* See virDomai= nModificationImpact (Since: v0.9.4) */ + VIR_DOMAIN_VCPU_LIVE =3D VIR_DOMAIN_AFFECT_LIVE, /* See virDomainMo= dificationImpact (Since: v0.8.5) */ + VIR_DOMAIN_VCPU_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, /* See virDomain= ModificationImpact (Since: v0.8.5) */ + + VIR_DOMAIN_VCPU_MAXIMUM =3D (1 << 2), /* Max rather than current count= (Since: v0.8.5) */ + VIR_DOMAIN_VCPU_GUEST =3D (1 << 3), /* Modify state of the cpu in th= e guest (Since: v1.1.0) */ + VIR_DOMAIN_VCPU_HOTPLUGGABLE =3D (1 << 4), /* Make vcpus added hot(un)= pluggable (Since: v2.4.0) */ } virDomainVcpuFlags; =20 int virDomainSetVcpus (virDomainPtr domain, --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481742; cv=none; d=zohomail.com; s=zohoarc; b=Ma6fWYxTM1+A9ZkNxbVJPinjFqKcFoyvY35dy9GEmzX3j7BHCcE6ffRdHe4g87zeRJC8st6BlgFQgR5tyczBG0zEAuCiuz1WzpQ7a9NH4ZDrM3GobYLCTC/GKI9xlDhnFwHwGDe69gXduU5MZ5SmIC+V7RY4B4m61KdHYADccKk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481742; 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=V1eBfQyBYMum8UQPZkdaAzKAdXOTFYXwOC4cBqYz5Ow=; b=YR1WFzLEvcm8zTRL192B8ju4F6mOoVeZ8triinDQ8KndOx5QpYi2HX0byfbgbCAu++7tO0YNtuH+cjBtcT18y+UUmqmP/X8xsegpH4gXGLOaq8ZOLB3Vn+4IEvp8Hy5/eXNqKRbjTdvmPRE0Cr5PB45TJX2Z3oPCbINaYL5qvE0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481742243430.8182129393847; Wed, 20 Apr 2022 12:09:02 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-159-_Mi0bPIZN7qxpAwqAdyQHg-1; Wed, 20 Apr 2022 15:08:57 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 544181C0BF03; Wed, 20 Apr 2022 19:08:48 +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 38ABD145BA60; Wed, 20 Apr 2022 19:08:48 +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 10BF8194035C; Wed, 20 Apr 2022 19:08:48 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id CEC5F1940354 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:45 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id A8915551E85; Wed, 20 Apr 2022 19:08:45 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 05495551E8E for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481740; 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=V1eBfQyBYMum8UQPZkdaAzKAdXOTFYXwOC4cBqYz5Ow=; b=W2Vs89/3B0RWaPXtslh76pW9nuMUgAW+G0wEOs0IR4NOQNi0NgyKE4UHdmPGXxA1EBzPxR xr4ECWkkNaM8EvqgIc79po1UuNBfaAWPdbQuZqw2YyNFVK9ySZxt3mcn4OGRFYPHS+ZPl6 c9az0httsCtyDQF6mdRtI/ocvLj0SEY= X-MC-Unique: _Mi0bPIZN7qxpAwqAdyQHg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 23/30] scripts: apibuild: parse 'Since' version for enums Date: Wed, 20 Apr 2022 21:08:12 +0200 Message-Id: <20220420190819.3093205-24-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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: 1650481744111100012 Content-Type: text/plain; charset="utf-8" This patch adds 'version' parameter to the generated XML API for enums. It'll require, for new additions, to add a comment with the version that the enum value was added. 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@redhat.com> --- scripts/apibuild.py | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index bdd3077c48..19e897b1ba 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -2178,6 +2178,26 @@ class docBuilder: self.scanModules() self.scanVersions() =20 + # 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): + since =3D "" + if comment is not None: + comment_match =3D re.search(r"\(?Since: v?(\d+\.\d+\.\d+\.?\d?= )\)?", + comment) + if comment_match: + # Remove Since tag from the comment + (start, end) =3D comment_match.span() + comment =3D comment[:start] + comment[end:] + comment =3D comment.strip() + # Only the version + since =3D comment_match.group(1) + + if since =3D=3D "": + self.warning("Missing 'Since' tag for: " + name) + return (since, comment) + def modulename_file(self, file): module =3D os.path.basename(file) if module[-2:] =3D=3D '.h': @@ -2211,7 +2231,15 @@ class docBuilder: if info[2] is not None and info[2] !=3D '': output.write(" type=3D'%s'" % info[2]) if info[1] is not None and info[1] !=3D '': - output.write(" info=3D'%s'" % escape(info[1])) + # Search for 'Since' version tag + (since, comment) =3D self.retrieve_comment_tags(name, info= [1]) + if len(since) > 0: + output.write(" version=3D'%s'" % escape(since)) + if len(comment) > 0: + output.write(" info=3D'%s'" % escape(comment)) + else: + self.warning("Missing docstring for enum: " + name) + output.write("/>\n") =20 def serialize_macro(self, output, name): --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481816; cv=none; d=zohomail.com; s=zohoarc; b=bRF1U/OF8H8WznoKG1QBv/RBe9vXqa8R4Pbobtvbd7nYz9wzpES57ujIZ/LftnKxeVV+CCKTk+BB19t5CdkDTUfGWJ8FZiSg3lAtDbSUnGpSlIVAXcAmZ1cT9EkqAwfSW8mg12K99BdUnk5o3+m0yKnSaK5zmACTJCnY1qNIMc8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481816; 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=Lpdn4TXGMkwtWOfTvCIwkARr9RWiKG71OUyRgU4YEFU=; b=Jnew0ibKaLBxqAi7ldZwlx74uNN1QqJi1CQmNbRa2TAcZuGtR1ab0kLu9mrvpWRqh3Yu7xJIhXg/M+pCuG1DxOv/hNJ0lGZOz6GHj3DjqePNSaLOMSPZ5iovbAFNOnFH0v5sWDqC97ZqXMzI9oSh+mis9HXNm/bahmx3mZga/pY= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481816725213.3613981018883; Wed, 20 Apr 2022 12:10:16 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-355-wwJe0jqdNc2FamC_dyPlfQ-1; Wed, 20 Apr 2022 15:09:03 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E275F1C0BF04; Wed, 20 Apr 2022 19:08:50 +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 CCEAF1410F39; Wed, 20 Apr 2022 19:08:50 +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 7BE751940353; Wed, 20 Apr 2022 19:08:50 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C84A91940361 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:46 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B19CA551E85; Wed, 20 Apr 2022 19:08:46 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 16D46551E8A for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481815; 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=Lpdn4TXGMkwtWOfTvCIwkARr9RWiKG71OUyRgU4YEFU=; b=Jg/EYbCPGgmjVRdu5MRBRSZdvZr/z6vPEFA2yAqW1fIlpwXBcebVUtFNK4LNKdoxCqk4Z3 CSWM3k6JUOu456VPxi3/bi/8twYWiRngCvgQbzL7WiK5iiUvjo7sNN3ZAB8bmOSUwIkEND auG3mmmFiVbxUYM/4P55g7gZbJIuiw4= X-MC-Unique: wwJe0jqdNc2FamC_dyPlfQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 24/30] scripts: apibuild: fix parsing block comments from typedef enum Date: Wed, 20 Apr 2022 21:08:13 +0200 Message-Id: <20220420190819.3093205-25-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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: 1650481818823100001 Content-Type: text/plain; charset="utf-8" Removed the TODO as we can rely to the serialize_typedef() the job to report missing comments. Signed-off-by: Victor Toso <victortoso@redhat.com> --- scripts/apibuild.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index 19e897b1ba..ddc2fff7af 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -1145,6 +1145,12 @@ class CParser: def parseTypedef(self, token): if token is None: return None + + # With typedef enum types, we can have comments parsed before the + # enum themselves. The parsing of enum values does clear the + # self.comment variable. So we store it here for later. + typedef_comment =3D self.comment + token =3D self.parseType(token) if token is None: self.error("parsing typedef") @@ -1168,7 +1174,7 @@ class CParser: "struct", type) base_type =3D "struct " + name else: - # TODO report missing or misformatted comments + self.comment =3D typedef_comment info =3D self.parseTypeComment(name, 1) self.index_add(name, self.filename, not self.is_he= ader, "typedef", type, info) --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481886; cv=none; d=zohomail.com; s=zohoarc; b=ITAI86uY9NJih3U32QrAlvMG7xajp86ZHksm2734KU3727m/ArGen5s0Zly72ziVc6sfwOeffEREW3+p5CvCF1yfj/PZ2IAVNOC73YrQgcloVHIuN5kGFCsME5Ui+pWCYy3WqdIHwP0TY93Qu68LbZ2j7O8Vj+bvbY05rYNte9M= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481886; 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=KK3Q83tIVFaZlat3KfsaCO71sLZ7eIq9owzrnpIQyzQ=; b=AypTFY2hiObn3VyYAoBrS30wksJw1QdBQI4v/FZnS87ff2m9TnqEYNbXrFMPrALpmYE6o6EfAt3Ox7OOt9vCUCDRpcD8PEdXvZFo8TCMd0lKyjnaqqkKnuE15RsKtKqODGfqPagJxwUfccGiFZDqkkUhQ8GPnYzjLsEgDC4RWaQ= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481886690806.8215970039929; Wed, 20 Apr 2022 12:11:26 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-388-6CDFxnjZNBGyAGUkDe-fLQ-1; Wed, 20 Apr 2022 15:08:59 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 09C1D3C16197; Wed, 20 Apr 2022 19:08:51 +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 E2289111E3FA; Wed, 20 Apr 2022 19:08:50 +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 A4AC71940351; Wed, 20 Apr 2022 19:08:50 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E5E20194035A for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:47 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B39E9551E85; Wed, 20 Apr 2022 19:08:47 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1C6BC551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481885; 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=KK3Q83tIVFaZlat3KfsaCO71sLZ7eIq9owzrnpIQyzQ=; b=R4HfJO4hLt6Q3oehC5EhsglNMjUTjt4cSIBiwoSsw4/eL/WshbRDDTtRXjKXoQaPmVaOmW 5XuQurEbNOiGMm2b3zGTQ2lhmTQj9muCUsUkgvEaiozkDXqrOJWjY5wmq6kr7/ZdQnlJK5 cLqZga9LieGugnxQNyGLFX00oMaxUFY= X-MC-Unique: 6CDFxnjZNBGyAGUkDe-fLQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 25/30] scripts: apibuild: parse 'Since' for typedefs Date: Wed, 20 Apr 2022 21:08:14 +0200 Message-Id: <20220420190819.3093205-26-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3 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: 1650481887313100001 Content-Type: text/plain; charset="utf-8" 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@redhat.com> --- 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: =20 def serialize_typedef(self, output, name): id =3D self.idx.typedefs[name] + (since, comment) =3D self.retrieve_comment_tags(name, id.extra) + version_tag =3D len(since) > 0 and f" version=3D'{since}'" or "" if id.info[0:7] =3D=3D 'struct ': - output.write(" <struct name=3D'%s' file=3D'%s' type=3D'%s'"= % ( - name, self.modulename_file(id.header), id.info)) + output.write(" <struct name=3D'%s' file=3D'%s' type=3D'%s'%= s" % ( + name, self.modulename_file(id.header), id.info, version_ta= g)) name =3D 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=3D'%s' file=3D'%s' type=3D'%s'= " % ( - name, self.modulename_file(id.header), id.info)) + output.write(" <typedef name=3D'%s' file=3D'%s' type=3D'%s'= %s" % ( + name, self.modulename_file(id.header), id.info, v= ersion_tag)) try: - desc =3D id.extra - if desc is not None and desc !=3D "": - output.write(">\n <info><![CDATA[%s]]></info>\n" = % (desc)) + if comment is not None and comment !=3D "": + output.write(">\n <info><![CDATA[%s]]></info>\n" = % (comment)) output.write(" </typedef>\n") else: output.write("/>\n") --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481863; cv=none; d=zohomail.com; s=zohoarc; b=gWwquJP5RiMYeHRHUnBROLf0ErTYv0JjgPep8c1nlNZG+Lt/7vmlGYeWlfHSEf5RSmjiG+gMcuo6wI2kJRUvJuRX1hsMmjVpBIrfLPEbehrH0/Q0JsJCVqO1iIyYD4WUK8TKes4KMxBqcH+supvv9YJS0ZwIb0GY6T3vayYr6DA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481863; 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=DZTMu9Nsh7rKi1ffACnAyjKOAR5d0Woz8u1+3sgEm4g=; b=UYATLj8AQfuA0PDnAVcnOYMIc6FN7TZrlyh0LOXTewU4xBKiMXIAWZ5/QCbcu7xHD8z5LWxzWB5Z0QPX7REdS+pU4V99U0XMkLZTaUGUfsRsMUhBD+VT387AtniboEOWhUKZHfOadoThkNV4WFFyCZi1118Rxyug0oC4klPxQx4= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481863586337.4278005156833; Wed, 20 Apr 2022 12:11:03 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-453-DQTf07xjNSm5Bwz2_okKBg-1; Wed, 20 Apr 2022 15:09:03 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 76A653C1618E; Wed, 20 Apr 2022 19:08:52 +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 5CD44C52C87; Wed, 20 Apr 2022 19:08:52 +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 4FE46194036A; Wed, 20 Apr 2022 19:08:51 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C71C01949763 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:48 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id BA906551E87; Wed, 20 Apr 2022 19:08:48 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 220A5551E82 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481862; 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=DZTMu9Nsh7rKi1ffACnAyjKOAR5d0Woz8u1+3sgEm4g=; b=eFK8bE1/Uy0t/0/OIOvExg8uclY04amTjUvqBuaoaIwtluw2yl/03nAipUr3lfQvTldJeN sUaHWzBB7CUZI/7U1uQsveNGfQO42VWfxECOkCqYu/awnFi4j1iC3OaZz1420MAlpF8nJ9 jKU6VZncbGPqICN8N+Hxqb30QCbPzVI= X-MC-Unique: DQTf07xjNSm5Bwz2_okKBg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 26/30] scripts: apibuild: parse 'Since' for macros Date: Wed, 20 Apr 2022 21:08:15 +0200 Message-Id: <20220420190819.3093205-27-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.8 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: 1650481865203100001 Content-Type: text/plain; charset="utf-8" This patch adds 'version' parameter to the generated XML API for macros It'll require, for new additions, to add a comment with the version that the macro 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@redhat.com> --- scripts/apibuild.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index 24ca98bd1c..b77eea0624 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -2267,11 +2267,15 @@ class docBuilder: output.write(" string=3D'%s'" % strValue) else: output.write(" raw=3D'%s'" % escape(rawValue)) + + (since, comment) =3D self.retrieve_comment_tags(name, desc) + if len(since) > 0: + output.write(" version=3D'%s'" % escape(since)) output.write(">\n") =20 - if desc is not None and desc !=3D "": - output.write(" <info><![CDATA[%s]]></info>\n" % (desc)) - self.indexString(name, desc) + if comment is not None and comment !=3D "": + output.write(" <info><![CDATA[%s]]></info>\n" % (comment)) + self.indexString(name, comment) for arg in args: (name, desc) =3D arg if desc is not None and desc !=3D "": --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481814; cv=none; d=zohomail.com; s=zohoarc; b=BuiKPNEsTUSfcajyg1UtWt8hbeCVSRY79D1CCksmebQGG2Hrf8DX2mZhpZ0tBPzxUHBUJDb/+FqAaJvJE+RTDfw5vY/S6CNSX1UsualYoMFcIygjR9OdtHHbSFiHLC4+HmDcLjMRYdjOp2qfzVb2Jx3uB4WTU6dMsdgrP8/FV/4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481814; 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=8Ipdewnr77UTIXYDWa3LljF36lp9pqrzYYZfoGiB4oA=; b=ARDwtDDO4iun5bqqrb1uZK9LR5xP8EMX6tk5D+aYvea879QouvDIvsGJfo0xuqwl5WLeN/HBrYVfllOestycT2di4gIraZcaxOYjk7jBPw+uJb69h9Oo7rLqbic1vMGKLpByrph5fTr9ZVqrlhYVOTR4iUfhhkK+T2384KDj9SE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481814667932.9739839677218; Wed, 20 Apr 2022 12:10:14 -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-438-Cl7tYX7IN_uRQQXHFpW7Ww-1; Wed, 20 Apr 2022 15:09:03 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 61A43805F70; Wed, 20 Apr 2022 19:08:53 +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 4474140D0170; Wed, 20 Apr 2022 19:08:53 +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 C59461940378; Wed, 20 Apr 2022 19:08:51 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B21121940353 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:49 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id A6B0F551E8A; Wed, 20 Apr 2022 19:08:49 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1CE39551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481813; 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=8Ipdewnr77UTIXYDWa3LljF36lp9pqrzYYZfoGiB4oA=; b=DZ2tdOQGvKfCiu0tkIzInsQhm2nINE573COk5QgNha/SNxuW1yg4ixvunoFTMqoQE4VKcU FoY9J7hJ9p+cTT+HTIm6vfw6XkAS72kFREKQCne7JPcy24/gWKUE6/iklpmkxa28JUkmuc ItchTPVh74H22Paa/2WmE21oEvuSkRg= X-MC-Unique: Cl7tYX7IN_uRQQXHFpW7Ww-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 27/30] scripts: apibuild: parse 'Since' for functions Date: Wed, 20 Apr 2022 21:08:16 +0200 Message-Id: <20220420190819.3093205-28-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481816754100001 Content-Type: text/plain; charset="utf-8" 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@redhat.com> --- scripts/apibuild.py | 126 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 113 insertions(+), 13 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index b77eea0624..ec10931151 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -111,6 +111,73 @@ ignored_functions =3D { "virErrorCopyNew": "private", } =20 +# 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 =3D { + 'virDomainSetBlockThreshold': '3.2.0', + 'virGetLastErrorMessage': '1.0.5.2', + 'virNodeDeviceCreate': '0.5.0', + 'virAdmClientClose': '1.3.5', + 'virAdmClientFree': '1.3.5', + 'virAdmClientGetID': '1.3.5', + 'virAdmClientGetInfo': '1.3.5', + 'virAdmClientGetTimestamp': '1.3.5', + 'virAdmClientGetTransport': '1.3.5', + 'virAdmConnectClose': '1.2.17', + 'virAdmConnectGetLibVersion': '1.3.1', + 'virAdmConnectGetURI': '1.3.1', + 'virAdmConnectIsAlive': '1.3.1', + 'virAdmConnectListServers': '1.3.2', + 'virAdmConnectLookupServer': '1.3.3', + 'virAdmConnectOpen': '1.2.17', + 'virAdmConnectRef': '1.2.17', + 'virAdmConnectRegisterCloseCallback': '1.3.1', + 'virAdmConnectUnregisterCloseCallback': '1.3.1', + 'virAdmGetVersion': '1.3.0', + 'virAdmServerFree': '1.3.2', + 'virAdmServerGetClientLimits': '1.3.5', + 'virAdmServerGetName': '1.3.2', + 'virAdmServerGetThreadPoolParameters': '1.3.4', + 'virAdmServerListClients': '1.3.5', + 'virAdmServerLookupClient': '1.3.5', + 'virAdmServerSetClientLimits': '1.3.5', + 'virAdmServerSetThreadPoolParameters': '1.3.4', + 'virAdmServerUpdateTlsFiles': '6.2.0', + 'virConnectFindStoragePoolSources': '0.4.6', + 'virConnectNumOfDefinedDomains': '0.1.6', + 'virConnectOpenAuth': '0.4.1', + 'virDomainBlockPeek': '0.4.4', + 'virDomainMemoryPeek': '0.4.4', + 'virNetworkUpdate': '1.0.0', + 'virConnectClose': '0.0.1', + 'virConnectGetType': '0.0.1', + 'virConnectGetVersion': '0.0.1', + 'virConnectListDomains': '0.0.1', + 'virConnectNumOfDomains': '0.0.1', + 'virConnectOpen': '0.0.1', + 'virConnectOpenReadOnly': '0.0.1', + 'virDomainCreateLinux': '0.0.1', + 'virDomainDestroy': '0.0.1', + 'virDomainFree': '0.0.1', + 'virDomainGetID': '0.0.1', + 'virDomainGetInfo': '0.0.1', + 'virDomainGetMaxMemory': '0.0.1', + 'virDomainGetName': '0.0.1', + 'virDomainGetOSType': '0.0.1', + 'virDomainGetXMLDesc': '0.0.1', + 'virDomainLookupByID': '0.0.1', + 'virDomainLookupByName': '0.0.1', + 'virDomainRestore': '0.0.2', + 'virDomainResume': '0.0.1', + 'virDomainSave': '0.0.2', + 'virDomainSetMaxMemory': '0.0.1', + 'virDomainShutdown': '0.0.1', + 'virDomainSuspend': '0.0.1', + 'virGetVersion': '0.0.1', +} + ignored_macros =3D { "_virSchedParameter": "backward compatibility macro for virTypedParame= ter", "_virBlkioParameter": "backward compatibility macro for virTypedParame= ter", @@ -2185,9 +2252,10 @@ class docBuilder: self.scanVersions() =20 # 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_commen= t=3D"" + ) -> (str, str, str): since =3D "" if comment is not None: comment_match =3D re.search(r"\(?Since: v?(\d+\.\d+\.\d+\.?\d?= )\)?", @@ -2200,9 +2268,20 @@ class docBuilder: # Only the version since =3D comment_match.group(1) =20 + if since =3D=3D "" and return_comment is not None: + return_match =3D re.search(r"\(?Since: v?(\d+\.\d+\.\d+\.?\d?)= \)?", + return_comment) + if return_match: + # Remove Since tag from the comment + (start, end) =3D return_match.span() + return_comment =3D return_comment[:start] + return_comment= [end:] + return_comment =3D return_comment.strip() + # Only the version + since =3D return_match.group(1) + if since =3D=3D "": self.warning("Missing 'Since' tag for: " + name) - return (since, comment) + return (since, comment, return_comment) =20 def modulename_file(self, file): module =3D os.path.basename(file) @@ -2238,7 +2317,7 @@ class docBuilder: output.write(" type=3D'%s'" % info[2]) if info[1] is not None and info[1] !=3D '': # Search for 'Since' version tag - (since, comment) =3D self.retrieve_comment_tags(name, info= [1]) + (since, comment, _) =3D self.retrieve_comment_tags(name, i= nfo[1]) if len(since) > 0: output.write(" version=3D'%s'" % escape(since)) if len(comment) > 0: @@ -2268,7 +2347,7 @@ class docBuilder: else: output.write(" raw=3D'%s'" % escape(rawValue)) =20 - (since, comment) =3D self.retrieve_comment_tags(name, desc) + (since, comment, _) =3D self.retrieve_comment_tags(name, desc) if len(since) > 0: output.write(" version=3D'%s'" % escape(since)) output.write(">\n") @@ -2302,7 +2381,7 @@ class docBuilder: =20 def serialize_typedef(self, output, name): id =3D self.idx.typedefs[name] - (since, comment) =3D self.retrieve_comment_tags(name, id.extra) + (since, comment, _) =3D self.retrieve_comment_tags(name, id.extra) version_tag =3D len(since) > 0 and f" version=3D'{since}'" or "" if id.info[0:7] =3D=3D 'struct ': output.write(" <struct name=3D'%s' file=3D'%s' type=3D'%s'%= s" % ( @@ -2354,6 +2433,12 @@ class docBuilder: if name =3D=3D debugsym and not quiet: print("=3D>", id) =20 + (ret, params, desc) =3D id.info + return_comment =3D (ret is not None and ret[1] is not None) and re= t[1] or "" + (since, comment, return_comment) =3D self.retrieve_comment_tags(na= me, desc, return_comment) + # Simple way to avoid setting empty version + version_tag =3D len(since) > 0 and f" version=3D'{since}'" or "" + # NB: this is consumed by a regex in 'getAPIFilenames' in hvsuppor= t.pl if id.type =3D=3D "function": ver =3D self.versions[name] @@ -2363,9 +2448,10 @@ class docBuilder: name, self.modulename_file(id.header), self.modulename_file(id.module), self.versions[name])) else: - output.write(" <functype name=3D'%s' file=3D'%s' module=3D'= %s'>\n" % ( + output.write(" <functype name=3D'%s' file=3D'%s' module=3D'= %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 +2462,33 @@ class docBuilder: apstr =3D apstr + " && " apstr =3D apstr + cond output.write(" <cond>%s</cond>\n" % (apstr)) + try: - (ret, params, desc) =3D 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 =3D name in self.versions and self.versions[name] or None + if len(since) > 0 and ver is not None and since !=3D ver: + if name in ignored_function_versions: + allowedver =3D ignored_function_versions[name] + if allowedver !=3D since: + self.warning(f"Function {name} has allowed version= {allowedver} but docstring says {since}") + else: + self.warning(f"Function {name} has symversion {ver} bu= t docstring says {since}") + + output.write(" <info><![CDATA[%s]]></info>\n" % (comment)) self.indexString(name, desc) + if ret[0] is not None: if ret[0] =3D=3D "void": output.write(" <return type=3D'void'/>\n") - elif (ret[1] is None or ret[1] =3D=3D '') and name not in = ignored_functions: + elif (return_comment =3D=3D '') and name not in ignored_fu= nctions: self.error("Missing documentation for return of functi= on `%s'" % name) else: output.write(" <return type=3D'%s' info=3D'%s'/>\= n" % ( - ret[0], escape(ret[1]))) + ret[0], escape(return_comment))) self.indexString(name, ret[1]) + for param in params: if param[0] =3D=3D 'void': continue --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481749; cv=none; d=zohomail.com; s=zohoarc; b=B+znDDCaWr4Th6bRffnExJBY8Fi0V2DeGTuraAT7JKoxCF7fye90OntNFRCxPrihJPeZYXQH1xv3m9Ed2T7ogUyYouUU3IJQJ2arHcYjqHME45AE7kWofTdahAM7inkSOvLb0hOSKZQdpcSARPuR5GiHh3P1h4nZ0VKeOSysCcQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481749; 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=TX3+ANkmEV98xadRy3JmNZdH2arEc3xDyvm9d0R3j8o=; b=k286ED/S8AXUzelwf3AKkR2dMh7pjnc26etSKeyWIwlCcSaTUSxExL9WZs6WK/Gsd1zQu+ZY1p4IuxAqHh6Rzgo9SBQb/QdMpeIXAJZgFnBVh/HqMB4iFz9X7X/nuVoHCz9rPShetxbhmMWs0wv9Q87nbKD/8V1QVz6kRNkGj/o= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481749399257.72742632610493; Wed, 20 Apr 2022 12:09:09 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-553-q6C7ErdYMfGy9YhLUF1W5w-1; Wed, 20 Apr 2022 15:09:04 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id CBB9F3C172CA; Wed, 20 Apr 2022 19:08:55 +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 B40D140D0166; Wed, 20 Apr 2022 19:08:55 +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 8E7F51940353; Wed, 20 Apr 2022 19:08:55 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B86611940361 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:50 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 808EC551E82; Wed, 20 Apr 2022 19:08:50 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0E42F551E85 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481748; 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=TX3+ANkmEV98xadRy3JmNZdH2arEc3xDyvm9d0R3j8o=; b=D37UsWYs03xbF9l5nB48FaKYYlitfeDDD0KN5Kdgnslb+EDDE6DAU6qCe8M8x1eyaN8ybT AZefltWFiDmzUO9XortAbNhjovTpvCUG8y5TPMYemDsXQYuf5hM/cLd61HJ19XovpI20V5 Bn/RjJHR7+aB9ufxQ8rAtkcPk9U0GDg= X-MC-Unique: q6C7ErdYMfGy9YhLUF1W5w-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 28/30] scripts: apibuild: factor out comment cleaning Date: Wed, 20 Apr 2022 21:08:17 +0200 Message-Id: <20220420190819.3093205-29-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481750224100023 Content-Type: text/plain; charset="utf-8" So we can use for comments that are being hold in helper variables. Signed-off-by: Victor Toso <victortoso@redhat.com> --- scripts/apibuild.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index ec10931151..151eba37e6 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -789,15 +789,18 @@ class CParser: line =3D line.replace('*', '', 1) return line =20 - def cleanupComment(self): - if not isinstance(self.comment, str): - return - # remove the leading * on multi-line comments - lines =3D self.comment.splitlines(True) + def cleanup_code_comment(self, comment: str) -> str: + if not isinstance(self.comment, str) or comment =3D=3D "": + return "" + + lines =3D comment.splitlines(True) com =3D "" for line in lines: com =3D com + self.strip_lead_star(line) - self.comment =3D com.strip() + return com.strip() + + def cleanupComment(self): + self.comment =3D self.cleanup_code_comment(self.comment) =20 def parseComment(self, token): com =3D token[1] --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 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=1650481747; cv=none; d=zohomail.com; s=zohoarc; b=GvjFIyCyybnPGWz1GHc0wp2scYH0aO8kfD12vu3SzUjr0iffEt5yoGEnVXqnx2FYQDIPe24BicunvDrno/8AJwhPzqP6NAcFqm9eVnp4EaSk3B0ZBXxGyk8yX5KASzHEsY9VnoWd8RlaERDVdvuGMyIukd2fgMzng6I097zCg5M= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481747; 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=VEO9EVjABiuUxiMMGS03JfjGSxJm2VabClyAdMtuDzA=; b=ERDAPNca/RN3yLARBm5qmnV+Eu2seXU1p8oVHIxgSLsygmwLQddSrywPYH5Z+dPDohGda8nSa6B4lAkPE5OJTrnZ173aSslBGDs031jX3KHsVA0x3ONptlzuwicR5hcsgjA+r0mI0jqU9FcWt7rhQA25eGTZjhQp2Og/rYKNlMw= 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=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> 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 1650481747141173.72458550912222; Wed, 20 Apr 2022 12:09:07 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-412-vOQDK6BdPJK8ky0DP20zSQ-1; Wed, 20 Apr 2022 15:09:04 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 602062805328; Wed, 20 Apr 2022 19:08:54 +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 126DE40D016B; Wed, 20 Apr 2022 19:08:54 +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 2AEB21940361; Wed, 20 Apr 2022 19:08:53 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 5A500194035C for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:51 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 4DA2D551E87; Wed, 20 Apr 2022 19:08:51 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id CA7F6551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481746; 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=VEO9EVjABiuUxiMMGS03JfjGSxJm2VabClyAdMtuDzA=; b=BKf/651XbB3E8O5au5SgrVLVyXVdgMnXiubt9bg+lox8yVYw2gCIajmQjuMg5Qfd/3Wsd8 FqfQVUHR4QIBzzFtBXmiKH5HOEZgJJf0F7y8H+q+681FMrl0bJb4YfoTn4MLXtCml9HzHL 6nFfnUK7fG8XjE765ebSe59BsEwsmLA= X-MC-Unique: vOQDK6BdPJK8ky0DP20zSQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 29/30] scripts: apibuild: add parsing variable's comments Date: Wed, 20 Apr 2022 21:08:18 +0200 Message-Id: <20220420190819.3093205-30-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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: 1650481748115100021 Content-Type: text/plain; charset="utf-8" scripts/apibuild.py did not consider exporting external variable's comments into the XML API. This commits fixes that. Noe that the way that CParser is designed, it is currently possible to lose a parsed comment when parsing other fields as self.comment in several places. I've added a comment to highlight this. Signed-off-by: Victor Toso <victortoso@redhat.com> --- scripts/apibuild.py | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index 151eba37e6..9bdea648d4 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -1997,10 +1997,14 @@ class CParser: if token is None or token[0] !=3D 'name': return token =20 + variable_comment =3D None if token[1] =3D=3D 'typedef': token =3D self.token() return self.parseTypedef(token) else: + # Store block of comment that might be from variable as + # the code uses self.comment a lot and it would lose it. + variable_comment =3D self.cleanup_code_comment(self.comment) token =3D self.parseType(token) type_orig =3D self.type if token is None or token[0] !=3D "name": @@ -2046,8 +2050,10 @@ class CParser: not self.is_header, "struct", self.struct_fields) else: + # Just to use the cleanupComment function. + info =3D (type, variable_comment) self.index_add(self.name, self.filename, - not self.is_header, "variable", typ= e) + not self.is_header, "variable", inf= o) break elif token[1] =3D=3D "(": token =3D self.token() @@ -2424,12 +2430,16 @@ class docBuilder: =20 def serialize_variable(self, output, name): id =3D self.idx.variables[name] - if id.info is not None: - output.write(" <variable name=3D'%s' file=3D'%s' type=3D'%s= '/>\n" % ( - name, self.modulename_file(id.header), id.info)) + (type, comment) =3D id.info + (since, comment, _) =3D self.retrieve_comment_tags(name, comment) + version_tag =3D len(since) > 0 and f" version=3D'{since}'" or "" + output.write(" <variable name=3D'%s' file=3D'%s' type=3D'%s'%s"= % ( + name, self.modulename_file(id.header), type, version_tag)) + if len(comment) =3D=3D 0: + output.write("/>\n") else: - output.write(" <variable name=3D'%s' file=3D'%s'/>\n" % ( - name, self.modulename_file(id.header))) + output.write(">\n <info><![CDATA[%s]]></info>\n" % (comme= nt)) + output.write(" </variable>\n") =20 def serialize_function(self, output, name): id =3D self.idx.functions[name] --=20 2.35.1 From nobody Sat May 18 17:16:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.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.129.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=1650481820; cv=none; d=zohomail.com; s=zohoarc; b=W66CNhQAno7LN8CUwFb/Ng/dR32UUcrNh2gv0BQcb3a2XBD97zbztZRYnxSQnR71lFgbdhfqkVp8xqJVqXpLlElhMq7+cxzuLZaQ83MvApfs4wYKQuYkfvhaS1Z3GVH3K01RH2MEhdODGNfDEqC0x6wuBe8CJpgOE/KfOC1pfcA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481820; 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=MHNr0P4ScB+v20nGkE4UVd5gBq1apLm3PGfRCv71fpY=; b=hanWZny80O0S0NOc3HqtSB41uZ/F9o9ZAXdBnWqXmf3Beqy5gEBoCi5dhQM8loSYEYpsv7a3AI/0cT3KRZgnqAxfE1VQx7/bMZUuvtzLeMqDZzA+B9zMct5N7QKFB31WurQYCxqE5hQZSMqor3gqQa1KnbT68YzskXF91JPCDko= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<victortoso@redhat.com> (p=none dis=none) Return-Path: <libvir-list-bounces@redhat.com> Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1650481820580285.84046794978747; Wed, 20 Apr 2022 12:10:20 -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-567-a5m1_tZCO4yRXWin6ctyGA-1; Wed, 20 Apr 2022 15:09:03 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id DE9D680D2A2; Wed, 20 Apr 2022 19:08:54 +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 C8037145BA60; Wed, 20 Apr 2022 19:08:54 +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 399791940347; Wed, 20 Apr 2022 19:08:54 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 2F7161940357 for <libvir-list@listman.corp.redhat.com>; Wed, 20 Apr 2022 19:08:52 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 1F3A3551E82; Wed, 20 Apr 2022 19:08:52 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id A0026551E86 for <libvir-list@redhat.com>; Wed, 20 Apr 2022 19:08:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481819; 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=MHNr0P4ScB+v20nGkE4UVd5gBq1apLm3PGfRCv71fpY=; b=IqNlx6YYXnupEDKCnrDRnPZa6bcOrKY/hx391MwufgLwQ09dIeyNDgrzhf8dm0X9g0cbmq yg9Ftuq1WpFrcZZYzXE0Ylc3atUk1H09004wKv9vJeisxzM1g9sZu/vTwF4BXSxthMvzyN mZSos1YQj1OpZ4RogHHtJ6iIG4ayKpQ= X-MC-Unique: a5m1_tZCO4yRXWin6ctyGA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v3 30/30] do-not-commit: script to validate output Date: Wed, 20 Apr 2022 21:08:19 +0200 Message-Id: <20220420190819.3093205-31-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <libvir-list.redhat.com> List-Unsubscribe: <https://listman.redhat.com/mailman/options/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=unsubscribe> List-Archive: <http://listman.redhat.com/archives/libvir-list/> List-Post: <mailto:libvir-list@redhat.com> List-Help: <mailto:libvir-list-request@redhat.com?subject=help> List-Subscribe: <https://listman.redhat.com/mailman/listinfo/libvir-list>, <mailto:libvir-list-request@redhat.com?subject=subscribe> Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" <libvir-list-bounces@redhat.com> X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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: 1650481822838100001 Content-Type: text/plain; charset="utf-8" A throw away script to validate that the generated XML has the correct versions. It checks if $keyword is present in $git_tag and also in the $next_git_tag but not in the $previous_git_tag. Takes almost a minute to run, in my computer. | python3 ./scripts/version-quest.py -i ./include/ -d ./build/docs/ | # libvirt has 2101 symbols | # libvirt-qemu has 19 symbols | # libvirt-lxc has 4 symbols | # libvirt-admin has 63 symbols | # Total of 2187 symbols checked Signed-off-by: Victor Toso <victortoso@redhat.com> --- scripts/version-quest.py | 190 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 scripts/version-quest.py diff --git a/scripts/version-quest.py b/scripts/version-quest.py new file mode 100644 index 0000000000..01e5d28c59 --- /dev/null +++ b/scripts/version-quest.py @@ -0,0 +1,190 @@ +#!/usr/bin/env python3 +# +# This is a simple utitly script to help check version of exported +# types in XML built with scripts/apibuild.py +# +# See Copyright for the status of this software. +# +# victortoso@redhat.com +# + +import os +import re +import argparse + +tags =3D [] +includedir =3D "" +xmldir =3D "" +next_release =3D "v8.3.0" + +allowlist =3D { + 'virDomainSetBlockThreshold': '3.2.0', + 'virGetLastErrorMessage': '1.0.5.2', + 'virNodeDeviceCreate': '0.5.0', + 'virAdmClientClose': '1.3.5', + 'virAdmClientFree': '1.3.5', + 'virAdmClientGetID': '1.3.5', + 'virAdmClientGetInfo': '1.3.5', + 'virAdmClientGetTimestamp': '1.3.5', + 'virAdmClientGetTransport': '1.3.5', + 'virAdmConnectClose': '1.2.17', + 'virAdmConnectGetLibVersion': '1.3.1', + 'virAdmConnectGetURI': '1.3.1', + 'virAdmConnectIsAlive': '1.3.1', + 'virAdmConnectListServers': '1.3.2', + 'virAdmConnectLookupServer': '1.3.3', + 'virAdmConnectOpen': '1.2.17', + 'virAdmConnectRef': '1.2.17', + 'virAdmConnectRegisterCloseCallback': '1.3.1', + 'virAdmConnectUnregisterCloseCallback': '1.3.1', + 'virAdmGetVersion': '1.3.0', + 'virAdmServerFree': '1.3.2', + 'virAdmServerGetClientLimits': '1.3.5', + 'virAdmServerGetName': '1.3.2', + 'virAdmServerGetThreadPoolParameters': '1.3.4', + 'virAdmServerListClients': '1.3.5', + 'virAdmServerLookupClient': '1.3.5', + 'virAdmServerSetClientLimits': '1.3.5', + 'virAdmServerSetThreadPoolParameters': '1.3.4', + 'virAdmServerUpdateTlsFiles': '6.2.0', + 'virConnectFindStoragePoolSources': '0.4.6', + 'virConnectNumOfDefinedDomains': '0.1.6', + 'virConnectOpenAuth': '0.4.1', + 'virDomainBlockPeek': '0.4.4', + 'virDomainMemoryPeek': '0.4.4', + 'virNetworkUpdate': '1.0.0', + 'virConnectClose': '0.0.1', + 'virConnectGetType': '0.0.1', + 'virConnectGetVersion': '0.0.1', + 'virConnectListDomains': '0.0.1', + 'virConnectNumOfDomains': '0.0.1', + 'virConnectOpen': '0.0.1', + 'virConnectOpenReadOnly': '0.0.1', + 'virDomainCreateLinux': '0.0.1', + 'virDomainDestroy': '0.0.1', + 'virDomainFree': '0.0.1', + 'virDomainGetID': '0.0.1', + 'virDomainGetInfo': '0.0.1', + 'virDomainGetMaxMemory': '0.0.1', + 'virDomainGetName': '0.0.1', + 'virDomainGetOSType': '0.0.1', + 'virDomainGetXMLDesc': '0.0.1', + 'virDomainLookupByID': '0.0.1', + 'virDomainLookupByName': '0.0.1', + 'virDomainRestore': '0.0.2', + 'virDomainResume': '0.0.1', + 'virDomainSave': '0.0.2', + 'virDomainSetMaxMemory': '0.0.1', + 'virDomainShutdown': '0.0.1', + 'virDomainSuspend': '0.0.1', + 'virGetVersion': '0.0.1', +} + + +def get_symbols(xmlpath: str): + symbols =3D [] + expression =3D "<(.*?) name=3D'(.*?)'.*version=3D'(.*?)'" + with open(xmlpath) as file: + for line in file: + r =3D re.search(expression, line) + if r is not None: + symbols.append(r.groups()) + + return symbols + + +def find_version(symbol, start_version): + index =3D start_version =3D=3D "" and -1 or tags.index(start_version) + for i in range(index + 1, len(tags)): + if git_check_symbol(symbol, tags[i]): + return tags[i] + + assert False + + +def get_tags_array() -> list[str]: + # We will be looking symbols at released tags. Only vx.y.z are + # interesting to us. + k =3D os.popen("git tag --list 'v*' | grep -v 'rc' | sort -V") + alltags =3D k.read().split() + return alltags + + +def git_check_symbol(symbol, version, full=3DFalse) -> bool: + path =3D full and "" or includedir + s =3D os.system(f"git grep -rqw {symbol} {version} {path}") + return os.waitstatus_to_exitcode(s) =3D=3D 0 + + +def check_symbol(symbol, xml_version) -> (bool, str): + # For functions that were released with wrong sym version + if symbol in allowlist: + docversion =3D f"v{allowlist[symbol]}" + if docversion =3D=3D xml_version: + return (False, f"{symbol} allowlist versions match: {xml_versi= on}") + + if not git_check_symbol(symbol, docversion, True): + version =3D find_version(symbol, docversion) + return (False, f"{symbol} allowlist {docversion} =3D> {version= }") + + return (True, "") + + # Too recent, just skip. + if xml_version =3D=3D next_release: + return (True, "") + + if xml_version not in tags: + return (False, f"{symbol}'s {xml_version} does not exist in git ta= gs") + + index =3D tags.index(xml_version) + + if not git_check_symbol(symbol, tags[index]): + return (False, f"{symbol} does not exist in version {xml_version}") + + # Added in the first release. Seems fine. + if index =3D=3D 0: + return (True, "") + + # Ooops. Symbol was found in the previous release too. + if git_check_symbol(symbol, tags[index - 1]): + version =3D find_version(symbol, "") + return (False, f"{symbol} {tags[index]} =3D> real: {version}") + + # Added in the last tag, nothing else to do. + if index =3D=3D len(tags) - 1: + return (True, "") + + # Ooops. Symbol was not found in the next release. + if not git_check_symbol(symbol, tags[index + 1]): + return (False, f"{symbol} in {tags[index]} but not {tags[index + 1= ]}") + + return (True, "") + + +if __name__ =3D=3D "__main__": + parser =3D argparse.ArgumentParser(description=3D"Quest: Versions!") + parser.add_argument("-d", "--xmldir", type=3Dstr, + help=3D"Directory of libvirt-.*.xml APIs") + parser.add_argument("-i", "--includedir", type=3Dstr, + help=3D"Include directory of libvirt") + + args =3D parser.parse_args() + includedir =3D args.includedir + xmldir =3D args.xmldir + tags =3D get_tags_array() + + counter =3D {} + xmlfiles =3D ["libvirt", "libvirt-qemu", "libvirt-lxc", "libvirt-admin= "] + for xml in xmlfiles: + symbols =3D get_symbols(f"{xmldir}/{xml}-api.xml") + counter[xml] =3D len(symbols) + for (symbol_type, symbol_name, symbol_version) in symbols: + ok, errmsg =3D check_symbol(symbol_name, f"v{symbol_version}") + if not ok: + print(f"{xml}: {symbol_type}: Failed: {errmsg}") + + total =3D 0 + for xml in counter.keys(): + total +=3D counter[xml] + print(f"# {xml} has {counter[xml]} symbols") + print(f"# Total of {total} symbols checked") --=20 2.35.1