fridtjof/qemu-cr16
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
qemu-cr16/qapi
History
John Snow 0462da9d6b 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>
2025-07-14 12:35:29 +02:00
..
acpi.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
audio.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
authz.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
block-core.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
block-export.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
block.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
char.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
common.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
compat.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
control.json qapi: Clean up "This command will do ..." command descriptions 2025-07-14 10:13:30 +02:00
crypto.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
cryptodev.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
cxl.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
dump.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
ebpf.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
error.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
introspect.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
job.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
machine-common.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
machine-s390x.json qapi: make s390x specific CPU commands unconditionally available 2025-05-28 18:56:08 +02:00
machine.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
meson.build qapi: make all generated files common 2025-05-28 18:56:08 +02:00
migration.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
misc-arm.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
misc-i386.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
misc.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
net.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
opts-visitor.c qapi: Inline and remove QERR_INVALID_PARAMETER definition 2024-04-24 09:50:58 +02:00
pci.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
pragma.json qapi: Document QCryptodevBackendServiceType 2024-10-02 09:10:01 +02:00
qapi-clone-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 2025-02-10 15:33:16 +01:00
qapi-dealloc-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 2025-02-10 15:33:16 +01:00
qapi-forward-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qapi-schema.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
qapi-type-helpers.c qapi: New strv_from_str_list() 2024-03-04 07:12:40 +01:00
qapi-util.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qapi-visit-core.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qdev.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
qmp-dispatch.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qmp-event.c qapi: Move include/qapi/qmp/ to include/qobject/ 2025-02-10 15:33:16 +01:00
qmp-registry.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qobject-input-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qobject-output-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 2025-02-10 15:45:04 +01:00
qom.json qapi: Clean up a few Errors: sections 2025-07-14 10:13:30 +02:00
replay.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
rocker.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
run-state.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
sockets.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
stats.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
string-input-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 2025-02-10 15:33:16 +01:00
string-output-visitor.c string-output-visitor: Fix (pseudo) struct handling 2024-01-26 11:16:58 +01:00
tpm.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
trace-events qapi: Generalize struct member policy checking 2021-10-29 18:23:09 +02:00
trace.h trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
trace.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
transaction.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
uefi.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
ui.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
vfio.json docs/sphinx: remove special parsing for freeform sections 2025-07-14 10:08:27 +02:00
virtio.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00
yank.json qapi: remove trivial "Returns:" sections 2025-07-14 12:35:29 +02:00