qemu-e2k/docs
Markus Armbruster 1d8bda128d qapi: The #optional tag is redundant, drop
We traditionally mark optional members #optional in the doc comment.
Before commit 3313b61, this was entirely manual.

Commit 3313b61 added some automation because its qapi2texi.py relied
on #optional to determine whether a member is optional.  This is no
longer the case since the previous commit: the only thing qapi2texi.py
still does with #optional is stripping it out.  We still reject bogus
qapi-schema.json and six places for qga/qapi-schema.json.

Thus, you can't actually rely on #optional to see whether something is
optional.  Yet we still make people add it manually.  That's just
busy-work.

Drop the code to check, fix up and strip out #optional, along with all
instances of #optional.  To keep it out, add code to reject it, to be
dropped again once the dust settles.

No change to generated documentation.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-18-git-send-email-armbru@redhat.com>
2017-03-16 07:13:02 +01:00
..
specs
aio_notify_accept.promela
aio_notify_bug.promela
aio_notify.promela
atomics.txt
bitmaps.md
blkdebug.txt
blkverify.txt
block-replication.txt
bootindex.txt
build-system.txt
ccid.txt
COLO-FT.txt
colo-proxy.txt
generic-loader.txt
ich9-ehci-uhci.cfg
igd-assign.txt
image-fuzzer.txt
live-block-ops.txt
lockcnt.txt
mach-virt-graphical.cfg
mach-virt-serial.cfg
memory-hotplug.txt
memory.txt
migration.txt
multi-thread-compression.txt
multi-thread-tcg.txt
multiple-iothreads.txt
multiseat.txt
nvdimm.txt
pci_expander_bridge.txt
pcie.txt
q35-emulated.cfg
q35-virtio-graphical.cfg
q35-virtio-serial.cfg
qapi-code-gen.txt qapi: The #optional tag is redundant, drop 2017-03-16 07:13:02 +01:00
qcow2-cache.txt
qdev-device-use.txt
qemu_logo.pdf
qemu-ga-ref.texi
qemu-qmp-ref.texi
qemupciserial.inf
qmp-intro.txt
qmp-spec.txt
rcu.txt
rdma.txt
replay.txt
spice-port-fqdn.txt
tcg-exclusive.promela
throttle.txt
tracing.txt
usb2.txt
usb-storage.txt
virtio-balloon-stats.txt
virtio-migration.txt
vnc-ledstate-Pseudo-encoding.txt
win32-qemu-event.promela
writing-qmp-commands.txt qapi: The #optional tag is redundant, drop 2017-03-16 07:13:02 +01:00
xbzrle.txt
xen-save-devices-state.txt