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

John Snow posted 4 patches 3 years, 1 month ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20210416192819.2958482-1-jsnow@redhat.com
Maintainers: Paolo Bonzini <pbonzini@redhat.com>, Bandan Das <bsd@redhat.com>, Laurent Vivier <lvivier@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Michael Roth <michael.roth@amd.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Thomas Huth <thuth@redhat.com>, Radoslaw Biernacki <rad@semihalf.com>, Tyrone Ting <kfting@nuvoton.com>, Eric Blake <eblake@redhat.com>, Havard Skinnemoen <hskinnemoen@google.com>, Stefan Hajnoczi <stefanha@redhat.com>, Juan Quintela <quintela@redhat.com>, Markus Armbruster <armbru@redhat.com>, Leif Lindholm <leif@nuviainc.com>, Cornelia Huck <cohuck@redhat.com>, Alexander Bulekov <alxndr@bu.edu>, Peter Maydell <peter.maydell@linaro.org>
There is a newer version of this series
docs/conf.py                               |   6 +-
docs/devel/build-system.rst                | 146 ++++++++++-----------
docs/devel/fuzzing.rst                     |   9 +-
docs/devel/index.rst                       |   1 +
docs/devel/migration.rst                   |  59 +++++----
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 +
docs/devel/qgraph.rst                      |   8 +-
docs/devel/tcg-plugins.rst                 |  14 +-
docs/devel/testing.rst                     |   8 +-
docs/interop/live-block-operations.rst     |   4 +-
docs/system/arm/cpu-features.rst           | 116 ++++++++--------
docs/system/arm/nuvoton.rst                |   2 +-
docs/system/arm/sbsa.rst                   |   4 +-
docs/system/cpu-hotplug.rst                |   2 +-
docs/system/guest-loader.rst               |   6 +-
docs/system/ppc/powernv.rst                |   8 +-
docs/system/removed-features.rst           |   2 +-
docs/system/riscv/microchip-icicle-kit.rst |   2 +-
docs/system/s390x/protvirt.rst             |  12 +-
qapi/block-core.json                       |   4 +-
scripts/qapi-lint.sh                       |  29 ++++
scripts/qapi/Makefile                      |   5 +
36 files changed, 370 insertions(+), 202 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 v2 0/4] [DO-NOT-MERGE] qapi: static typing conversion, "pt0"
Posted by John Snow 3 years, 1 month ago
This is a manual testing pre-requisite for other QAPI cleanup
patches. It isn't polished, and I am not ready to polish it, so it's
included here as an informative basis for ongoing work only.

It changes the default role for Sphinx markup involving single-backticks
from "default", which merely renders text as if it was a ``literal``, to
"any", which behaves like a cross-reference target.

To do this, existing uses of the single-backtick markup are converted
(whenever they do not resolve to something meaningful), to
double-backticks.

Then, 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.

John Snow (4):
  [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick
    (``)
  [DO-NOT-MERGE] docs/sphinx: change default role to "any"
  [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi
  [DO-NOT-MERGE]: Add some ad-hoc linting helpers.

 docs/conf.py                               |   6 +-
 docs/devel/build-system.rst                | 146 ++++++++++-----------
 docs/devel/fuzzing.rst                     |   9 +-
 docs/devel/index.rst                       |   1 +
 docs/devel/migration.rst                   |  59 +++++----
 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 +
 docs/devel/qgraph.rst                      |   8 +-
 docs/devel/tcg-plugins.rst                 |  14 +-
 docs/devel/testing.rst                     |   8 +-
 docs/interop/live-block-operations.rst     |   4 +-
 docs/system/arm/cpu-features.rst           | 116 ++++++++--------
 docs/system/arm/nuvoton.rst                |   2 +-
 docs/system/arm/sbsa.rst                   |   4 +-
 docs/system/cpu-hotplug.rst                |   2 +-
 docs/system/guest-loader.rst               |   6 +-
 docs/system/ppc/powernv.rst                |   8 +-
 docs/system/removed-features.rst           |   2 +-
 docs/system/riscv/microchip-icicle-kit.rst |   2 +-
 docs/system/s390x/protvirt.rst             |  12 +-
 qapi/block-core.json                       |   4 +-
 scripts/qapi-lint.sh                       |  29 ++++
 scripts/qapi/Makefile                      |   5 +
 36 files changed, 370 insertions(+), 202 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.30.2