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

John Snow posted 4 patches 1 year, 2 months ago
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/.flake8                  |  3 ++-
scripts/qapi/Makefile                 |  5 +++++
scripts/qapi/pylintrc                 |  1 +
21 files changed, 165 insertions(+), 2 deletions(-)
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 v4 0/4] [DO-NOT-MERGE] qapi: static typing conversion, "pt0"
Posted by John Snow 1 year, 2 months 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.

(Except for the last two patches, which you should totally merge.)

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.

V4:
 - Rebased on today's origin/master;
 - Updated config files to work with today's linter tool versions.

John Snow (4):
  [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi
  [DO-NOT-MERGE]: Add some ad-hoc linting helpers.
  qapi: Update flake8 config
  qapi: update pylint configuration

 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/.flake8                  |  3 ++-
 scripts/qapi/Makefile                 |  5 +++++
 scripts/qapi/pylintrc                 |  1 +
 21 files changed, 165 insertions(+), 2 deletions(-)
 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.39.0