[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 38/51] docs/devel: move API to end of tcg-plugins.rst
From: |
Alex Bennée |
Subject: |
[PATCH v1 38/51] docs/devel: move API to end of tcg-plugins.rst |
Date: |
Thu, 29 Sep 2022 12:42:18 +0100 |
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: <20220921160801.1490125-9-alex.bennee@linaro.org>
---
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
- [PATCH v1 14/51] pc-bios/s390-ccw: detect CC options just once, (continued)
- [PATCH v1 14/51] pc-bios/s390-ccw: detect CC options just once, Alex Bennée, 2022/09/29
- [PATCH v1 12/51] configure: do not invoke as/ld directly for pc-bios/optionrom, Alex Bennée, 2022/09/29
- [PATCH v1 04/51] tests/docker: run script use realpath instead of readlink, Alex Bennée, 2022/09/29
- [PATCH v1 16/51] build: add recursive distclean rules, Alex Bennée, 2022/09/29
- [PATCH v1 28/51] configure: build ROMs with container-based cross compilers, Alex Bennée, 2022/09/29
- [PATCH v1 09/51] tests/docker: update fedora-win[32|64]-cross with lcitool, Alex Bennée, 2022/09/29
- [PATCH v1 13/51] pc-bios/optionrom: detect CC options just once, Alex Bennée, 2022/09/29
- [PATCH v1 15/51] vof: add distclean target, Alex Bennée, 2022/09/29
- [PATCH v1 19/51] tests: simplify Makefile invocation for tests/tcg, Alex Bennée, 2022/09/29
- [PATCH v1 36/51] plugins: Assert mmu_idx in range before use in qemu_plugin_get_hwaddr, Alex Bennée, 2022/09/29
- [PATCH v1 38/51] docs/devel: move API to end of tcg-plugins.rst,
Alex Bennée <=
- [PATCH v1 34/51] disas: use result of ->read_memory_func, Alex Bennée, 2022/09/29
- [PATCH v1 43/51] gdbstub: move sstep flags probing into AccelClass, Alex Bennée, 2022/09/29
- [PATCH v1 25/51] configure: move tests/tcg/Makefile.prereqs to root build directory, Alex Bennée, 2022/09/29
- [PATCH v1 27/51] configure: cleanup creation of tests/tcg target config, Alex Bennée, 2022/09/29
- [PATCH v1 24/51] tests/tcg: move compiler tests to Makefiles, Alex Bennée, 2022/09/29
- [PATCH v1 29/51] pc-bios/optionrom: Adopt meson style Make output, Alex Bennée, 2022/09/29
- [PATCH v1 17/51] configure: return status code from probe_target_compiler, Alex Bennée, 2022/09/29
- [PATCH v1 21/51] tests/tcg: add distclean rule, Alex Bennée, 2022/09/29
- [PATCH v1 49/51] contrib/gitdm: add WANG Xuerui to individual contributers, Alex Bennée, 2022/09/29
- [PATCH v1 23/51] tests/tcg: clean up calls to run-test, Alex Bennée, 2022/09/29