OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

plugins: cleanup kernel-doc for qemu_plugin_install

Browse Source 
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>
This commit is contained in:
Alex Bennée 2021-03-12 17:28:12 +00:00
parent 841dcc0813
commit 1caa8d9f2c
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/qemu/qemu-plugin.h
View File

@ -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,