summary refs log tree commit diff stats
path: root/docs/devel/index-api.rst
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2022-03-09 13:52:15 +0000
committerAlex Bennée <alex.bennee@linaro.org>2022-03-23 10:37:49 +0000
commitc6afd2bdfd69e9a8d2c0c7c41aac5255e34a60bc (patch)
tree61462037db7fb05ceca425ac55982dfa62b72b58 /docs/devel/index-api.rst
parentb8003f99565c9d7862938c586fecd1d9a56ee22d (diff)
downloadfocaccia-qemu-c6afd2bdfd69e9a8d2c0c7c41aac5255e34a60bc.tar.gz
focaccia-qemu-c6afd2bdfd69e9a8d2c0c7c41aac5255e34a60bc.zip
docs/devel: try and impose some organisation
We have a growing set of developer docs but the index is currently in
order of when stuff was added. Try and make things a bit easier to
find my adding sub indexes and organising into themes.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org>
Diffstat (limited to 'docs/devel/index-api.rst')
-rw-r--r--docs/devel/index-api.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/devel/index-api.rst b/docs/devel/index-api.rst
new file mode 100644
index 0000000000..b749240272
--- /dev/null
+++ b/docs/devel/index-api.rst
@@ -0,0 +1,15 @@
+Internal QEMU APIs
+------------------
+
+Details about how QEMU's various internal APIs. Most of these are
+generated from in-code annotations to function prototypes.
+
+.. toctree::
+   :maxdepth: 2
+   :includehidden:
+
+   bitops
+   loads-stores
+   memory
+   modules
+   ui