From nobody Tue Oct 7 11:15:44 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1615965812; cv=none; d=zohomail.com; s=zohoarc; b=VXz2LeNHie6hqknYHczNP6BuBFWR6XLf90DTn8gokSc4EpA52vpWVX+lEspVTWahdaoUEexbp+sZ3dC//dk3n7a35I8z2YxsDlSWzJkD0qByJV1JFsoFgTfvWnjaZpf8yLjvwrkZqr0Jib3YH+8UT/PuV2fSLVrMKTSOCAlMdH8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1615965812; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=Z/GsiICGeaT2/Why33IGYP3Vu7Bpn+W4JV5DMBIlNpM=; b=C9A8lzxJXUA0mtF52upSYKAML/kre32cA33IKD4mqKocxMjk9Dpi/wJPg/XRyWYcACXacV0SNiuYOzobu85UuZUYTG6ytH+JEhu4n4l1j0f/Y31xVinWS1fNQ4enu0q02bLnY8p5FUemvMAJAn2exmyNluUMZtbDwkVHy0VV3iE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 161596581253097.98761472482317; Wed, 17 Mar 2021 00:23:32 -0700 (PDT) Received: from localhost ([::1]:57172 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lMQWh-0005Ar-91 for importer@patchew.org; Wed, 17 Mar 2021 03:23:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:44192) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lMQVe-0003W9-Qb for qemu-devel@nongnu.org; Wed, 17 Mar 2021 03:22:26 -0400 Received: from mail-ej1-x62f.google.com ([2a00:1450:4864:20::62f]:40136) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lMQVd-0007tD-AB for qemu-devel@nongnu.org; Wed, 17 Mar 2021 03:22:26 -0400 Received: by mail-ej1-x62f.google.com with SMTP id ci14so912230ejc.7 for ; Wed, 17 Mar 2021 00:22:24 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id hd37sm10401176ejc.114.2021.03.17.00.22.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Mar 2021 00:22:20 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 128C51FF90; Wed, 17 Mar 2021 07:22:17 +0000 (GMT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Z/GsiICGeaT2/Why33IGYP3Vu7Bpn+W4JV5DMBIlNpM=; b=A4CeZukubX6Yq7d7NiYXfsDHyPgGgxjGn57BYQ1gwkX3XuN7FWHaFs9zbqgGGfv3ze AR4Tan3xrivTQkUCGUvo7SFzD0K636lozGfI3qUs19wKg7oif0ZemEppnuj1HG332FvC QNk+Nb9FIb379G+VN9D3C1kIkHZ3wHlD2LOhofDJIjHOzJ2+q5cDed4wqpQou5ohus6h yHnf02522hkOK45rMPF6XI8JILXvAHdltzw0cCxDv0KQl/rpzkTav/KM90udKIEJL2zb 7MzdHB+kfmGihZ2CIl8kICG4TqArf9bsdwerhiPPgvegOPES818GHMp2oIynNgXkMSA4 +8xQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Z/GsiICGeaT2/Why33IGYP3Vu7Bpn+W4JV5DMBIlNpM=; b=Vua72NZGZieSZW6/90oM7mOkVOmfwjHE0UJQBZipiFGh9xzfAd6tmQFsZ4wNOvtJe/ r1mE3CojncQgnV6blzvESw4CJC8Ku4uUGR5qbDZvqikKg/hDydJ0z2lFE/zd7tXDq6Li VsjHgN122A96OiFqR7mM+JIQdtgDzvu43NGrmOPa0ORlCZB1lXgyCjLABmj/usIuas/p ZmW8Dr8Q19hRU+G19IezwEZIwc7LU2d1uS8hWe2XHxXAcj7u+M1cvwsjIPyqYRr81LZ4 vEuLMb5Kvvx3ewo2cslsw3GcTFuDzuh+Knn7RPA7D5yJoymZlm+b/zgbpSmxuwfI+rjr oaeQ== X-Gm-Message-State: AOAM531mb44UueV31pX0WEuCMmCdTh2lmCCYZgw8rWKp6C++ZKIXwhCe flK7+i7RadyPAZfHOaL2P4fLRQ== X-Google-Smtp-Source: ABdhPJxKw2wqGpRXe1fLvV/79Sl1uAED6JKjJzU/P927OAlQ/HHK1yWh6eQQNXPPwCr5bzHBz4sJdg== X-Received: by 2002:a17:906:2dda:: with SMTP id h26mr33465820eji.163.1615965744072; Wed, 17 Mar 2021 00:22:24 -0700 (PDT) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL v2 04/15] plugins: expand kernel-doc for qemu_info_t Date: Wed, 17 Mar 2021 07:22:05 +0000 Message-Id: <20210317072216.16316-5-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210317072216.16316-1-alex.bennee@linaro.org> References: <20210317072216.16316-1-alex.bennee@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::62f; envelope-from=alex.bennee@linaro.org; helo=mail-ej1-x62f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , qemu-devel@nongnu.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) It seems kernel-doc struggles a bit with typedef structs but with enough encouragement we can get something out of it. Signed-off-by: Alex Benn=C3=A9e Message-Id: <20210312172821.31647-5-alex.bennee@linaro.org> diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h index 3303dce862..4b84c6c293 100644 --- a/include/qemu/qemu-plugin.h +++ b/include/qemu/qemu-plugin.h @@ -49,22 +49,30 @@ extern QEMU_PLUGIN_EXPORT int qemu_plugin_version; =20 #define QEMU_PLUGIN_VERSION 1 =20 -typedef struct { - /* string describing architecture */ +/** + * struct qemu_info_t - system information for plugins + * + * This structure provides for some limited information about the + * system to allow the plugin to make decisions on how to proceed. For + * example it might only be suitable for running on some guest + * architectures or when under full system emulation. + */ +typedef struct qemu_info_t { + /** @target_name: string describing architecture */ const char *target_name; + /** @version: minimum and current plugin API level */ struct { int min; int cur; } version; - /* is this a full system emulation? */ + /** @system_emulation: is this a full system emulation? */ bool system_emulation; union { - /* - * smp_vcpus may change if vCPUs can be hot-plugged, max_vcpus - * is the system-wide limit. - */ + /** @system: information relevant to system emulation */ struct { + /** @system.smp_vcpus: initial number of vCPUs */ int smp_vcpus; + /** @system.max_vcpus: maximum possible number of vCPUs */ int max_vcpus; } system; }; --=20 2.20.1