From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>
Subject: [PULL 13/21] docs/devel/qom: Fix indentation of code blocks
Date: Mon, 5 Oct 2020 17:09:52 -0400 [thread overview]
Message-ID: <20201005211000.710404-14-ehabkost@redhat.com> (raw)
In-Reply-To: <20201005211000.710404-1-ehabkost@redhat.com>
Some code blocks had one extra space, fix that.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20201003025424.199291-4-ehabkost@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
docs/devel/qom.rst | 76 +++++++++++++++++++++++-----------------------
1 file changed, 38 insertions(+), 38 deletions(-)
diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index c4857d95c8e..a47e1b9a239 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -284,28 +284,28 @@ in the header file:
.. code-block:: c
:caption: Declaring a simple type
- OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
+ OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
This is equivalent to the following:
.. code-block:: c
:caption: Expansion from declaring a simple type
- typedef struct MyDevice MyDevice;
- typedef struct MyDeviceClass MyDeviceClass;
+ typedef struct MyDevice MyDevice;
+ typedef struct MyDeviceClass MyDeviceClass;
- G_DEFINE_AUTOPTR_CLEANUP_FUNC(MyDeviceClass, object_unref)
+ G_DEFINE_AUTOPTR_CLEANUP_FUNC(MyDeviceClass, object_unref)
- #define MY_DEVICE_GET_CLASS(void *obj) \
- OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE)
- #define MY_DEVICE_CLASS(void *klass) \
- OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE)
- #define MY_DEVICE(void *obj)
- OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE)
+ #define MY_DEVICE_GET_CLASS(void *obj) \
+ OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE)
+ #define MY_DEVICE_CLASS(void *klass) \
+ OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE)
+ #define MY_DEVICE(void *obj)
+ OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE)
- struct MyDeviceClass {
- DeviceClass parent_class;
- };
+ struct MyDeviceClass {
+ DeviceClass parent_class;
+ };
The 'struct MyDevice' needs to be declared separately.
If the type requires virtual functions to be declared in the class
@@ -319,33 +319,33 @@ In the simple case the OBJECT_DEFINE_TYPE macro is suitable:
.. code-block:: c
:caption: Defining a simple type
- OBJECT_DEFINE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
+ OBJECT_DEFINE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
This is equivalent to the following:
.. code-block:: c
:caption: Expansion from defining a simple type
- static void my_device_finalize(Object *obj);
- static void my_device_class_init(ObjectClass *oc, void *data);
- static void my_device_init(Object *obj);
-
- static const TypeInfo my_device_info = {
- .parent = TYPE_DEVICE,
- .name = TYPE_MY_DEVICE,
- .instance_size = sizeof(MyDevice),
- .instance_init = my_device_init,
- .instance_finalize = my_device_finalize,
- .class_size = sizeof(MyDeviceClass),
- .class_init = my_device_class_init,
- };
-
- static void
- my_device_register_types(void)
- {
- type_register_static(&my_device_info);
- }
- type_init(my_device_register_types);
+ static void my_device_finalize(Object *obj);
+ static void my_device_class_init(ObjectClass *oc, void *data);
+ static void my_device_init(Object *obj);
+
+ static const TypeInfo my_device_info = {
+ .parent = TYPE_DEVICE,
+ .name = TYPE_MY_DEVICE,
+ .instance_size = sizeof(MyDevice),
+ .instance_init = my_device_init,
+ .instance_finalize = my_device_finalize,
+ .class_size = sizeof(MyDeviceClass),
+ .class_init = my_device_class_init,
+ };
+
+ static void
+ my_device_register_types(void)
+ {
+ type_register_static(&my_device_info);
+ }
+ type_init(my_device_register_types);
This is sufficient to get the type registered with the type
system, and the three standard methods now need to be implemented
@@ -358,9 +358,9 @@ This accepts an array of interface type names.
.. code-block:: c
:caption: Defining a simple type implementing interfaces
- OBJECT_DEFINE_TYPE_WITH_INTERFACES(MyDevice, my_device,
- MY_DEVICE, DEVICE,
- { TYPE_USER_CREATABLE }, { NULL })
+ OBJECT_DEFINE_TYPE_WITH_INTERFACES(MyDevice, my_device,
+ MY_DEVICE, DEVICE,
+ { TYPE_USER_CREATABLE }, { NULL })
If the type is not intended to be instantiated, then then
the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead:
@@ -368,7 +368,7 @@ the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead:
.. code-block:: c
:caption: Defining a simple abstract type
- OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
+ OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE)
--
2.26.2
next prev parent reply other threads:[~2020-10-05 21:20 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 21:09 [PULL 00/21] machine + QOM queue, 2020-10-05 Eduardo Habkost
2020-10-05 21:09 ` [PULL 01/21] numa: hmat: require parent cache description before the next level one Eduardo Habkost
2020-10-05 21:09 ` [PULL 02/21] hw/core/qdev-properties: Use qemu_strtol() in set_mac() handler Eduardo Habkost
2020-10-05 21:09 ` [PULL 03/21] hw/core/qdev-properties: Use qemu_strtoul() in set_pci_host_devaddr() Eduardo Habkost
2020-10-05 21:09 ` [PULL 04/21] hw/core/qdev-properties: Fix code style Eduardo Habkost
2020-10-05 21:09 ` [PULL 05/21] hw/core/qdev-properties: Export enum-related functions Eduardo Habkost
2020-10-05 21:09 ` [PULL 06/21] hw/core/qdev-properties: Export qdev_prop_enum Eduardo Habkost
2020-10-05 21:09 ` [PULL 07/21] hw/core/qdev-properties: Export some integer-related functions Eduardo Habkost
2020-10-05 21:09 ` [PULL 08/21] hw/core/qdev-properties: Extract system-mode specific properties Eduardo Habkost
2020-10-05 21:09 ` [PULL 09/21] hw/core/cpu: Add missing 'exec/cpu-common.h' include Eduardo Habkost
2020-10-05 21:09 ` [PULL 10/21] qom: Improve error message displayed with missing object properties Eduardo Habkost
2020-10-05 21:09 ` [PULL 11/21] qom: Fix DECLARE_*CHECKER documentation Eduardo Habkost
2020-10-05 21:09 ` [PULL 12/21] docs/devel/qom: Fix indentation of bulleted list Eduardo Habkost
2020-10-05 21:09 ` Eduardo Habkost [this message]
2020-10-05 21:09 ` [PULL 14/21] docs/devel/qom: Use *emphasis* for emphasis Eduardo Habkost
2020-10-05 21:09 ` [PULL 15/21] docs/devel/qom: Remove usage of <code> Eduardo Habkost
2020-10-05 21:09 ` [PULL 16/21] docs/devel/qom: Avoid long lines Eduardo Habkost
2020-10-05 21:09 ` [PULL 17/21] kernel-doc: Handle function typedefs that return pointers Eduardo Habkost
2020-10-05 21:09 ` [PULL 18/21] kernel-doc: Handle function typedefs without asterisks Eduardo Habkost
2020-10-05 21:09 ` [PULL 19/21] qom: Explicitly tag doc comments for typedefs and structs Eduardo Habkost
2020-10-05 21:09 ` [PULL 20/21] memory: Explicitly tag doc comments for structs Eduardo Habkost
2020-10-05 21:10 ` [PULL 21/21] kernel-doc: Remove $decl_type='type name' hack Eduardo Habkost
2020-10-06 14:03 ` [PULL 00/21] machine + QOM queue, 2020-10-05 Peter Maydell
2020-10-06 14:36 ` Eduardo Habkost
2020-10-06 14:38 ` Peter Maydell
2020-10-06 14:42 ` Daniel P. Berrangé
2020-10-06 18:47 ` Thomas Huth
2020-10-06 19:10 ` Paolo Bonzini
2020-10-07 9:10 ` Daniel P. Berrangé
2020-10-07 8:17 ` Daniel P. Berrangé
2020-10-06 14:41 ` Paolo Bonzini
2020-10-06 15:04 ` Igor Mammedov
2020-10-06 15:23 ` Igor Mammedov
2020-10-06 15:42 ` Paolo Bonzini
2020-10-06 16:14 ` Igor Mammedov
2020-10-06 18:43 ` Thomas Huth
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=20201005211000.710404-14-ehabkost@redhat.com \
--to=ehabkost@redhat.com \
--cc=berrange@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).