| Message ID | 20210312172821.31647-6-alex.bennee@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | plugins/next (phys addr, syscalls, lots of docs) | expand |
On Mar 12 17:28, Alex Bennée wrote: > kernel-doc doesn't like multiple Note sections. Also add an explicit > Return. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Aaron Lindsay <aaron@os.amperecomputing.com> > --- > include/qemu/qemu-plugin.h | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > 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 >
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,
kernel-doc doesn't like multiple Note sections. Also add an explicit Return. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> --- include/qemu/qemu-plugin.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) -- 2.20.1