Hi, The QAPI documentation is currently done in two places, the json schema and a more human-friendly text file. The goal is to avoid duplication and to generate friendly versions from the schema (pdf, man etc). Thus, all documentation should be moved to the schema.
In order to facilitate the review, the documentation move has been splitted, and is going to sent by chunks of ~30 patches. This way it should take about 5 series to complete (~150 patches). I suggest that the qapi maintainers (Markus/Eric) compile the reviewed patches in a branch and merge upstream in one go (either merging move commits or not) when the series complete and the documentation is finally generated to avoid an in-between state. The wip branch with all the pending patches: https://github.com/elmarco/qemu/commits/qapi-doc And a sneak peek of the generated pdf documentation: https://fedorapeople.org/~elmarco/qemu-qapi.pdf The series is currently based on Markus qapi-next branch. Marc-André Lureau (30): qmp-commands: move 'pmemsave' doc to schema qmp-commands: move 'cont' doc to schema qmp-commands: move 'system_wakeup' doc to schema qmp-commands: move 'inject-nmi' doc to schema qmp-commands: move 'set_link' doc to schema qmp-commands: move 'balloon' doc to schema qmp-commands: move 'transaction' doc to schema qmp-commands: move 'human-monitor-command' doc to schema qmp-commands: move 'migrate_cancel' doc to schema qmp-commands: move 'migrate_set_downtime' doc to schema qmp-commands: move 'migrate_set_speed' doc to schema qmp-commands: move 'query-migrate-cache-size' doc to schema qmp-commands: move 'set_password' doc to schema qmp-commands: move 'expire_password' doc to schema qmp-commands: move 'change' doc to schema qmp-commands: move 'migrate' doc to schema qmp-commands: move 'migrate-incoming' doc to schema qmp-commands: move 'xen-save-devices-state' doc to schema qmp-commands: move 'xen-set-global-dirty-log' doc to schema qmp-commands: move 'device_del' doc to schema qmp-commands: move 'dump-guest-memory' doc to schema qmp-commands: move 'query-dump-guest-memory-capability' doc to schema qmp-commands: move 'dump-skeys' doc to schema qmp-commands: move 'netdev_add' doc to schema qmp-commands: move 'netdev_del' doc to schema qmp-commands: move 'object-add' doc to schema qmp-commands: move 'object-del' doc to schema qmp-commands: move 'getfd' doc to schema qmp-commands: move 'closefd' doc to schema qmp-commands: move 'add-fd' doc to schema docs/qmp-commands.txt | 603 -------------------------------------------------- qapi-schema.json | 292 +++++++++++++++++++++++- 2 files changed, 283 insertions(+), 612 deletions(-) -- 2.10.0
