[PATCH v2 05/10] qapi: add "Details:" markers where potentially needed

John Snow posted 10 patches 3 days, 13 hours ago
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, Pierrick Bouvier <pierrick.bouvier@linaro.org>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, "Daniel P. Berrangé" <berrange@redhat.com>, Kashyap Chamarthy <kchamart@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Stefano Garzarella <sgarzare@redhat.com>, John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, Richard Henderson <richard.henderson@linaro.org>, Paolo Bonzini <pbonzini@redhat.com>, Eric Blake <eblake@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Jiri Pirko <jiri@resnulli.us>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Stefan Hajnoczi <stefanha@redhat.com>, Alex Williamson <alex@shazbot.org>, "Cédric Le Goater" <clg@redhat.com>, Lukas Straub <lukasstraub2@web.de>, Kostiantyn Kostiuk <kkostiuk@redhat.com>
[PATCH v2 05/10] qapi: add "Details:" markers where potentially needed
Posted by John Snow 3 days, 13 hours ago
There are several locations within the QAPI source that are classified
as "Intro" text, even though semantically this is not true. Altering
these sections with an explicit Details: marker currently yields no
difference to rendered output. In the future, the inliner and/or the
addition of new stub sections *may* make these distinctions important.

These locations were identified using a heuristic patch to the QAPI doc
parser to emit a warning for Intro sections consisting of two or more
paragraphs without any other explicit section present in the source
code.

Signed-off-by: John Snow <jsnow@redhat.com>

---

[Review note: this patch does not change the *.ir output at all; there
is no visible difference whatsoever. The point of this patch is solely
to prevent yelping by the heuristic checker. It may or may not become
relevant later once the inliner is merged, I did not audit that far -
neither did I spend time attempting to improve the heuristic yelper,
believing "KISS". --js]

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qapi/migration.json | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/qapi/migration.json b/qapi/migration.json
index 2142f74e3c7..558b4f145ed 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1651,6 +1651,8 @@
 #
 # Xen uses this command to notify replication to trigger a checkpoint.
 #
+# Details:
+#
 # .. qmp-example::
 #
 #     -> { "execute": "xen-colo-do-checkpoint" }
@@ -1724,6 +1726,8 @@
 #
 # Pause a migration.  Currently it only supports postcopy.
 #
+# Details:
+#
 # .. qmp-example::
 #
 #     -> { "execute": "migrate-pause" }
-- 
2.53.0