From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: minyihh@uci.edu, ma.mandourr@gmail.com, Luke.Craig@ll.mit.edu,
cota@braap.org, aaron@os.amperecomputing.com,
kuhn.chenqun@huawei.com, robhenry@microsoft.com,
mahmoudabdalghany@outlook.com,
"Alex Bennée" <alex.bennee@linaro.org>,
"Alexandre Iooss" <erdnaxe@crans.org>
Subject: [PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst
Date: Wed, 21 Sep 2022 17:07:59 +0100 [thread overview]
Message-ID: <20220921160801.1490125-9-alex.bennee@linaro.org> (raw)
In-Reply-To: <20220921160801.1490125-1-alex.bennee@linaro.org>
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
next prev parent reply other threads:[~2022-09-21 16:24 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-21 16:07 [PATCH v1 00/10] plugins/next (disas, monitor, docs, execlog) Alex Bennée
2022-09-21 16:07 ` [PATCH v1 01/10] monitor: expose monitor_puts to rest of code Alex Bennée
2022-09-21 17:34 ` Philippe Mathieu-Daudé via
2022-09-22 4:30 ` Markus Armbruster
2022-09-22 15:06 ` Kevin Wolf
2022-09-21 16:07 ` [PATCH v1 02/10] disas: generalise plugin_printf and use for monitor_disas Alex Bennée
2022-09-21 16:07 ` [PATCH v1 03/10] disas: use result of ->read_memory_func Alex Bennée
2022-09-21 17:37 ` Philippe Mathieu-Daudé via
2022-09-21 16:07 ` [PATCH v1 04/10] tests/tcg: add memory-sve test for aarch64 Alex Bennée
2022-09-28 22:54 ` Richard Henderson
2022-09-21 16:07 ` [PATCH v1 05/10] plugins: extend execlog to filter matches Alex Bennée
2022-09-21 16:07 ` [PATCH v1 06/10] plugins: Assert mmu_idx in range before use in qemu_plugin_get_hwaddr Alex Bennée
2022-09-21 17:40 ` Philippe Mathieu-Daudé via
2022-09-21 16:07 ` [PATCH v1 07/10] docs/devel: clean-up qemu invocations in tcg-plugins Alex Bennée
2022-09-21 17:39 ` Philippe Mathieu-Daudé via
2022-09-21 16:07 ` Alex Bennée [this message]
2022-09-21 17:39 ` [PATCH v1 08/10] docs/devel: move API to end of tcg-plugins.rst Philippe Mathieu-Daudé via
2022-09-21 16:08 ` [PATCH v1 09/10] contrib/plugins: reset skip when matching in execlog Alex Bennée
2022-09-21 17:38 ` Philippe Mathieu-Daudé via
2022-09-28 22:59 ` Richard Henderson
2022-09-21 16:08 ` [PATCH v1 10/10] docs/devel: document the test plugins Alex Bennée
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220921160801.1490125-9-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=Luke.Craig@ll.mit.edu \
--cc=aaron@os.amperecomputing.com \
--cc=cota@braap.org \
--cc=erdnaxe@crans.org \
--cc=kuhn.chenqun@huawei.com \
--cc=ma.mandourr@gmail.com \
--cc=mahmoudabdalghany@outlook.com \
--cc=minyihh@uci.edu \
--cc=qemu-devel@nongnu.org \
--cc=robhenry@microsoft.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).