[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 27/48] modules: module.h kerneldoc annotations
From: |
Paolo Bonzini |
Subject: |
[PULL 27/48] modules: module.h kerneldoc annotations |
Date: |
Thu, 8 Jul 2021 17:17:27 +0200 |
From: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Jose R. Ziviani <jziviani@suse.de>
Message-Id: <20210624103836.2382472-24-kraxel@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
include/qemu/module.h | 59 +++++++++++++++++++++++++++++++++----------
1 file changed, 45 insertions(+), 14 deletions(-)
diff --git a/include/qemu/module.h b/include/qemu/module.h
index 7f4b1af819..8bc80535a4 100644
--- a/include/qemu/module.h
+++ b/include/qemu/module.h
@@ -74,11 +74,18 @@ void module_load_qom_one(const char *type);
void module_load_qom_all(void);
void module_allow_arch(const char *arch);
-/*
- * module info annotation macros
+/**
+ * DOC: module info annotation macros
*
- * scripts/modinfo-collect.py will collect module info,
- * using the preprocessor and -DQEMU_MODINFO
+ * `scripts/modinfo-collect.py` will collect module info,
+ * using the preprocessor and -DQEMU_MODINFO.
+ *
+ * `scripts/modinfo-generate.py` will create a module meta-data database
+ * from the collected information so qemu knows about module
+ * dependencies and QOM objects implemented by modules.
+ *
+ * See `*.modinfo` and `modinfo.c` in the build directory to check the
+ * script results.
*/
#ifdef QEMU_MODINFO
# define modinfo(kind, value) \
@@ -87,24 +94,48 @@ void module_allow_arch(const char *arch);
# define modinfo(kind, value)
#endif
-/* module implements QOM type <name> */
+/**
+ * module_obj
+ *
+ * @name: QOM type.
+ *
+ * This module implements QOM type @name.
+ */
#define module_obj(name) modinfo(obj, name)
-/* module has a dependency on <name> */
+/**
+ * module_dep
+ *
+ * @name: module name
+ *
+ * This module depends on module @name.
+ */
#define module_dep(name) modinfo(dep, name)
-/* module is for target architecture <name> */
+/**
+ * module_arch
+ *
+ * @arch: target architecture
+ *
+ * This module is for target architecture @arch.
+ *
+ * Note that target-dependent modules are tagged automatically, so
+ * this is only needed in case target-independent modules should be
+ * restricted. Use case example: the ccw bus is implemented by s390x
+ * only.
+ */
#define module_arch(name) modinfo(arch, name)
-/* module registers QemuOpts <name> */
+/**
+ * module_opts
+ *
+ * @name: QemuOpts name
+ *
+ * This module registers QemuOpts @name.
+ */
#define module_opts(name) modinfo(opts, name)
-/*
- * module info database
- *
- * scripts/modinfo-generate.c will build this using the data collected
- * by scripts/modinfo-collect.py
- */
+/* module info database (created by scripts/modinfo-generate.py) */
typedef struct QemuModinfo QemuModinfo;
struct QemuModinfo {
const char *name;
--
2.31.1
- [PULL 14/48] modules: add ccid module annotations, (continued)
- [PULL 14/48] modules: add ccid module annotations, Paolo Bonzini, 2021/07/08
- [PULL 08/48] modules: check if all dependencies can be satisfied, Paolo Bonzini, 2021/07/08
- [PULL 11/48] modules: add chardev module annotations, Paolo Bonzini, 2021/07/08
- [PULL 15/48] modules: add ui module annotations, Paolo Bonzini, 2021/07/08
- [PULL 16/48] modules: add s390x module annotations, Paolo Bonzini, 2021/07/08
- [PULL 17/48] modules: add block module annotations, Paolo Bonzini, 2021/07/08
- [PULL 18/48] modules: use modinfo for dependencies, Paolo Bonzini, 2021/07/08
- [PULL 23/48] modules: check arch on qom lookup, Paolo Bonzini, 2021/07/08
- [PULL 19/48] modules: use modinfo for qom load, Paolo Bonzini, 2021/07/08
- [PULL 20/48] modules: use modinfo for qemu opts load, Paolo Bonzini, 2021/07/08
- [PULL 27/48] modules: module.h kerneldoc annotations,
Paolo Bonzini <=
- [PULL 24/48] modules: target-specific module build infrastructure, Paolo Bonzini, 2021/07/08
- [PULL 25/48] modules: add documentation for module sourcesets, Paolo Bonzini, 2021/07/08
- [PULL 21/48] modules: add tracepoints, Paolo Bonzini, 2021/07/08
- [PULL 22/48] modules: check arch and block load on mismatch, Paolo Bonzini, 2021/07/08
- [PULL 29/48] accel: autoload modules, Paolo Bonzini, 2021/07/08
- [PULL 28/48] modules: hook up modules.h to docs build, Paolo Bonzini, 2021/07/08
- [PULL 30/48] accel: add qtest module annotations, Paolo Bonzini, 2021/07/08
- [PULL 32/48] accel: add tcg module annotations, Paolo Bonzini, 2021/07/08
- [PULL 35/48] usb: drop usb_host_dev_is_scsi_storage hook, Paolo Bonzini, 2021/07/08
- [PULL 37/48] usb: build usb-host as module, Paolo Bonzini, 2021/07/08