qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Elena Ufimtseva" <elena.ufimtseva@oracle.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	peter.maydell@linaro.org,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Thomas Huth" <thuth@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Alexandre Iooss" <erdnaxe@crans.org>,
	"John G Johnson" <john.g.johnson@oracle.com>,
	"Jagannathan Raman" <jag.raman@oracle.com>,
	"Juan Quintela" <quintela@redhat.com>,
	"Eduardo Habkost" <eduardo@habkost.net>,
	"Richard Henderson" <richard.henderson@linaro.org>,
	"Mahmoud Mandour" <ma.mandourr@gmail.com>,
	"Mark Cave-Ayland" <mark.cave-ayland@ilande.co.uk>
Subject: [PATCH 8/9] docs/devel: mention the spacing requirement for QOM
Date: Thu, 20 Apr 2023 16:57:22 +0100	[thread overview]
Message-ID: <20230420155723.1711048-9-alex.bennee@linaro.org> (raw)
In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org>

We have a more complete document on QOM but we should at least mention
the style requirements in the style guide.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Cc: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>
---
 docs/devel/qom.rst   |  2 ++
 docs/devel/style.rst | 29 +++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index 3e34b07c98..c9237950d0 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -1,3 +1,5 @@
+.. _qom:
+
 ===========================
 The QEMU Object Model (QOM)
 ===========================
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 5bc6f2f095..0bd01f3fca 100644
--- a/docs/devel/style.rst
+++ b/docs/devel/style.rst
@@ -628,6 +628,35 @@ are still some caveats to beware of
 QEMU Specific Idioms
 ********************
 
+QEMU Object Model Declarations
+==============================
+
+The QEMU Object Model (QOM) provides a framework for handling objects
+in the base C language. The first declaration of a storage or class
+structure should always be the parent and leave a visual space between
+that declaration and the new code.
+
+.. code-block:: c
+
+    typedef struct MyDeviceState {
+        DeviceState parent_obj;
+
+        /* Properties */
+        int prop_a;
+        char *prob_b;
+        /* Other stuff */
+        int internal_state;
+    } MyDeviceState;
+
+    typedef struct MyDeviceClass {
+        ObjectClass parent_class;
+
+        void (*new_fn1)(void);
+        bool (*new_fn2)(CPUState *);
+   } MyDeviceClass;
+
+See :ref:`qom` for more details.
+
 Error handling and reporting
 ============================
 
-- 
2.39.2



  parent reply	other threads:[~2023-04-20 15:58 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-20 15:57 [PATCH 0/9] docs: various (style, punctuation and typo fixes) Alex Bennée
2023-04-20 15:57 ` [PATCH 1/9] docs/devel/kconfig.rst: Fix incorrect markup Alex Bennée
2023-04-20 20:53   ` Juan Quintela
2023-04-20 15:57 ` [PATCH 2/9] qemu-options.hx: Update descriptions of memory options for NUMA node Alex Bennée
2023-04-20 20:55   ` Juan Quintela
2023-04-21  6:18   ` Philippe Mathieu-Daudé
2023-04-20 15:57 ` [PATCH 3/9] docs: Fix typo (wphx => whpx) Alex Bennée
2023-04-20 15:57 ` [PATCH 4/9] docs/cxl: Fix sentence Alex Bennée
2023-04-21 12:30   ` Jonathan Cameron via
2023-04-20 15:57 ` [PATCH 5/9] MAINTAINERS: Add Juan Quintela to developer guides review Alex Bennée
2023-04-20 15:57 ` [PATCH 6/9] docs/system: remove excessive punctuation from guest-loader docs Alex Bennée
2023-04-20 16:35   ` Thomas Huth
2023-04-20 20:56   ` Juan Quintela
2023-04-20 15:57 ` [PATCH 7/9] docs/devel: make a statement about includes Alex Bennée
2023-04-20 20:57   ` Juan Quintela
2023-04-20 15:57 ` Alex Bennée [this message]
2023-04-20 19:32   ` [PATCH 8/9] docs/devel: mention the spacing requirement for QOM Mark Cave-Ayland
2023-04-21  6:15     ` Philippe Mathieu-Daudé
2023-04-26  8:47       ` Mark Cave-Ayland
2023-04-20 20:58   ` Juan Quintela
2023-04-20 15:57 ` [PATCH 9/9] docs/style: call out the use of GUARD macros Alex Bennée
2023-04-20 20:58   ` Juan Quintela
2023-04-21  6:17   ` Philippe Mathieu-Daudé
2023-04-21  9:07   ` Vladimir Sementsov-Ogievskiy
2023-04-24  9:07     ` Alex Bennée
2023-04-24 12:58       ` Vladimir Sementsov-Ogievskiy
2023-04-20 16:05 ` [PATCH 0/9] docs: various (style, punctuation and typo fixes) Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230420155723.1711048-9-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=elena.ufimtseva@oracle.com \
    --cc=erdnaxe@crans.org \
    --cc=jag.raman@oracle.com \
    --cc=john.g.johnson@oracle.com \
    --cc=ma.mandourr@gmail.com \
    --cc=mark.cave-ayland@ilande.co.uk \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=philmd@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=quintela@redhat.com \
    --cc=richard.henderson@linaro.org \
    --cc=thuth@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).