From nobody Tue Feb 10 10:54:08 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1650481719; cv=none; d=zohomail.com; s=zohoarc; b=lo9Zkj6HPPe9IOXDDG/7b1iA5DeppnSgiIw1ZtU47aLS+3kmbx8WbLPrA1/ih8cGnvxFEG0MGZBdl0V8shWN+R/9bd6g+2R7vNzHSTya+zvqThfKj/h5WHNF2PAf7gn6QkTC7ZpNTUg/OGj+C+BwCTTo9G2SfjfvVB0umIMqzQM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1650481719; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=u07I5l7SElfGXtCY++hkrgAWAL2XEp1/ulFLHyRZo2E=; b=ac5C2uhd3Rho6Awuz4lij3/pHRCtN/lpi+gONWA+hRS3f0x2tbLjjYHSpV6GL+tuD8LNMhnJjbZu+jpj23Dtq3kWK+nB+yawqWcycXwqczODEy8YjTSEWxQg+I01jQb5T49GiXvkkULLlJoFJ6FB322GL24ZEQUMhmNDFKCE1FU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1650481719554630.3705687407645; Wed, 20 Apr 2022 12:08:39 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-122-AaDvANH3NdK2k1v88OYc3A-1; Wed, 20 Apr 2022 15:08:32 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 092EE3811F2D; Wed, 20 Apr 2022 19:08:28 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id EA295145BA63; Wed, 20 Apr 2022 19:08:27 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 9444F194036E; Wed, 20 Apr 2022 19:08:26 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1D2121940361 for ; Wed, 20 Apr 2022 19:08:24 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 06DAB551E85; Wed, 20 Apr 2022 19:08:24 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id 70BFB551E86 for ; Wed, 20 Apr 2022 19:08:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650481718; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=u07I5l7SElfGXtCY++hkrgAWAL2XEp1/ulFLHyRZo2E=; b=B55nxXlz8JB4oH5t8yC1eNrV3T1rcaY/5XBplcOK5t8hDZeVRcqiHxWwCEuVH7geOuR5vW XA0psCzsb/KW9JOqudwqhjiXjm/bWvha+xBi8Lq/ZfhFfb6cln7gRoWeYsN/8S37EdtMJu GXBATrx1Mqa+MkHLlYnroeapoWRIjSA= X-MC-Unique: AaDvANH3NdK2k1v88OYc3A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v3 03/30] docstring: Fix generated documentation of virConnectListAllNodeDeviceFlags Date: Wed, 20 Apr 2022 21:07:52 +0200 Message-Id: <20220420190819.3093205-4-victortoso@redhat.com> In-Reply-To: <20220420190819.3093205-1-victortoso@redhat.com> References: <20220420190819.3093205-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1650481720417100002 Content-Type: text/plain; charset="utf-8" scripts/apibuild.py does not handle well enum's with comments between values. The outcome depends on whether the enum value has its own docstring or not and if there is spaces between the enum values or not. Either way, virConnectListAllNodeDeviceFlags documentation is explicit that this enum is about filtering node devices. We can move the information that it is either by "capability" or "active" state to the block of comment above. Using git diff --word-diff to show the fixed ouput xml (redacted). = -]{+Matrix'/>+} -]{+Queue'/>+} -]{+info=3D'DRM device'/>+} -]{+info=3D'FC Host Bus Adapter'/>+} -]{+info=3D'Mediated device'/>+} -]{+info=3D'Capable of mediated devices'/>+} -]{+info=3D'Network device'/>+} -]{+info=3D'PCI device'/>+} -]{+= device'/>+} +} -]{+info=3D'SCSI Host Bus Adapter'/>+} -]{+Target'/>+} -]{+info=3D'System capability'/>+} -]{+interface'/>+} -]{+info=3D'Device with VPD'/>+} -]{+info=3D'Capable of vport'/>+} -]{+info=3D'Inactive device= s'/>+} Signed-off-by: Victor Toso Reviewed-by: Peter Krempa --- include/libvirt/libvirt-nodedev.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/libvirt/libvirt-nodedev.h b/include/libvirt/libvirt-no= dedev.h index 0c01d51aab..8efcd7f506 100644 --- a/include/libvirt/libvirt-nodedev.h +++ b/include/libvirt/libvirt-nodedev.h @@ -60,9 +60,9 @@ int virNodeListDevices (virConne= ctPtr conn, /* * virConnectListAllNodeDevices: * - * Flags used to filter the returned node devices. */ + * Flags used to filter either by capability or active state, the + * returned node devices. */ typedef enum { - /* filter the devices by cap type */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM =3D 1 << 0, /* System= capability */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV =3D 1 << 1, /* PCI de= vice */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV =3D 1 << 2, /* USB de= vice */ @@ -86,7 +86,6 @@ typedef enum { VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX =3D 1 << 20, /* s390 A= P Matrix */ VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD =3D 1 << 21, /* Device= with VPD */ =20 - /* filter the devices by active state */ VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE =3D 1 << 30, /* Inacti= ve devices */ VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE =3D 1U << 31, /* Activ= e devices */ } virConnectListAllNodeDeviceFlags; --=20 2.35.1