[PATCH v2 04/10] qapi: add "Details:" markers where 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 04/10] qapi: add "Details:" markers where needed
Posted by John Snow 3 days, 13 hours ago
Add additional "Details:" markers in places where doing so *currently*
impacts the rendered output order of documentation sections.

There are two cases where this is done:

(1) Where we insert stub/autogenerated documentation for
    members/args/etc and return information is dependent on the
    intro-details split location. Adding a "Details:" marker facilitates
    inserting this information in the middle of the documentation block
    instead of at the end.

    These are locations where we likely SHOULD have been using the
    "TODO:" hack which was formalized in the previous commit, but had
    not been.

(2) Cases where "Since:" currently behaves as the Intro/Details
    separation point, but in the wrong location. Since this edit changes
    the output, these changes are included in this patch as well. These
    locations are for HV_BALLOON_STATUS_REPORT, query-gic-capabilities,
    and query-sev.

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

---

[Review note: this patch DOES change the output of the *.ir files, but
intentionally for these locations. --js]

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qapi/block-core.json | 3 +++
 qapi/machine.json    | 2 ++
 qapi/misc-arm.json   | 2 ++
 qapi/misc-i386.json  | 2 ++
 qapi/qom.json        | 4 ++++
 qga/qapi-schema.json | 2 ++
 6 files changed, 15 insertions(+)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 508b081ac16..abdcddb0a09 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -5007,6 +5007,9 @@
 # @blockdev-reopen:
 #
 # Reopens one or more block devices using the given set of options.
+#
+# Details:
+#
 # Any option not specified will be reset to its default value
 # regardless of its previous status.  If an option cannot be changed
 # or a particular driver does not support reopening then the command
diff --git a/qapi/machine.json b/qapi/machine.json
index bc2279b2526..012f61e2a7e 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1223,6 +1223,8 @@
 # Emitted when the hv-balloon driver receives a "STATUS" message from
 # the guest.
 #
+# Details:
+#
 # .. note:: This event is rate-limited.
 #
 # Since: 8.2
diff --git a/qapi/misc-arm.json b/qapi/misc-arm.json
index 4dc66d00e5c..4e3f1a54055 100644
--- a/qapi/misc-arm.json
+++ b/qapi/misc-arm.json
@@ -33,6 +33,8 @@
 # It will return a list of `GICCapability` objects that describe its
 # capability bits.
 #
+# Details:
+#
 # On non-ARM targets this command will report an error as the GIC
 # technology is not applicable.
 #
diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json
index 05a94d6c416..c92853507f3 100644
--- a/qapi/misc-i386.json
+++ b/qapi/misc-i386.json
@@ -127,6 +127,8 @@
 #
 # Return information about SEV/SEV-ES/SEV-SNP.
 #
+# Details:
+#
 # If unavailable due to an incompatible configuration the returned
 # @enabled field is set to 'false' and the state of all other fields
 # is unspecified.
diff --git a/qapi/qom.json b/qapi/qom.json
index 1b47abd44e9..568b7d4b997 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -777,6 +777,8 @@
 #
 # Properties for memory-backend-shm objects.
 #
+# Details:
+#
 # This memory backend supports only shared memory, which is the
 # default.
 #
@@ -792,6 +794,8 @@
 #
 # Properties for memory-backend-epc objects.
 #
+# Details:
+#
 # The @merge boolean option is false by default with epc
 #
 # The @dump boolean option is false by default with epc
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index c57bc9a02f6..f2c17d08703 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -420,6 +420,8 @@
 #
 # Get guest fsfreeze state.
 #
+# Details:
+#
 # .. note:: This may fail to properly report the current state as a
 #    result of some other guest processes having issued an fs
 #    freeze/thaw.
-- 
2.53.0