summaryrefslogtreecommitdiffstats
path: root/docs/devel
diff options
context:
space:
mode:
authorAlex Bennée2021-03-23 17:52:48 +0100
committerAlex Bennée2021-03-24 15:24:44 +0100
commitca955bd726d49a0194b68fd43ccd0f92fdea71ec (patch)
tree18d210ec49eb19b32cbd0e8b627f7bdec34adf62 /docs/devel
parentscripts/kernel-doc: strip QEMU_ from function definitions (diff)
downloadqemu-ca955bd726d49a0194b68fd43ccd0f92fdea71ec.tar.gz
qemu-ca955bd726d49a0194b68fd43ccd0f92fdea71ec.tar.xz
qemu-ca955bd726d49a0194b68fd43ccd0f92fdea71ec.zip
docs/devel: include the plugin API information from the headers
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> Reviewed-by: Aaron Lindsay <aaron@os.amperecomputing.com> Message-Id: <20210323165308.15244-3-alex.bennee@linaro.org>
Diffstat (limited to 'docs/devel')
-rw-r--r--docs/devel/tcg-plugins.rst5
1 files changed, 5 insertions, 0 deletions
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
=====