qapi: convert example sections to qmp-example rST directives
Status from this message: Queued, thanks!
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v2 Latest9 patches 6 repliesApplied
- v18 patches 20 repliesSuperseded
Changes in v2 from the cover letter
- Rebased on origin/master; converted one more example
- Fixed (most?) minor nits from last review
- Didn't address lack of newline in text mode or enhanced lexer (yet)
Patches in v2 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/9 | : Add some ad-hoc linting helpers.scripts/ scripts/ | +66 | 0 replies | |
| 2/9 | docs/qapidoc: factor out do_parse()docs/ | +19 | 0 replies | |
| 3/9 | docs/qapidoc: create qmp-example directivedocs/ | +55 | 0 replies | |
| 4/9 | docs/qapidoc: add QMP highlighting to annotated qmp-example blocksdocs/ | +49 | 0 replies | |
| 5/9 | docs/sphinx: add CSS styling for qmp-example directivedocs/ | +49 | 0 replies | |
| 6/9 | qapi: convert "Example" sections without titlesqapi/ qapi/ qapi/ +22 more | +219 | 3 replies | |
| 7/9 | qapi: convert "Example" sections with titlesqapi/ qapi/ qapi/ +3 more | +52 | 0 replies | |
| 8/9 | qapi: convert "Example" sections with longer proseqapi/ qapi/ qapi/ +1 more | +62 | 0 replies | |
| 9/9 | qapi: remove "Example" doc sectiondocs/ scripts/ tests/ +2 more | +98 | 1 reply |
Reviews trailers per patch
7 of 9 patches have a Reviewed-by or Acked-by.
| Patch | Markus Armbruster |
|---|---|
| 1/9 | |
| 2/9 | R-b |
| 3/9 | A-b |
| 4/9 | A-b |
| 5/9 | A-b |
| 6/9 | |
| 7/9 | R-b |
| 8/9 | R-b |
| 9/9 | R-b |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives
This patchset focuses on converting example sections to rST directives using a new .. qmp-example:: directive.
V2:
- Rebased on origin/master; converted one more example
- Fixed (most?) minor nits from last review
- Didn't address lack of newline in text mode or enhanced lexer (yet)
Changes since this was split out from the prior series:
- Harmonie updated the CSS for the example block section.
I think it's really tidy now! Thanks Harmonie!
- Dependence on SphinxDirective was removed, but it will likely re-appear in the next series anyway.
- qapi-code-gen.rst was updated with a section on how to write examples.
- Various minor tweaks to comments, commit messages, docs, etc.
Harmonie Snow (1):
docs/sphinx: add CSS styling for qmp-example directive
John Snow (8):
[DO-NOT-MERGE]: Add some ad-hoc linting helpers. docs/qapidoc: factor out do_parse()
docs/qapidoc: create qmp-example directive docs/qapidoc: add QMP highlighting to annotated qmp-example blocks
qapi: convert "Example" sections without titles
qapi: convert "Example" sections with titles
qapi: convert "Example" sections with longer prose
qapi: remove "Example" doc section
docs/devel/qapi-code-gen.rst | 58 +++++++++-- docs/sphinx-static/theme_overrides.css | 49 ++++++++++ docs/sphinx/qapidoc.py | 130 ++++++++++++++++++++++--- qapi/acpi.json | 4 +- qapi/block-core.json | 88 +++++++++-------- qapi/block.json | 57 ++++++----- qapi/char.json | 24 +++-- qapi/control.json | 8 +- qapi/dump.json | 8 +- qapi/machine-target.json | 2 +- qapi/machine.json | 68 +++++++------ qapi/migration.json | 90 +++++++++-------- qapi/misc-target.json | 22 ++--- qapi/misc.json | 32 +++--- qapi/net.json | 22 +++-- qapi/pci.json | 2 +- qapi/qdev.json | 10 +- qapi/qom.json | 16 +-- qapi/replay.json | 8 +- qapi/rocker.json | 8 +- qapi/run-state.json | 32 +++--- qapi/tpm.json | 6 +- qapi/trace.json | 4 +- qapi/transaction.json | 2 +- qapi/ui.json | 45 ++++----- qapi/vfio.json | 2 +- qapi/virtio.json | 45 ++++++--- qapi/yank.json | 4 +- scripts/qapi-lint.sh | 61 ++++++++++++ scripts/qapi/Makefile | 5 + scripts/qapi/parser.py | 10 +- tests/qapi-schema/doc-good.json | 19 ++-- tests/qapi-schema/doc-good.out | 26 +++-- tests/qapi-schema/doc-good.txt | 23 ++--- 34 files changed, 662 insertions(+), 328 deletions(-) create mode 100755 scripts/qapi-lint.sh create mode 100644 scripts/qapi/Makefile
Signature · 1 line
2.45.0