[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 00/30] Move qapi documentation to schema (part 1/5)
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH 00/30] Move qapi documentation to schema (part 1/5) |
Date: |
Tue, 13 Sep 2016 17:01:39 +0400 |
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 'add_client' doc to schema
qmp-commands: move 'query-name' doc to schema
qmp-commands: move 'query-kvm' doc to schema
qmp-commands: move 'query-status' doc to schema
qmp-commands: move 'query-uuid' doc to schema
qmp-commands: move 'query-chardev' doc to schema
qmp-commands: move 'query-chardev-backends' doc to schema
qmp-commands: move 'ringbuf-write' doc to schema
qmp-commands: move 'ringbuf-read' doc to schema
qmp-commands: move 'query-events' doc to schema
qmp-commands: move 'query-migrate' doc to schema
qmp-commands: move 'migrate-set-capabilities' doc to schema
qmp-commands: move 'query-migrate-capabilities' doc to schema
qmp-commands: move 'migrate-set-parameters' doc to schema
qmp-commands: move 'query-migrate-parameters' doc to schema
qmp-commands: move 'client_migrate_info' doc to schema
qmp-commands: move 'migrate-start-postcopy' doc to schema
qmp-commands: move 'query-mice' doc to schema
qmp-commands: move 'query-cpus' doc to schema
qmp-commands: move 'query-iothreads' doc to schema
qmp-commands: move 'query-vnc' doc to schema
qmp-commands: move 'query-spice' doc to schema
qmp-commands: move 'query-balloon' doc to schema
qmp-commands: move 'query-pci' doc to schema
qmp-commands: move 'quit' doc to schema
qmp-commands: move 'stop' doc to schema
qmp-commands: move 'system_reset' doc to schema
qmp-commands: move 'system_powerdown' doc to schema
qmp-commands: move 'cpu-add' doc to schema
qmp-commands: move 'memsave' doc to schema
docs/qmp-commands.txt | 1075 -------------------------------------------------
qapi-schema.json | 620 +++++++++++++++++++++++++++-
2 files changed, 601 insertions(+), 1094 deletions(-)
--
2.10.0
- [Qemu-devel] [PATCH 00/30] Move qapi documentation to schema (part 1/5),
Marc-André Lureau <=
- [Qemu-devel] [PATCH 01/30] qmp-commands: move 'add_client' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 02/30] qmp-commands: move 'query-name' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 03/30] qmp-commands: move 'query-kvm' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 05/30] qmp-commands: move 'query-uuid' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 04/30] qmp-commands: move 'query-status' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 06/30] qmp-commands: move 'query-chardev' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 07/30] qmp-commands: move 'query-chardev-backends' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 08/30] qmp-commands: move 'ringbuf-write' doc to schema, Marc-André Lureau, 2016/09/13