Skip to content

Commit

Permalink
docs/devel: split qom-api reference into new file
Browse files Browse the repository at this point in the history
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: <20230630180423.558337-27-alex.bennee@linaro.org>
  • Loading branch information
stsquad committed Jul 3, 2023
1 parent 307c0a4 commit da966a8
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/devel/index-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ generated from in-code annotations to function prototypes.
loads-stores
memory
modules
qom-api
qdev-api
ui
zoned-storage
7 changes: 7 additions & 0 deletions docs/devel/qdev-api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _qdev-api:

================================
QEMU Device (qdev) API Reference
================================

.. kernel-doc:: include/hw/qdev-core.h
9 changes: 9 additions & 0 deletions docs/devel/qom-api.rst
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion docs/devel/qom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit da966a8

Please sign in to comment.