Re: [Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squashed)

[Markus Armbruster]

Markus Armbruster  writes:

> Marc-André Lureau  writes:
>
>> 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
>
> I apologize for the delay in review, in particular since parts of this
> series rot rather quickly.
>
> You already rebased your git branch to commit 4387f56 on master.  The
> branch has PATCH 07 split.  The branch doesn't rebase cleanly to current
> master, but the conflicts are all in the shards of PATCH 07.
>
> For review, I applied the patches as sent to current master (commit
> ede0cbe).  Two patches conflict.  PATCH 07 "(SQUASHED) qmp-commands docs
> move to schema" I simply skipped.  PATCH 11 "build-sys: make and install
> the generated schema docs" conflicts with commit 78e8779 "qemu-doc:
> merge qemu-tech and qemu-doc", but it's easy enough to resolve, and you
> already did it in your git branch.

Actually, needs a conflict resolution fix:

diff --git a/Makefile b/Makefile
index 8cf1e38..24d5fb8 100644
--- a/Makefile
+++ b/Makefile
@@ -627,8 +627,8 @@ qemu-ga-qapi.7: qemu-ga-qapi.texi
 
 dvi: qemu-doc.dvi qemu-qapi.dvi qemu-ga-qapi.dvi
 html: qemu-doc.html qemu-qapi.html qemu-ga-qapi.html
-info: qemu-doc.info qemu-tech.info qemu-qapi.info qemu-ga-qapi.info
-pdf: qemu-doc.pdf qemu-tech.pdf qemu-qapi.pdf qemu-ga-qapi.pdf
+info: qemu-doc.info qemu-qapi.info qemu-ga-qapi.info
+pdf: qemu-doc.pdf qemu-qapi.pdf qemu-ga-qapi.pdf
 
 qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \
qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \


> Next: actual review the patches.

Re: [Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squashed)

[Markus Armbruster]

Marc-André Lureau  writes:

> 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

I apologize for the delay in review, in particular since parts of this
series rot rather quickly.

You already rebased your git branch to commit 4387f56 on master.  The
branch has PATCH 07 split.  The branch doesn't rebase cleanly to current
master, but the conflicts are all in the shards of PATCH 07.

For review, I applied the patches as sent to current master (commit
ede0cbe).  Two patches conflict.  PATCH 07 "(SQUASHED) qmp-commands docs
move to schema" I simply skipped.  PATCH 11 "build-sys: make and install
the generated schema docs" conflicts with commit 78e8779 "qemu-doc:
merge qemu-tech and qemu-doc", but it's easy enough to resolve, and you
already did it in your git branch.

Next: actual review the patches.

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

[Marc-André Lureau]

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