From: Paolo Bonzini <pbonzini@redhat.com>
To: Fam Zheng <famz@redhat.com>
Cc: Stefan Hajnoczi <stefanha@gmail.com>,
John Snow <jsnow@redhat.com>,
Peter Maydell <peter.maydell@linaro.org>,
QEMU Developers <qemu-devel@nongnu.org>,
Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: [Qemu-devel] Sphinx for QEMU docs? (and a doc-comment format question)
Date: Thu, 10 Nov 2016 05:08:03 -0500 (EST) [thread overview]
Message-ID: <1281860074.11905116.1478772483799.JavaMail.zimbra@redhat.com> (raw)
In-Reply-To: <20161110033914.GE8422@lemon>
----- Original Message -----
> From: "Fam Zheng" <famz@redhat.com>
> To: "Stefan Hajnoczi" <stefanha@gmail.com>
> Cc: "John Snow" <jsnow@redhat.com>, "Peter Maydell" <peter.maydell@linaro.org>, "QEMU Developers"
> <qemu-devel@nongnu.org>, "Stefan Hajnoczi" <stefanha@redhat.com>, "Paolo Bonzini" <pbonzini@redhat.com>
> Sent: Thursday, November 10, 2016 4:39:14 AM
> Subject: Re: [Qemu-devel] Sphinx for QEMU docs? (and a doc-comment format question)
>
> On Wed, 11/09 11:32, Stefan Hajnoczi wrote:
> > No doc comments -> error.
>
> I'm not sure that is a good idea. For example all .bdrv_co_flush_to_disk
> implementations have the same semantics and signature, requiring doc comments
> everywhere might be too much.
The check would be only on specific files. However, I find it hard to
implement it if we place doc comments for types in headers and those for
functions in .c files (with automatically generated docs, most of the
advantages of doc comments in headers go away).
Paolo
next prev parent reply other threads:[~2016-11-10 10:08 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-05 18:42 [Qemu-devel] Sphinx for QEMU docs? (and a doc-comment format question) Peter Maydell
2016-11-07 9:35 ` Daniel P. Berrange
2016-11-07 13:30 ` Stefan Hajnoczi
2016-11-07 13:41 ` Daniel P. Berrange
2016-11-07 13:49 ` Peter Maydell
2016-11-07 22:52 ` John Snow
2016-11-08 16:20 ` Stefan Hajnoczi
2016-11-08 16:24 ` John Snow
2016-11-09 11:32 ` Stefan Hajnoczi
2016-11-10 3:39 ` Fam Zheng
2016-11-10 9:55 ` Stefan Hajnoczi
2016-11-10 10:08 ` Paolo Bonzini [this message]
2016-11-10 10:55 ` Daniel P. Berrange
2016-11-08 23:56 ` Paolo Bonzini
2016-11-07 15:03 ` Peter Maydell
2016-11-07 17:04 ` Paolo Bonzini
2016-11-07 17:20 ` Peter Maydell
2016-11-07 17:50 ` Paolo Bonzini
2016-11-07 18:23 ` Peter Maydell
2016-11-07 19:43 ` Paolo Bonzini
2016-11-07 20:36 ` Peter Maydell
2016-11-08 5:02 ` Emilio G. Cota
2017-01-05 16:47 ` 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=1281860074.11905116.1478772483799.JavaMail.zimbra@redhat.com \
--to=pbonzini@redhat.com \
--cc=famz@redhat.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@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).