[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_instal
From: |
Aaron Lindsay |
Subject: |
Re: [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_install |
Date: |
Fri, 12 Mar 2021 13:21:45 -0500 |
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
>
- [PATCH v1 00/14] plugins/next (phys addr, syscalls, lots of docs), Alex Bennée, 2021/03/12
- [PATCH v1 01/14] plugins: new syscalls plugin, Alex Bennée, 2021/03/12
- [PATCH v1 03/14] docs/devel: include the plugin API information from the headers, Alex Bennée, 2021/03/12
- [PATCH v1 02/14] plugins: Expose physical addresses instead of device offsets, Alex Bennée, 2021/03/12
- [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_install, Alex Bennée, 2021/03/12
- Re: [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_install,
Aaron Lindsay <=
- [PATCH v1 08/14] plugins: add qemu_plugin_cb_flags to kernel-doc, Alex Bennée, 2021/03/12
- [PATCH v1 07/14] plugins: expand the typedef kernel-docs for translation, Alex Bennée, 2021/03/12
- [PATCH v1 10/14] plugins: expand inline exec kernel-doc documentation., Alex Bennée, 2021/03/12
- [PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t, Alex Bennée, 2021/03/12