From: Markus Armbruster <armbru@redhat.com>
To: David Hildenbrand <david@redhat.com>
Cc: qemu-devel@nongnu.org,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Kevin Wolf" <kwolf@redhat.com>,
"Hanna Czenczek" <hreitz@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Marcel Apfelbaum" <marcel@redhat.com>,
"Jiri Pirko" <jiri@resnulli.us>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: Re: Let's close member documentation gaps
Date: Mon, 25 Mar 2024 15:36:05 +0100 [thread overview]
Message-ID: <87zfumjs4q.fsf@pond.sub.org> (raw)
In-Reply-To: <1dba9f83-4e2e-451f-8523-c19340b6fdcf@redhat.com> (David Hildenbrand's message of "Mon, 25 Mar 2024 15:14:31 +0100")
David Hildenbrand <david@redhat.com> writes:
> On 25.03.24 15:13, David Hildenbrand wrote:
>> On 25.03.24 10:36, Markus Armbruster wrote:
>>> If you're cc'ed, I have a bit of doc work for you. Search for your
>>> name to find it.
>>>
>>> The QAPI generator forces you to document your stuff. Except for
>>> commands, events, enum and object types listed in pragma
>>> documentation-exceptions, the generator silently defaults missing
>>> documentation to "Not documented". Right now, we're using this loophole
>>> some 500 times.
>>>
>> What would be the right step to make sure I am resolving these "hidden"
>> issues, and that the QAPI generator would be happy with my changes?
>
> Ah, I assume simply removing the offender from "qapi/pragma.json" and then compiling.
Correct!
next prev parent reply other threads:[~2024-03-25 14:37 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-25 9:36 Let's close member documentation gaps Markus Armbruster
2024-03-25 14:13 ` David Hildenbrand
2024-03-25 14:14 ` David Hildenbrand
2024-03-25 14:36 ` Markus Armbruster [this message]
2024-03-26 8:27 ` Markus Armbruster
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=87zfumjs4q.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=david@redhat.com \
--cc=hreitz@redhat.com \
--cc=jiri@resnulli.us \
--cc=kwolf@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel@redhat.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
/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.