All of lore.kernel.org
 help / color / mirror / Atom feed
From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Peter Maydell" <peter.maydell@linaro.org>
Subject: fixup! docs: Move object.h overview doc comment to qom.rst
Date: Thu, 10 Sep 2020 20:23:33 -0400	[thread overview]
Message-ID: <20200911002333.GP1618070@habkost.net> (raw)
In-Reply-To: <20200910221526.10041-10-ehabkost@redhat.com>

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



  reply	other threads:[~2020-09-11  0:24 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-10 22:15 [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx Eduardo Habkost
2020-09-10 22:15 ` [PATCH 1/9] qom: Document all function parameters in doc comments Eduardo Habkost
2020-09-10 22:15 ` [PATCH 2/9] qom: Use kernel-doc private/public tags in structs Eduardo Habkost
2020-09-10 22:15 ` [PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate Eduardo Habkost
2020-09-10 22:15 ` [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment Eduardo Habkost
2020-09-10 22:15 ` [PATCH 5/9] qom: Reformat section titles using Sphinx syntax Eduardo Habkost
2020-09-10 22:15 ` [PATCH 6/9] qom: Indent existing code examples Eduardo Habkost
2020-09-10 22:15 ` [PATCH 7/9] qom: Add code block markup to all code blocks Eduardo Habkost
2020-09-10 22:15 ` [PATCH 8/9] docs: Create docs/devel/qom.rst Eduardo Habkost
2020-09-10 22:15 ` [PATCH 9/9] docs: Move object.h overview doc comment to qom.rst Eduardo Habkost
2020-09-11  0:23   ` Eduardo Habkost [this message]
2020-09-22  9:38 ` [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx Paolo Bonzini

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=20200911002333.GP1618070@habkost.net \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.