From nobody Sat May 11 21:53:44 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=1650655459; cv=none; d=zohomail.com; s=zohoarc; b=BIV/NpCXOfra05cjT3hz15IC1nT4w40OKRN6JQCjg2vdWJno5a5PGyc78AaaaPTKkx7XqfLiCp/6b5mfPX2Yn2VBdarpoKsb1hzngikeEude+rYqiXNLEkk9ribxoMPWd9IoukTwl3gSBAdUx3dLSovKMy0TTeYwo3ZjdF7jC8A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655459; 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=HIuSr/MmQUtn4xO0CpAO/N+GwaeoJk/WunomCIDXl6Y=; b=UGAC6mNWz9pIlszM0R6u5NSePm1MTTWOMjOiGL4bsdE+1u7//vBe2x5eaief39O1TtVFoHjx9Kj43U1dbFlrMKvdd2l678Ewpa9+lcZ1Q/fRucJpcpQXfYUpFWOb/ZG07ugYGg9zRxMKtdE2MmQMhdLhHZV5aYzRNBG6Rin4ZvM= 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 1650655459750395.53419471512825; Fri, 22 Apr 2022 12:24:19 -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-371-02RUnXO0PfioVPu3bb_51A-1; Fri, 22 Apr 2022 15:24:11 -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 EB674804189; Fri, 22 Apr 2022 19:24:06 +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 D6B2114A5066; Fri, 22 Apr 2022 19:24:05 +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 142B01940361; Fri, 22 Apr 2022 19:24:04 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B26A21940351 for ; Fri, 22 Apr 2022 19:24:02 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 923D22026614; Fri, 22 Apr 2022 19:24:02 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id D6D222026609 for ; Fri, 22 Apr 2022 19:24:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655458; 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=HIuSr/MmQUtn4xO0CpAO/N+GwaeoJk/WunomCIDXl6Y=; b=HvuWNSWrIUydqxmPuGnU3jwqOIlXyEXdSAqCYPSjd4tpLyt93CuzEqVGa4LnLL/wUsZWoA OLmJMr8FIgyE/Q2GaqG7iYz7URO9nUKpQerIQzshyjGNLTFwKcHbUGzonpvTQlSHrJGNRp fhNIMRWdu4twMV2hWVLsNV0JUqPIHT0= X-MC-Unique: 02RUnXO0PfioVPu3bb_51A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 01/19] docstring: typedef: fix version of virConnectListAllStoragePoolsFlags Date: Fri, 22 Apr 2022 21:23:26 +0200 Message-Id: <20220422192344.830350-2-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.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: 1650655460126100006 Content-Type: text/plain; charset="utf-8" This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 19/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso --- include/libvirt/libvirt-storage.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index b23961cad5..94802bb2c5 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -292,7 +292,7 @@ int virConnectListDefinedStoragePoo= ls(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, --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655460; cv=none; d=zohomail.com; s=zohoarc; b=SapTYJMaa5TL98hnSsP89xMXqmNVaofTbvdoH7zJCwyA2x0GSZ+TUN3OfRRxnAX3fcynLewBAHQgq3RUD2l0xhkA6QCiuOYeRPdF9ses3QOHX9SjicSI1lahVHKukliRMYHvz6cefcXqCIF5cvMFss0EL9M5j2X1ra1ALzOTMe4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655460; 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=8qMQSwV3UrPqECfbw3Ne8aA+xf5OqnKMfvOYtRD1onY=; b=eCfc3k6oe2cGvkKwH5IVfQ0CUno2rgOCNKY6pGZOpVwK1Pd030rmiDlnWLoEC1mTmB94VGEdjuxiuf64/W4tVmNZvTipGYQ59UPSXXgOb1csTQTXylYZBeOIx6C3eCDdFjig+ZeU+Q4ye5mLrGRLXmvINw05MUVHFcIvzxeLmHs= 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 1650655460124601.1439467987877; Fri, 22 Apr 2022 12:24: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-258-3oqDp-lpMeWMNtf7e2OT1A-1; Fri, 22 Apr 2022 15:24:12 -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 6C14A803E2E; Fri, 22 Apr 2022 19:24:07 +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 2929414A5067; Fri, 22 Apr 2022 19:24:07 +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 04C6F194036E; Fri, 22 Apr 2022 19:24:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 6EC651940351 for ; Fri, 22 Apr 2022 19:24:03 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 61454200C0CF; Fri, 22 Apr 2022 19:24:03 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id E04AD200E287 for ; Fri, 22 Apr 2022 19:24:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655458; 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=8qMQSwV3UrPqECfbw3Ne8aA+xf5OqnKMfvOYtRD1onY=; b=OR7YVlZer1tbfoLPMZR2ofVGTPFwIgi7SozCopkqPS/AxKUIkM35g8S83uCxmpS+WfT1RD MthCUhoHVWBNbrwxApsUx0iu4qArrZYk5kxF1K/G4TLTsjKRxjy2wY67IwvAu9JW0jfFBP xLzW9qOA6eHh+TDMawvOIPsVdbEkrt0= X-MC-Unique: 3oqDp-lpMeWMNtf7e2OT1A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 02/19] docstring: typedef: fix version of virDomainDeviceModifyFlags Date: Fri, 22 Apr 2022 21:23:27 +0200 Message-Id: <20220422192344.830350-3-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.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: 1650655462337100001 Content-Type: text/plain; charset="utf-8" This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 20/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso --- include/libvirt/libvirt-domain.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 9aa214f3df..ad920f230d 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -2511,7 +2511,7 @@ int virDomainGetVcpus (virD= omainPtr domain, /** * virDomainDeviceModifyFlags: * - * Since: v1.0.0 + * Since: v0.7.7 */ typedef enum { /* See virDomainModificationImpact for these flags. */ --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655503; cv=none; d=zohomail.com; s=zohoarc; b=c1E15cE7fPQ+1RKC9oVUDxlEWWjhSn+m+zxp7aFS/wBsbPvX1GMJu0o4ZrjKktoAAGmQcvc9mkCPYNmK8Gnqtgr240sO0V301dNYIfoclT/LzIewwW3X4gY4taFBMaU8USw9UtuF2T0NQWKGTBJXZQoVduzdAgRWbZXXUaCrnaU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655503; 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=qtlZ4L4K9SfVHUXQzQ7+nJyPB0vqsr5dLRUBVR4AA4w=; b=ZV486efyKo9bD3B3z2qf/PRgg3KL2dfrQzM26NNZ6OvRYPINqgmB0fB2XmN3RSyDn8yJWUGr9ZGijpVjsLm5MUUC8O34rKp9mjUWvo6UH4hGoWPavfmir2kI5doYl4B/63uX57fijcsd9JwOWrOwVmWnqClJo1CoXm4IufGfUr4= 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 1650655503016222.96266801442675; Fri, 22 Apr 2022 12:25: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-6-2rJEiE0yPnGDXTacf46q7w-1; Fri, 22 Apr 2022 15:24:11 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id C1F551801DA7; Fri, 22 Apr 2022 19:24:07 +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 AEAC92166B5E; Fri, 22 Apr 2022 19:24:07 +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 50707194037B; Fri, 22 Apr 2022 19:24:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 4A7F1194036B for ; Fri, 22 Apr 2022 19:24:04 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 3B8032026614; Fri, 22 Apr 2022 19:24:04 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id B0E1D2026609 for ; Fri, 22 Apr 2022 19:24:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655502; 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=qtlZ4L4K9SfVHUXQzQ7+nJyPB0vqsr5dLRUBVR4AA4w=; b=GWPNPwNzS6TnVHZYQ0q0QGSXk0gvvPFLBhnRo7JN/MjmwVySPSlJH4H+pmXHrhzJsB/Iyq PUlmrp54tgFJ0r/3CE4JGeB+J6y4QzAmM6QUMUrioS/3tAhbzKw6E8vXWvTQ4794xhvNOB gITIjjcoQHD/1VgdOfTL2/w+TF5VR/A= X-MC-Unique: 2rJEiE0yPnGDXTacf46q7w-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 03/19] docstring: typedef: fix version of virDomainMemoryModFlags Date: Fri, 22 Apr 2022 21:23:28 +0200 Message-Id: <20220422192344.830350-4-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 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: 1650655505149100001 Content-Type: text/plain; charset="utf-8" This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 21/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso --- include/libvirt/libvirt-domain.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index ad920f230d..1b2d50e7c6 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1755,7 +1755,7 @@ int virDomainGetMemoryParameters(virDomainPtr dom= ain, * * Memory size modification flags. * - * Since: v1.0.0 + * Since: v0.9.0 */ typedef enum { /* See virDomainModificationImpact for these flags. */ --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655456; cv=none; d=zohomail.com; s=zohoarc; b=hXmhfUdHMHaFsZlT/MuklSwaFVrAzDnKyQ8GQrAEVRJKyabZzJ3TU9B2cyvwRCPqsezXzoBp884HPBtOEyV1RHtX8op4kqRkYk2kwDFl5sS46yfu9fdzRDSq2eyWj3xvwR9iiepq88m+hLwBLUjSI6ufpYFhefvsnqokxhbFdcU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655456; 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=nHJOnAuGSYq239EhH2bGBRIlbtcZctkxFKPKdVBjBCU=; b=nEjfFrUe3eNJ9OzMR7CT5V3L9374o8Nx/ZrfLe+RBYr15Apkv+Tt69TOTM4FzIiAwysEpEnFqd9E7ualOuuJ4VU4/pjJve+a0YoCiHJUF3xQkdOHdLfTbSxMzGHvcbsBZp3jgG1ANnqlNKZsvf591w0WULG7WU7ziK6iTqjks2s= 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 1650655456905595.6632044739887; Fri, 22 Apr 2022 12:24: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-665-bsKWj1cbN3KQ_XY1nDpR4Q-1; Fri, 22 Apr 2022 15:24:12 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 681A12811805; Fri, 22 Apr 2022 19:24:08 +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 555902166B5E; Fri, 22 Apr 2022 19:24:08 +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 A31271940358; Fri, 22 Apr 2022 19:24:06 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 43D5F1940379 for ; Fri, 22 Apr 2022 19:24:05 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 2889A2026609; Fri, 22 Apr 2022 19:24:05 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 895FE2026614 for ; Fri, 22 Apr 2022 19:24:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655455; 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=nHJOnAuGSYq239EhH2bGBRIlbtcZctkxFKPKdVBjBCU=; b=FCu+5EOUcE1jlMGjdRfxD3hWq+TVw3SRpe+S/o8dbA4tj41Yd6yWUkOXt388LVTW3dOJpE sc70RdZoeQM/ZDLWdaG1QbYsyQBOBa+7B6/ZINdMTtT4WXlH1fTL72VJIEgwM0fp4QK0eN UOPzY/NH7QJTHQ79FKMLCiW3aZ/Jg7k= X-MC-Unique: bsKWj1cbN3KQ_XY1nDpR4Q-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 04/19] docstring: typedef: fix version of virDomainVcpuFlags Date: Fri, 22 Apr 2022 21:23:29 +0200 Message-Id: <20220422192344.830350-5-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 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: 1650655458148100001 Content-Type: text/plain; charset="utf-8" This was a mistake on my side in the v3 iteration of the series. I've introduced the wrong version number in v3 10/30 and fixed later in v3 22/30. Apologies. Fixes: 034432e47b Signed-off-by: Victor Toso --- include/libvirt/libvirt-domain.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 1b2d50e7c6..138133b719 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -2264,7 +2264,7 @@ typedef virVcpuInfo *virVcpuInfoPtr; * * Flags for controlling virtual CPU hot-plugging. * - * Since: v1.0.0 + * Since: v0.8.5 */ typedef enum { /* See virDomainModificationImpact for these flags. */ --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655458; cv=none; d=zohomail.com; s=zohoarc; b=ZRCEgVBpJbbNPzcxweDKu65YipBvXGPe3qha2UGjneDbgfiJdrBQmQX20zrnl/KynRD2HaI+FwzTbkb+cwDr2o3ojDTeQ2gdJ3LJhm0o8xzT9OU/VSdaJzNHM3TjKthZvHJM4ORv8nqkxbLQwJhFDldPUAZVrT+jZJjQtuFgBZo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655458; 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=BVrhyCFaKsLkJ6P+L5hsxtRRQI5xt28aZx9HI4UgNbw=; b=GmrnhbIM4phL01/TVP3hXebjYAU3pe9LWwrunTK732ls2O7QoB6mEeX711atGoRSkBWcDxislnXNJ9FCcKjrws6L2UmtiQuDuYlcqLeX5shnzAI7HJ7SIvJoYNYzi1o10ixIaDsWww86ibFdd2HAzZ9xB4UyPaMxELgQmKyZods= 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 1650655458385192.08274589982102; Fri, 22 Apr 2022 12:24:18 -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-551-stn64MeEO3u6PAAuWAdY0g-1; Fri, 22 Apr 2022 15:24:12 -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 1D12A1014A85; Fri, 22 Apr 2022 19:24:09 +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 08F3BC44AE5; Fri, 22 Apr 2022 19:24:09 +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 640ED1940363; Fri, 22 Apr 2022 19:24:07 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 559781940358 for ; Fri, 22 Apr 2022 19:24:06 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 227CE2026614; Fri, 22 Apr 2022 19:24:06 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8ACAC200C0CF for ; Fri, 22 Apr 2022 19:24:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655457; 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=BVrhyCFaKsLkJ6P+L5hsxtRRQI5xt28aZx9HI4UgNbw=; b=hts8zOXAiZHLxj+ZPUvM6YuqRq9z0ARVLPAfLHO44eq4t7mxU2mxz7JMiMoyiy9oTUqj8P MMSzuvAxSzO5YgsR6mpNWx/kdemhXRUlEkb2UUnTkkXDQ2dg0ogFBEkWalazThLDQIZToF eSte4YIuAHyTckftmc51tReDnYK55MA= X-MC-Unique: stn64MeEO3u6PAAuWAdY0g-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 05/19] docstring: remove comments between enum values Date: Fri, 22 Apr 2022 21:23:30 +0200 Message-Id: <20220422192344.830350-6-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.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: 1650655460126100005 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. This commit removes some generic comments that I have spotted. Signed-off-by: Victor Toso --- include/libvirt/libvirt-domain.h | 6 ------ include/libvirt/libvirt-storage.h | 1 - 2 files changed, 7 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 138133b719..0fa4509b73 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1758,12 +1758,10 @@ int virDomainGetMemoryParameters(virDomainPtr d= omain, * Since: v0.9.0 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ 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. */ VIR_DOMAIN_MEM_MAXIMUM =3D (1 << 2), /* affect Max rather than current= */ } virDomainMemoryModFlags; =20 @@ -2267,12 +2265,10 @@ typedef virVcpuInfo *virVcpuInfoPtr; * Since: v0.8.5 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ 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 */ VIR_DOMAIN_VCPU_HOTPLUGGABLE =3D (1 << 4), /* Make vcpus added hot(un)= pluggable */ @@ -2514,12 +2510,10 @@ int virDomainGetVcpus (vi= rDomainPtr domain, * Since: v0.7.7 */ typedef enum { - /* See virDomainModificationImpact for these flags. */ 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. */ VIR_DOMAIN_DEVICE_MODIFY_FORCE =3D (1 << 2), /* Forcibly modify device (ex. force eject a cdrom= ) */ } virDomainDeviceModifyFlags; diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 94802bb2c5..46803eba2d 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -304,7 +304,6 @@ typedef enum { VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART =3D 1 << 4, VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART =3D 1 << 5, =20 - /* 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, --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655456; cv=none; d=zohomail.com; s=zohoarc; b=dYkTVI4B8/aaRz1XzomxrmkfAQgS3Sb5PghvQXmn/64lpXVo35T2PwVJcR/A0R2ysdD/ULLyaJcIArmdym2/aW7WUf3X/3oGQdiyMrioPxtWKsqEID9ZqBf6GwpRmM2r8S2efXlBzBy6F5ZYZGF/UwSzXWu+mP0jlceRfedyxxU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655456; 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=/b0Bi0qWNjOZbvF7prBEYZrigtb2zNdiyVV22cylA0E=; b=DgTVeclj3dtEhNyHJqtvLmrmq0mKst7tN06M3ooOccV7ICRops9QLN9kE0/LH/+U+pWB9gcrmaypu/2AyF3WdFY+RrmFlFrHjngERZCiCeYIa21EvMl5IskikcUJHqxcuxiNCQ5N65JXid1+YTdjRzwB1iUVEit7fcD2AErF4/g= 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 1650655456617239.67216208630555; Fri, 22 Apr 2022 12:24:16 -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-232-D74_sLPePUSwRdpW2oeaeg-1; Fri, 22 Apr 2022 15:24:13 -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 E127B86B8A3; Fri, 22 Apr 2022 19:24:09 +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 CEC4E14A5060; Fri, 22 Apr 2022 19:24:09 +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 ED8711940353; Fri, 22 Apr 2022 19:24:08 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 4133A1940361 for ; Fri, 22 Apr 2022 19:24:07 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 0DA04200C0CF; Fri, 22 Apr 2022 19:24:07 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 85449200E287 for ; Fri, 22 Apr 2022 19:24:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655455; 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=/b0Bi0qWNjOZbvF7prBEYZrigtb2zNdiyVV22cylA0E=; b=Cyz56oIg5FesGnfzojBGPMOO8ygfwwoV4TDiiXKqff+SjB0eCp41y4B4CkpVJ4PXpAmHwR WQbKlyygRiN4wGSdQ79OFx6lMPh2Y3jkZnnIlihu33CSK2R+w1ZnLpS7LQb+2hUv6N0QUQ Zod9wDHfSPedZ1+HDTpIeLk8eLd15so= X-MC-Unique: D74_sLPePUSwRdpW2oeaeg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 06/19] docstring: avoid sc_prohibit_nonreentrant in a comment Date: Fri, 22 Apr 2022 21:23:31 +0200 Message-Id: <20220422192344.830350-7-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.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: 1650655458157100002 Content-Type: text/plain; charset="utf-8" Follow up patch will add Since metadata to enum values of virStorageVolWipeAlgorithm. This patch is necessary to avoid breaking the build with syntax-check. Signed-off-by: Victor Toso --- include/libvirt/libvirt-storage.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 46803eba2d..381a8d95bc 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -201,11 +201,11 @@ typedef enum { 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 */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 =3D 6, /* 7-pass random data */ =20 - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random data */ =20 - VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random */ + VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random data */ =20 VIR_STORAGE_VOL_WIPE_ALG_TRIM =3D 9, /* 1-pass, trim all data on the volume by using TRIM or DISCARD = */ --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655463; cv=none; d=zohomail.com; s=zohoarc; b=Ob8n7DDWwjlGEPPG4vwkoEsiElLbEUQbaSUPiV8BdQ3eLR3XDN3HK6K7l2zYnuMkWOJbhCXJWl/RhRiChZg65mJOjncFcQ2aOxbyP+PWyJaAQBUadsDqgP55GpT8S1xe4n097ZI/Ak2FfMxtMvP3sPVVVEDx0r4euo85+24eDr8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655463; 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=/UKY/b2lLaVyt35Gkp4iycWvGUgizIGrnnUE9gKZgAY=; b=Mb8k/OPh/x4r5TjTvKHpv81EREFA2hsk5uO5CVTHt0UA4WuRNTnGTq+FXIF6HfwY9eLHZgOgrM3NOIMgkdEWpJNjcB/B8nIRbR6JSfZBbeD8Z3V0XSOTS01m7Whjg0BY5DwUBF3d9ZLi0u2yhP6WYpF96zkRvqvyFaQHi/64amc= 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 1650655463609940.5592389152403; Fri, 22 Apr 2022 12:24:23 -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-509-6OAzCSVkPienpeFMPYB9Hw-1; Fri, 22 Apr 2022 15:24:20 -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 9AC7F1C0514C; Fri, 22 Apr 2022 19:24:17 +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 6CCD1565DAA; Fri, 22 Apr 2022 19:24:17 +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 41A541940353; Fri, 22 Apr 2022 19:24:17 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B364E1940351 for ; Fri, 22 Apr 2022 19:24:15 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id A4337200C0CF; Fri, 22 Apr 2022 19:24:15 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1838F2024CC3 for ; Fri, 22 Apr 2022 19:24:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655462; 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=/UKY/b2lLaVyt35Gkp4iycWvGUgizIGrnnUE9gKZgAY=; b=QuKIYJO8v2UL978TPKjP3Vjn3bMeDtIGC+1Wbf9qyWGoUlYvPEMjMFwmhtYYbLN6KXlSTg MSd3DJY344by4pJ59b6DiU+yVMHSNX3vVAmfHs+vtxwCMbMnjdLOjK/8kkuX8Dkc9SIMWl llJUb6kY/FoQ+L7ikj4EClzB0m7Zc4E= X-MC-Unique: 6OAzCSVkPienpeFMPYB9Hw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v4 07/19] docstring: enums: libvirt: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:32 +0200 Message-Id: <20220422192344.830350-8-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.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: 1650655464284100003 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 | 1196 +++++++++++-------- 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 | 166 +-- include/libvirt/libvirt-stream.h | 12 +- include/libvirt/virterror.h | 406 +++---- 13 files changed, 1150 insertions(+), 986 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/= libvirt-domain-checkpoint.h index d5dea750db..5476325503 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -61,13 +61,13 @@ virConnectPtr virDomainCheckpointGetConnect(virDomainCh= eckpointPtr checkpoint); */ 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. */ @@ -80,11 +80,11 @@ virDomainCheckpointPtr virDomainCheckpointCreateXML(vir= DomainPtr domain, * Since: v5.6.0 */ 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 */ @@ -106,18 +106,18 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpoi= ntPtr 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 */ @@ -147,9 +147,9 @@ virDomainCheckpointPtr virDomainCheckpointGetParent(vir= DomainCheckpointPtr check * Since: v5.6.0 */ 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 35eeb21e27..0f4124925c 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -60,28 +60,28 @@ virConnectPtr virDomainSnapshotGetConnect(virDomainSnap= shotPtr snapshot); */ 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 */ @@ -94,7 +94,7 @@ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomain= Ptr domain, * Since: v5.1.0 */ 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 */ @@ -118,45 +118,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 */ @@ -216,10 +216,10 @@ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr= snapshot, * Since: v0.9.5 */ 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 @@ -237,9 +237,9 @@ int virDomainRevertToSnapshot(virDomainSnapshotPtr snap= shot, * Since: v0.8.0 */ 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 0fa4509b73..5e165f60ed 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -55,15 +55,15 @@ typedef virDomain *virDomainPtr; * Since: v0.0.1 */ 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 @@ -71,6 +71,8 @@ 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; @@ -81,10 +83,10 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -94,21 +96,21 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -118,10 +120,10 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -131,23 +133,23 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -157,11 +159,11 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -171,19 +173,19 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -193,11 +195,11 @@ typedef enum { * Since: v0.9.2 */ 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 @@ -207,10 +209,10 @@ typedef enum { * Since: v0.9.11 */ 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 @@ -220,10 +222,10 @@ typedef enum { * Since: v1.0.0 */ 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 @@ -235,17 +237,17 @@ typedef enum { * Since: v0.9.3 */ 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 @@ -258,16 +260,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 @@ -319,10 +321,10 @@ typedef virDomainControlInfo *virDomainControlInfoPtr; * Since: v0.9.2 */ 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 /** @@ -361,13 +363,13 @@ typedef virDomainInfo *virDomainInfoPtr; * Since: v0.0.1 */ 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 @@ -710,9 +712,9 @@ typedef virDomainInterfaceStatsStruct *virDomainInterfa= ceStatsPtr; * Since: v0.7.5 */ 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 /* @@ -720,14 +722,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 @@ -736,52 +748,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 @@ -813,11 +855,11 @@ typedef virDomainMemoryStatStruct *virDomainMemorySta= tPtr; * Since: v0.7.5 */ 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 /** @@ -828,20 +870,22 @@ typedef enum { * Since: v1.2.3 */ 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; @@ -859,6 +903,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 @@ -867,6 +914,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 @@ -877,6 +927,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 @@ -884,17 +937,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 @@ -904,6 +966,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 @@ -914,6 +979,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 @@ -921,6 +989,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 @@ -931,6 +1002,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 @@ -940,6 +1014,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 @@ -947,11 +1024,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 @@ -960,6 +1043,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 @@ -977,6 +1063,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 @@ -984,6 +1073,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 @@ -991,12 +1083,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 @@ -1007,6 +1105,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 @@ -1333,7 +1434,7 @@ int virDomainMigrateSetCompressionCache(virDomainPtr = domain, * Since: v5.1.0 */ 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 @@ -1400,12 +1501,12 @@ virDomainPtr virDomainLookupByUUIDString= (virConnectPtr conn, * Since: v0.9.10 */ 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); @@ -1418,12 +1519,12 @@ int virDomainShutdownFlags (vi= rDomainPtr domain, * Since: v0.9.10 */ 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, @@ -1442,9 +1543,9 @@ int virDomainDestroy (virD= omainPtr domain); * Since: v0.9.4 */ 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, @@ -1477,10 +1578,10 @@ int virDomainPMWakeup (vi= rDomainPtr domain, * Since: v0.9.4 */ 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, @@ -1758,11 +1859,11 @@ int virDomainGetMemoryParameters(virDomainPtr d= omain, * Since: v0.9.0 */ typedef enum { - 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 - 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 @@ -1776,13 +1877,13 @@ typedef enum { * Since: v0.9.9 */ 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 @@ -1843,8 +1944,8 @@ int virDomainGetSecurityLabel (vi= rDomainPtr domain, * Since: v6.1.0 */ 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, @@ -1858,12 +1959,12 @@ int virDomainGetSecurityLabelLi= st (virDomainPtr domain, * Since: v0.9.10 */ 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 @@ -1893,10 +1994,10 @@ virDomainGetMetadata(virDomainPtr domain, * Since: v0.3.3 */ 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 /** @@ -1905,7 +2006,7 @@ typedef enum { * Since: v5.1.0 */ 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, @@ -2026,7 +2127,7 @@ int virDomainBlockPeek (virDomain= Ptr dom, * Since: v0.9.11 */ 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, @@ -2101,8 +2202,8 @@ int virDomainMemoryStats (virDoma= inPtr dom, * Since: v0.4.4 */ 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, @@ -2117,7 +2218,7 @@ int virDomainMemoryPeek (virDomai= nPtr dom, * Since: v1.2.12 */ 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 /* @@ -2138,18 +2239,18 @@ int virDomainUndefine (vi= rDomainPtr domain); */ 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 @@ -2169,28 +2270,28 @@ int virConnectListDefinedDomain= s (virConnectPtr conn, * Since: v0.9.13 */ 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, @@ -2218,12 +2319,12 @@ int virDomainSetAutostart (vi= rDomainPtr domain, * Since: v0.1.4 */ 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 @@ -2233,8 +2334,8 @@ typedef enum { * Since: v6.10.0 */ 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 /** @@ -2265,13 +2366,13 @@ typedef virVcpuInfo *virVcpuInfoPtr; * Since: v0.8.5 */ typedef enum { - 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, + 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) */ =20 - 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 */ - VIR_DOMAIN_VCPU_HOTPLUGGABLE =3D (1 << 4), /* Make vcpus added hot(un)= pluggable */ + 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, @@ -2510,12 +2611,11 @@ int virDomainGetVcpus (vi= rDomainPtr domain, * Since: v0.7.7 */ typedef enum { - 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, /* See vi= rDomainModificationImpact (Since: v0.7.7) */ + VIR_DOMAIN_DEVICE_MODIFY_CONFIG =3D VIR_DOMAIN_AFFECT_CONFIG, /* See = virDomainModificationImpact (Since: v0.7.7) */ =20 - VIR_DOMAIN_DEVICE_MODIFY_FORCE =3D (1 << 2), /* Forcibly modify device - (ex. force eject a cdrom= ) */ + VIR_DOMAIN_DEVICE_MODIFY_FORCE =3D (1 << 2), /* Forcibly modify device= (ex. force eject a cdrom) (Since: v0.8.6) */ } virDomainDeviceModifyFlags; =20 int virDomainAttachDevice(virDomainPtr domain, const char *xml); @@ -2556,16 +2656,16 @@ struct _virDomainStatsRecord { * Since: v1.2.8 */ 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 /** @@ -2574,21 +2674,21 @@ typedef enum { * Since: v1.2.8 */ 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, @@ -2897,30 +2997,45 @@ int virDomainSetPerfEvents(virDomainPtr dom, * Since: v0.9.4 */ 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 @@ -2934,8 +3049,8 @@ typedef enum { * Since: v0.9.12 */ 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, @@ -2950,7 +3065,7 @@ int virDomainBlockJobAbort(virDomainPtr dom, const ch= ar *disk, */ 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 /** @@ -3002,7 +3117,7 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const = char *disk, */ 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, @@ -3018,7 +3133,7 @@ int virDomainBlockJobSetSpeed(virDomainPtr dom, const= char *disk, */ 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, @@ -3033,18 +3148,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, @@ -3059,17 +3174,20 @@ int virDomainBlockRebase(virDomainPtr dom, const ch= ar *disk, * Since: v1.2.8 */ 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 @@ -3133,17 +3251,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, @@ -3370,12 +3488,12 @@ virDomainGetBlockIoTune(virDomainPtr dom, * Since: v0.9.10 */ 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 @@ -3413,16 +3531,16 @@ int virDomainGetDiskErrors(virDomainPtr dom, * Since: v0.9.3 */ 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 @@ -3430,6 +3548,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; @@ -3474,80 +3594,80 @@ int virDomainSendKey(virDomainPtr domain, * Since: v1.0.1 */ 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 @@ -3576,18 +3696,18 @@ virDomainPtr virDomainCreateLinux (vi= rConnectPtr conn, * Since: v0.5.0 */ 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 @@ -3599,13 +3719,13 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3617,11 +3737,11 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3633,14 +3753,14 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3652,18 +3772,18 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3675,14 +3795,14 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3694,16 +3814,16 @@ typedef enum { * Since: v0.5.0 */ 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 @@ -3716,19 +3836,22 @@ typedef enum { * Since: v0.9.8 */ 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 @@ -3740,11 +3863,11 @@ typedef enum { * Since: v0.10.2 */ 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 @@ -3756,11 +3879,11 @@ typedef enum { * Since: v1.1.1 */ 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 @@ -3772,14 +3895,14 @@ typedef enum { * Since: v6.9.0 */ 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 @@ -3793,24 +3916,36 @@ 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 @@ -3822,11 +3957,14 @@ typedef enum { */ 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 @@ -3868,15 +4006,15 @@ int virDomainIsUpdated(virDomainPtr dom); * Since: v0.7.7 */ 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 @@ -3937,9 +4075,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, @@ -3957,19 +4095,19 @@ int virDomainAbortJob(virDomainPtr dom); * Since: v3.3.0 */ 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 @@ -4416,16 +4554,16 @@ typedef void (*virConnectDomainEventRTCChangeCallba= ck)(virConnectPtr conn, * Since: v0.8.0 */ 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 @@ -4453,12 +4591,12 @@ typedef void (*virConnectDomainEventWatchdogCallbac= k)(virConnectPtr conn, * Since: v0.8.0 */ 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 @@ -4518,12 +4656,12 @@ typedef void (*virConnectDomainEventIOErrorReasonCa= llback)(virConnectPtr conn, * Since: v0.8.0 */ 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 @@ -4535,12 +4673,12 @@ typedef enum { * Since: v0.8.0 */ 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 @@ -4663,13 +4801,13 @@ typedef void (*virConnectDomainEventGraphicsCallbac= k)(virConnectPtr conn, * Since: v0.9.4 */ 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 @@ -4713,15 +4851,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 @@ -4760,11 +4904,11 @@ typedef void (*virConnectDomainEventDiskChangeCallb= ack)(virConnectPtr conn, * Since: v0.9.11 */ 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 @@ -5348,11 +5492,11 @@ typedef void (*virConnectDomainEventTunableCallback= )(virConnectPtr conn, * Since: v1.2.11 */ 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 @@ -5362,12 +5506,12 @@ typedef enum { * Since: v1.2.11 */ 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 @@ -5491,33 +5635,33 @@ typedef void (*virConnectDomainEventMemoryDeviceSiz= eChangeCallback)(virConnectPt * Since: v0.8.0 */ 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 @@ -5525,6 +5669,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; @@ -5551,9 +5697,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, @@ -5569,7 +5715,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, @@ -5583,7 +5729,7 @@ int virDomainOpenChannel(virDomainPtr dom, * Since: v0.9.7 */ 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, @@ -5652,7 +5798,7 @@ int virDomainGetTime(virDomainPtr dom, * Since: v1.2.5 */ 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, @@ -5669,12 +5815,12 @@ int virDomainSetTime(virDomainPtr dom, * Since: v0.2.3 */ 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 /** @@ -5726,12 +5872,12 @@ typedef virSchedParameter *virSchedParameterPtr; * Since: v0.9.0 */ 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 /** @@ -5783,12 +5929,12 @@ typedef virBlkioParameter *virBlkioParameterPtr; * Since: v0.8.5 */ 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 /** @@ -5837,12 +5983,12 @@ typedef virMemoryParameter *virMemoryParameterPtr; * Since: v1.2.14 */ 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 @@ -5898,7 +6044,7 @@ void virDomainInterfaceFree(virDomainInterfacePtr ifa= ce); * Since: v1.2.16 */ 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, @@ -5936,12 +6082,12 @@ int virDomainSetBlockThreshold(virDomainPtr domain, * Since: v3.9.0 */ 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 @@ -5951,15 +6097,15 @@ typedef enum { * Since: v3.9.0 */ 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 @@ -6075,13 +6221,13 @@ int virDomainSetLaunchSecurityState(virDomainPtr do= main, * Since: v5.7.0 */ 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, @@ -6096,9 +6242,9 @@ int virDomainGetGuestInfo(virDomainPtr domain, * Since: v5.10.0 */ 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, @@ -6112,7 +6258,7 @@ int virDomainAgentSetResponseTimeout(virDomainPtr dom= ain, */ 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, @@ -6134,8 +6280,8 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, * Since: v6.10.0 */ 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 @@ -6151,8 +6297,8 @@ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, * Since: v7.1.0 */ 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, @@ -6168,14 +6314,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 @@ -6189,9 +6335,9 @@ typedef enum { * Since: v8.1.0 */ 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 76b06eca38..89dea437c0 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -38,10 +38,10 @@ * Since: v0.5.0 */ 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 763c5fe774..aa4d2a583f 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -57,12 +57,12 @@ typedef virConnect *virConnectPtr; * Since: v0.9.8 */ 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 @@ -214,7 +214,7 @@ struct _virNodeInfo { * Since: v0.9.8 */ typedef enum { - VIR_NODE_CPU_STATS_ALL_CPUS =3D -1, + VIR_NODE_CPU_STATS_ALL_CPUS =3D -1, /* (Since: v0.9.3) */ } virNodeGetCPUStatsAllCPUs; =20 /** @@ -310,7 +310,7 @@ struct _virNodeCPUStats { * Since: v0.9.8 */ typedef enum { - VIR_NODE_MEMORY_STATS_ALL_CELLS =3D -1, + VIR_NODE_MEMORY_STATS_ALL_CELLS =3D -1, /* (Since: v0.9.3) */ } virNodeGetMemoryStatsAllCells; =20 /** @@ -589,8 +589,8 @@ int virNodeGetSEVInfo (virConnectPtr conn, * Since: v0.4.1 */ 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 /** @@ -599,18 +599,18 @@ typedef enum { * Since: v0.4.1 */ 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 @@ -909,13 +909,13 @@ int virConnectIsAlive(virConnectPtr conn); * Since: v0.7.5 */ 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 @@ -926,9 +926,9 @@ typedef enum { */ 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, @@ -955,8 +955,8 @@ int virConnectGetCPUModelNames(virConnectPtr conn, * Since: v1.1.2 */ 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, @@ -987,10 +987,10 @@ int virNodeGetFreePages(virConnectPtr conn, */ 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 9d140b27bb..66ede43f43 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -65,8 +65,8 @@ int virConnectListDefinedInterfaces = (virConnectPtr conn, * Since: v0.10.2 */ 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, @@ -87,7 +87,7 @@ const char* virInterfaceGetMACString (virInt= erfacePtr iface); * Since: v0.7.3 */ 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 /** @@ -96,7 +96,7 @@ typedef enum { * Since: v7.7.0 */ 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 0eb60700e2..39a38f0c3f 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -33,7 +33,7 @@ * Since: v0.9.10 */ 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 /** @@ -104,14 +104,14 @@ int virConnectListDefinedNetworks= (virConnectPtr conn, * Since: v0.10.2 */ 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, @@ -133,7 +133,7 @@ virNetworkPtr virNetworkLookupByUUIDString = (virConnectPtr conn, * Since: v7.8.0 */ 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 /* @@ -150,7 +150,7 @@ virNetworkPtr virNetworkCreateXMLFlags(virCon= nectPtr conn, * Since: v7.7.0 */ 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 /* @@ -176,13 +176,13 @@ int virNetworkUndefine (virN= etworkPtr network); * Since: v0.10.2 */ 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 @@ -195,21 +195,21 @@ typedef enum { * Since: v0.10.2 */ 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 @@ -222,9 +222,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 /* @@ -277,13 +277,13 @@ int virNetworkIsPersistent(virNetworkPtr net); * Since: v1.2.1 */ 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 @@ -327,7 +327,7 @@ typedef void (*virConnectNetworkEventLifecycleCallback)= (virConnectPtr conn, * Since: v1.2.1 */ 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 @@ -335,6 +335,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: v1.2.1 */ # endif } virNetworkEventID; @@ -345,11 +347,11 @@ typedef enum { * Since: v1.2.6 */ 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 @@ -427,8 +429,8 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net, * Since: v5.5.0 */ 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 cdf0df9e0a..7d4dbd58b9 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -68,31 +68,31 @@ int virNodeListDevices (virCon= nectPtr conn, * Since: v0.10.2 */ 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, @@ -176,8 +176,8 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev); * Since: v2.2.0 */ 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 @@ -185,6 +185,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; @@ -225,13 +227,13 @@ int virConnectNodeDeviceEventDeregisterAny(virConnect= Ptr conn, * Since: v2.2.0 */ 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 e08616f5e2..279cc3740e 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -93,7 +93,7 @@ virNWFilterPtr virNWFilterLookupByUUIDString (vi= rConnectPtr conn, * Since: v7.7.0 */ 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 /* @@ -126,7 +126,7 @@ int virNWFilterFree (virNWF= ilterPtr nwfilter); * Since: v7.8.0 */ 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 5af6f13b6d..537b5595b4 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -51,12 +51,12 @@ typedef virSecret *virSecretPtr; * Since: v0.7.1 */ 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 @@ -64,6 +64,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; @@ -84,13 +86,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, @@ -109,7 +111,7 @@ virSecretPtr virSecretLookupByUsage(virConne= ctPtr conn, * Since: v7.7.0 */ 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, @@ -154,8 +156,8 @@ int virSecretFree (virSec= retPtr secret); * Since: v3.0.0 */ 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 @@ -163,6 +165,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; @@ -203,11 +207,11 @@ int virConnectSecretEventDeregisterAny(virConnectPtr = conn, * Since: v3.0.0 */ 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 381a8d95bc..8f62b6f87a 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -54,14 +54,14 @@ typedef virStoragePool *virStoragePoolPtr; * Since: v0.4.1 */ 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 @@ -71,11 +71,11 @@ typedef enum { * Since: v0.4.1 */ 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 /** @@ -84,8 +84,8 @@ typedef enum { * Since: v0.4.1 */ 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 /** @@ -94,20 +94,26 @@ typedef enum { * Since: v1.3.1 */ 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 @@ -159,16 +165,16 @@ typedef virStorageVol *virStorageVolPtr; * Since: v0.4.1 */ 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 @@ -178,9 +184,9 @@ typedef enum { * Since: v0.4.1 */ 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 /** @@ -189,26 +195,26 @@ typedef enum { * Since: v0.9.10 */ 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 data */ + Cryptography" (1996) (Since:= v0.9.10) */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 =3D 6, /* 7-pass random data (Since= : v0.9.10) */ =20 - VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random data */ + VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 =3D 7, /* 33-pass random data (Sin= ce: v0.9.10) */ =20 - VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random data */ + VIR_STORAGE_VOL_WIPE_ALG_RANDOM =3D 8, /* 1-pass random data (Since: v= 0.9.10) */ =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 @@ -216,6 +222,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; @@ -257,7 +265,7 @@ typedef virStorageVolInfo *virStorageVolInfoPtr; * Since: v0.9.13 */ 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 /* @@ -295,29 +303,29 @@ int virConnectListDefinedStorageP= ools(virConnectPtr conn, * 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, - - 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, @@ -349,7 +357,7 @@ virStoragePoolPtr virStoragePoolLookupByTargetPat= h(virConnectPtr conn, * Since: v7.7.0 */ 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 /* @@ -427,8 +435,8 @@ const char* virStorageVolGetKey = (virStorageVolPtr vol); * Since: v1.0.1 */ 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, @@ -444,7 +452,7 @@ virStorageVolPtr virStorageVolCreateXMLFrom = (virStoragePoolPtr pool, * Since: v3.4.0 */ 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, @@ -459,7 +467,7 @@ int virStorageVolDownload = (virStorageVolPtr vol, * Since: v3.4.0 */ 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, @@ -493,9 +501,9 @@ char * virStorageVolGetPath = (virStorageVolPtr vol); * Since: v0.9.10 */ 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, @@ -525,8 +533,8 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool); * Since: v2.0.0 */ 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 @@ -534,6 +542,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; @@ -574,15 +584,15 @@ int virConnectStoragePoolEventDeregisterAny(virConnec= tPtr conn, * Since: v2.0.0 */ 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 7c320e278e..a44612cd88 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -34,7 +34,7 @@ * Since: v0.7.2 */ typedef enum { - VIR_STREAM_NONBLOCK =3D (1 << 0), + VIR_STREAM_NONBLOCK =3D (1 << 0), /* (Since: v0.7.2) */ } virStreamFlags; =20 virStreamPtr virStreamNew(virConnectPtr conn, @@ -55,7 +55,7 @@ int virStreamRecv(virStreamPtr st, * Since: v3.4.0 */ 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, @@ -245,10 +245,10 @@ int virStreamSparseRecvAll(virStreamPtr stream, * Since: v0.7.2 */ 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 2ae2b93be3..c4bcdf88bf 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -38,9 +38,9 @@ extern "C" { * Since: v0.1.0 */ 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 /** @@ -52,98 +52,98 @@ typedef enum { * Since: v0.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 @@ -220,137 +220,137 @@ struct _virError { * Since: v0.1.0 */ 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 11 21:53:44 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=1650655476; cv=none; d=zohomail.com; s=zohoarc; b=eqJdk3ZPZnEc4jIvLik8TiwUlUvyLo2ovVy5R9xeshb5Aeh4FhGNQGrcZTUQyizz9ED35l1f5nJH6xJvqnWNkKbf6HR7WC5eT8thLE11weh2g+MnrizYxzK1RUkpev/hKp8v8vUuGVCtY0nx1uSBtc6P5fYmXw4aMF4HhTy4Fq4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655476; 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=Apx5SXH9bfI/Mx6rjAYJ7T4O3QDAOmrsnDXUb+c6PYw=; b=X0dEyUXFAIlsDNqZCd0l+iSktTYS2zTERfQ2fNBmFMvq3B3kt9CLgQFO9IKAKyD8bb5mIcqyI4KPdwRysu7zQmPir2Ca6xRUW/c9SolEXo2GU/0F/ZUEh9G0Aqui/rOVUz4pIieffWMZFggfIUmmt4kzfg6+xHedLjVZWkRC9rk= 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 1650655476007551.2999129011948; Fri, 22 Apr 2022 12:24:36 -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-342-67K2YjsWOXm0C-_Fpt5S8A-1; Fri, 22 Apr 2022 15:24:30 -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 339D1185A7A4; Fri, 22 Apr 2022 19:24:23 +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 1ECF155BCA4; Fri, 22 Apr 2022 19:24:23 +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 B3CE51940352; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 201631940355 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:21 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 14B8C2024CCC; Fri, 22 Apr 2022 19:24:21 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7F2E2200B42B for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655475; 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=Apx5SXH9bfI/Mx6rjAYJ7T4O3QDAOmrsnDXUb+c6PYw=; b=SH/WyoA8cRPr/AkmRgVEKSJFZae4cN8hOOX/khfRoYjzo6boLQYWXn8fVPeDxx+cVPVjJA A6nxm+EVOoNm30+1fh0vpDDJw9u1TaLOs4DrNmYU4p9+YEPa8s99dqak3LW2w4OxzdCojj 0wjy2ijFr83PGswmQpEiDMypZBET99Q= X-MC-Unique: 67K2YjsWOXm0C-_Fpt5S8A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 08/19] docstring: enums: admin: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:33 +0200 Message-Id: <20220422192344.830350-9-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655476212100003 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> --- 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..e77dbada53 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: v2.= 0.0) */ + VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (S= ince: v2.0.0) */ + VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Sin= ce: v2.0.0) */ =20 # ifdef VIR_ENUM_SENTINELS - VIR_CLIENT_TRANS_LAST + VIR_CLIENT_TRANS_LAST /* (Since: v2.0.0) */ # endif } virClientTransport; =20 --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655473; cv=none; d=zohomail.com; s=zohoarc; b=U2vLJu3d4rw1oO1Vckax6EUA/CrTdrx3gjCedpfRLUD9BPo1nrQVvL0i3E3pfOCXoBd/3ICY/2by2qS8JbDmIbdbt40hNKCHDm3j3OkQTzVqVR6FCF/5DnZRjnfCfro3RonWxVjUtjcIMTpIV2xdrLSxyPMU9naODkA2v7cb50k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655473; 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=lAPG1nAEAAFVNwzVuPf21g/aTgeur/SV0n0a5p9TljE=; b=JukoAH8hRxt7Ibd/DWc9VWlmvu3T+uPJZAdbnEgBggNCq5kq1BL1jGv+aqI7MNnvAf4voFkrIOvy6FdBia7eo9kgZ3j8qIY+dIh2prMBQTnUmSxd6qWYccqMkAxNlJUZ3XVMRexeG8JeF/cFDlA3AmJsGvKXPIwD/51QSuX8sME= 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 1650655473104380.4956011478903; Fri, 22 Apr 2022 12:24:33 -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-154-r4whTW6TOgm2R50r672m1g-1; Fri, 22 Apr 2022 15:24:25 -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 7C8FA3811A34; Fri, 22 Apr 2022 19:24:23 +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 64CB6111DCF2; Fri, 22 Apr 2022 19:24:23 +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 D693C194035B; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 22BFF1940351 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id E87F52026614; Fri, 22 Apr 2022 19:24:21 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6E1E7200C0CF for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655471; 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=lAPG1nAEAAFVNwzVuPf21g/aTgeur/SV0n0a5p9TljE=; b=MP/0qf9U0Li1qzG/TWqo8ZAnwjYekRDsSFWoohdk2xXj+o3aSmf/VhADW7j3rtivTJbs8K w8XjQrRd2QutBAJf4Vli6AIDinV1flI+wGTDW9fNakRslWE9jawV8JusooSWGe9OwpSPGJ P+okrJoOFzadZE47WpckM0Uq8OYyoDQ= X-MC-Unique: r4whTW6TOgm2R50r672m1g-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 09/19] docstring: macros: admin: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:34 +0200 Message-Id: <20220422192344.830350-10-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655474241100001 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> --- include/libvirt/libvirt-admin.h | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index e77dbada53..d24067b304 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -132,6 +132,8 @@ 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: v2.0.0 */ =20 # define VIR_THREADPOOL_WORKERS_MIN "minWorkers" @@ -142,6 +144,8 @@ 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: v2.0.0 */ =20 # define VIR_THREADPOOL_WORKERS_MAX "maxWorkers" @@ -150,6 +154,8 @@ 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: v2.0.0 */ =20 # define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers" @@ -161,6 +167,8 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_THREADPOOL_WORKERS_FREE "freeWorkers" @@ -172,6 +180,8 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers" @@ -183,6 +193,8 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnect= Ptr conn, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_THREADPOOL_JOB_QUEUE_DEPTH "jobQueueDepth" @@ -233,6 +245,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_READONLY "readonly" @@ -244,6 +258,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_SOCKET_ADDR "sock_addr" @@ -255,6 +271,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_SASL_USER_NAME "sasl_user_name" @@ -267,6 +285,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME "tls_x509_dname" @@ -279,6 +299,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_UNIX_USER_ID "unix_user_id" @@ -291,6 +313,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_UNIX_USER_NAME "unix_user_name" @@ -303,6 +327,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_UNIX_GROUP_ID "unix_group_id" @@ -315,6 +341,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_UNIX_GROUP_NAME "unix_group_name" @@ -327,6 +355,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_UNIX_PROCESS_ID "unix_process_id" @@ -339,6 +369,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * NOTE: This attribute is read-only and any attempt to set it will be den= ied * by daemon + * + * Since: v2.0.0 */ =20 # define VIR_CLIENT_INFO_SELINUX_CONTEXT "selinux_context" @@ -356,6 +388,8 @@ 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: v2.0.0 */ =20 # define VIR_SERVER_CLIENTS_MAX "nclients_max" @@ -367,6 +401,8 @@ 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: v2.0.0 */ =20 # define VIR_SERVER_CLIENTS_CURRENT "nclients" @@ -376,6 +412,8 @@ 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: v2.0.0 */ =20 # define VIR_SERVER_CLIENTS_UNAUTH_MAX "nclients_unauth_max" @@ -388,6 +426,8 @@ 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: v2.0.0 */ =20 # define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth" --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655524; cv=none; d=zohomail.com; s=zohoarc; b=R7WZJ9A9/rtLUv/ggyvGcDxWeLooOwz/ytd3k1VbzDOCGIWSxvQu6hllDcO/6wsK2W1w0EvlDMeWrtEyWFTa7pBwplC+RTPKlUXvcIljivBUIRDdyQFqPYLDYqf83S/xXBY3XqgauyvacEdH0plEHF1PiAvnMTtl+o/2Ro0DZzk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655524; 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=TQ64a8o3RTSAYunZKtRKNkeja+oV8TgTpXkn7u0et4g=; b=USAlfJwbIFiWV3tAaDqRJEblrStIqoJEwRKfHp0PzWN0HM0PTZkc0K9tCmFeRsrOUd6lpE9/F4qZdn1kGlM7EXMiJAi4v/onOBQKBtUBHyTtzW+yminES47Sx1b2RrE0lZJbgBPgBOyO1Rn0dz77DFpFx1xcz5Jil8Y9zadCh3s= 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 1650655524007282.1058460151768; Fri, 22 Apr 2022 12:25:24 -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-491-rTOFG--GM6W4WggMXdyR1Q-1; Fri, 22 Apr 2022 15:24:28 -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 4755D3811A40; Fri, 22 Apr 2022 19:24:25 +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 20C2241047EF; Fri, 22 Apr 2022 19:24:25 +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 B5BF21940355; Fri, 22 Apr 2022 19:24:24 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E4A141940362 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id D5BB2200C0CF; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 426C52026614 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655507; 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=TQ64a8o3RTSAYunZKtRKNkeja+oV8TgTpXkn7u0et4g=; b=GbywtoHjuB5JsixXqeYJvt/UKt+uq735HeAcWIHWR/JyF2m+kq5xXUC2LFuaJWIdxQLwJv IZ2qjKGHYRlQUkaXHqoh3rVPZdOeZ9OAeeNlEdWUEL9XOxvK3/uOV8f7cgC+OQIp715cVs OXi47aGCLmSYFDqVZckntcYIdTbQGQ0= X-MC-Unique: rTOFG--GM6W4WggMXdyR1Q-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 10/19] docstring: typedef: admin:: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:35 +0200 Message-Id: <20220422192344.830350-11-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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.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: 1650655525224100001 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 | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index d24067b304..67b17fe0c0 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -37,6 +37,8 @@ extern "C" { * * a virAdmConnect is a private structure representing a connection to * libvirt daemon. + * + * Since: v2.0.0 */ typedef struct _virAdmConnect virAdmConnect; =20 @@ -45,6 +47,8 @@ typedef struct _virAdmConnect virAdmConnect; * * a virAdmServer is a private structure and client-side representation of * a remote server object + * + * Since: v2.0.0 */ typedef struct _virAdmServer virAdmServer; =20 @@ -53,6 +57,8 @@ 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: v2.0.0 */ typedef struct _virAdmClient virAdmClient; =20 @@ -62,6 +68,8 @@ 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: v2.0.0 */ typedef virAdmConnect *virAdmConnectPtr; =20 @@ -71,6 +79,8 @@ 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: v2.0.0 */ typedef virAdmServer *virAdmServerPtr; =20 @@ -80,6 +90,8 @@ 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: v2.0.0 */ typedef virAdmClient *virAdmClientPtr; =20 @@ -216,6 +228,11 @@ long long virAdmClientGetTimestamp(virAdmClientPtr cli= ent); int virAdmClientGetTransport(virAdmClientPtr client); int virAdmClientFree(virAdmClientPtr client); =20 +/** + * virClientTransport: + * + * Since: v2.0.0 + */ typedef enum { VIR_CLIENT_TRANS_UNIX =3D 0, /* connection via UNIX socket (Since: v2.= 0.0) */ VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (S= ince: v2.0.0) */ --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655505; cv=none; d=zohomail.com; s=zohoarc; b=VYoyEWlbyIGj3j/7mWaeDGs4HYH75fHSxUQhRQlt+RU2ZQbYgJfvod4MxGnf4BYRmZxo/FQSaS1Yw12Zt7l/lJ1YXi44BUZ8wieVnos7s7w41ctxE2pXZ/eagMfM6dqXXXU2injAR9M99ocu9BwRfbCkvPapJzRfW3Wsb13Lm70= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655505; 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=TvuU0LiNh/qZytOBYqsXFVcbVbd9COOtdv0LGYvmGZM=; b=lC5lboRgCyKn+eWf/pF6VRKSoMvVRu9YTTDzZcNStxmnC098XQuJYJLViUymwazPZQaZ5e4xvTKCyz00xmHk/OIIRiJmQDBedQ+eRsxKYX31TlfMuAVA95bja2lS+aXFAPt+8Ql1soUMdsh6UWbLAgSuTSqzhfcRe630txYI2EM= 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 1650655505555951.2037605858912; Fri, 22 Apr 2022 12:25: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-653-riI_L5WsNa6xminw8A9zCw-1; Fri, 22 Apr 2022 15:25:00 -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 33414804199; Fri, 22 Apr 2022 19:24:57 +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 0C91241047ED; Fri, 22 Apr 2022 19:24:57 +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 6E5B61940362; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 083371940352 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:52 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C8F78200B41A; Fri, 22 Apr 2022 19:24:52 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id BEAC4200E287 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655504; 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=TvuU0LiNh/qZytOBYqsXFVcbVbd9COOtdv0LGYvmGZM=; b=HIUd1tFkIFzDJ7uOEGXLu3It5menE2cDxt9o02rRMlP1iW2LohomoGQRwruy/Ag3jlAjC8 mB0kD9uWugh6WSOXY2BaQvl/V+h/dw2vQshJtmhbU6lLd6qxACvZKsp/6VcrSsNXoEyDmB ACSYzgoD7bAIUoCUtrKefx1KI5ek+Gs= X-MC-Unique: riI_L5WsNa6xminw8A9zCw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 11/19] docstring: function: libvirt: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:36 +0200 Message-Id: <20220422192344.830350-12-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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.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: 1650655507390100003 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 | 48 ++++ include/libvirt/libvirt-event.h | 16 ++ include/libvirt/libvirt-host.h | 4 + include/libvirt/libvirt-network.h | 4 + include/libvirt/libvirt-nodedev.h | 4 + include/libvirt/libvirt-secret.h | 4 + include/libvirt/libvirt-storage.h | 4 + include/libvirt/libvirt-stream.h | 12 + include/libvirt/virterror.h | 2 + src/libvirt-domain-checkpoint.c | 24 ++ src/libvirt-domain-snapshot.c | 42 ++++ src/libvirt-domain.c | 371 +++++++++++++++++++++++++++++- src/libvirt-host.c | 68 ++++++ src/libvirt-interface.c | 42 ++++ src/libvirt-network.c | 89 +++++++ src/libvirt-nodedev.c | 54 +++++ src/libvirt-nwfilter.c | 48 ++++ src/libvirt-secret.c | 40 ++++ src/libvirt-storage.c | 114 +++++++++ src/libvirt-stream.c | 34 +++ src/libvirt.c | 12 + src/util/virerror.c | 30 +++ src/util/virevent.c | 18 ++ 23 files changed, 1083 insertions(+), 1 deletion(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 5e165f60ed..bba37dfbcf 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -3980,6 +3980,8 @@ 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, @@ -4526,6 +4528,8 @@ 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, @@ -4540,6 +4544,8 @@ 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, @@ -4577,6 +4583,7 @@ 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, @@ -4612,6 +4619,8 @@ 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, @@ -4639,6 +4648,7 @@ 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, @@ -4782,6 +4792,8 @@ 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, @@ -4834,6 +4846,8 @@ 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, @@ -4887,6 +4901,8 @@ 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, @@ -4924,6 +4940,8 @@ 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, @@ -4943,6 +4961,8 @@ 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, @@ -4961,6 +4981,8 @@ 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, @@ -4977,6 +4999,8 @@ 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, @@ -4995,6 +5019,8 @@ 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, @@ -5012,6 +5038,8 @@ 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, @@ -5029,6 +5057,8 @@ 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, @@ -5048,6 +5078,8 @@ 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, @@ -5066,6 +5098,8 @@ 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, @@ -5089,6 +5123,8 @@ 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, @@ -5113,6 +5149,8 @@ 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, @@ -5478,6 +5516,8 @@ 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, @@ -5528,6 +5568,8 @@ 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, @@ -5557,6 +5599,8 @@ 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, @@ -5582,6 +5626,8 @@ 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, @@ -5606,6 +5652,8 @@ 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 89dea437c0..cc517044c6 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -54,6 +54,8 @@ 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 @@ -81,6 +83,8 @@ 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, @@ -94,6 +98,8 @@ 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 @@ -109,6 +115,8 @@ 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 @@ -119,6 +127,8 @@ 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 @@ -137,6 +147,8 @@ typedef void (*virEventTimeoutCallback)(int timer, void= *opaque); * this purpose. * * Returns a timer value + * + * Since: v0.5.0 */ typedef int (*virEventAddTimeoutFunc)(int timeout, virEventTimeoutCallback cb, @@ -150,6 +162,8 @@ 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 @@ -164,6 +178,8 @@ 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 aa4d2a583f..b5cf8a4a4a 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -650,6 +650,8 @@ 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, @@ -841,6 +843,8 @@ 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 39a38f0c3f..0a9f0ecb0d 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -300,6 +300,8 @@ 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, @@ -398,6 +400,8 @@ 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 7d4dbd58b9..455bc2ce57 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -202,6 +202,8 @@ 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, @@ -251,6 +253,8 @@ 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 537b5595b4..a71c3e7eba 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -182,6 +182,8 @@ 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, @@ -229,6 +231,8 @@ 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 8f62b6f87a..30e3dc25c5 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -559,6 +559,8 @@ 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, @@ -610,6 +612,8 @@ 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 a44612cd88..6b82711244 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -98,6 +98,8 @@ 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, @@ -136,6 +138,8 @@ int virStreamSendAll(virStreamPtr st, * * Returns 0 on success, * -1 upon error + * + * Since: v3.4.0 */ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, int *inData, @@ -162,6 +166,8 @@ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st, * * Returns 0 on success, * -1 upon error. + * + * Since: v3.4.0 */ typedef int (*virStreamSourceSkipFunc)(virStreamPtr st, long long length, @@ -199,6 +205,8 @@ 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, @@ -229,6 +237,8 @@ int virStreamRecvAll(virStreamPtr st, * * Returns 0 on success, * -1 upon error + * + * Since: v3.4.0 */ typedef int (*virStreamSinkHoleFunc)(virStreamPtr st, long long length, @@ -261,6 +271,8 @@ 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 c4bcdf88bf..4e6dfaa3f4 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -360,6 +360,8 @@ 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..a92404a56f 100644 --- a/src/libvirt-domain-checkpoint.c +++ b/src/libvirt-domain-checkpoint.c @@ -35,6 +35,8 @@ 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 +60,8 @@ virDomainCheckpointGetName(virDomainCheckpointPtr checkpo= int) * call. * * Returns the domain or NULL. + * + * Since: v5.6.0 */ virDomainPtr virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint) @@ -81,6 +85,8 @@ virDomainCheckpointGetDomain(virDomainCheckpointPtr check= point) * call. * * Returns the connection or NULL. + * + * Since: v5.6.0 */ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint) @@ -138,6 +144,8 @@ 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 +215,8 @@ 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 +291,8 @@ 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 +360,8 @@ 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 +408,8 @@ 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 +456,8 @@ 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 +511,8 @@ virDomainCheckpointGetParent(virDomainCheckpointPtr che= ckpoint, * silently ignored. * * Returns 0 on success, -1 on error. + * + * Since: v5.6.0 */ int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint, @@ -543,6 +563,8 @@ 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 +588,8 @@ 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..021f6f599d 100644 --- a/src/libvirt-domain-snapshot.c +++ b/src/libvirt-domain-snapshot.c @@ -35,6 +35,8 @@ 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 +60,8 @@ virDomainSnapshotGetName(virDomainSnapshotPtr snapshot) * call. * * Returns the domain or NULL. + * + * Since: v0.9.5 */ virDomainPtr virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) @@ -81,6 +85,8 @@ virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot) * call. * * Returns the connection or NULL. + * + * Since: v0.9.5 */ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot) @@ -213,6 +219,8 @@ 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 +279,8 @@ 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 +334,8 @@ 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 +400,8 @@ 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 +490,8 @@ 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 +541,8 @@ 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 +609,8 @@ 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 +682,8 @@ 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 +728,8 @@ 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 +770,8 @@ 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 +812,8 @@ 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 +856,8 @@ 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 +896,8 @@ 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 +937,8 @@ 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 +1018,8 @@ 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 +1077,8 @@ 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 +1129,8 @@ 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 +1154,8 @@ 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..e27d611882 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -49,6 +49,8 @@ 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.3 */ int virConnectListDomains(virConnectPtr conn, int *ids, int maxids) @@ -82,6 +84,8 @@ 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.3 */ int virConnectNumOfDomains(virConnectPtr conn) @@ -115,6 +119,8 @@ virConnectNumOfDomains(virConnectPtr conn) * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.3.0 */ virConnectPtr virDomainGetConnect(virDomainPtr dom) @@ -162,6 +168,8 @@ 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 +236,8 @@ 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 +294,8 @@ 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.3 */ virDomainPtr virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc, @@ -307,6 +319,8 @@ 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.3 */ virDomainPtr virDomainLookupByID(virConnectPtr conn, int id) @@ -346,6 +360,8 @@ 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 +401,8 @@ 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 +440,8 @@ 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.3 */ virDomainPtr virDomainLookupByName(virConnectPtr conn, const char *name) @@ -472,6 +492,8 @@ 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.3 */ int virDomainDestroy(virDomainPtr domain) @@ -537,6 +559,8 @@ 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 +601,8 @@ 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.3 */ int virDomainFree(virDomainPtr domain) @@ -608,6 +634,8 @@ 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 +664,8 @@ virDomainRef(virDomainPtr domain) * special state like VIR_DOMAIN_PMSUSPENDED. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainSuspend(virDomainPtr domain) @@ -678,6 +708,8 @@ virDomainSuspend(virDomainPtr domain) * special state like VIR_DOMAIN_PMSUSPENDED. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainResume(virDomainPtr domain) @@ -734,6 +766,8 @@ virDomainResume(virDomainPtr domain) * * Returns: 0 on success, * -1 on failure. + * + * Since: v0.9.10 */ int virDomainPMSuspendForDuration(virDomainPtr dom, @@ -781,6 +815,8 @@ virDomainPMSuspendForDuration(virDomainPtr dom, * * Returns: 0 on success, * -1 on failure. + * + * Since: v0.9.11 */ int virDomainPMWakeup(virDomainPtr dom, @@ -828,6 +864,8 @@ virDomainPMWakeup(virDomainPtr dom, * and virDomainSaveImageDefineXML(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainSave(virDomainPtr domain, const char *to) @@ -910,6 +948,8 @@ 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 +1010,8 @@ 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.3 */ int virDomainRestore(virConnectPtr conn, const char *from) @@ -1042,6 +1084,8 @@ 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 +1148,8 @@ 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 +1218,8 @@ 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 +1294,8 @@ 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 +1372,8 @@ 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 +1453,8 @@ 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 +1514,8 @@ virDomainScreenshot(virDomainPtr domain, * be deleted when the domain quits. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainShutdown(virDomainPtr domain) @@ -1520,6 +1576,8 @@ 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 +1636,8 @@ 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 +1682,8 @@ 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 +1723,8 @@ 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.3 */ const char * virDomainGetName(virDomainPtr domain) @@ -1683,6 +1747,8 @@ 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 +1779,8 @@ 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 +1808,8 @@ 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.3 */ unsigned int virDomainGetID(virDomainPtr domain) @@ -1762,6 +1832,8 @@ virDomainGetID(virDomainPtr domain) * * Returns the new string or NULL in case of error, the string must be * freed by the caller. + * + * Since: v0.0.3 */ char * virDomainGetOSType(virDomainPtr domain) @@ -1801,6 +1873,8 @@ virDomainGetOSType(virDomainPtr domain) * * Returns the memory size in kibibytes (blocks of 1024 bytes), or 0 in * case of error. + * + * Since: v0.0.3 */ unsigned long virDomainGetMaxMemory(virDomainPtr domain) @@ -1850,6 +1924,8 @@ virDomainGetMaxMemory(virDomainPtr domain) * virDomainSetMemoryFlags(). * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory) @@ -1903,6 +1979,8 @@ 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 +2043,8 @@ 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 +2105,8 @@ 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 +2157,8 @@ 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 +2233,8 @@ 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 +2302,8 @@ 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 +2369,8 @@ 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 +2428,8 @@ 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 +2495,8 @@ 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 +2555,8 @@ virDomainGetBlkioParameters(virDomainPtr domain, * can be extracted. * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v0.0.3 */ int virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info) @@ -2507,6 +2603,8 @@ 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 +2648,8 @@ 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 +2711,8 @@ 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.3 */ char * virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags) @@ -2660,6 +2762,8 @@ 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 +2814,8 @@ 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 +3669,8 @@ 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 +3867,8 @@ 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 +4078,8 @@ 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 +4368,8 @@ 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 +4446,8 @@ virDomainMigrateToURI(virDomainPtr domain, * virDomainMigrateToURI3. * * Returns 0 if the migration succeeded, -1 upon error. + * + * Since: v0.9.2 */ int virDomainMigrateToURI2(virDomainPtr domain, @@ -4412,6 +4528,8 @@ 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 +5399,8 @@ 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 +5449,8 @@ 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 +5516,8 @@ virDomainGetSchedulerParameters(virDomainPtr domain, * } * * Returns -1 in case of error, 0 in case of success. + * + * Since: v0.9.2 */ int virDomainGetSchedulerParametersFlags(virDomainPtr domain, @@ -5458,6 +5582,8 @@ 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 +5638,8 @@ 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 +5711,8 @@ 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 +5790,8 @@ 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 +5861,8 @@ 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 +5923,8 @@ 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 +5993,8 @@ 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 +6085,8 @@ 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 +6166,8 @@ 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.3 */ int virDomainBlockPeek(virDomainPtr dom, @@ -6095,6 +6237,8 @@ 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 +6307,8 @@ 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.3 */ int virDomainMemoryPeek(virDomainPtr dom, @@ -6299,6 +6445,8 @@ 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 +6497,8 @@ 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 +6542,8 @@ 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 +6587,8 @@ 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 +6658,8 @@ 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 +6699,8 @@ 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.5 */ int virConnectNumOfDefinedDomains(virConnectPtr conn) @@ -6586,6 +6744,8 @@ 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 +6845,8 @@ 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 +6888,8 @@ 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 +6958,8 @@ 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 +7036,8 @@ 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 +7095,8 @@ 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 +7138,8 @@ 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 +7180,8 @@ 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 +7224,8 @@ 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 +7311,8 @@ 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 +7370,8 @@ 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 +7443,8 @@ 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 +7514,8 @@ 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 +7572,8 @@ 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 +7641,7 @@ 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 +7700,8 @@ 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 +7779,7 @@ 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 +7835,8 @@ 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 +7902,8 @@ 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 +7963,8 @@ 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 +8009,8 @@ 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 +8050,8 @@ 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 +8095,8 @@ 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 +8161,8 @@ 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 +8222,8 @@ 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 +8285,8 @@ 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 +8340,8 @@ 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 +8384,8 @@ 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 +8448,8 @@ 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 +8535,8 @@ 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 +8604,8 @@ 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 +8665,8 @@ 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 +8711,8 @@ 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 +8795,8 @@ 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 +8861,8 @@ 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 +8917,8 @@ 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 +8979,8 @@ 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 +9024,8 @@ 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 +9060,8 @@ 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 +9095,8 @@ 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 +9137,8 @@ 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 +9172,8 @@ 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 +9211,8 @@ 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 +9277,8 @@ 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 +9331,8 @@ 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 +9375,8 @@ 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 +9418,8 @@ 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 +9460,8 @@ 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 +9506,8 @@ virDomainMigrateGetCompressionCache(virDomainPtr doma= in, * virDomainGetJobStats. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v1.0.3 */ int virDomainMigrateSetCompressionCache(virDomainPtr domain, @@ -9298,6 +9552,8 @@ 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 +9597,8 @@ virDomainMigrateSetMaxSpeed(virDomainPtr domain, * migration. * * Returns 0 in case of success, -1 otherwise. + * + * Since: v0.9.5 */ int virDomainMigrateGetMaxSpeed(virDomainPtr domain, @@ -9434,6 +9692,8 @@ 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 +9757,8 @@ 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 +9817,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 +9875,8 @@ virConnectDomainEventDeregisterAny(virConnectPtr conn, * 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 +9924,8 @@ virDomainManagedSave(virDomainPtr dom, unsigned int f= lags) * * 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 +9964,8 @@ virDomainHasManagedSaveImage(virDomainPtr dom, unsign= ed 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 +10012,8 @@ 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 +10072,8 @@ 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 +10139,8 @@ 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 +10205,8 @@ 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 +10264,8 @@ 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 +10316,8 @@ 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 +10401,8 @@ 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 +10480,8 @@ 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 +10545,8 @@ 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 +10621,8 @@ 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 +10767,8 @@ 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 +10899,8 @@ 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 +11047,8 @@ 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 +11108,8 @@ 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 +11190,8 @@ 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 +11253,8 @@ 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 +11330,8 @@ 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 +11461,8 @@ 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 +11563,8 @@ 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 +11610,8 @@ 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 +11661,8 @@ 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 +11707,8 @@ 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 +11752,8 @@ 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 +11799,8 @@ 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 +11851,8 @@ 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 +11899,8 @@ 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 +11951,8 @@ 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 +12359,8 @@ 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 +12440,8 @@ 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 +12509,8 @@ 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 +12543,8 @@ 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 +12580,8 @@ 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 +12674,8 @@ 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 +12717,8 @@ 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 +12762,8 @@ 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 +12822,8 @@ 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 +12873,8 @@ 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 +13027,8 @@ 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 +13103,8 @@ 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 +13154,8 @@ 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 +13211,8 @@ 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 +13279,8 @@ 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 +13338,8 @@ 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 +13436,8 @@ 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 +13488,8 @@ 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 +13539,8 @@ virDomainBackupGetXMLDesc(virDomainPtr domain, * * Returns: number of keys stored in @keys, * -1 otherwise. + * + * Since: v6.10.0 */ int virDomainAuthorizedSSHKeysGet(virDomainPtr domain, @@ -13246,6 +13609,8 @@ virDomainAuthorizedSSHKeysGet(virDomainPtr domain, * * Returns: 0 on success, * -1 otherwise. + * + * Since: v6.10.0 */ int virDomainAuthorizedSSHKeysSet(virDomainPtr domain, @@ -13314,6 +13679,8 @@ virDomainAuthorizedSSHKeysSet(virDomainPtr domain, * * Returns: number of messages stored in @msgs, * -1 otherwise. + * + * Since: v7.1.0 */ int virDomainGetMessages(virDomainPtr domain, @@ -13356,6 +13723,8 @@ 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..7e7545d447 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -47,6 +47,8 @@ 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 +87,8 @@ 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 +153,8 @@ 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.3 */ const char * virConnectGetType(virConnectPtr conn) @@ -180,6 +186,8 @@ 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.3 */ int virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer) @@ -216,6 +224,8 @@ 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 +266,8 @@ 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 +307,8 @@ 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 +343,8 @@ 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 +383,8 @@ 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 +434,8 @@ 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 +472,8 @@ 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 +554,8 @@ 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 +643,8 @@ 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 +692,8 @@ 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 +740,8 @@ 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 +795,8 @@ 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 +861,8 @@ 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 +911,8 @@ 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 +956,8 @@ 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 +996,8 @@ 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 +1033,8 @@ 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 +1077,8 @@ 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 +1135,8 @@ 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 +1199,8 @@ 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 +1257,8 @@ 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 +1328,8 @@ 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 +1403,8 @@ 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 +1442,8 @@ 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 +1490,8 @@ virConnectIsAlive(virConnectPtr conn) * context. * * Returns 0 on success, -1 on error + * + * Since: v0.10.0 */ int virConnectRegisterCloseCallback(virConnectPtr conn, @@ -1471,6 +1529,8 @@ 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 +1573,8 @@ 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 +1661,8 @@ 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 +1733,8 @@ 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 +1788,8 @@ 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..b1194fd803 100644 --- a/src/libvirt-interface.c +++ b/src/libvirt-interface.c @@ -36,6 +36,8 @@ 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 +78,8 @@ 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 +119,8 @@ 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 +164,8 @@ 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 +201,8 @@ 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 +246,8 @@ 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 +290,8 @@ 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 +331,8 @@ 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 +368,8 @@ 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 +394,8 @@ 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 +427,8 @@ 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 +480,8 @@ 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 +528,8 @@ 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 +573,8 @@ 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 +622,8 @@ 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 +670,8 @@ 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 +695,8 @@ 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 +728,8 @@ 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 +770,8 @@ 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 +812,8 @@ 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 +849,8 @@ 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..0d1524ce34 100644 --- a/src/libvirt-network.c +++ b/src/libvirt-network.c @@ -38,6 +38,8 @@ 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 +88,8 @@ 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 +129,8 @@ 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 +173,8 @@ 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 +210,8 @@ 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 +254,8 @@ 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 +297,8 @@ 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 +338,8 @@ 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 +376,8 @@ 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 +417,8 @@ 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 +460,8 @@ 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 +502,8 @@ 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 +545,8 @@ 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 +582,8 @@ 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 +632,8 @@ virNetworkUndefine(virNetworkPtr network) * running state, its persistent configuration, or both. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.10.2 */ int virNetworkUpdate(virNetworkPtr network, @@ -670,6 +700,8 @@ 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 +742,8 @@ 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 +782,8 @@ 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 +815,8 @@ 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 +840,8 @@ 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 +864,8 @@ 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 +896,8 @@ 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 +933,8 @@ 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 +972,8 @@ 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 +1012,8 @@ 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 +1054,8 @@ 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 +1094,8 @@ 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 +1129,8 @@ 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 +1190,8 @@ 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 +1253,8 @@ 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 +1357,7 @@ 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 +1399,8 @@ 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 +1429,8 @@ 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 +1468,8 @@ 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 +1510,8 @@ 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 +1560,8 @@ 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 +1606,8 @@ 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 +1646,8 @@ virNetworkPortCreateXML(virNetworkPtr net, * call. * * Returns the virNetworkPtr or NULL in case of failure. + * + * Since: v5.5.0 */ virNetworkPtr virNetworkPortGetNetwork(virNetworkPortPtr port) @@ -1597,6 +1672,8 @@ 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 +1711,8 @@ 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 +1744,8 @@ 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 +1778,8 @@ 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 +1828,8 @@ 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 +1867,8 @@ 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 +1900,8 @@ 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..1caf3c8479 100644 --- a/src/libvirt-nodedev.c +++ b/src/libvirt-nodedev.c @@ -40,6 +40,8 @@ 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 +88,8 @@ 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 +139,8 @@ 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 +184,8 @@ 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 +226,8 @@ 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 +270,8 @@ 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 +305,8 @@ 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 +329,8 @@ 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 +362,8 @@ 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 +400,8 @@ 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 +441,8 @@ 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 +474,8 @@ 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 +514,8 @@ 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 +569,8 @@ 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 +616,8 @@ 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 +661,8 @@ 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 +703,8 @@ 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 +744,8 @@ 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 +786,8 @@ 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 +827,8 @@ 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 +866,8 @@ virNodeDeviceUndefine(virNodeDevicePtr dev, * Start a defined node device: * * Returns 0 in case of success and -1 in case of failure. + * + * Since: v7.3.0 */ int virNodeDeviceCreate(virNodeDevicePtr dev, @@ -889,6 +931,8 @@ 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 +997,8 @@ virConnectNodeDeviceEventRegisterAny(virConnectPtr conn, * 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 +1036,8 @@ 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 +1077,8 @@ 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 +1115,8 @@ 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 +1150,8 @@ 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..bac50e89a3 100644 --- a/src/libvirt-nwfilter.c +++ b/src/libvirt-nwfilter.c @@ -35,6 +35,8 @@ 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 +79,8 @@ 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 +125,8 @@ 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 +167,8 @@ 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 +208,8 @@ 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 +249,8 @@ 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 +286,8 @@ 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 +311,8 @@ 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 +335,8 @@ 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 +367,8 @@ 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 +401,8 @@ 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 +444,8 @@ 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 +483,8 @@ 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 +525,8 @@ 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 +571,8 @@ 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 +604,8 @@ 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 +652,8 @@ 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 +689,8 @@ 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 +714,8 @@ 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 +738,8 @@ 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 +774,8 @@ 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 +817,8 @@ 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 +859,8 @@ 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 +905,8 @@ 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..ccf47a8f07 100644 --- a/src/libvirt-secret.c +++ b/src/libvirt-secret.c @@ -35,6 +35,8 @@ 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 +58,8 @@ 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 +120,8 @@ 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 +166,8 @@ 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 +210,8 @@ 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 +253,8 @@ 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 +297,8 @@ 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 +346,8 @@ 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 +386,8 @@ 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 +418,8 @@ 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 +452,8 @@ 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 +483,8 @@ 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 +508,8 @@ 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 +550,8 @@ 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 +597,8 @@ 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 +640,8 @@ 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 +689,8 @@ 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 +713,8 @@ 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 +764,8 @@ 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 +832,8 @@ 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..a31a18dbe9 100644 --- a/src/libvirt-storage.c +++ b/src/libvirt-storage.c @@ -37,6 +37,8 @@ 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 +106,8 @@ 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 +147,8 @@ 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 +193,8 @@ 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 +232,8 @@ 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 +278,8 @@ 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 +330,8 @@ 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.5 */ char * virConnectFindStoragePoolSources(virConnectPtr conn, @@ -361,6 +375,8 @@ 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 +416,8 @@ 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 +457,8 @@ 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 +497,8 @@ 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 +538,8 @@ 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 +581,8 @@ 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 +626,8 @@ 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 +669,8 @@ 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 +709,8 @@ 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 +749,8 @@ 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 +793,8 @@ 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 +835,8 @@ 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 +876,8 @@ 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 +910,8 @@ 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 +937,8 @@ 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 +977,8 @@ 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 +1001,8 @@ 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 +1033,8 @@ 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 +1065,8 @@ 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 +1111,8 @@ 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 +1151,8 @@ 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 +1193,8 @@ 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 +1243,8 @@ 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 +1281,8 @@ 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 +1322,8 @@ virStoragePoolNumOfVolumes(virStoragePoolPtr pool) * virStoragePoolListAllVolumes(). * * Returns the number of names fetched, or -1 on error + * + * Since: v0.4.1 */ int virStoragePoolListVolumes(virStoragePoolPtr pool, @@ -1299,6 +1363,8 @@ virStoragePoolListVolumes(virStoragePoolPtr pool, * call. * * Returns the virConnectPtr or NULL in case of failure. + * + * Since: v0.4.1 */ virConnectPtr virStorageVolGetConnect(virStorageVolPtr vol) @@ -1325,6 +1391,8 @@ 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 +1433,8 @@ 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 +1475,8 @@ 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 +1513,8 @@ 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 +1538,8 @@ 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 +1573,8 @@ 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 +1626,8 @@ 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 +1692,8 @@ 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 +1777,8 @@ virStorageVolDownload(virStorageVolPtr vol, * capacity, and allocation. * * Returns 0, or -1 upon error. + * + * Since: v0.9.0 */ int virStorageVolUpload(virStorageVolPtr vol, @@ -1748,6 +1832,8 @@ 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 +1883,8 @@ 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 +1931,8 @@ virStorageVolWipe(virStorageVolPtr vol, * problematic. * * Returns 0 on success, or -1 on error. + * + * Since: v0.9.10 */ int virStorageVolWipePattern(virStorageVolPtr vol, @@ -1883,6 +1973,8 @@ 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 +2006,8 @@ 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 +2032,8 @@ 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 +2084,8 @@ 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 +2130,8 @@ virStorageVolGetInfoFlags(virStorageVolPtr vol, * the storage volume * * Returns the XML document, or NULL on error + * + * Since: v0.4.1 */ char * virStorageVolGetXMLDesc(virStorageVolPtr vol, @@ -2073,6 +2173,8 @@ 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 +2236,8 @@ 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 +2287,8 @@ 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 +2322,8 @@ 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 +2382,8 @@ 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 +2447,8 @@ 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 +2488,8 @@ 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..2bc9535eb1 100644 --- a/src/libvirt-stream.c +++ b/src/libvirt-stream.c @@ -52,6 +52,8 @@ 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 +87,8 @@ 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 +167,8 @@ 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 +264,8 @@ 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 +353,8 @@ 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 +422,8 @@ virStreamRecvFlags(virStreamPtr stream, * * Returns 0 on success, * -1 error + * + * Since: v3.4.0 */ int virStreamSendHole(virStreamPtr stream, @@ -455,6 +467,8 @@ 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 +591,8 @@ 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 +722,8 @@ 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 +863,8 @@ 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 +978,8 @@ 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 +1073,8 @@ 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 +1118,8 @@ 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 +1155,8 @@ 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 +1201,8 @@ virStreamEventRemoveCallback(virStreamPtr stream) * beforehand. * * Returns 0 on success, -1 upon error + * + * Since: v0.7.2 */ int virStreamFinish(virStreamPtr stream) @@ -1215,6 +1245,8 @@ virStreamFinish(virStreamPtr stream) * beforehand. * * Returns 0 on success, -1 upon error + * + * Since: v0.7.2 */ int virStreamAbort(virStreamPtr stream) @@ -1259,6 +1291,8 @@ 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..ec685355b1 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -296,6 +296,8 @@ virGlobalInit(void) * connection attempt. * * Returns 0 in case of success, -1 in case of error + * + * Since: v0.1.0 */ int virInitialize(void) @@ -797,6 +799,8 @@ 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.3 */ int virGetVersion(unsigned long *libVer, const char *type G_GNUC_UNUSED, @@ -1185,6 +1189,8 @@ virConnectOpenInternal(const char *name, * is no longer needed. * * Returns a pointer to the hypervisor connection or NULL in case of error + * + * Since: v0.0.3 */ virConnectPtr virConnectOpen(const char *name) @@ -1218,6 +1224,8 @@ 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.3 */ virConnectPtr virConnectOpenReadOnly(const char *name) @@ -1252,6 +1260,8 @@ 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.0 */ virConnectPtr virConnectOpenAuth(const char *name, @@ -1300,6 +1310,8 @@ 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.3 */ int virConnectClose(virConnectPtr conn) diff --git a/src/util/virerror.c b/src/util/virerror.c index e864a50fba..ea320ebbf1 100644 --- a/src/util/virerror.c +++ b/src/util/virerror.c @@ -254,6 +254,8 @@ 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 +273,8 @@ 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 +293,8 @@ 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 +313,8 @@ virGetLastErrorDomain(void) * * Returns the most recent error message string in this * thread, or a generic message if none is set + * + * Since: v1.0.6 */ const char * virGetLastErrorMessage(void) @@ -361,6 +369,8 @@ 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 +402,8 @@ 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 +467,8 @@ 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 +487,8 @@ virResetError(virErrorPtr err) * @err: error to free * * Resets and frees the given error. + * + * Since: v0.6.1 */ void virFreeError(virErrorPtr err) @@ -489,6 +505,8 @@ 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 +537,8 @@ 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 +573,8 @@ 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 +601,8 @@ 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 +622,8 @@ 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 +641,8 @@ 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 +661,8 @@ 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..6add093216 100644 --- a/src/util/virevent.c +++ b/src/util/virevent.c @@ -69,6 +69,8 @@ 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 +96,8 @@ virEventAddHandle(int fd, * virEventRegisterImpl() or virEventRegisterDefaultImpl(). * * Will not fail if fd exists. + * + * Since: v0.9.3 */ void virEventUpdateHandle(int watch, int events) @@ -112,6 +116,8 @@ 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 +145,8 @@ 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 +174,8 @@ 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 +194,8 @@ 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 +244,8 @@ 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 +314,8 @@ int virEventRequireImpl(void) * virEventAddHandle() or virConnectDomainEventRegisterAny(). * * Returns 0 on success, -1 on failure. + * + * Since: v0.9.0 */ int virEventRegisterDefaultImpl(void) { @@ -335,6 +351,8 @@ 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 11 21:53:44 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=1650655568; cv=none; d=zohomail.com; s=zohoarc; b=FRjJWGvrf+A/Kn+BGiSXB6a+9JsFwasOZRzeWeDgiq0mA5NRwtkgrirt46kkwsL6GZL8G0IT7J0WuTVBwKxUrBghrGLv/dKkzPT8sGS/DXxMTqnzfeV3aL28cIPQ+LiY84qLEOCybEjwaJIDwiQZsz0DfqqpjKWvIAkezEQUxnM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655568; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=yjcwDzQb0UPlxYiWVT8fEFYqU81h1KfrUq8dGWp9rss=; b=UE/oRAN1LoEKjbaYpRT7YIqAIUxHw9fyS3yiRFJI+zG5tnf+zd24Ns0RL15PZ4YnfxWzWclFx3gezWf39MWQTQu9yUC4CwxQkvO4nj7EnZIwqTRy9CnkdAHq8cwxKa/DhQnQJ+vaRZcG7tvCRpF44TOF27UxKyXBVJYXGoyrv60= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from=<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 1650655568603967.8891333122785; Fri, 22 Apr 2022 12:26:08 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-629-8MhH4CF-PSSvD0zkVpyG5A-1; Fri, 22 Apr 2022 15:24:59 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id AA0318002BF; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 95CC141636D; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 293791940352; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 083171940351 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:53 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id BD9E92024CC3; Fri, 22 Apr 2022 19:24:53 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2CF952026614 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655567; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=yjcwDzQb0UPlxYiWVT8fEFYqU81h1KfrUq8dGWp9rss=; b=dBkr0Fnl89N1ngMUNY3xPKzNjTGlf7ErrjPP87RQREB+BykBbBaG06i/pGMrsRDeU0qxPX Tu7kH5QvII8TCe/vKOWQ4mOymOhDBt2vTTNcMjkOzlUvW9WqrWigCiyqDgSI7R0AT1mRFo 0TWNRpNJBj8qW1sRFmmYRoDVO0Gf3U4= X-MC-Unique: 8MhH4CF-PSSvD0zkVpyG5A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 12/19] docstring: function: admin: Add 'Since version' metadata Date: Fri, 22 Apr 2022 21:23:37 +0200 Message-Id: <20220422192344.830350-13-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655569631100001 Content-Type: text/plain; charset="utf-8" Either create or append to existing docstring, the version (git tag) that a given function was introduced in the format: Since: v1.2.3 Signed-off-by: Victor Toso <victortoso@redhat.com> --- include/libvirt/libvirt-admin.h | 2 ++ src/admin/libvirt-admin.c | 62 +++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admi= n.h index 67b17fe0c0..989348ee7b 100644 --- a/include/libvirt/libvirt-admin.h +++ b/include/libvirt/libvirt-admin.h @@ -120,6 +120,8 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * @opaque: opaque client data * * A callback to be registered, in case a connection was closed. + * + * Since: v2.0.0 */ typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn, int reason, diff --git a/src/admin/libvirt-admin.c b/src/admin/libvirt-admin.c index 01546a7bc2..3cdaaf1de2 100644 --- a/src/admin/libvirt-admin.c +++ b/src/admin/libvirt-admin.c @@ -84,6 +84,8 @@ virAdmGlobalInit(void) * necessary for the application to call virAdmInitialize. * * Returns 0 in case of success, -1 in case of error + * + * Since: v2.0.0 */ int virAdmInitialize(void) @@ -200,6 +202,8 @@ virAdmGetDefaultURI(virConf *conf, char **uristr) * Opens connection to admin interface of the daemon. * * Returns @virAdmConnectPtr object or NULL on error + * + * Since: v2.0.0 */ virAdmConnectPtr virAdmConnectOpen(const char *name, unsigned int flags) @@ -284,6 +288,8 @@ virAdmConnectOpen(const char *name, unsigned int flags) * some other object still has a temporary reference to the connection, bu= t the * application should not try to further use a connection after the * virAdmConnectClose that matches the initial open. + * + * Since: v2.0.0 */ int virAdmConnectClose(virAdmConnectPtr conn) @@ -319,6 +325,8 @@ virAdmConnectClose(virAdmConnectPtr conn) * would increment the reference count. * * Returns 0 in case of success, -1 in case of failure + * + * Since: v2.0.0 */ int virAdmConnectRef(virAdmConnectPtr conn) @@ -346,6 +354,8 @@ virAdmConnectRef(virAdmConnectPtr conn) * instead. * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmGetVersion(unsigned long long *libVer) @@ -377,6 +387,8 @@ virAdmGetVersion(unsigned long long *libVer) * * Returns 1, if the connection is alive, 0 if there isn't an existing * connection at all or the channel has already been closed, or -1 on erro= r. + * + * Since: v2.0.0 */ int virAdmConnectIsAlive(virAdmConnectPtr conn) @@ -411,6 +423,8 @@ virAdmConnectIsAlive(virAdmConnectPtr conn) * * Returns an URI string related to the connection or NULL in case of an e= rror. * Caller is responsible for freeing the string. + * + * Since: v2.0.0 */ char * virAdmConnectGetURI(virAdmConnectPtr conn) @@ -445,6 +459,8 @@ virAdmConnectGetURI(virAdmConnectPtr conn) * context. * * Returns 0 on success, -1 on error + * + * Since: v2.0.0 */ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb, @@ -498,6 +514,8 @@ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr= conn, * registration, it will be invoked. * * Returns 0 on success, -1 on error + * + * Since: v2.0.0 */ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn, virAdmConnectCloseFunc cb) @@ -528,6 +546,8 @@ int virAdmConnectUnregisterCloseCallback(virAdmConnectP= tr conn, * major * 1,000,000 + minor * 1,000 + release. * * Returns 0 on success, -1 on failure and @libVer follows this format: + * + * Since: v2.0.0 */ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, unsigned long long *libVer) @@ -556,6 +576,8 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn, * * Returns a pointer to the name or NULL. The string doesn't need to be * deallocated since its lifetime will be the same as the server object. + * + * Since: v2.0.0 */ const char * virAdmServerGetName(virAdmServerPtr srv) @@ -576,6 +598,8 @@ virAdmServerGetName(virAdmServerPtr srv) * The data structure is freed and should not be used thereafter. * * Returns 0 on success, -1 on failure. + * + * Since: v2.0.0 */ int virAdmServerFree(virAdmServerPtr srv) { @@ -599,6 +623,8 @@ int virAdmServerFree(virAdmServerPtr srv) * Get client's unique numeric ID. * * Returns numeric value used for client's ID or -1 in case of an error. + * + * Since: v2.0.0 */ unsigned long long virAdmClientGetID(virAdmClientPtr client) @@ -622,6 +648,8 @@ virAdmClientGetID(virAdmClientPtr client) * Returns client's connection timestamp (seconds from epoch in UTC) or 0 * (epoch time) if libvirt doesn't have any information about client's * connection time, or -1 in case of an error. + * + * Since: v2.0.0 */ long long virAdmClientGetTimestamp(virAdmClientPtr client) @@ -647,6 +675,8 @@ virAdmClientGetTimestamp(virAdmClientPtr client) * * Returns integer representation of the connection transport used by @cli= ent * (this will be one of virClientTransport) or -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmClientGetTransport(virAdmClientPtr client) @@ -666,6 +696,8 @@ virAdmClientGetTransport(virAdmClientPtr client) * structure is freed and should not be used thereafter. * * Returns 0 in success, -1 on failure. + * + * Since: v2.0.0 */ int virAdmClientFree(virAdmClientPtr client) { @@ -697,6 +729,8 @@ int virAdmClientFree(virAdmClientPtr client) * this extra element from the final count. * Caller is responsible to call virAdmServerFree() on each list element, * followed by freeing @servers. + * + * Since: v2.0.0 */ int virAdmConnectListServers(virAdmConnectPtr conn, @@ -735,6 +769,8 @@ virAdmConnectListServers(virAdmConnectPtr conn, * * Returns the requested server or NULL in case of failure. If the * server cannot be found, then VIR_ERR_NO_SERVER error is raised. + * + * Since: v2.0.0 */ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn, @@ -776,6 +812,8 @@ virAdmConnectLookupServer(virAdmConnectPtr conn, * VIR_THREADPOOL_WORKERS_CURRENT * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, @@ -815,6 +853,8 @@ virAdmServerGetThreadPoolParameters(virAdmServerPtr srv, * failure. * * Returns 0 on success, -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, @@ -856,6 +896,8 @@ virAdmServerSetThreadPoolParameters(virAdmServerPtr srv, * excluding this extra element from the final count. * Caller is responsible to call virAdmClientFree() on each list element, * followed by freeing @clients. + * + * Since: v2.0.0 */ int virAdmServerListClients(virAdmServerPtr srv, @@ -894,6 +936,8 @@ virAdmServerListClients(virAdmServerPtr srv, * * Returns the requested client or NULL in case of failure. If the * client could not be found, then VIR_ERR_NO_CLIENT error is raised. + * + * Since: v2.0.0 */ virAdmClientPtr virAdmServerLookupClient(virAdmServerPtr srv, @@ -940,6 +984,8 @@ virAdmServerLookupClient(virAdmServerPtr srv, * * Returns 0 if the information has been successfully retrieved or -1 in c= ase * of an error. + * + * Since: v2.0.0 */ int virAdmClientGetInfo(virAdmClientPtr client, @@ -974,6 +1020,8 @@ virAdmClientGetInfo(virAdmClientPtr client, * * Returns 0 if the daemon's connection with @client was closed successful= ly * or -1 in case of an error. + * + * Since: v2.0.0 */ int virAdmClientClose(virAdmClientPtr client, unsigned int flags) @@ -1011,6 +1059,8 @@ int virAdmClientClose(virAdmClientPtr client, * * Returns 0 on success, allocating @params to size returned in @nparams, = or * -1 in case of an error. Caller is responsible for deallocating @params. + * + * Since: v2.0.0 */ int virAdmServerGetClientLimits(virAdmServerPtr srv, @@ -1051,6 +1101,8 @@ virAdmServerGetClientLimits(virAdmServerPtr srv, * * Returns 0 if the limits have been changed successfully or -1 in case of= an * error. + * + * Since: v2.0.0 */ int virAdmServerSetClientLimits(virAdmServerPtr srv, @@ -1089,6 +1141,8 @@ virAdmServerSetClientLimits(virAdmServerPtr srv, * * Returns 0 if the TLS files have been updated successfully or -1 in case= of an * error. + * + * Since: v6.2.0 */ int virAdmServerUpdateTlsFiles(virAdmServerPtr srv, @@ -1127,6 +1181,8 @@ virAdmServerUpdateTlsFiles(virAdmServerPtr srv, * caller. Caller is also responsible for freeing @outputs correctly. * * Returns the count of outputs in @outputs, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, @@ -1168,6 +1224,8 @@ virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn, * * Returns the number of filters returned in @filters, or -1 in case of * an error. + * + * Since: v3.0.0 */ int virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, @@ -1208,6 +1266,8 @@ virAdmConnectGetLoggingFilters(virAdmConnectPtr conn, * * Returns 0 if the new output or the set of outputs has been defined * successfully, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, @@ -1246,6 +1306,8 @@ virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn, * * Returns 0 if the new filter or the set of filters has been defined * successfully, or -1 in case of an error. + * + * Since: v3.0.0 */ int virAdmConnectSetLoggingFilters(virAdmConnectPtr conn, --=20 2.35.1 From nobody Sat May 11 21:53:44 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=1650655505; cv=none; d=zohomail.com; s=zohoarc; b=GMIzrOHGHEGM7DkrFhyaeQdyRI6FbntCBA0u+vF9f3NwY73A2EDC1mnTY7RoXQ+giBigee6n/EJcO/D9yqmuB0iuWI47cGSoZKllsXUYegS/qQqMnRm3Y+pg4XU9U44kAwu+1fEeQ3RqFuwtmyBKYcpB4lO++AUqMDoh/keA9Eo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655505; 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=Y1pEaH8clVxhfmj7GKWI+vq96mY8MVAjTVt/EECWx654d36TMx35LjugU9tYjX98sJgPY1GQ6VUL/HOdtHbpFGVMJU148jXMa352QKnITcODKFQc8kLkEc7OA2r2+PRQLTDqizAkMJfx2LSNZIF6QItowhbGqTCv273BhdZDHvc= 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 1650655505715829.3698435766875; Fri, 22 Apr 2022 12:25: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-651-6F3jKW2QPXKiQUpx9PxVLQ-1; Fri, 22 Apr 2022 15:25:03 -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 5D0BC281AF3A; Fri, 22 Apr 2022 19:24:57 +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 4567841636F; Fri, 22 Apr 2022 19:24:57 +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 9097F194036C; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D23D81940351 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:55 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B628B2024CC3; Fri, 22 Apr 2022 19:24:55 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 243212026614 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:53 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655504; 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=cBQtH/m9XGRjrc1rujwPO3FFsDLNblQpeillvUxRyS7GHebcMKkdwjR5pWD/mmy+z6StzI IBcfvhTk7izv8fWsDFHArHTd3nOvV8ocNX0yRroEcntKqp8ExisFskbK2VVOJAMCxU9mfK rFR1MrKjZDOgdTGgSNWFIP7+Gsj1wE4= X-MC-Unique: 6F3jKW2QPXKiQUpx9PxVLQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 13/19] scripts: apibuild: parse 'Since' version for enums Date: Fri, 22 Apr 2022 21:23:38 +0200 Message-Id: <20220422192344.830350-14-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655507270100002 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> Reviewed-by: Andrea Bolognani <abologna@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 11 21:53:44 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=1650655563; cv=none; d=zohomail.com; s=zohoarc; b=FyOtNmAGtnBNun0HgFngt9Qh9IhpgWsVYqgBzX8HnAayHQpPIxBoC4oYt+OrBNYOVs761Q5xaweEYZwpwPlz4U3/wDHg5wpaTRRoHWv4qqSVS1So5XAihwlXQY+0R8VxN/RMn1gQHN8vSRCkzqYleVLUMyRmKvIKMxz7U56Lfyc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655563; 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=A9KgoEDbvx9DxllRYZDf3xBAQ4IOS6HDtoWpNcCpDadPVu6FRt2Bzx43RyIRHDWRlqZkcSflvxMH/0a6pE7GLCHfgvmCz4df+GVL8pz1kWZNqyD0UvAoTAhron9HXgj3ToH4G56xyx3A4GV6Q5I/3AEHL6J8a0dC2gbWKSELqJs= 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 1650655563360508.88390494125645; Fri, 22 Apr 2022 12:26: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-640-Y1vcRS5KPpO4F_xwhZv_tw-1; Fri, 22 Apr 2022 15:25:01 -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 A8EC53C16193; Fri, 22 Apr 2022 19:24:58 +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 92BBB40CF918; Fri, 22 Apr 2022 19:24:58 +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 05C621940365; Fri, 22 Apr 2022 19:24:58 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C566C1940359 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id BB6252024CCB; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 252772024CC3 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655562; 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=EKRsPM0r3h1wNvXqBtWP62uKaQdxBfOmKHil9UF37+L3JJSSBsh3TVveDonMjOge/21lq7 HaU3YNZebAFJwsadUc+OCXKeeqUkyD4UKkEXhnTMg8xYM1XfApoPvGwrPOgcddoa01XQOP vqMJtTuLCSJmF7U0rWg2Xy3lf1WNCWA= X-MC-Unique: Y1vcRS5KPpO4F_xwhZv_tw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 14/19] scripts: apibuild: fix parsing block comments from typedef enum Date: Fri, 22 Apr 2022 21:23:39 +0200 Message-Id: <20220422192344.830350-15-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655565583100001 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 11 21:53:44 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=1650655505; cv=none; d=zohomail.com; s=zohoarc; b=dEq6JHj0zF0SgsegooP/AMpI1uQO4pm+NwcOe++YKqWlGhoM85B47zPIWwkfj1MW3yEpQiv00hhr8dKmWy6qwC9AUqyU7FHFh2YxAnPsUkrMXvWtMXXTydtHyp350ZETNhlPwDXfogeN3xqEX4Qyl/PwS7femNdbAc93wJRzrwY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655505; 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=IDmZ83Yr7tHwLzYm7+DMXHjPfmCbF2qMV1m7mFOa46bmmggZketOY2l9HKyGYKeRCixDpl8z6Ss6BwW12gkP0+rXwxgp76xSldu+JAPrQFYdjn9nRAmLCY8npr6KyiyI5yBCDyd0UgdZbGtIckmE2mDWROpEtmBRqv/vrS7HPxM= 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 16506555058241008.6688447113804; Fri, 22 Apr 2022 12:25: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-373-c18TlvJbPceJ-to64lhuHw-1; Fri, 22 Apr 2022 15:25:02 -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 DA4EF811E7A; Fri, 22 Apr 2022 19:24:59 +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 C456F409B3FD; Fri, 22 Apr 2022 19:24:59 +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 6863F1940352; Fri, 22 Apr 2022 19:24:59 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id F250F1940363 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:24:57 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C1DF22024CCB; Fri, 22 Apr 2022 19:24:57 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2B1D92024CC3 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655504; 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=CUuMxuL8Ak+JYyPZLBkuIsti2d+/1aUUED5yT9KIO+PBALH1DKJb5F35fE6qa6EnGYm64j TX6gjlCoccvts6/UNQvMMFS1fAuD2xisHma49PNZt6s8KAJIdA1RQo6IeyrYiqCs6WVY6F XirkJlFv9TMcDHmq2e/yAYo6q3vPJc8= X-MC-Unique: c18TlvJbPceJ-to64lhuHw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 15/19] scripts: apibuild: parse 'Since' for typedefs Date: Fri, 22 Apr 2022 21:23:40 +0200 Message-Id: <20220422192344.830350-16-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650656408425100001 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 11 21:53:44 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=1650655513; cv=none; d=zohomail.com; s=zohoarc; b=Ewf7rmAmoHnbtTbL54/pMER85cLki2nnKcsacTTZSeCML0Qq8vOBL10rGsq1kANfo+IxNruZJdD6g/nnPeR65e44v/vns4GOZrSmLivvWKlAVubHrWKUZOEROmpAbknSkPyCslNTUB7HJGRZv3p8vZ1xNp+rpaJASBscWH58Bks= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655513; 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=PMb3UgqCyg5mc+phQAKRVNm+KwQ/SifO8w03gAhzThOM2Uet96s6zY6V6Fgv8eXLVdM1QlsvYhRCcXhen+EwmpwvYTejsGcsCf0VmoBVHxrf9QEN6qf85rUi6Lhug2U/dVaXBKViXjdMqOGO50Itnw/QvJD41k/9sWSjBb9pJOg= 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 1650655513052985.4436463893247; Fri, 22 Apr 2022 12:25:13 -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-531-xi_82CEYNOaPbqwfRCWCVw-1; Fri, 22 Apr 2022 15:25:09 -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 8198B1018AA4; Fri, 22 Apr 2022 19:25:06 +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 2BC3141636D; Fri, 22 Apr 2022 19:25:06 +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 BA52D1940352; Fri, 22 Apr 2022 19:25:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D83561940352 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:25:04 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B8CEB200B41A; Fri, 22 Apr 2022 19:25:04 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 225BB200E287 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:24:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655512; 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=Yc0azaY7veHMWbhgpyVZtcQSlpmdBv5h3JCD0cP6FEPCqz0EBc94zuSRCy5f6NVoaano2g ZCX0eTUlXXDIs3GsUjeJI1vpweQy1W1BHjm0Eow9mitTWvkN+RgCTgIyo6x8+3cxCyNoTI r6kjClaJlZQkoJ4oOT5p4WOSmiAB7UE= X-MC-Unique: xi_82CEYNOaPbqwfRCWCVw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 16/19] scripts: apibuild: parse 'Since' for macros Date: Fri, 22 Apr 2022 21:23:41 +0200 Message-Id: <20220422192344.830350-17-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655515198100003 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 11 21:53:44 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=1650655512; cv=none; d=zohomail.com; s=zohoarc; b=ll1dod8KodTT0M4nzHsQKFnRxjn27ZUvNSsBqCtyBa32Tg7wKVmS+MPjAxm7xnspkUqpKWr2KJQSCEF2jms/yPUMYRou3JpACb44qy8Chst8rYKW6VZ1r7/zlQqx6Vl3vwOVSrUtbyB5/x5odqni2vzbB6mWb07qyHPO2TT5B2k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655512; 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=cMyrRv4YQ+Byq7BHFVhAiawHfc+snXmA+X17/na7D5Y=; b=b4e5+hmtYzuU+B84D4MGJ2bE3yHwUiX72IvCL/wnENCdPIX1xHyFMTYfFV1+bPpRPi/JDPwvCZIBr9mavkvQmYvtE+48lpmxWgdp0ONZuWkvudFlCXtnnWfwYbUG1F7sB/CqLeCYVUkHn1eo91HgWk1IKTSqRyt0LPKaM9hNaV4= 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 1650655512586524.2554718688128; Fri, 22 Apr 2022 12:25:12 -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-624-jf3rcSaGNb20ZCytn4GRgw-1; Fri, 22 Apr 2022 15:25:10 -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 670CB1014A66; Fri, 22 Apr 2022 19:25:07 +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 5081441636E; Fri, 22 Apr 2022 19:25:07 +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 190F31940352; Fri, 22 Apr 2022 19:25:07 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C186A1940355 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:25:05 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 999A6200B41A; Fri, 22 Apr 2022 19:25:05 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1D7AA200E287 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:25:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655511; 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=cMyrRv4YQ+Byq7BHFVhAiawHfc+snXmA+X17/na7D5Y=; b=YeMGFv0G2Tv0PMoMGSWvSClSdZYJ31OWhlsH1iaPEZs8S+jg2NyGKSj3vc2BYK9eYILjVv CJv4DZFuOMqGIW89kH3smI6aFEC5D7MrMpmBYkjqI73OOvBAeapfpRYUxgrWj9LZfExAWS 4Ba9wxHBkplYvIq1BCCJzrPXegK9nsc= X-MC-Unique: jf3rcSaGNb20ZCytn4GRgw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 17/19] scripts: apibuild: parse 'Since' for functions Date: Fri, 22 Apr 2022 21:23:42 +0200 Message-Id: <20220422192344.830350-18-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655513188100001 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 | 70 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 13 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index b77eea0624..b86d20e364 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -111,6 +111,17 @@ 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', + 'virAdmServerUpdateTlsFiles': '6.2.0', + 'virDomainBlockPeek': '0.4.3', + 'virDomainMemoryPeek': '0.4.3', +} + ignored_macros =3D { "_virSchedParameter": "backward compatibility macro for virTypedParame= ter", "_virBlkioParameter": "backward compatibility macro for virTypedParame= ter", @@ -2185,9 +2196,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 +2212,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 +2261,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 +2291,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 +2325,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 +2377,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 +2392,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 +2406,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 11 21:53:44 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=1650655516; cv=none; d=zohomail.com; s=zohoarc; b=QSjJGM3NKAolaeGcsTFaTAIkacMlynffmpWajHmeSPVos06y+NQpUSBd9ShL5Z9ExKMfr/LRqGgRSX4E/6reqNlL5awgWk8Qttdr8jffIcsCPu+Npo9ilIkgH98ie6Qc/kUAmn0RvQYZooVXJk2PQDK25cjEyD/lScX6P8AnLGM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655516; 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=8Gr+tW4dr3h10ZLzHzxueWHOuJJjwwMzyfYOguN0+28=; b=kK7kFkrlM4z22GxzJylf5UYgtzVJjtoIPPO6T4qYAlPy6FDWAvbALr+sd67kdkgytfs7c7g8VL5ibm3i3dhrhLddCIstx69ia1B/FBXlWv5dIK7TEBoTDyDjDzYTQR4owUhtvyESeHNfXLCYxXV3ZorAWmWKBJDNiUkNLqzCqkI= 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 1650655516783292.30419041335153; Fri, 22 Apr 2022 12:25:16 -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-154-OlJssyPGNM2IxJ92CxnBSg-1; Fri, 22 Apr 2022 15:25:11 -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 6B592180075D; Fri, 22 Apr 2022 19:25:08 +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 57F8714A5066; Fri, 22 Apr 2022 19:25:08 +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 1A2181940355; Fri, 22 Apr 2022 19:25:08 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id CDDD01940351 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:25:06 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id ABF8A2024CC3; Fri, 22 Apr 2022 19:25:06 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 158262026614 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:25:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655515; 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=8Gr+tW4dr3h10ZLzHzxueWHOuJJjwwMzyfYOguN0+28=; b=WR4rotOyJ63v0wVpzeLnNLaJTNYnp+RhZtA//spOh4lKpKQJTLkGiXEjs+oDu5WkiJyb9R JwnSFOcSGMnvXjeEHqUsgATwq4QwVGCBAzgiQWWPBzSx0dl+JmX83wT2GnYEdbnDju2vHg gRK/sJD17xc9bXGgdA+KJrf9Ivs8Cuw= X-MC-Unique: OlJssyPGNM2IxJ92CxnBSg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 18/19] scripts: apibuild: factor out comment cleaning Date: Fri, 22 Apr 2022 21:23:43 +0200 Message-Id: <20220422192344.830350-19-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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: 1650655517165100005 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 b86d20e364..40ee0a3c63 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -733,15 +733,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(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 11 21:53:44 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=1650655526; cv=none; d=zohomail.com; s=zohoarc; b=MHWRLj2yTCZOQJvUWckB9mwqcAtpWqeYBT5K5qawAkS5Wc9JeUt07Lugz7NKGTGCLEOAI+4xcQzIaU6ERQoYNvsLGI/JpqvjqWDsbkwLZ0Og2XKlRVHAdV+s44u6qD6aK3K0Fnw/N1ugFETnrUENGskTGZEp05DgXhU09csY6Tk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650655526; 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=H6PwZYTVVMATmQTU4Z9dczhuPWMYBxna1ZniNTJpdek=; b=LuB0M2wYqzu1FxYoWFeu6e83nyAuIJpcbT2PO5zaryVaCW2onUdEh838IaFDm/TEOdB5rq8sAMP8jeW0VqOE5dJrd9RgFTr2bZyvzOeT0Fl1f7jDXF+a73QrTLP7A7Cgwk6FHO3UPB7wugx0TYL1lfguf26CsWx8XP0wML8Nd30= 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 1650655526072354.10198639353837; Fri, 22 Apr 2022 12:25: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-562-kVZV_rGiPCSAfkECVb4S_w-1; Fri, 22 Apr 2022 15:25:20 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D5AAA800B28; Fri, 22 Apr 2022 19:25:18 +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 C16AB2026609; Fri, 22 Apr 2022 19:25:18 +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 681901940352; Fri, 22 Apr 2022 19:25:18 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 11FA51940351 for <libvir-list@listman.corp.redhat.com>; Fri, 22 Apr 2022 19:25:17 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id E5CE52026609; Fri, 22 Apr 2022 19:25:16 +0000 (UTC) Received: from tapioca.home (unknown [10.40.194.99]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5612A200C0E6 for <libvir-list@redhat.com>; Fri, 22 Apr 2022 19:25:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650655524; 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=H6PwZYTVVMATmQTU4Z9dczhuPWMYBxna1ZniNTJpdek=; b=NtJUBfFCL5Ml3Zr0G8NcNKNd+VYm9HHq4SAUO5iSeSnEOFWvp0TX2k+3KPXSawKrwMUi28 GtT9g7YYP1hrwUYk6hvE9u9F3ATTQ3yJJbmPqvHDhlByEcNemCLq7jIRmi8jz+IeXNTQ2m /N1mWHU2Fz4c/Km5idA116gqNETlM3M= X-MC-Unique: kVZV_rGiPCSAfkECVb4S_w-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso <victortoso@redhat.com> To: libvir-list@redhat.com Subject: [PATCH v4 19/19] scripts: apibuild: add parsing variable's comments Date: Fri, 22 Apr 2022 21:23:44 +0200 Message-Id: <20220422192344.830350-20-victortoso@redhat.com> In-Reply-To: <20220422192344.830350-1-victortoso@redhat.com> References: <20220422192344.830350-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools <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.4 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: 1650655527196100003 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 | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index 40ee0a3c63..c2920d811c 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -733,11 +733,17 @@ class CParser: line =3D line.replace('*', '', 1) return line =20 - def cleanup_code_comment(self, comment: str) -> str: + def cleanup_code_comment(self, comment: str, type_name=3D"") -> str: if not isinstance(comment, str) or comment =3D=3D "": return "" =20 lines =3D comment.splitlines(True) + + # If type_name is provided, check and remove header of + # the comment block. + if type_name !=3D "" and f"{type_name}:" in lines[0]: + del lines[0] + com =3D "" for line in lines: com =3D com + self.strip_lead_star(line) @@ -1941,10 +1947,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.comment token =3D self.parseType(token) type_orig =3D self.type if token is None or token[0] !=3D "name": @@ -1990,8 +2000,11 @@ class CParser: not self.is_header, "struct", self.struct_fields) else: + # Just to use the cleanupComment function. + variable_comment =3D self.cleanup_code_comment(var= iable_comment, self.name) + 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() @@ -2368,12 +2381,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