| Message ID | 20250408072001.2518323-1-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
Here's my argument for taking this into 10.0.
The changes can be divided into four parts:
1. Address deficiencies right at the beginning of the three QMP manuals:
* "QEMU QMP Reference Manual" section "Introduction" suffers from bit
rot: much of the contents is useless or misleading.
* The "QEMU Storage Daemon QMP Reference Manual" and the "QEMU Guest
Agent Protocol Reference" lack a proper introduction.
* "QEMU Guest Agent Protocol Reference" has a useless table of
contents.
* "QEMU QMP Reference Manual" and "QEMU Storage Daemon QMP Reference
Manual" both have a needlessly ugly table of contents.
2. Render the example notation in these introductions properly. This
involves changing *one* line of code in docs/sphinx/qmp_lexer.py.
This is the only code change, everything else is documentation.
3. Minor cleanup of rocker QMP documentation
4. Minor improvement of QAPI developer documentation
Applied, thanks. Please update the changelog at https://wiki.qemu.org/ChangeLog/10.0 for any user-visible changes.
The following changes since commit dfaecc04c46d298e9ee81bd0ca96d8754f1c27ed: Merge tag 'pull-riscv-to-apply-20250407-1' of https://github.com/alistair23/qemu into staging (2025-04-07 09:18:33 -0400) are available in the Git repository at: https://repo.or.cz/qemu/armbru.git tags/pull-qapi-2025-04-08 for you to fetch changes up to 8d41a7dfc2a8f21228b7f29314dd68ad0aa96d10: qga/qapi-schema: Add a proper introduction (2025-04-08 09:04:34 +0200) ---------------------------------------------------------------- QAPI patches patches for 2025-04-08 ---------------------------------------------------------------- Markus Armbruster (11): docs/devel/qapi-code-gen: Tidy up whitespace qapi/rocker: Tidy up query-rocker-of-dpa-flows example docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC docs/interop: Sanitize QMP reference manuals TOC docs/devel/qapi-code-gen: Improve the part on qmp-example directive docs/sphinx/qmp_lexer: Generalize elision syntax docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts qapi/qapi-schema: Update introduction for example notation qapi/qapi-schema: Address the introduction's bit rot storage-daemon/qapi/qapi-schema: Add a proper introduction qga/qapi-schema: Add a proper introduction docs/devel/qapi-code-gen.rst | 53 ++++++++++++++++------------ docs/interop/qemu-ga-ref.rst | 3 -- docs/interop/qemu-qmp-ref.rst | 2 +- docs/interop/qemu-storage-daemon-qmp-ref.rst | 2 +- docs/sphinx/qmp_lexer.py | 2 +- qapi/qapi-schema.json | 31 +++++----------- qapi/rocker.json | 2 +- qga/qapi-schema.json | 20 +++++++++-- storage-daemon/qapi/qapi-schema.json | 22 ++++++++++-- tests/qapi-schema/doc-good.json | 2 +- tests/qapi-schema/doc-good.out | 2 +- tests/qapi-schema/doc-good.txt | 2 +- 12 files changed, 83 insertions(+), 60 deletions(-)