qemu-e2k/qga
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
..
installer qga/win/installer: add VssOption to installer 2023-03-08 18:26:49 +02:00
vss-win32 qga/: spelling fixes 2023-09-08 13:08:52 +03:00
channel-posix.c qga/: spelling fixes 2023-09-08 13:08:52 +03:00
channel-win32.c qga: Add spaces around operator 2021-03-16 20:20:37 -05:00
channel.h qga: add systemd socket activation support 2017-03-06 00:54:18 -06:00
commands-bsd.c qga: Add initial OpenBSD and NetBSD support 2022-12-20 15:54:41 +02:00
commands-common.h qga: Move HW address getting to a separate function 2022-10-26 20:35:07 +03:00
commands-linux.c qga: Move Linux-specific FS freeze/thaw code to a separate file 2022-10-26 20:35:07 +03:00
commands-posix-ssh.c qga/: spelling fixes 2023-09-08 13:08:52 +03:00
commands-posix.c qga: Solaris has net/if_arp.h and netinet/if_ether.h but not ETHER_ADDR_LEN 2024-01-30 12:14:28 +02:00
commands-win32.c qga-win: Fix guest-get-fsinfo multi-disks collection 2024-01-30 12:14:11 +02:00
commands.c qga: Improve guest-exec-status error message 2023-11-17 10:07:52 +01:00
cutils.c qga: Clean up includes 2023-02-08 07:16:23 +01:00
cutils.h qga: Clean up includes 2023-02-08 07:16:23 +01:00
guest-agent-command-state.c qga: use local path for local headers 2018-06-01 19:20:38 +03:00
guest-agent-core.h qga: Replace 'blacklist' and 'whitelist' in the guest agent sources 2022-09-20 12:37:00 +02:00
main.c guest-agent: improve help for --allow-rpcs and --block-rpcs 2024-01-30 12:10:37 +02:00
meson.build configure, meson: rename targetos to host_os 2023-12-31 09:11:29 +01:00
messages-win32.mc qga-win: add logging to Windows event log 2022-12-20 15:54:41 +02:00
qapi-schema.json qapi: Require member documentation (with loophole) 2024-02-12 10:04:31 +01:00
service-win32.c qga: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
service-win32.h qga-win: changing --retry-path option behavior 2018-10-31 09:04:20 -05:00
vss-win32.c qga-win: add support for qmp_guest_fsfreeze_freeze_list 2018-10-30 16:48:49 -05:00
vss-win32.h qga-win: add support for qmp_guest_fsfreeze_freeze_list 2018-10-30 16:48:49 -05:00