]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi: remove trivial "Returns:" sections
authorJohn Snow <jsnow@redhat.com>
Fri, 11 Jul 2025 05:10:44 +0000 (01:10 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 14 Jul 2025 10:35:29 +0000 (12:35 +0200)
commit0462da9d6b1918c741c632f57d743d5851ec5983
tree260c6d6e864e92470671d1321df3a66ef96d3879
parent636c96cd77d39aaec3e1c09b9990b76b015566e1
qapi: remove trivial "Returns:" sections

The new qapidoc.py can generate "Returns" statements with type
information just fine, so we can remove it from the source where it
doesn't add anything particularly novel or helpful and just repeats the
type info.

This patch is fairly "gentle" and doesn't aggressively touch other
"Returns" lines that could be rephrased to omit repeating type
information; it only removes lines that appear appropriate to wholly
remove.

To help facilitate auto-generated placement, a few doc blocks have a
"TODO:" line inserted to help the placement algorithm differentiate the
introductory paragraph(s) from the rest of the documentation.

The auto-generated returns are in the exact same spot, except for
query-migrationthreads, query-machines, and
x-query-virtio-queue-element.  These auto-generation moves to a better
spot.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711051045.51110-4-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Two more Returns: removed, commit message amended to explain
auto-generated returns generated into a different spot]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
15 files changed:
qapi/audio.json
qapi/block-core.json
qapi/char.json
qapi/cryptodev.json
qapi/machine.json
qapi/migration.json
qapi/misc-arm.json
qapi/misc-i386.json
qapi/misc.json
qapi/rocker.json
qapi/run-state.json
qapi/tpm.json
qapi/ui.json
qapi/virtio.json
qapi/yank.json