OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

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>
This commit is contained in:
Alex Bennée 2022-09-29 12:42:18 +01:00
parent 1d0603a990
commit 7f522743df
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/devel/tcg-plugins.rst
View File

@ -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 details of instructions and system configuration only through the
exported *qemu_plugin* functions. exported *qemu_plugin* functions.
API
~~~
.. kernel-doc:: include/qemu/qemu-plugin.h
Internals 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 associativity of the L2 cache, respectively. Setting any of the L2
configuration arguments implies ``l2=on``. configuration arguments implies ``l2=on``.
(default: N = 2097152 (2MB), B = 64, A = 16) (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