[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t
From: |
Alex Bennée |
Subject: |
[PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t |
Date: |
Fri, 12 Mar 2021 17:28:11 +0000 |
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ée <alex.bennee@linaro.org>
---
include/qemu/qemu-plugin.h | 22 +++++++++++++++-------
1 file changed, 15 insertions(+), 7 deletions(-)
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;
#define QEMU_PLUGIN_VERSION 1
-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;
};
--
2.20.1
- [PATCH v1 02/14] plugins: Expose physical addresses instead of device offsets, (continued)
- [PATCH v1 02/14] plugins: Expose physical addresses instead of device offsets, Alex Bennée, 2021/03/12
- [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_install, Alex Bennée, 2021/03/12
- [PATCH v1 08/14] plugins: add qemu_plugin_cb_flags to kernel-doc, Alex Bennée, 2021/03/12
- [PATCH v1 07/14] plugins: expand the typedef kernel-docs for translation, Alex Bennée, 2021/03/12
- [PATCH v1 10/14] plugins: expand inline exec kernel-doc documentation., Alex Bennée, 2021/03/12
- [PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t,
Alex Bennée <=
- [PATCH v1 06/14] plugins: expand the callback typedef kernel-docs, Alex Bennée, 2021/03/12
- [PATCH v1 12/14] plugins: expand kernel-doc for memory query and instrumentation, Alex Bennée, 2021/03/12
- [PATCH v1 09/14] plugins: add qemu_plugin_id_t to kernel-doc, Alex Bennée, 2021/03/12
- [PATCH v1 13/14] plugins: getting qemu_plugin_get_hwaddr only expose one function prototype, Alex Bennée, 2021/03/12