qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squash


From: Marc-André Lureau
Subject: [Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squashed)
Date: Sun, 25 Sep 2016 22:18:25 +0400

Hi,

Add a qapi2texi script to generate the documentation from the qapi
schemas. Build various new documentation targets for it: pdf, man,
txt. The 7th 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

v1->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 (11):
  qapi: add qapi2texi script
  qapi: fix schema symbol sections
  qapi: fix missing symbol @prefix
  qapi: fix @ACPI sections
  docs: add qapi texi template
  build-sys: add qapi doc generation targets
  (SQUASHED) qmp-commands docs move to schema
  qapi: add some sections in docs and fix
  qga: fix guest-get-memory-block-info doc
  texi2pod: learn quotation, deftp and deftypefn
  build-sys: make and install the generated schema docs

 Makefile                        |   47 +-
 scripts/qapi.py                 |  100 +-
 scripts/qapi2texi.py            |  314 ++++
 scripts/texi2pod.pl             |   44 +-
 docs/qapi-code-gen.txt          |   44 +-
 docs/qemu-ga-qapi.template.texi |   58 +
 docs/qemu-qapi.template.texi    |  148 ++
 docs/qmp-commands.txt           | 3802 ---------------------------------------
 docs/qmp-events.txt             |  719 --------
 docs/qmp-intro.txt              |   87 -
 qapi-schema.json                | 1291 ++++++++++++-
 qapi/block-core.json            |  675 ++++++-
 qapi/block.json                 |   60 +-
 qapi/common.json                |   43 +-
 qapi/crypto.json                |   40 +-
 qapi/event.json                 |  245 +++
 qapi/rocker.json                |   60 +-
 qapi/trace.json                 |   16 +
 qga/qapi-schema.json            |    4 +-
 19 files changed, 3089 insertions(+), 4708 deletions(-)
 create mode 100755 scripts/qapi2texi.py
 create mode 100644 docs/qemu-ga-qapi.template.texi
 create mode 100644 docs/qemu-qapi.template.texi
 delete mode 100644 docs/qmp-intro.txt

-- 
2.10.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]