From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: robhenry@microsoft.com, mahmoudabdalghany@outlook.com,
aaron@os.amperecomputing.com, cota@braap.org,
kuhn.chenqun@huawei.com, "Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH v1 03/14] docs/devel: include the plugin API information from the headers
Date: Fri, 12 Mar 2021 17:28:10 +0000 [thread overview]
Message-ID: <20210312172821.31647-4-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210312172821.31647-1-alex.bennee@linaro.org>
We have kerneldoc tags for the headers so we might as well extract
them into our developer documentation whilst we are at it.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
docs/devel/tcg-plugins.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
index 39ce86ed96..18c6581d85 100644
--- a/docs/devel/tcg-plugins.rst
+++ b/docs/devel/tcg-plugins.rst
@@ -63,6 +63,11 @@ valid during the lifetime of the callback so it is important that any
information that is needed is extracted during the callback and saved
by the plugin.
+API
+===
+
+.. kernel-doc:: include/qemu/qemu-plugin.h
+
Usage
=====
--
2.20.1
next prev parent reply other threads:[~2021-03-12 18:21 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-12 17:28 [PATCH v1 00/14] plugins/next (phys addr, syscalls, lots of docs) Alex Bennée
2021-03-12 17:28 ` [PATCH v1 01/14] plugins: new syscalls plugin Alex Bennée
2021-03-12 17:28 ` [PATCH v1 02/14] plugins: Expose physical addresses instead of device offsets Alex Bennée
2021-03-12 17:28 ` Alex Bennée [this message]
2021-03-12 18:19 ` [PATCH v1 03/14] docs/devel: include the plugin API information from the headers Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t Alex Bennée
2021-03-12 18:20 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 05/14] plugins: cleanup kernel-doc for qemu_plugin_install Alex Bennée
2021-03-12 18:21 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 06/14] plugins: expand the callback typedef kernel-docs Alex Bennée
2021-03-12 18:25 ` Aaron Lindsay via
2021-03-15 18:04 ` Alex Bennée
2021-03-12 17:28 ` [PATCH v1 07/14] plugins: expand the typedef kernel-docs for translation Alex Bennée
2021-03-12 18:27 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 08/14] plugins: add qemu_plugin_cb_flags to kernel-doc Alex Bennée
2021-03-12 18:29 ` Aaron Lindsay via
2021-03-16 13:40 ` Alex Bennée
2021-03-16 14:05 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 09/14] plugins: add qemu_plugin_id_t " Alex Bennée
2021-03-12 18:29 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 10/14] plugins: expand inline exec kernel-doc documentation Alex Bennée
2021-03-12 18:30 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 11/14] plugins: expand kernel-doc for instruction query and instrumentation Alex Bennée
2021-03-12 18:36 ` Aaron Lindsay via
2021-03-16 13:48 ` Alex Bennée
2021-03-16 14:00 ` Aaron Lindsay via
2021-03-12 17:28 ` [PATCH v1 12/14] plugins: expand kernel-doc for memory " Alex Bennée
2021-03-12 18:40 ` Aaron Lindsay via
2021-03-16 13:55 ` Alex Bennée
2021-03-12 17:28 ` [PATCH v1 13/14] plugins: getting qemu_plugin_get_hwaddr only expose one function prototype Alex Bennée
2021-03-12 17:28 ` [PATCH v1 14/14] plugins: Fixes typo in qemu-plugin.h 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=20210312172821.31647-4-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=aaron@os.amperecomputing.com \
--cc=cota@braap.org \
--cc=kuhn.chenqun@huawei.com \
--cc=mahmoudabdalghany@outlook.com \
--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).