[PULL,26/48] modules: add module_obj() note to QOM docs

Commit Message

Paolo Bonzini July 8, 2021, 3:17 p.m. UTC

From: Gerd Hoffmann <[e-mail]>

Signed-off-by: Gerd Hoffmann <[e-mail]>
Reviewed-by: Paolo Bonzini <[e-mail]>
Reviewed-by: Jose R. Ziviani <[e-mail]>
Message-Id: <[e-mail]>
Signed-off-by: Paolo Bonzini <[e-mail]>
---
 docs/devel/qom.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Patch

diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index 42d0dc4f4d..e5fe3597cd 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -87,6 +87,14 @@  specific type:
    #define MY_DEVICE(obj) \
       OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE)
 
+In case the ObjectClass implementation can be built as module a
+module_obj() line must be added to make sure qemu loads the module
+when the object is needed.
+
+.. code-block:: c
+
+   module_obj(TYPE_MY_DEVICE);
+
 Class Initialization
 ====================