Skip to content

qapi: add formal "intro" section

John Snow linux-edac qemu-devel 4 versions – Applied

Status from this message: Queued. Thanks!

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest13 patches 2 repliesApplied
  2. v316 patches 14 repliesSuperseded
  3. v213 patches 15 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v112 patches5 repliesSuperseded

Patches in v4 Applied

#Subject and filesSizeRepliesApplied
1/13python: temporarily restrict max mypy versionpython/setup.cfg+2 -10 replies
2/13tests/qapi: generate output in source ordertests/qapi-schema/doc-good.out tests/qapi-schema/test-qapi.py+48 -480 replies
3/13qapi/docs: remove unused QAPIDoc subsection membersscripts/qapi/parser.py+0 -60 replies
4/13qapi/docs: add has_features propertyscripts/qapi/parser.py+6 -20 replies
5/13qapi/docs: make remaining subsection members "private"scripts/qapi/parser.py+24 -240 replies
6/13qapi/docs: fix comment phrasingscripts/qapi/parser.py+1 -10 replies
7/13qapi/docs: add "Intro" sectiondocs/sphinx/qapidoc.py scripts/qapi/parser.py+3 -20 replies
8/13qapi/parser: move _insert_near_kind() methodscripts/qapi/parser.py+17 -160 replies
9/13qapi/parser: add mea culpa comment for ensure_returnsscripts/qapi/parser.py+7 -00 replies
10/13qapi/docs: adjust stub member insertion algorithmdocs/sphinx/qapidoc.py scripts/qapi/parser.py+64 -360 replies
11/13qapi/docs: remove implicit Plain sectionscripts/qapi/parser.py tests/qapi-schema/doc-good.out+1 -170 replies
12/13qapi/docs: add rendering for INTRO sectionsdocs/sphinx/qapidoc.py+14 -30 replies
13/13qapi/docs: add "Intro" section parsingdocs/devel/qapi-code-gen.rst scripts/qapi/parser.py tests/qapi-schema/doc-good.out+27 -110 replies

Reviews trailers per patch

1 of 13 patches has a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchMarkus Armbruster
SeriesR-b
1/13
2/13
3/13R-b
4/13
5/13
6/13
7/13
8/13
9/13
10/13
11/13
12/13
13/13

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v4 thread

Cover letter [PATCH v4 00/13] qapi: add formal "intro" section

Hiya, this is a series that explores a potential syntax for a designated "Intro" section. Markus knows why I want this, but for everyone else: a designated "Introduction" section is useful for the desired "inliner" feature for the new QAPI doc system. Commits explain a bit more. This is prep work and doesn't really change anything tangibly except source code syntax for the QAPI docs.

It is designed so that this conversion can happen incrementally with no actual difference to the rendered manuals, so each QAPI module can be converted one at a time for easier review and merging in an arbitrary order.

V4: A few minor comment touch-ups; omitted module conversions.

V3: changed intro section syntax, made various fixes and changes; I'm going to be honest Markus I did not keep a strict account this time ;_;

V2: punt intro sections to the subsequent line and adjust the parser accordingly. Left as an RFC patch that undoes some things this series does instead of properly factoring into the series.

John Snow (13):
python: temporarily restrict max mypy version tests/qapi: generate output in source order qapi/docs: remove unused QAPIDoc subsection members qapi/docs: add has_features property qapi/docs: make remaining subsection members "private" qapi/docs: fix comment phrasing
qapi/docs: add "Intro" section
qapi/parser: move _insert_near_kind() method qapi/parser: add mea culpa comment for ensure_returns qapi/docs: adjust stub member insertion algorithm qapi/docs: remove implicit Plain section qapi/docs: add rendering for INTRO sections qapi/docs: add "Intro" section parsing

 docs/devel/qapi-code-gen.rst   |  16 ++--
 docs/sphinx/qapidoc.py         |  61 +++++++-----
 python/setup.cfg               |   3 +-
 scripts/qapi/parser.py         | 167 +++++++++++++++++++--------------
 tests/qapi-schema/doc-good.out |  86 +++++++++--------
 tests/qapi-schema/test-qapi.py |  14 +--
 6 files changed, 197 insertions(+), 150 deletions(-)
Signature · 1 line
2.54.0