qemu/docs
Markus Armbruster b6c37ebaaf docs/devel/qapi-code-gen: Improve QAPI schema language doc
We document the language by giving patterns of valid JSON objects.
The patterns contain placeholders we don't define anywhere; their
names have to speak for themselves.  I guess they do, but I'd prefer a
bit more rigor.  Provide a grammar instead, and rework the text
accordingly.

Documentation for QAPI schema conditionals (commit 967c885108,
6cc32b0e14, 87adbbffd4..3e270dcacc) and feature flags (commit
6a8c0b5102) was bolted on.  The sections documenting types, commands
and events don't mention them.  Section "Features" and "Configuring
the schema" then provide additional syntax for types, commands and
events.  I hate that.  Fix the sections documenting types, commands
and events to provide accurate syntax, and point to "Features" and
"Configuring the schema" for details.

We talk about "(top-level) expressions other than include and pragma".
Adopt more convenient terminology: a (top-level) expression is either
a directive (include or pragma) or a definition (anything else).

Avoid the terms "dictionary" and "key".  Stick to JSON terminology
"object" and "member name" instead.

While there, make spacing more consistent.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190913201349.24332-16-armbru@redhat.com>
2019-09-24 14:07:22 +02:00
..
config
devel docs/devel/qapi-code-gen: Improve QAPI schema language doc 2019-09-24 14:07:22 +02:00
interop qemu-ga: Convert invocation documentation to rST 2019-09-13 16:05:01 +01:00
specs docs/specs: initial spec summary for Ultravisor-related hcalls 2019-08-21 17:17:12 +10:00
sphinx sphinx: add qmp_lexer 2019-07-10 15:08:06 -04:00
spin
amd-memory-encryption.txt
barrier.txt ui: add an embedded Barrier client 2019-09-17 13:43:22 +02:00
block-replication.txt
bootindex.txt
can.txt
ccid.txt
COLO-FT.txt
colo-proxy.txt
conf.py qemu-ga: Convert invocation documentation to rST 2019-09-13 16:05:01 +01:00
cpu-hotplug.rst
generic-loader.txt
hyperv.txt i386/kvm: add support for Direct Mode for Hyper-V synthetic timers 2019-06-21 02:29:39 +02:00
igd-assign.txt
image-fuzzer.txt
index.rst docs: provide documentation on the POWER9 XIVE interrupt controller 2019-05-29 11:39:47 +10:00
memory-hotplug.txt
multi-thread-compression.txt
multiseat.txt
nvdimm.txt docs/nvdimm: add example on persistent backend setup 2019-09-16 06:27:35 -04:00
pci_expander_bridge.txt
pcie.txt
pcie_pci_bridge.txt
pr-manager.rst
pvrdma.txt
qcow2-cache.txt qcow2: Default to 4KB for the qcow2 cache entry size 2019-03-08 12:26:45 +01:00
qdev-device-use.txt
qemu-block-drivers.texi qemu-doc: Do not hard-code the name of the QEMU binary 2019-09-05 13:18:52 +02:00
qemu-cpu-models.texi qemu-doc: Do not hard-code the name of the QEMU binary 2019-09-05 13:18:52 +02:00
qemu_logo.pdf
qemupciserial.inf
rdma.txt
replay.txt
security.texi doc: document that the monitor console is a privileged control interface 2019-07-19 14:21:08 +01:00
spice-port-fqdn.txt
throttle.txt
usb-storage.txt
usb2.txt
vfio-ap.txt
virtio-balloon-stats.txt
virtio-pmem.rst virtio pmem: user document 2019-09-16 06:57:24 -04:00
xbzrle.txt
xen-save-devices-state.txt