[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 25/26] docs/devel: split qom-api reference into new file
From: |
Alex Bennée |
Subject: |
[PATCH 25/26] docs/devel: split qom-api reference into new file |
Date: |
Fri, 23 Jun 2023 13:20:59 +0100 |
Lets try and keep the overview of the sub-system digestible by
splitting the core API stuff into a separate file. As QOM and QDEV
work together we should also try and enumerate the qdev_ functions.
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20230619171437.357374-5-alex.bennee@linaro.org>
---
v2
- also include qdev API
---
docs/devel/index-api.rst | 2 ++
docs/devel/qdev-api.rst | 7 +++++++
docs/devel/qom-api.rst | 9 +++++++++
docs/devel/qom.rst | 3 ++-
4 files changed, 20 insertions(+), 1 deletion(-)
create mode 100644 docs/devel/qdev-api.rst
create mode 100644 docs/devel/qom-api.rst
diff --git a/docs/devel/index-api.rst b/docs/devel/index-api.rst
index 7108821746..539ad29c21 100644
--- a/docs/devel/index-api.rst
+++ b/docs/devel/index-api.rst
@@ -11,5 +11,7 @@ generated from in-code annotations to function prototypes.
loads-stores
memory
modules
+ qom-api
+ qdev-api
ui
zoned-storage
diff --git a/docs/devel/qdev-api.rst b/docs/devel/qdev-api.rst
new file mode 100644
index 0000000000..3f35eea025
--- /dev/null
+++ b/docs/devel/qdev-api.rst
@@ -0,0 +1,7 @@
+.. _qdev-api:
+
+================================
+QEMU Device (qdev) API Reference
+================================
+
+.. kernel-doc:: include/hw/qdev-core.h
diff --git a/docs/devel/qom-api.rst b/docs/devel/qom-api.rst
new file mode 100644
index 0000000000..ed1f17e797
--- /dev/null
+++ b/docs/devel/qom-api.rst
@@ -0,0 +1,9 @@
+.. _qom-api:
+
+=====================================
+QEMU Object Model (QOM) API Reference
+=====================================
+
+This is the complete API documentation for :ref:`qom`.
+
+.. kernel-doc:: include/qom/object.h
diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index 2828843058..c342ce18e3 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -387,4 +387,5 @@ OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead:
API Reference
-------------
-.. kernel-doc:: include/qom/object.h
+See the :ref:`QOM API<qom-api>` and :ref:`QDEV API<qdev-api>`
+documents for the complete API description.
--
2.39.2
- [PATCH 21/26] docs/devel: add some front matter to the devel index, (continued)
- [PATCH 21/26] docs/devel: add some front matter to the devel index, Alex Bennée, 2023/06/23
- [PATCH 20/26] plugins: update lockstep to use g_memdup2, Alex Bennée, 2023/06/23
- [PATCH 23/26] include/hw/qdev-core: fixup kerneldoc annotations, Alex Bennée, 2023/06/23
- [PATCH 17/26] tests/avocado: update firmware to enable sbsa-ref/max, Alex Bennée, 2023/06/23
- [PATCH 26/26] docs/devel: introduce some key concepts for QOM development, Alex Bennée, 2023/06/23
- [PATCH 18/26] plugins: force slow path when plugins instrument memory ops, Alex Bennée, 2023/06/23
- [PATCH 25/26] docs/devel: split qom-api reference into new file,
Alex Bennée <=