[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
fixup! docs: Move object.h overview doc comment to qom.rst
|
From: |
Eduardo Habkost |
|
Subject: |
fixup! docs: Move object.h overview doc comment to qom.rst |
|
Date: |
Thu, 10 Sep 2020 20:23:33 -0400 |
On Thu, Sep 10, 2020 at 06:15:26PM -0400, Eduardo Habkost wrote:
> 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>
Fixup for a bug I introduced accidentally before sending the
series.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index 2070a2ced4..1a2e5dc661 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -80,7 +80,7 @@ specific type:
.. code-block::
:caption: Typecasting macros
-#define MY_DEVICE_GET_CLASS(obj) \
+ #define MY_DEVICE_GET_CLASS(obj) \
OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE)
#define MY_DEVICE_CLASS(klass) \
OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE)
--
Eduardo
- [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx, Eduardo Habkost, 2020/09/10
- [PATCH 1/9] qom: Document all function parameters in doc comments, Eduardo Habkost, 2020/09/10
- [PATCH 2/9] qom: Use kernel-doc private/public tags in structs, Eduardo Habkost, 2020/09/10
- [PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate, Eduardo Habkost, 2020/09/10
- [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment, Eduardo Habkost, 2020/09/10
- [PATCH 5/9] qom: Reformat section titles using Sphinx syntax, Eduardo Habkost, 2020/09/10
- [PATCH 7/9] qom: Add code block markup to all code blocks, Eduardo Habkost, 2020/09/10
- [PATCH 6/9] qom: Indent existing code examples, Eduardo Habkost, 2020/09/10
- [PATCH 8/9] docs: Create docs/devel/qom.rst, Eduardo Habkost, 2020/09/10
- [PATCH 9/9] docs: Move object.h overview doc comment to qom.rst, Eduardo Habkost, 2020/09/10
- fixup! docs: Move object.h overview doc comment to qom.rst,
Eduardo Habkost <=
- Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx, Paolo Bonzini, 2020/09/22