[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v2 05/15] plugins: cleanup kernel-doc for qemu_plugin_install
From: |
Alex Bennée |
Subject: |
[PULL v2 05/15] plugins: cleanup kernel-doc for qemu_plugin_install |
Date: |
Wed, 17 Mar 2021 07:22:06 +0000 |
kernel-doc doesn't like multiple Note sections. Also add an explicit
Return.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20210312172821.31647-6-alex.bennee@linaro.org>
diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h
index 4b84c6c293..ac1bb318da 100644
--- a/include/qemu/qemu-plugin.h
+++ b/include/qemu/qemu-plugin.h
@@ -85,15 +85,15 @@ typedef struct qemu_info_t {
* @argc: number of arguments
* @argv: array of arguments (@argc elements)
*
- * All plugins must export this symbol.
- *
- * Note: Calling qemu_plugin_uninstall() from this function is a bug. To raise
- * an error during install, return !0.
+ * All plugins must export this symbol which is called when the plugin
+ * is first loaded. Calling qemu_plugin_uninstall() from this function
+ * is a bug.
*
* Note: @info is only live during the call. Copy any information we
- * want to keep.
+ * want to keep. @argv remains valid throughout the lifetime of the
+ * loaded plugin.
*
- * Note: @argv remains valid throughout the lifetime of the loaded plugin.
+ * Return: 0 on successful loading, !0 for an error.
*/
QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,
const qemu_info_t *info,
--
2.20.1
- Re: [PULL v2 01/15] utils: Use fixed-point arithmetic in qemu_strtosz, (continued)
[PULL v2 03/15] plugins: Expose physical addresses instead of device offsets, Alex Bennée, 2021/03/17
[PULL v2 04/15] plugins: expand kernel-doc for qemu_info_t, Alex Bennée, 2021/03/17
[PULL v2 02/15] plugins: new syscalls plugin, Alex Bennée, 2021/03/17
[PULL v2 08/15] plugins: add qemu_plugin_cb_flags to kernel-doc, Alex Bennée, 2021/03/17
[PULL v2 07/15] plugins: expand the typedef kernel-docs for translation, Alex Bennée, 2021/03/17
[PULL v2 05/15] plugins: cleanup kernel-doc for qemu_plugin_install,
Alex Bennée <=
[PULL v2 06/15] plugins: expand the callback typedef kernel-docs, Alex Bennée, 2021/03/17
[PULL v2 09/15] plugins: add qemu_plugin_id_t to kernel-doc, Alex Bennée, 2021/03/17
[PULL v2 12/15] plugins: expand kernel-doc for memory query and instrumentation, Alex Bennée, 2021/03/17
[PULL v2 10/15] plugins: expand inline exec kernel-doc documentation., Alex Bennée, 2021/03/17
[PULL v2 11/15] plugins: expand kernel-doc for instruction query and instrumentation, Alex Bennée, 2021/03/17
[PULL v2 13/15] plugins: getting qemu_plugin_get_hwaddr only expose one function prototype, Alex Bennée, 2021/03/17
[PULL v2 15/15] hw/core: Only build guest-loader if libfdt is available, Alex Bennée, 2021/03/17
[PULL v2 14/15] plugins: Fixes typo in qemu-plugin.h, Alex Bennée, 2021/03/17
Re: [PULL v2 00/15] misc fixes (strtoz, plugins, guest-loader), Peter Maydell, 2021/03/18