[PATCH v3 0/2] [DO-NOT-MERGE] qapi: static typing conversion, "pt0"

John Snow posted 2 patches 4 years ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20220204224256.2110500-1-jsnow@redhat.com
Maintainers: Peter Maydell <peter.maydell@linaro.org>, Michael Roth <michael.roth@amd.com>, Markus Armbruster <armbru@redhat.com>
There is a newer version of this series
docs/conf.py                          |  3 ++-
docs/devel/index.rst                  |  1 +
docs/devel/python/index.rst           |  7 +++++++
docs/devel/python/qapi.commands.rst   |  7 +++++++
docs/devel/python/qapi.common.rst     |  7 +++++++
docs/devel/python/qapi.error.rst      |  7 +++++++
docs/devel/python/qapi.events.rst     |  7 +++++++
docs/devel/python/qapi.expr.rst       |  7 +++++++
docs/devel/python/qapi.gen.rst        |  7 +++++++
docs/devel/python/qapi.introspect.rst |  7 +++++++
docs/devel/python/qapi.main.rst       |  7 +++++++
docs/devel/python/qapi.parser.rst     |  8 ++++++++
docs/devel/python/qapi.rst            | 26 ++++++++++++++++++++++++
docs/devel/python/qapi.schema.rst     |  7 +++++++
docs/devel/python/qapi.source.rst     |  7 +++++++
docs/devel/python/qapi.types.rst      |  7 +++++++
docs/devel/python/qapi.visit.rst      |  7 +++++++
scripts/qapi-lint.sh                  | 29 +++++++++++++++++++++++++++
scripts/qapi/Makefile                 |  5 +++++
19 files changed, 162 insertions(+), 1 deletion(-)
create mode 100644 docs/devel/python/index.rst
create mode 100644 docs/devel/python/qapi.commands.rst
create mode 100644 docs/devel/python/qapi.common.rst
create mode 100644 docs/devel/python/qapi.error.rst
create mode 100644 docs/devel/python/qapi.events.rst
create mode 100644 docs/devel/python/qapi.expr.rst
create mode 100644 docs/devel/python/qapi.gen.rst
create mode 100644 docs/devel/python/qapi.introspect.rst
create mode 100644 docs/devel/python/qapi.main.rst
create mode 100644 docs/devel/python/qapi.parser.rst
create mode 100644 docs/devel/python/qapi.rst
create mode 100644 docs/devel/python/qapi.schema.rst
create mode 100644 docs/devel/python/qapi.source.rst
create mode 100644 docs/devel/python/qapi.types.rst
create mode 100644 docs/devel/python/qapi.visit.rst
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
[PATCH v3 0/2] [DO-NOT-MERGE] qapi: static typing conversion, "pt0"
Posted by John Snow 4 years ago
This is a manual testing pre-requisite for other QAPI cleanup
patches. It isn't meant for inclusion, it's included here as an
informative basis for ongoing work only.

sphinx-autodoc is enabled for the scripts/qapi package so that docstring
formatting can be validated and inspected to make sure the output looks
"nice". It is not necessarily how we'd want to expose this information,
ultimately, but serves as a good smoke test for base-line docstring
consistency.

Lastly, some scripts/tools for running linters with "canonical"
configurations are provided as a means to verify the linting
base-line. I use these to validate my own work.

V3:
 - Happy New Year. Rebased on top of today's origin/master.

John Snow (2):
  [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi
  [DO-NOT-MERGE]: Add some ad-hoc linting helpers.

 docs/conf.py                          |  3 ++-
 docs/devel/index.rst                  |  1 +
 docs/devel/python/index.rst           |  7 +++++++
 docs/devel/python/qapi.commands.rst   |  7 +++++++
 docs/devel/python/qapi.common.rst     |  7 +++++++
 docs/devel/python/qapi.error.rst      |  7 +++++++
 docs/devel/python/qapi.events.rst     |  7 +++++++
 docs/devel/python/qapi.expr.rst       |  7 +++++++
 docs/devel/python/qapi.gen.rst        |  7 +++++++
 docs/devel/python/qapi.introspect.rst |  7 +++++++
 docs/devel/python/qapi.main.rst       |  7 +++++++
 docs/devel/python/qapi.parser.rst     |  8 ++++++++
 docs/devel/python/qapi.rst            | 26 ++++++++++++++++++++++++
 docs/devel/python/qapi.schema.rst     |  7 +++++++
 docs/devel/python/qapi.source.rst     |  7 +++++++
 docs/devel/python/qapi.types.rst      |  7 +++++++
 docs/devel/python/qapi.visit.rst      |  7 +++++++
 scripts/qapi-lint.sh                  | 29 +++++++++++++++++++++++++++
 scripts/qapi/Makefile                 |  5 +++++
 19 files changed, 162 insertions(+), 1 deletion(-)
 create mode 100644 docs/devel/python/index.rst
 create mode 100644 docs/devel/python/qapi.commands.rst
 create mode 100644 docs/devel/python/qapi.common.rst
 create mode 100644 docs/devel/python/qapi.error.rst
 create mode 100644 docs/devel/python/qapi.events.rst
 create mode 100644 docs/devel/python/qapi.expr.rst
 create mode 100644 docs/devel/python/qapi.gen.rst
 create mode 100644 docs/devel/python/qapi.introspect.rst
 create mode 100644 docs/devel/python/qapi.main.rst
 create mode 100644 docs/devel/python/qapi.parser.rst
 create mode 100644 docs/devel/python/qapi.rst
 create mode 100644 docs/devel/python/qapi.schema.rst
 create mode 100644 docs/devel/python/qapi.source.rst
 create mode 100644 docs/devel/python/qapi.types.rst
 create mode 100644 docs/devel/python/qapi.visit.rst
 create mode 100755 scripts/qapi-lint.sh
 create mode 100644 scripts/qapi/Makefile

-- 
2.34.1