[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v1 03/14] docs/devel: include the plugin API information from
From: |
Aaron Lindsay |
Subject: |
Re: [PATCH v1 03/14] docs/devel: include the plugin API information from the headers |
Date: |
Fri, 12 Mar 2021 13:19:58 -0500 |
On Mar 12 17:28, Alex Bennée wrote:
> We have kerneldoc tags for the headers so we might as well extract
> them into our developer documentation whilst we are at it.
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Aaron Lindsay <aaron@os.amperecomputing.com>
> ---
> docs/devel/tcg-plugins.rst | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
> index 39ce86ed96..18c6581d85 100644
> --- a/docs/devel/tcg-plugins.rst
> +++ b/docs/devel/tcg-plugins.rst
> @@ -63,6 +63,11 @@ valid during the lifetime of the callback so it is
> important that any
> information that is needed is extracted during the callback and saved
> by the plugin.
>
> +API
> +===
> +
> +.. kernel-doc:: include/qemu/qemu-plugin.h
> +
> Usage
> =====
>
> --
> 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
- Re: [PATCH v1 03/14] docs/devel: include the plugin API information from the headers,
Aaron Lindsay <=
- [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
- [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