From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:46270) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZAxcw-0000RO-5N for qemu-devel@nongnu.org; Fri, 03 Jul 2015 05:51:23 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZAxco-0005Fp-Sr for qemu-devel@nongnu.org; Fri, 03 Jul 2015 05:51:22 -0400 Received: from mail-qg0-x234.google.com ([2607:f8b0:400d:c04::234]:35327) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZAxco-0005Ef-OO for qemu-devel@nongnu.org; Fri, 03 Jul 2015 05:51:14 -0400 Received: by qget71 with SMTP id t71so44191236qge.2 for ; Fri, 03 Jul 2015 02:51:13 -0700 (PDT) Sender: =?UTF-8?B?TWFyYy1BbmRyw6kgTHVyZWF1?= From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 3 Jul 2015 11:50:59 +0200 Message-Id: <1435917064-17827-1-git-send-email-marcandre.lureau@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [Qemu-devel] [PATCH 0/5] RFC: generate QAPI doc from json List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , armbru@redhat.com, mdroth@linux.vnet.ibm.com Hi, This is a small series adding a script to generate documentation of QAPI/QMP based on json "schema" files (man/pdf/html...) According to the wiki page http://wiki.qemu.org/QMP [1], this is one of the goal to get rid of duplicated documentation in qmp-commands.hx by generating it from json. A preview of the PDF result can be found there: https://elmarco.fedorapeople.org/qemu-qapi.pdf [1] Could someone create an account for me, so I can point to this series in the wiki? thanks Marc-André Lureau (5): qapi: add comment block before ChardevDummy qapi: add missing @ qapi: add qapi2texi script texi2pod: learn quotation, deftp and deftypefn build-sys: generate QAPI doc based on json Makefile | 35 +++++++-- qapi-schema.json | 8 +- scripts/qapi.py | 78 ++++++++++++++++++- scripts/qapi2texi.py | 212 +++++++++++++++++++++++++++++++++++++++++++++++++++ scripts/texi2pod.pl | 44 ++++++++++- 5 files changed, 365 insertions(+), 12 deletions(-) create mode 100644 scripts/qapi2texi.py -- 2.4.3