From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org, "Jiri Pirko" <jiri@resnulli.us>,
"Fan Ni" <fan.ni@samsung.com>,
"Stefano Garzarella" <sgarzare@redhat.com>,
"Michael Roth" <michael.roth@amd.com>,
"Gonglei (Arei)" <arei.gonglei@huawei.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
qemu-block@nongnu.org, "Daniel P. Berrangé" <berrange@redhat.com>,
"Jonathan Cameron" <jonathan.cameron@huawei.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Kashyap Chamarthy" <kchamart@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Hanna Reitz" <hreitz@redhat.com>, "Mads Ynddal" <mads@ynddal.dk>,
"Ani Sinha" <anisinha@redhat.com>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"Kevin Wolf" <kwolf@redhat.com>, "Eric Blake" <eblake@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>,
"Peter Xu" <peterx@redhat.com>, "Cleber Rosa" <crosa@redhat.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Konstantin Kostiuk" <kkostiuk@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Alex Williamson" <alex.williamson@redhat.com>,
"Zhenwei Pi" <pizhenwei@bytedance.com>,
"Jason Wang" <jasowang@redhat.com>,
"Lukas Straub" <lukasstraub2@web.de>
Subject: Re: [PATCH v3 5/5] qapi: lift restriction on using '=' in doc blocks
Date: Fri, 27 Jun 2025 11:41:15 +0200 [thread overview]
Message-ID: <87cyapo72c.fsf@pond.sub.org> (raw)
In-Reply-To: <20250618165353.1980365-6-jsnow@redhat.com> (John Snow's message of "Wed, 18 Jun 2025 12:53:53 -0400")
John Snow <jsnow@redhat.com> writes:
Let's explain why. Here's my attempt:
We reject lines starting with '=' in definition documentation. This
made sense when such lines were headings in free-form documentation,
but not in definition documentation.
Before the previous commit, lines starting with '=' were headings in
free-form documentation, and rejected in definition documentation,
where such headings could not work.
The previous commit dropped the headings feature from free-form
documentation, because we can simply use plain rST headings.
Rejecting them in definition documentation no longer makes sense, so
drop that, too.
> Signed-off-by: John Snow <jsnow@redhat.com>
next prev parent reply other threads:[~2025-06-27 9:41 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-18 16:53 [PATCH v3 0/5] docs: remove legacy qapidoc John Snow
2025-06-18 16:53 ` [PATCH v3 1/5] docs/sphinx: adjust qapidoc to cope with same-line error sections John Snow
2025-06-30 12:23 ` Markus Armbruster
2025-07-14 7:24 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 2/5] docs/sphinx: parse @references in freeform text John Snow
2025-06-27 9:54 ` Markus Armbruster
2025-06-27 16:40 ` John Snow
2025-06-18 16:53 ` [PATCH v3 3/5] docs/sphinx: remove legacy QAPI manual generator John Snow
2025-06-27 9:53 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 4/5] docs/sphinx: remove special parsing for freeform sections John Snow
2025-06-27 9:52 ` Markus Armbruster
2025-06-27 16:44 ` John Snow
2025-06-27 16:49 ` John Snow
2025-06-30 12:32 ` Markus Armbruster
2025-07-14 7:20 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 5/5] qapi: lift restriction on using '=' in doc blocks John Snow
2025-06-27 9:41 ` Markus Armbruster [this message]
2025-07-14 8:09 ` [PATCH v3 0/5] docs: remove legacy qapidoc 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=87cyapo72c.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=alex.williamson@redhat.com \
--cc=anisinha@redhat.com \
--cc=arei.gonglei@huawei.com \
--cc=berrange@redhat.com \
--cc=clg@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=fan.ni@samsung.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=jiri@resnulli.us \
--cc=jonathan.cameron@huawei.com \
--cc=jsnow@redhat.com \
--cc=kchamart@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=mads@ynddal.dk \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=pizhenwei@bytedance.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=sgarzare@redhat.com \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stefanha@redhat.com \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--cc=zhao1.liu@intel.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 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.