qemu-e2k/docs
Markus Armbruster f57e1d05bf sphinx/qapidoc: Do not emit TODO sections into user manuals
QAPI doc comments are for QMP users: they go into the "QEMU QMP
Reference Manual" and the "QEMU Storage Daemon QMP Reference Manual".

The doc comment TODO sections are for somebody else, namely for the
people who can do: developers.  Do not emit them into the user
manuals.

This elides the following TODOs:

* SchemaInfoCommand

  # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)

  This is a note to developers adding introspection to the guest
  agent.  It makes no sense to users.

* @query-hotpluggable-cpus

  # TODO: Better documentation; currently there is none.

  This is a reminder for developers.  It doesn't help users.

* @device_add

  # TODO: This command effectively bypasses QAPI completely due to its
  #       "additional arguments" business.  It shouldn't have been added to
  #       the schema in this form.  It should be qapified properly, or
  #       replaced by a properly qapified command.

  Likewise.

Eliding them is an improvement.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-7-armbru@redhat.com>
Reviewed-by: Ani Sinha <anisinha@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
2023-05-09 09:10:14 +02:00
..
_templates
about docs/about/deprecated.rst: Add "since 7.1" tag to dtb-kaslr-seed deprecation 2023-05-02 15:47:40 +01:00
config docs/config: Set the "kvm" accelerator via "[accel]" section 2023-03-08 08:57:42 +01:00
devel sphinx/qapidoc: Do not emit TODO sections into user manuals 2023-05-09 09:10:14 +02:00
interop qapi: @foo should be used to reference, not `foo` 2023-04-28 11:48:34 +02:00
specs virtio,pc,pci: fixes, features, cleanups 2023-04-25 09:13:27 +01:00
sphinx sphinx/qapidoc: Do not emit TODO sections into user manuals 2023-05-09 09:10:14 +02:00
sphinx-static
spin
system docs/system: remove excessive punctuation from guest-loader docs 2023-04-27 14:58:41 +01:00
tools virtiofsd: Remove source 2023-02-16 18:15:08 +00:00
user bsd-user: Add '-one-insn-per-tb' option equivalent to '-singlestep' 2023-05-02 15:47:40 +01:00
block-replication.txt
bypass-iommu.txt
COLO-FT.txt
colo-proxy.txt
conf.py virtiofsd: Remove build and docs glue 2023-02-16 18:15:08 +00:00
defs.rst.inc
igd-assign.txt
image-fuzzer.txt
index.rst
memory-hotplug.txt
meson.build docs/sphinx/kerneldoc.py: Honour --enable-werror 2023-03-16 14:39:10 +01:00
multi-thread-compression.txt
multiseat.txt
nvdimm.txt
pci_expander_bridge.txt
pcie_pci_bridge.txt
pcie_sriov.txt docs: Remove obsolete descriptions of SR-IOV support 2023-04-24 22:56:55 -04:00
pcie.txt
pvrdma.txt
qcow2-cache.txt
qdev-device-use.txt
qemu-option-trace.rst.inc
qemupciserial.inf
rdma.txt
spice-port-fqdn.txt
throttle.txt
u2f.txt
xbzrle.txt
xen-save-devices-state.txt