From: "Marc-André Lureau" <marcandre.lureau@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, armbru@redhat.com,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [Qemu-devel] [PATCH v4 00/15] qapi doc generation (whole version, squashed)
Date: Thu, 10 Nov 2016 19:21:54 +0400 [thread overview]
Message-ID: <20161110152209.18379-1-marcandre.lureau@redhat.com> (raw)
Add a qapi2texi script to generate the documentation from the qapi
schemas.
The 13th patch in this series is a squashed version of the
documentation move from qmp-commands.txt to the schemas. The whole
version (not sent on the ML to avoid spamming) is in the following git
branch: https://github.com/elmarco/qemu/commits/qapi-doc
v4:
- more device_add schema fixes
- do not merge docs/qmp-intro.txt in qemu-qmp-ref.texi
- remove needless @ifinfo, add GPL copying text
- added qemu logo to pdf
- added some r-b tags
v3:
- many improvements to the doc parser:
- throws an error in various malformated conditions
- allows multiple meta-sections, except for "Since:" and "Return:"
- build a list of docs, instead of attaching docs to expressions
- accept() breaks on new doc block, and get_doc() returns a QAPIDoc
- fix more documentation to fit the new parser
- use a master texi file that includes the generated file, instead of
templated texi file
- texi fixes after Markus review
- only build and install html and man pages by default
- fix .gitignore
v2:
- change licence to be lgpl2+
- fix some comments & commit message
- add more code comments
- improve the doc parsing to treat only "Since" as a special case not
requiring ":" (common notation in the doc)
- include some early schema doc fixes (to fix generated doc)
- include the squashed version of the doc move
- include the man page and installation build changes
Marc-André Lureau (15):
qapi: improve device_add schema
qga/schema: fix double-return in doc
qga/schema: improve guest-set-vcpus Returns: section
qapi: fix schema symbol sections
qapi: fix missing symbol @prefix
qapi: fix various symbols mismatch in documentation
qapi: use one symbol per line
qapi: add missing colon-ending for section name
qapi: add some sections in docs
docs: add master qapi texi files
qapi: add qapi2texi script
texi2pod: learn quotation, deftp and deftypefn
qmp-commands: (SQUASHED) move doc to schema
docs: add qemu logo
build-sys: add qapi doc generation targets
Makefile | 57 +-
scripts/qapi.py | 175 +-
scripts/qapi2texi.py | 316 ++++
scripts/texi2pod.pl | 44 +-
.gitignore | 11 +-
docs/qapi-code-gen.txt | 44 +-
docs/qemu-ga-ref.texi | 82 +
docs/qemu-qmp-ref.texi | 82 +
docs/qemu_logo.pdf | Bin 0 -> 9117 bytes
{pc-bios => docs}/qemu_logo.svg | 0
docs/qmp-commands.txt | 3824 ---------------------------------------
docs/qmp-events.txt | 731 --------
docs/qmp-intro.txt | 3 +-
qapi-schema.json | 1623 +++++++++++++++--
qapi/block-core.json | 894 +++++++--
qapi/block.json | 82 +-
qapi/common.json | 52 +-
qapi/crypto.json | 41 +-
qapi/event.json | 304 +++-
qapi/introspect.json | 28 +-
qapi/rocker.json | 63 +-
qapi/trace.json | 25 +-
qga/qapi-schema.json | 64 +-
23 files changed, 3527 insertions(+), 5018 deletions(-)
create mode 100755 scripts/qapi2texi.py
create mode 100644 docs/qemu-ga-ref.texi
create mode 100644 docs/qemu-qmp-ref.texi
create mode 100644 docs/qemu_logo.pdf
rename {pc-bios => docs}/qemu_logo.svg (100%)
delete mode 100644 docs/qmp-commands.txt
delete mode 100644 docs/qmp-events.txt
--
2.10.0
next reply other threads:[~2016-11-10 15:22 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-10 15:21 Marc-André Lureau [this message]
2016-11-10 15:21 ` [Qemu-devel] [PATCH v4 01/15] qapi: improve device_add schema Marc-André Lureau
2016-11-17 17:30 ` Markus Armbruster
2016-11-17 17:36 ` Markus Armbruster
2016-11-10 15:21 ` [Qemu-devel] [PATCH v4 02/15] qga/schema: fix double-return in doc Marc-André Lureau
2016-11-17 17:30 ` Markus Armbruster
2016-11-17 17:36 ` Markus Armbruster
2016-11-10 15:21 ` [Qemu-devel] [PATCH v4 03/15] qga/schema: improve guest-set-vcpus Returns: section Marc-André Lureau
2016-11-17 17:30 ` Markus Armbruster
2016-11-17 17:37 ` Markus Armbruster
2016-11-10 15:21 ` [Qemu-devel] [PATCH v4 04/15] qapi: fix schema symbol sections Marc-André Lureau
2016-11-17 17:31 ` Markus Armbruster
2016-11-17 17:38 ` Markus Armbruster
2016-11-10 15:21 ` [Qemu-devel] [PATCH v4 05/15] qapi: fix missing symbol @prefix Marc-André Lureau
2016-11-17 17:31 ` Markus Armbruster
2016-11-17 17:38 ` Markus Armbruster
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 06/15] qapi: fix various symbols mismatch in documentation Marc-André Lureau
2016-11-17 17:33 ` Markus Armbruster
2016-11-17 17:38 ` Markus Armbruster
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 07/15] qapi: use one symbol per line Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 08/15] qapi: add missing colon-ending for section name Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 09/15] qapi: add some sections in docs Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 10/15] docs: add master qapi texi files Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 11/15] qapi: add qapi2texi script Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 12/15] texi2pod: learn quotation, deftp and deftypefn Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 13/15] qmp-commands: (SQUASHED) move doc to schema Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 14/15] docs: add qemu logo Marc-André Lureau
2016-11-10 15:43 ` Daniel P. Berrange
2016-11-17 10:49 ` Marc-André Lureau
2016-11-10 15:22 ` [Qemu-devel] [PATCH v4 15/15] build-sys: add qapi doc generation targets Marc-André Lureau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161110152209.18379-1-marcandre.lureau@redhat.com \
--to=marcandre.lureau@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.