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
..
_templates	docs: Add QEMU version information to HTML footer	2021-07-18 10:59:47 +01:00
about	docs/about: Deprecate the old "power5+" and "power7+" CPU names	2024-02-05 14:21:21 +01:00
config	vl: recognize audiodev groups in configuration files	2023-09-22 17:35:11 +02:00
devel	qapi: Require member documentation (with loophole)	2024-02-12 10:04:31 +01:00
interop	guest-agent: improve help for --allow-rpcs and --block-rpcs	2024-01-30 12:10:37 +02:00
specs	hw/fsi: Added FSI documentation	2024-02-01 08:33:18 +01:00
sphinx	sphinx/qapidoc: Drop code to generate doc for simple union tag	2024-02-12 10:04:31 +01:00
sphinx-static	docs/sphinx: add 's' keyboard binding to focus search	2021-11-08 12:27:23 +04:00
spin	docs: create config/, devel/ and spin/ subdirectories	2017-06-07 18:22:03 +02:00
system	hw/ssi: Implement BCM2835 SPI Controller	2024-02-02 13:51:59 +00:00
tools	docs/tools/qemu-img.rst: fix typo (sumarizes)	2023-12-23 19:35:47 +03:00
user	cli: Remove deprecated '-singlestep' command line option	2024-01-19 11:38:32 +01:00
COLO-FT.txt	migration: block incoming colo when capability is disabled	2023-05-10 18:48:12 +02:00
block-replication.txt	docs/block-replication.txt: Fix replication top-id command demo	2021-12-17 11:35:00 +01:00
bypass-iommu.txt	docs: Add documentation for iommu bypass	2021-07-16 11:10:45 -04:00
colo-proxy.txt	colo: examples: remove mentions of script= and (wrong) downscript=	2024-01-30 21:20:20 +03:00
conf.py	Update copyright dates to 2023	2023-05-30 15:50:17 +01:00
defs.rst.inc	docs: Fix typo in the default name of the qemu-system-x86_64 binary	2021-04-01 14:28:39 +02:00
igd-assign.txt	vfio/pci: Add IGD documentation	2016-05-26 11:12:05 -06:00
image-fuzzer.txt	docs: Render binary names as monospaced text	2021-11-22 15:02:38 +01:00
index.rst	docs: standardize book titles to === with overline	2021-09-13 13:56:26 +02:00
memory-hotplug.txt	docs: Grammar and spelling fixes	2018-07-13 10:16:04 +01:00
meson.build	configure: bootstrap sphinx with mkvenv	2023-05-18 08:53:51 +02:00
multi-thread-compression.txt	docs tests: Fix use of migrate_set_parameter	2023-09-08 13:08:52 +03:00
multiseat.txt	docs: Spell QEMU all caps	2021-11-19 10:16:58 +01:00
nvdimm.txt	docs/nvdimm: Update nvdimm option value in machine example	2021-09-27 10:57:21 +02:00
pci_expander_bridge.txt	pxb: cleanup	2016-03-11 16:59:12 +02:00
pcie.txt	docs/pcie.txt: Replace ioh3420 with pcie-root-port	2023-01-28 06:21:30 -05:00
pcie_pci_bridge.txt	docs: add slot when adding new PCIe root port	2021-07-03 03:12:35 -04:00
pcie_sriov.txt	pcie: Use common ARI next function number	2023-07-10 18:59:32 -04:00
pvrdma.txt	docs: Fix broken links	2020-09-01 09:31:33 +02:00
qcow2-cache.txt	qcow2: Document the Extended L2 Entries feature	2020-08-25 08:33:20 +02:00
qdev-device-use.txt	util: remove support -chardev tty and -chardev parport	2023-01-06 00:51:02 +01:00
qemu-option-trace.rst.inc	qemu-option-trace.rst.inc: Don't use option:: markup	2020-11-02 16:52:18 +00:00
qemupciserial.inf	docs: Grammar and spelling fixes	2018-07-13 10:16:04 +01:00
rdma.txt	docs tests: Fix use of migrate_set_parameter	2023-09-08 13:08:52 +03:00
requirements.txt	readthodocs: fully specify a build environment	2024-01-12 13:23:48 +00:00
spice-port-fqdn.txt	docs: add spice-port-fqdn.txt	2012-12-17 14:01:41 +01:00
throttle.txt	docs: Drop deprecated 'props' from object-add	2021-11-22 15:02:38 +01:00
xbzrle.txt	migrate: remove QMP/HMP commands for speed, downtime and cache size	2021-03-18 09:22:55 +00:00
xen-save-devices-state.txt	Fix up dangling references to qmp-commands.* in comment and doc	2018-03-02 13:48:26 -06:00