diff mbox series

[v1,03/14] docs/devel: include the plugin API information from the headers

Message ID 20210312172821.31647-4-alex.bennee@linaro.org
State Superseded
Headers show
Series plugins/next (phys addr, syscalls, lots of docs) | expand

Commit Message

Alex Bennée March 12, 2021, 5:28 p.m. UTC
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>

---
 docs/devel/tcg-plugins.rst | 5 +++++
 1 file changed, 5 insertions(+)

-- 
2.20.1

Comments

Gonglei (Arei)" via March 12, 2021, 6:19 p.m. UTC | #1
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

>
diff mbox series

Patch

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
 =====