From nobody Tue Feb 10 17:08:18 2026 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=1649969285; cv=none; d=zohomail.com; s=zohoarc; b=TuUWh+Dksj7g81HeuU879qOB8zwsUGzowoCHQAISMlAfao/qgxHvC7mqtk7rKcpOirCM5DrG+nGwYjeSTnYPHX96RHQZ5utebOPHQY8imKSLpyNNB24b0kNjvDbDw+FgwUrUUDW4vBKVNaKHnz/X5omq5Nmhpub4Hu0zNBTWoDE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1649969285; 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=XSgvw0cf6TVfEorCeNHZb3z4anj3EQObpKep/QKI2+Y=; b=BUptoBTU1AZ59lSm1gAVU2wkM7ej3AhGfQVTjE3WpLGzSZyQxV1pJURAyH7OrMugVlij4BXS7jKdcSxVAAHct5Iqp5Gj7xOaKjvhNT0NCOTirvdZV1/Fpr04lpI/q1D1WuGPX8xE6L8pC41zWmtnKaLx5ApqFMpLlajQ5IDqmBc= 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 1649969285191296.143944087308; Thu, 14 Apr 2022 13:48: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-627-rst79FZgOPS7_EO_mrSxfQ-1; Thu, 14 Apr 2022 16:47:58 -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 7B2A61014A63; Thu, 14 Apr 2022 20:47: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 64C09492D58; Thu, 14 Apr 2022 20:47:55 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1D21A194034E; Thu, 14 Apr 2022 20:47:55 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1DE5D194034B for ; Thu, 14 Apr 2022 20:47:52 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 051922167D68; Thu, 14 Apr 2022 20:47:52 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.2]) by smtp.corp.redhat.com (Postfix) with ESMTP id 623612167D64 for ; Thu, 14 Apr 2022 20:47:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1649969284; 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=XSgvw0cf6TVfEorCeNHZb3z4anj3EQObpKep/QKI2+Y=; b=Tj3n3wHAPVkx5x7qW6WTlps3smQgDJ96PLGvUP/TAHsvzd/Q5Ny6qK8ye2Wk0MGGG4UuY8 GSw/3p72P7BQA+3Wq7K0Y450z+QInVXcM7OGwi33cCuM3dN+7sJhBiwj4Evca2Gw7/rdGQ ceUxQQTBpk6+jlvVALHRez+5EmLuJ+I= X-MC-Unique: rst79FZgOPS7_EO_mrSxfQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v2 01/34] docs: Fix generated documentation of virConnectListAllNodeDeviceFlags Date: Thu, 14 Apr 2022 22:47:12 +0200 Message-Id: <20220414204745.108966-2-victortoso@redhat.com> In-Reply-To: <20220414204745.108966-1-victortoso@redhat.com> References: <20220414204745.108966-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 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: 1649969286282100001 Content-Type: text/plain; charset="utf-8"; x-default="true" 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. 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 --- 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