[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst
From: |
Alex Bennée |
Subject: |
[PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst |
Date: |
Wed, 21 Sep 2022 17:07:59 +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>
---
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 00/10] plugins/next (disas, monitor, docs, execlog), Alex Bennée, 2022/09/21
- [PATCH v1 01/10] monitor: expose monitor_puts to rest of code, Alex Bennée, 2022/09/21
- [PATCH v1 04/10] tests/tcg: add memory-sve test for aarch64, Alex Bennée, 2022/09/21
- [PATCH v1 03/10] disas: use result of ->read_memory_func, Alex Bennée, 2022/09/21
- [PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst,
Alex Bennée <=
- [PATCH v1 06/10] plugins: Assert mmu_idx in range before use in qemu_plugin_get_hwaddr, Alex Bennée, 2022/09/21
- [PATCH v1 02/10] disas: generalise plugin_printf and use for monitor_disas, Alex Bennée, 2022/09/21
- [PATCH v1 07/10] docs/devel: clean-up qemu invocations in tcg-plugins, Alex Bennée, 2022/09/21
- [PATCH v1 05/10] plugins: extend execlog to filter matches, Alex Bennée, 2022/09/21
- [PATCH v1 09/10] contrib/plugins: reset skip when matching in execlog, Alex Bennée, 2022/09/21