Re: [PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst

2022-09-21 Thread Philippe Mathieu-Daudé via 

On 21/9/22 18:07, Alex Bennée wrote:

The API documentation is quite dry and doesn't flow nicely with the
rest of the document. Move it to its own section at the bottom along
with a little leader text to remind people to update it.

Signed-off-by: Alex Bennée 
---
  docs/devel/tcg-plugins.rst | 15 ++-
  1 file changed, 10 insertions(+), 5 deletions(-)


Reviewed-by: Philippe Mathieu-Daudé

[PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst

2022-09-21 Thread Alex Bennée 
The API documentation is quite dry and doesn't flow nicely with the
rest of the document. Move it to its own section at the bottom along
with a little leader text to remind people to update it.

Signed-off-by: Alex Bennée 
---
 docs/devel/tcg-plugins.rst | 15 ++-
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
index a6fdde01f8..8b40b2a606 100644
--- a/docs/devel/tcg-plugins.rst
+++ b/docs/devel/tcg-plugins.rst
@@ -110,11 +110,6 @@ details are opaque to plugins. The plugin is able to query 
select
 details of instructions and system configuration only through the
 exported *qemu_plugin* functions.
 
-API
-~~~
-
-.. kernel-doc:: include/qemu/qemu-plugin.h
-
 Internals
 -
 
@@ -448,3 +443,13 @@ The plugin has a number of arguments, all of them are 
optional:
   associativity of the L2 cache, respectively. Setting any of the L2
   configuration arguments implies ``l2=on``.
   (default: N = 2097152 (2MB), B = 64, A = 16)
+
+API
+---
+
+The following API is generated from the inline documentation in
+``include/qemu/qemu-plugin.h``. Please ensure any updates to the API
+include the full kernel-doc annotations.
+
+.. kernel-doc:: include/qemu/qemu-plugin.h
+
-- 
2.34.1