[PATCH 00/11] qapi: Documentation improvements

Markus Armbruster posted 11 patches 8 months, 2 weeks ago
Failed in applying to current master (apply log)
docs/devel/qapi-code-gen.rst                 | 53 ++++++++++++--------
docs/interop/qemu-ga-ref.rst                 |  3 --
docs/interop/qemu-qmp-ref.rst                |  2 +-
docs/interop/qemu-storage-daemon-qmp-ref.rst |  2 +-
docs/sphinx/qmp_lexer.py                     |  2 +-
qapi/qapi-schema.json                        | 31 ++++--------
qapi/rocker.json                             |  2 +-
qga/qapi-schema.json                         | 20 ++++++--
storage-daemon/qapi/qapi-schema.json         | 22 ++++++--
tests/qapi-schema/doc-good.json              |  2 +-
tests/qapi-schema/doc-good.out               |  2 +-
tests/qapi-schema/doc-good.txt               |  2 +-
12 files changed, 83 insertions(+), 60 deletions(-)
[PATCH 00/11] qapi: Documentation improvements
Posted by Markus Armbruster 8 months, 2 weeks ago
Markus Armbruster (11):
  docs/devel/qapi-code-gen: Tidy up whitespace
  qapi/rocker: Tidy up query-rocker-of-dpa-flows example
  docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC
  docs/interop: Sanitize QMP reference manuals TOC
  docs/devel/qapi-code-gen: Improve the part on qmp-example directive
  docs/sphinx/qmp_lexer: Generalize elision syntax
  docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts
  qapi/qapi-schema: Update introduction for example notation
  qapi/qapi-schema: Address the introduction's bit rot
  storage-daemon/qapi/qapi-schema: Add a proper introduction
  qga/qapi-schema: Add a proper introduction

 docs/devel/qapi-code-gen.rst                 | 53 ++++++++++++--------
 docs/interop/qemu-ga-ref.rst                 |  3 --
 docs/interop/qemu-qmp-ref.rst                |  2 +-
 docs/interop/qemu-storage-daemon-qmp-ref.rst |  2 +-
 docs/sphinx/qmp_lexer.py                     |  2 +-
 qapi/qapi-schema.json                        | 31 ++++--------
 qapi/rocker.json                             |  2 +-
 qga/qapi-schema.json                         | 20 ++++++--
 storage-daemon/qapi/qapi-schema.json         | 22 ++++++--
 tests/qapi-schema/doc-good.json              |  2 +-
 tests/qapi-schema/doc-good.out               |  2 +-
 tests/qapi-schema/doc-good.txt               |  2 +-
 12 files changed, 83 insertions(+), 60 deletions(-)

-- 
2.48.1
Re: [PATCH 00/11] qapi: Documentation improvements
Posted by Eric Blake 8 months, 1 week ago
On Fri, Apr 04, 2025 at 02:14:02PM +0200, Markus Armbruster wrote:
> Markus Armbruster (11):
>   docs/devel/qapi-code-gen: Tidy up whitespace
>   qapi/rocker: Tidy up query-rocker-of-dpa-flows example
>   docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC
>   docs/interop: Sanitize QMP reference manuals TOC
>   docs/devel/qapi-code-gen: Improve the part on qmp-example directive
>   docs/sphinx/qmp_lexer: Generalize elision syntax
>   docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts
>   qapi/qapi-schema: Update introduction for example notation
>   qapi/qapi-schema: Address the introduction's bit rot
>   storage-daemon/qapi/qapi-schema: Add a proper introduction
>   qga/qapi-schema: Add a proper introduction

I noticed at least one typo and replied in-place, but overall the
series is good once you touch that up.  For the series:

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org
Re: [PATCH 00/11] qapi: Documentation improvements
Posted by Markus Armbruster 8 months, 1 week ago
Queued for 10.0.