From: John Snow <jsnow@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>,
Markus Armbruster <armbru@redhat.com>
Cc: "Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>,
"Gabriel Barreto" <sbarreto.gabriel@gmail.com>,
"QEMU Developers" <qemu-devel@nongnu.org>,
"Emilio G. Cota" <cota@braap.org>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>
Subject: Re: [Qemu-devel] Introducing GSoC project: API Documentation Generation
Date: Tue, 21 May 2019 16:32:35 -0400 [thread overview]
Message-ID: <7e468375-ca5f-0048-789e-c41d09065eeb@redhat.com> (raw)
In-Reply-To: <CAFEAcA8db=UsyU_kRBoatFT2ULQBqL318xRhg+CV4D_7hV76Og@mail.gmail.com>
On 5/21/19 11:27 AM, Peter Maydell wrote:
> On Tue, 21 May 2019 at 16:18, Markus Armbruster <armbru@redhat.com> wrote:
>> Anyway. What's so special about QEMU that justifies coming up with our
>> own doc syntax? Other than "we made a hash of it, and cleaning it up
>> would be work".
>
> The major problem as far as kernel-doc is concerned is that
> it somewhat bakes in the kernel's style choice that the
> 'struct' keyword is not hidden behind typedefs, and so it
> gets a bit confused by QEMU's "use typedefs for struct types"
> style. The rest, as you say, is just a matter of fixing up
> our syntax errors.
>
> thanks
> -- PMM
>
But this is the one we're going with? Do we have a plan for teaching it
not to panic for our use of named custom types?
--js
next prev parent reply other threads:[~2019-05-21 20:46 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-20 18:41 [Qemu-devel] Introducing GSoC project: API Documentation Generation Eduardo Habkost
2019-05-20 18:48 ` John Snow
2019-05-21 8:53 ` Daniel P. Berrangé
2019-05-21 9:43 ` Peter Maydell
2019-05-21 11:06 ` Daniel P. Berrangé
2019-05-21 10:55 ` Paolo Bonzini
2019-05-21 15:18 ` Markus Armbruster
2019-05-21 15:25 ` Daniel P. Berrangé
2019-05-21 15:27 ` Peter Maydell
2019-05-21 17:14 ` Paolo Bonzini
2019-05-21 20:32 ` John Snow [this message]
2019-05-21 20:37 ` Eduardo Habkost
2019-05-22 8:20 ` Paolo Bonzini
2019-05-23 12:20 ` John Snow
2019-05-24 18:34 ` Paolo Bonzini
2019-05-24 19:08 ` Eduardo Habkost
2019-05-24 20:02 ` Paolo Bonzini
2019-05-21 16:17 ` Eduardo Habkost
2019-05-21 17:14 ` Paolo Bonzini
2019-05-21 9:42 ` Peter Maydell
2019-05-21 11:01 ` 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=7e468375-ca5f-0048-789e-c41d09065eeb@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=cota@braap.org \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=sbarreto.gabriel@gmail.com \
--cc=stefanha@redhat.com \
/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).