diff options
| author | Alex Bennée <alex.bennee@linaro.org> | 2022-09-29 12:42:18 +0100 |
|---|---|---|
| committer | Alex Bennée <alex.bennee@linaro.org> | 2022-10-06 11:53:40 +0100 |
| commit | 7f522743dfcea095fe77755386e980cbb5db4ef4 (patch) | |
| tree | bdfbdc87a12eea2b11363716ae4e3a6c077fc549 /docs | |
| parent | 1d0603a990b4363ec7680bd99a249f43ad42cc21 (diff) | |
docs/devel: move API to end of tcg-plugins.rst
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 <alex.bennee@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-Id: <20220929114231.583801-39-alex.bennee@linaro.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/tcg-plugins.rst | 15 |
1 files 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 + |