[PATCH 00/11] docs/qapi: enable new guest-agent and storage-daemon docs

John Snow posted 11 patches 8 months, 1 week ago
Failed in applying to current master (apply log)
docs/conf.py                                 |   7 +
docs/devel/qapi-domain.rst                   |  70 ++++-
docs/interop/qemu-ga-ref.rst                 |   2 +
docs/interop/qemu-qmp-ref.rst                |   1 +
docs/interop/qemu-storage-daemon-qmp-ref.rst |   2 +
docs/sphinx/qapi_domain.py                   | 297 +++++++++++++------
docs/sphinx/qapidoc.py                       |  12 +
qapi/qapi-schema.json                        |   2 +-
qga/qapi-schema.json                         |   3 +
storage-daemon/qapi/qapi-schema.json         |   8 +
10 files changed, 303 insertions(+), 101 deletions(-)
[PATCH 00/11] docs/qapi: enable new guest-agent and storage-daemon docs
Posted by John Snow 8 months, 1 week ago
Add namespaces, turn on QGA and QSD.

John Snow (11):
  docs/qapi_domain: isolate TYPE_CHECKING imports
  docs/qapi-domain: always store fully qualified name in signode
  docs/qapi_domain: add namespace support to FQN
  docs/qapi-domain: add :namespace: override option
  docs/qapi-domain: add qapi:namespace directive
  docs/qapidoc: add :namespace: option to qapi-doc directive
  docs/qapi_domain: add namespace support to cross-references
  docs/qapi-domain: add namespaced index support
  docs: add QAPI namespace "QMP" to qemu-qmp-ref
  docs: disambiguate references in qapi-domain.rst
  docs: enable transmogrifier for QSD and QGA

 docs/conf.py                                 |   7 +
 docs/devel/qapi-domain.rst                   |  70 ++++-
 docs/interop/qemu-ga-ref.rst                 |   2 +
 docs/interop/qemu-qmp-ref.rst                |   1 +
 docs/interop/qemu-storage-daemon-qmp-ref.rst |   2 +
 docs/sphinx/qapi_domain.py                   | 297 +++++++++++++------
 docs/sphinx/qapidoc.py                       |  12 +
 qapi/qapi-schema.json                        |   2 +-
 qga/qapi-schema.json                         |   3 +
 storage-daemon/qapi/qapi-schema.json         |   8 +
 10 files changed, 303 insertions(+), 101 deletions(-)

-- 
2.48.1

Re: [PATCH 00/11] docs/qapi: enable new guest-agent and storage-daemon docs
Posted by Markus Armbruster 8 months ago
John Snow <jsnow@redhat.com> writes:

> Add namespaces, turn on QGA and QSD.

I'm queuing this as is, with typo fixes in one commit message.

There's some followup work:

* You wanted to think some more on reference resolution.  In particular

    (With maybe a bug or two for trying to find module names in some
    circumstances. Will have to check that over...)

* I had a hard time understanding the reference resolution algorithm
  from the commit message.  Whether the code is sufficiently obvious I
  can't say, because I didn't look closely.  We might want more
  comments.  Not today.  The user documentation on reference resolution
  in qapi-domain.rst looks sufficient.

* I have questions on the QAPI index.  They may or may not lead to
  followup work.

* During review, we realized that the introduction sections of the three
  reference manuals (QMP, QSD, QGA) need work.  Not this series' fault.
  I'll see what I can do.

Thanks!