067109a11c
docs/devel: mention the spacing requirement for QOM
...
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 >
Reviewed-by: Juan Quintela <quintela@redhat.com >
Reviewed-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk >
Message-Id: <20230424092249.58552-18-alex.bennee@linaro.org >
2023-04-27 14:58:51 +01:00
7a21bee2aa
misc: fix commonly doubled up words
...
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com >
Message-Id: <20220707163720.1421716-5-berrange@redhat.com >
Reviewed-by: Peter Maydell <peter.maydell@linaro.org >
Signed-off-by: Thomas Huth <thuth@redhat.com >
2022-08-01 11:58:02 +02:00
28053143ab
docs/devel: fix description of OBJECT_DECLARE_SIMPLE_TYPE
...
Since 30b5707c26alex.bennee@linaro.org >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Message-Id: <20220725140520.515340-13-alex.bennee@linaro.org >
2022-07-29 09:48:01 +01:00
e95b135f88
modules: add module_obj() note to QOM docs
...
Signed-off-by: Gerd Hoffmann <kraxel@redhat.com >
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com >
Reviewed-by: Jose R. Ziviani <jziviani@suse.de >
Message-Id: <20210624103836.2382472-23-kraxel@redhat.com >
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com >
2021-07-09 18:20:27 +02:00
38a0d5bcde
docs/devel/qom: Avoid long lines
...
Long code lines don't look good in the rendered documents, make
them shorter.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com >
Message-Id: <20201003025424.199291-7-ehabkost@redhat.com >
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
2020-10-06 11:09:35 -04:00
acc34c2144
docs/devel/qom: Use *emphasis* for emphasis
...
<emphasis> is not valid reST syntax.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com >
Message-Id: <20201003025424.199291-5-ehabkost@redhat.com >
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
2020-10-06 11:09:35 -04:00
671b3db056
docs/devel/qom: Fix indentation of code blocks
...
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 >
2020-10-06 11:09:35 -04:00
258c732769
docs/devel/qom: Fix indentation of bulleted list
...
The list was incorrectly parsed as a literal block due to
indentation.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com >
Message-Id: <20201003025424.199291-3-ehabkost@redhat.com >
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
2020-10-06 11:09:35 -04:00
9cb54b18e8
docs: Move object.h overview doc comment to qom.rst
...
Move the whole contents of the overview doc comment from object.h
to qom.rst.
This makes the documentation source easier to read and edit, and
also solves the backslash escaping issue at the typecasting macro
examples.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
Message-Id: <20200910221526.10041-10-ehabkost@redhat.com >
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com >
2020-09-30 19:11:36 +02:00
cd442a45db
docs: Create docs/devel/qom.rst
...
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com >
Message-Id: <20200910221526.10041-9-ehabkost@redhat.com >
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com >
2020-09-30 19:11:36 +02:00
