From: Peter Maydell <peter.maydell@linaro.org>
To: Eduardo Habkost <ehabkost@redhat.com>
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"QEMU Developers" <qemu-devel@nongnu.org>
Subject: Re: [PATCH for-6.2 06/10] docs: qom: Remove unnecessary class typedefs from example
Date: Wed, 4 Aug 2021 21:45:07 +0100 [thread overview]
Message-ID: <CAFEAcA88WZC8WUaOcUYpCEkH4jx3ds3C4FXM_WytbPeaC0zhgA@mail.gmail.com> (raw)
In-Reply-To: <20210804204029.5am76o3rh6uhrwgh@habkost.net>
On Wed, 4 Aug 2021 at 21:40, Eduardo Habkost <ehabkost@redhat.com> wrote:
>
> On Mon, Aug 02, 2021 at 01:19:14PM +0100, Peter Maydell wrote:
> > On Thu, 29 Jul 2021 at 19:01, Eduardo Habkost <ehabkost@redhat.com> wrote:
> > >
> > > When there's no specific class struct used for a QOM type, we
> > > normally don't define a typedef for it. Remove the typedef from
> > > the minimal example, as it is unnecessary.
> > Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> >
> > though I agree with Daniel that in the long-term we should reverse
> > the structure of the documents so the recommended macros go first
> > and the behind-the-scenes boilerplate last.
>
> I agree 100%, and maybe I will give it a try later.
>
> My immediate goal was to just remove the examples in the docs
> where type checking macros were defined manually. Since we
> introduced the new QOM helper macros, the number of OBJECT_CHECK
> macros in the QEMU tree almost doubled (from 40 in commit
> 8110fa1d94f2 to 75 in commit bccabb3a5d60).
Yeah, to be clear, I'm all in favour of changes like this patchset
and don't think we should hold them up because we have a theoretical
larger restructuring of the documentation we might one day (or never)
get round to.
-- PMM
next prev parent reply other threads:[~2021-08-04 20:47 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-29 17:55 [PATCH for-6.2 00/10] QOM documentation updates Eduardo Habkost
2021-07-29 17:55 ` [PATCH for-6.2 01/10] docs: qom: Replace old GTK-Doc #symbol syntax with `symbol` Eduardo Habkost
2021-08-02 12:14 ` Peter Maydell
2021-08-04 20:31 ` Eduardo Habkost
2021-08-04 20:42 ` Peter Maydell
2021-08-04 21:00 ` Eduardo Habkost
2021-08-05 0:26 ` John Snow
2021-08-05 16:36 ` Eduardo Habkost
2021-08-05 19:07 ` Eduardo Habkost
2021-07-29 17:55 ` [PATCH for-6.2 02/10] docs: qom: Use Sphinx cross references more often Eduardo Habkost
2021-07-29 17:55 ` [PATCH for-6.2 03/10] docs: qom: Fix autoptr expansion example Eduardo Habkost
2021-08-02 12:16 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 04/10] docs: qom: Fix "API Reference" heading level Eduardo Habkost
2021-08-02 12:16 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 05/10] docs: qom: Add subsection headings to declaration/definition macros section Eduardo Habkost
2021-07-30 13:15 ` Philippe Mathieu-Daudé
2021-08-02 12:17 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 06/10] docs: qom: Remove unnecessary class typedefs from example Eduardo Habkost
2021-07-30 8:16 ` Markus Armbruster
2021-07-30 8:43 ` Peter Maydell
2021-07-30 9:19 ` Daniel P. Berrangé
2021-08-02 12:19 ` Peter Maydell
2021-08-04 20:40 ` Eduardo Habkost
2021-08-04 20:45 ` Peter Maydell [this message]
2021-07-29 17:55 ` [PATCH for-6.2 07/10] docs: qom: Fix OBJECT_DECLARE_SIMPLE_TYPE documentation Eduardo Habkost
2021-08-02 12:24 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 08/10] docs: qom: Show actual typecast functions in examples Eduardo Habkost
2021-08-02 12:25 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 09/10] docs: qom: Remove OBJECT_CHECK macro examples Eduardo Habkost
2021-08-02 12:27 ` Peter Maydell
2021-07-29 17:55 ` [PATCH for-6.2 10/10] MAINTAINERS: Add qom.rst to QOM section Eduardo Habkost
2021-08-02 12:28 ` Peter Maydell
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=CAFEAcA88WZC8WUaOcUYpCEkH4jx3ds3C4FXM_WytbPeaC0zhgA@mail.gmail.com \
--to=peter.maydell@linaro.org \
--cc=berrange@redhat.com \
--cc=ehabkost@redhat.com \
--cc=pbonzini@redhat.com \
--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).