From: Eduardo Habkost <ehabkost@redhat.com>
To: Paolo Bonzini <pbonzini@redhat.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards
Date: Fri, 2 Oct 2020 15:18:31 -0400 [thread overview]
Message-ID: <20201002191831.GH7303@habkost.net> (raw)
In-Reply-To: <e63e073b-31b3-590d-2f9b-e871c9677448@redhat.com>
On Fri, Oct 02, 2020 at 08:50:22PM +0200, Paolo Bonzini wrote:
> On 02/10/20 20:46, Eduardo Habkost wrote:
> > This is not the code that parses "#MemoryRegionSection", it is
> > the code that parses:
> >
> > /**
> > * MemoryRegionSection: describes a fragment of a #MemoryRegion
> > ^^^^^^^ this line
>
> We can probably just adjust the comments to include the "struct" keyword
> first. There aren't that many, (un)fortunately.
>
> It may even be possible to print to stderr the file and line number so
> that the script tells us where the hack is firing.
>
There are 3 lines where the hack is correctly triggered, but we
can just change it to use "struct MyTypeName" instead:
include/exec/memory.h:681: HERE
include/exec/memory.h:699: HERE
include/exec/memory.h:743: HERE
And 29 lines where it's probably being triggered by mistake:
include/qom/object.h:47: HERE
include/qom/object.h:66: HERE
include/qom/object.h:78: HERE
include/qom/object.h:87: HERE
include/qom/object.h:110: HERE
include/qom/object.h:118: HERE
include/qom/object.h:140: HERE
include/qom/object.h:162: HERE
include/qom/object.h:179: HERE
include/qom/object.h:200: HERE
include/qom/object.h:218: HERE
include/qom/object.h:241: HERE
include/qom/object.h:259: HERE
include/qom/object.h:313: HERE
include/qom/object.h:330: HERE
include/qom/object.h:353: HERE
include/qom/object.h:370: HERE
include/qom/object.h:432: HERE
include/qom/object.h:442: HERE
include/qom/object.h:452: HERE
include/qom/object.h:469: HERE
include/qom/object.h:483: HERE
include/qom/object.h:496: HERE
include/qom/object.h:506: HERE
include/qom/object.h:521: HERE
include/qom/object.h:531: HERE
include/qom/object.h:543: HERE
include/qom/object.h:861: HERE
--
Eduardo
next prev parent reply other threads:[~2020-10-02 19:19 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-29 14:02 [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build Paolo Bonzini
2019-11-29 14:02 ` [PATCH 1/8] docs: import Linux kernel-doc script and extension Paolo Bonzini
2019-12-02 17:50 ` Peter Maydell
2019-11-29 14:02 ` [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards Paolo Bonzini
2019-12-02 18:01 ` Peter Maydell
2019-12-02 18:17 ` Paolo Bonzini
2020-10-02 18:34 ` Eduardo Habkost
2020-10-02 18:43 ` Peter Maydell
2020-10-02 18:46 ` Eduardo Habkost
2020-10-02 18:50 ` Paolo Bonzini
2020-10-02 19:18 ` Eduardo Habkost [this message]
2019-11-29 14:02 ` [PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension Paolo Bonzini
2019-11-29 14:02 ` [PATCH 4/8] Makefile: disable Sphinx nitpicking Paolo Bonzini
2019-11-29 14:02 ` [PATCH 5/8] bitops.h: Silence kernel-doc complaints Paolo Bonzini
2019-11-29 14:02 ` [PATCH 6/8] docs: Create bitops.rst as example of kernel-docs Paolo Bonzini
2019-11-29 14:02 ` [PATCH 7/8] memory.h: Silence kernel-doc complaints Paolo Bonzini
2019-12-02 18:04 ` Peter Maydell
2019-11-29 14:02 ` [PATCH 8/8] docs: add memory API reference Paolo Bonzini
2019-12-02 18:05 ` Peter Maydell
2019-11-30 1:54 ` [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build no-reply
2019-12-02 18:06 ` Peter Maydell
2019-12-02 18:13 ` 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=20201002191831.GH7303@habkost.net \
--to=ehabkost@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.