diff options
| author | Alex Bennée <alex.bennee@linaro.org> | 2021-03-12 17:28:12 +0000 |
|---|---|---|
| committer | Alex Bennée <alex.bennee@linaro.org> | 2021-03-17 07:17:46 +0000 |
| commit | 1caa8d9f2c38464242f9cf366cdc25b78d8308b4 (patch) | |
| tree | a5815dc75317875ca78f8cc4e5eda182474453c9 | |
| parent | 841dcc0813155087f11ef02790f9650a1e199c5b (diff) | |
| download | qemu-1caa8d9f2c38464242f9cf366cdc25b78d8308b4.zip qemu-1caa8d9f2c38464242f9cf366cdc25b78d8308b4.tar.gz qemu-1caa8d9f2c38464242f9cf366cdc25b78d8308b4.tar.bz2 | |
plugins: cleanup kernel-doc for qemu_plugin_install
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>
| -rw-r--r-- | include/qemu/qemu-plugin.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h index 4b84c6c..ac1bb31 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, |