]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/sphinx: remove special parsing for freeform sections
authorJohn Snow <jsnow@redhat.com>
Wed, 18 Jun 2025 16:53:52 +0000 (12:53 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 14 Jul 2025 08:08:27 +0000 (10:08 +0200)
commit6c10778826a873b9012d95e63298a6f879debcaa
tree9707775416b8a85c047ef42facefb1c42eb1a3bd
parent8d789c8cdb8de2cae39f217b6c9607ac9c036c8c
docs/sphinx: remove special parsing for freeform sections

Remove the QAPI doc section heading syntax, use plain rST section
headings instead.

Tests and documentation are updated to match.

Interestingly, Plain rST headings work fine before this patch, except
for over- and underlining with '=', which the doc parser rejected as
invalid QAPI doc section heading in free-form comments.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250618165353.1980365-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Add more detail to commit message]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
48 files changed:
docs/devel/qapi-code-gen.rst
docs/interop/firmware.json
docs/interop/vhost-user.json
docs/sphinx/qapidoc.py
qapi/acpi.json
qapi/audio.json
qapi/authz.json
qapi/block-core.json
qapi/block-export.json
qapi/block.json
qapi/char.json
qapi/common.json
qapi/compat.json
qapi/control.json
qapi/crypto.json
qapi/cryptodev.json
qapi/cxl.json
qapi/dump.json
qapi/ebpf.json
qapi/error.json
qapi/introspect.json
qapi/job.json
qapi/machine-common.json
qapi/machine.json
qapi/migration.json
qapi/misc.json
qapi/net.json
qapi/pci.json
qapi/qapi-schema.json
qapi/qdev.json
qapi/qom.json
qapi/replay.json
qapi/rocker.json
qapi/run-state.json
qapi/sockets.json
qapi/stats.json
qapi/tpm.json
qapi/trace.json
qapi/transaction.json
qapi/uefi.json
qapi/ui.json
qapi/vfio.json
qapi/virtio.json
qapi/yank.json
scripts/qapi/parser.py
storage-daemon/qapi/qapi-schema.json
tests/qapi-schema/doc-good.json
tests/qapi-schema/doc-good.out