Markus Armbruster 0cec50119f qapi: Require member documentation (with loophole) ... The QAPI generator forces you to document your stuff. Except for command arguments, event data, and members of enum and object types: these the generator silently "documents" as "Not documented". We can't require proper documentation there without first fixing all the offenders. We've always had too many offenders to pull that off. Right now, we have more than 500. Worse, we seem to fix old ones no faster than we add new ones: in the past year, we fixed 22 ones, but added 26 new ones. To help arrest the backsliding, make missing documentation an error unless the command, type, or event is in listed in new pragma documentation-exceptions. List all the current offenders: 117 commands and types in qapi/, and 9 in qga/. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240205074709.3613229-7-armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>		2024-02-12 10:04:31 +01:00
..
acpi.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
audio.json	audio/pw: Pipewire->PipeWire case fix for user-visible text	2023-07-17 15:22:56 +04:00
authz.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
block-core.json	qapi/block-core: Fix BlockLatencyHistogramInfo doc markup	2024-02-12 10:04:31 +01:00
block-export.json	qapi: Elide "Potential additional modes" from generated docs	2024-02-03 09:20:01 +01:00
block.json	qapi: Reformat recent doc comments to conform to current conventions	2023-07-26 14:51:36 +02:00
char.json	qapi: Indent tagged doc comment sections properly	2024-01-26 07:04:53 +01:00
common.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
compat.json	qapi: Belatedly update CompatPolicy documentation for unstable	2023-10-19 07:02:29 +02:00
control.json	docs/interop: Convert qmp-spec.txt to rST	2023-05-22 10:21:01 +02:00
crypto.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
cryptodev.json	spelling: information	2023-06-09 23:38:16 +03:00
cxl.json	qapi: Reformat recent doc comments to conform to current conventions	2023-07-26 14:51:36 +02:00
dump.json	dump: Add command interface for kdump-raw formats	2023-11-02 18:40:37 +04:00
error.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
introspect.json	qapi: Drop redundant documentation of inherited members	2024-02-03 09:19:25 +01:00
job.json	blockjob: introduce block-job-change QMP command	2023-10-31 18:20:25 +01:00
machine-common.json	CPU topology: extend with s390 specifics	2023-10-20 07:16:53 +02:00
machine-target.json	qapi,risc-v: add query-cpu-model-expansion	2023-11-07 11:06:01 +10:00
machine.json	qapi: Indent tagged doc comment sections properly	2024-01-26 07:04:53 +01:00
meson.build	CPU topology: extend with s390 specifics	2023-10-20 07:16:53 +02:00
migration.json	qapi: Indent tagged doc comment sections properly	2024-02-12 10:04:31 +01:00
misc-target.json	qapi: Drop redundant documentation of conditional	2024-02-03 09:19:55 +01:00
misc.json	qapi: Indent tagged doc comment sections properly	2024-02-12 10:04:31 +01:00
net.json	qapi: Fix mangled "Returns" sections in documentation	2024-01-26 07:04:53 +01:00
opts-visitor.c	cutils: Adjust signature of parse_uint[_full]	2023-06-02 12:27:19 -05:00
pci.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
pragma.json	qapi: Require member documentation (with loophole)	2024-02-12 10:04:31 +01:00
qapi-clone-visitor.c	qapi: Make visitor functions taking Error ** return bool, not void	2020-07-10 15:18:08 +02:00
qapi-dealloc-visitor.c	qapi: Make visitor functions taking Error ** return bool, not void	2020-07-10 15:18:08 +02:00
qapi-forward-visitor.c	qapi: remove needless include	2022-03-22 14:46:18 +04:00
qapi-schema.json	CPU topology: extend with s390 specifics	2023-10-20 07:16:53 +02:00
qapi-type-helpers.c	monitor: introduce HumanReadableText and HMP support	2021-11-02 15:55:13 +00:00
qapi-util.c	qapi: Fix dangling references to docs/devel/qapi-code-gen.txt	2024-01-26 07:04:53 +01:00
qapi-visit-core.c	qapi: Factor out compat_policy_input_ok()	2021-10-29 21:27:20 +02:00
qdev.json	qapi: Indent tagged doc comment sections properly	2024-02-12 10:04:31 +01:00
qmp-dispatch.c	monitor: use aio_co_reschedule_self()	2024-02-07 14:44:21 +01:00
qmp-event.c	Replace qemu_gettimeofday() with g_get_real_time()	2022-04-06 10:50:37 +02:00
qmp-registry.c	qapi: Generalize command policy checking	2021-10-29 18:24:46 +02:00
qobject-input-visitor.c	include: add qemu/keyval.h	2022-04-21 17:03:51 +04:00
qobject-output-visitor.c	qapi: Extend -compat to set policy for unstable interfaces	2021-10-29 21:28:01 +02:00
qom.json	qapi: Fix mangled "Returns" sections in documentation	2024-01-26 07:04:53 +01:00
rdma.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
replay.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
rocker.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
run-state.json	qapi: Remove deprecated 'singlestep' member of StatusInfo	2024-01-19 11:38:32 +01:00
sockets.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
stats.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
string-input-visitor.c	qapi, qemu-options: make all parsing visitors parse boolean options the same	2020-11-04 12:00:40 -05:00
string-output-visitor.c	string-output-visitor: Fix (pseudo) struct handling	2024-01-26 11:16:58 +01:00
tpm.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +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	qapi: Reformat recent doc comments to conform to current conventions	2023-07-26 14:51:36 +02:00
transaction.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
ui.json	Make Pixman an optional dependency	2023-11-07 19:00:03 +08:00
virtio.json	qdev: add IOThreadVirtQueueMappingList property type	2023-12-21 22:49:28 +01:00
yank.json	qapi: Indent tagged doc comment sections properly	2024-01-26 07:04:53 +01:00