[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 8/9] docs/devel: mention the spacing requirement for QOM
From: |
Philippe Mathieu-Daudé |
Subject: |
Re: [PATCH 8/9] docs/devel: mention the spacing requirement for QOM |
Date: |
Fri, 21 Apr 2023 08:15:17 +0200 |
User-agent: |
Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0) Gecko/20100101 Thunderbird/102.10.0 |
On 20/4/23 21:32, Mark Cave-Ayland wrote:
On 20/04/2023 16:57, Alex Bennée wrote:
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(+)
A couple of points:
1) It is probably worth removing the typedefs given that they are
handled by the various QOM macros
2) There should be mention of the fixed names "parent_obj" and
"parent_class" for
the first declaration.
How about something like this:
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
s/should/must/
that declaration and the new code.
For a storage structure the first declaration should always be called
"parent_obj" and for a class structure the first member should always
be called "parent_class" as below:
.. code-block:: c
struct MyDeviceState {
DeviceState parent_obj;
/* Properties */
int prop_a;
char *prob_b;
Should we mention "We recommend placing instance/class properties fields
just after the parent field"?
/* Other stuff */
int internal_state;
};
struct MyDeviceClass {
DeviceClass parent_class;
void (*new_fn1)(void);
bool (*new_fn2)(CPUState *);
};
Note that there is no need to provide typedefs for QOM structures since
these are generated automatically by the QOM declaration macros. See
:ref:`qom` for more details.
ATB,
Mark.
- Re: [PATCH 1/9] docs/devel/kconfig.rst: Fix incorrect markup, (continued)
- [PATCH 4/9] docs/cxl: Fix sentence, Alex Bennée, 2023/04/20
- [PATCH 2/9] qemu-options.hx: Update descriptions of memory options for NUMA node, Alex Bennée, 2023/04/20
- [PATCH 7/9] docs/devel: make a statement about includes, Alex Bennée, 2023/04/20
- [PATCH 8/9] docs/devel: mention the spacing requirement for QOM, Alex Bennée, 2023/04/20
- Re: [PATCH 8/9] docs/devel: mention the spacing requirement for QOM, Juan Quintela, 2023/04/20
- [PATCH 6/9] docs/system: remove excessive punctuation from guest-loader docs, Alex Bennée, 2023/04/20
- [PATCH 3/9] docs: Fix typo (wphx => whpx), Alex Bennée, 2023/04/20
- [PATCH 9/9] docs/style: call out the use of GUARD macros, Alex Bennée, 2023/04/20