Thanks for your service!
Remove the old qapidoc and the option to enable the transmogrifier,
leaving the "transmogrifier" as the ONLY qapi doc generator. This in
effect also converts the QAPI test to use the new documentation
generator, too.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/interop/qemu-ga-ref.rst | 1 -
docs/interop/qemu-qmp-ref.rst | 1 -
docs/interop/qemu-storage-daemon-qmp-ref.rst | 1 -
docs/sphinx/qapidoc.py | 25 +-
docs/sphinx/qapidoc_legacy.py | 440 -------------------
python/tests/qapi-isort.sh | 2 +-
6 files changed, 2 insertions(+), 468 deletions(-)
delete mode 100644 docs/sphinx/qapidoc_legacy.py
diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
index 25f6e24b03c..ea6652ae43e 100644
--- a/docs/interop/qemu-ga-ref.rst
+++ b/docs/interop/qemu-ga-ref.rst
@@ -2,5 +2,4 @@ QEMU Guest Agent Protocol Reference
===================================
.. qapi-doc:: qga/qapi-schema.json
- :transmogrify:
:namespace: QGA
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
index 3bc1ca12b16..f0ce39ad67d 100644
--- a/docs/interop/qemu-qmp-ref.rst
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -7,5 +7,4 @@ QEMU QMP Reference Manual
:local:
.. qapi-doc:: qapi/qapi-schema.json
- :transmogrify:
:namespace: QMP
diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst
index dc7bde262ae..4dbb6a2cc83 100644
--- a/docs/interop/qemu-storage-daemon-qmp-ref.rst
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
@@ -5,5 +5,4 @@ QEMU Storage Daemon QMP Reference Manual
:local:
.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
- :transmogrify:
:namespace: QSD
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 8011ac9efaf..c9c477378f5 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -64,8 +64,6 @@
from sphinx.util.docutils import SphinxDirective, switch_source_input
from sphinx.util.nodes import nested_parse_with_titles
-from qapidoc_legacy import QAPISchemaGenRSTVisitor # type: ignore
-
if TYPE_CHECKING:
from typing import (
@@ -504,15 +502,9 @@ class QAPIDocDirective(NestedDirective):
option_spec = {
"qapifile": directives.unchanged_required,
"namespace": directives.unchanged,
- "transmogrify": directives.flag,
}
has_content = False
- def new_serialno(self) -> str:
- """Return a unique new ID string suitable for use as a node's ID"""
- env = self.state.document.settings.env
- return "qapidoc-%d" % env.new_serialno("qapidoc")
-
def transmogrify(self, schema: QAPISchema) -> nodes.Element:
logger.info("Transmogrifying QAPI to rST ...")
vis = Transmogrifier()
@@ -590,21 +582,10 @@ def write_intermediate(self, content: StringList, filename: str) -> None:
outfile.write(f" {rcol}")
outfile.write("\n")
- def legacy(self, schema: QAPISchema) -> nodes.Element:
- vis = QAPISchemaGenRSTVisitor(self)
- vis.visit_begin(schema)
- for doc in schema.docs:
- if doc.symbol:
- vis.symbol(doc, schema.lookup_entity(doc.symbol))
- else:
- vis.freeform(doc)
- return vis.get_document_node() # type: ignore
-
def run(self) -> Sequence[nodes.Node]:
env = self.state.document.settings.env
qapifile = env.config.qapidoc_srctree + "/" + self.arguments[0]
qapidir = os.path.dirname(qapifile)
- transmogrify = "transmogrify" in self.options
try:
schema = QAPISchema(qapifile)
@@ -617,11 +598,7 @@ def run(self) -> Sequence[nodes.Node]:
# so they are displayed nicely to the user
raise ExtensionError(str(err)) from err
- if transmogrify:
- contentnode = self.transmogrify(schema)
- else:
- contentnode = self.legacy(schema)
-
+ contentnode = self.transmogrify(schema)
return contentnode.children
diff --git a/docs/sphinx/qapidoc_legacy.py b/docs/sphinx/qapidoc_legacy.py
deleted file mode 100644
index 13520f4c26b..00000000000
--- a/docs/sphinx/qapidoc_legacy.py
+++ /dev/null
@@ -1,440 +0,0 @@
-# coding=utf-8
-# type: ignore
-#
-# QEMU qapidoc QAPI file parsing extension
-#
-# Copyright (c) 2020 Linaro
-#
-# This work is licensed under the terms of the GNU GPLv2 or later.
-# See the COPYING file in the top-level directory.
-
-"""
-qapidoc is a Sphinx extension that implements the qapi-doc directive
-
-The purpose of this extension is to read the documentation comments
-in QAPI schema files, and insert them all into the current document.
-
-It implements one new rST directive, "qapi-doc::".
-Each qapi-doc:: directive takes one argument, which is the
-pathname of the schema file to process, relative to the source tree.
-
-The docs/conf.py file must set the qapidoc_srctree config value to
-the root of the QEMU source tree.
-
-The Sphinx documentation on writing extensions is at:
-https://www.sphinx-doc.org/en/master/development/index.html
-"""
-
-import re
-import textwrap
-
-from docutils import nodes
-from docutils.statemachine import ViewList
-from qapi.error import QAPISemError
-from qapi.gen import QAPISchemaVisitor
-from qapi.parser import QAPIDoc
-
-
-def dedent(text: str) -> str:
- # Adjust indentation to make description text parse as paragraph.
-
- lines = text.splitlines(True)
- if re.match(r"\s+", lines[0]):
- # First line is indented; description started on the line after
- # the name. dedent the whole block.
- return textwrap.dedent(text)
-
- # Descr started on same line. Dedent line 2+.
- return lines[0] + textwrap.dedent("".join(lines[1:]))
-
-
-class QAPISchemaGenRSTVisitor(QAPISchemaVisitor):
- """A QAPI schema visitor which generates docutils/Sphinx nodes
-
- This class builds up a tree of docutils/Sphinx nodes corresponding
- to documentation for the various QAPI objects. To use it, first
- create a QAPISchemaGenRSTVisitor object, and call its
- visit_begin() method. Then you can call one of the two methods
- 'freeform' (to add documentation for a freeform documentation
- chunk) or 'symbol' (to add documentation for a QAPI symbol). These
- will cause the visitor to build up the tree of document
- nodes. Once you've added all the documentation via 'freeform' and
- 'symbol' method calls, you can call 'get_document_nodes' to get
- the final list of document nodes (in a form suitable for returning
- from a Sphinx directive's 'run' method).
- """
- def __init__(self, sphinx_directive):
- self._cur_doc = None
- self._sphinx_directive = sphinx_directive
- self._top_node = nodes.section()
- self._active_headings = [self._top_node]
-
- def _make_dlitem(self, term, defn):
- """Return a dlitem node with the specified term and definition.
-
- term should be a list of Text and literal nodes.
- defn should be one of:
- - a string, which will be handed to _parse_text_into_node
- - a list of Text and literal nodes, which will be put into
- a paragraph node
- """
- dlitem = nodes.definition_list_item()
- dlterm = nodes.term('', '', *term)
- dlitem += dlterm
- if defn:
- dldef = nodes.definition()
- if isinstance(defn, list):
- dldef += nodes.paragraph('', '', *defn)
- else:
- self._parse_text_into_node(defn, dldef)
- dlitem += dldef
- return dlitem
-
- def _make_section(self, title):
- """Return a section node with optional title"""
- section = nodes.section(ids=[self._sphinx_directive.new_serialno()])
- if title:
- section += nodes.title(title, title)
- return section
-
- def _nodes_for_ifcond(self, ifcond, with_if=True):
- """Return list of Text, literal nodes for the ifcond
-
- Return a list which gives text like ' (If: condition)'.
- If with_if is False, we don't return the "(If: " and ")".
- """
-
- doc = ifcond.docgen()
- if not doc:
- return []
- doc = nodes.literal('', doc)
- if not with_if:
- return [doc]
-
- nodelist = [nodes.Text(' ('), nodes.strong('', 'If: ')]
- nodelist.append(doc)
- nodelist.append(nodes.Text(')'))
- return nodelist
-
- def _nodes_for_one_member(self, member):
- """Return list of Text, literal nodes for this member
-
- Return a list of doctree nodes which give text like
- 'name: type (optional) (If: ...)' suitable for use as the
- 'term' part of a definition list item.
- """
- term = [nodes.literal('', member.name)]
- if member.type.doc_type():
- term.append(nodes.Text(': '))
- term.append(nodes.literal('', member.type.doc_type()))
- if member.optional:
- term.append(nodes.Text(' (optional)'))
- if member.ifcond.is_present():
- term.extend(self._nodes_for_ifcond(member.ifcond))
- return term
-
- def _nodes_for_variant_when(self, branches, variant):
- """Return list of Text, literal nodes for variant 'when' clause
-
- Return a list of doctree nodes which give text like
- 'when tagname is variant (If: ...)' suitable for use in
- the 'branches' part of a definition list.
- """
- term = [nodes.Text(' when '),
- nodes.literal('', branches.tag_member.name),
- nodes.Text(' is '),
- nodes.literal('', '"%s"' % variant.name)]
- if variant.ifcond.is_present():
- term.extend(self._nodes_for_ifcond(variant.ifcond))
- return term
-
- def _nodes_for_members(self, doc, what, base=None, branches=None):
- """Return list of doctree nodes for the table of members"""
- dlnode = nodes.definition_list()
- for section in doc.args.values():
- term = self._nodes_for_one_member(section.member)
- # TODO drop fallbacks when undocumented members are outlawed
- if section.text:
- defn = dedent(section.text)
- else:
- defn = [nodes.Text('Not documented')]
-
- dlnode += self._make_dlitem(term, defn)
-
- if base:
- dlnode += self._make_dlitem([nodes.Text('The members of '),
- nodes.literal('', base.doc_type())],
- None)
-
- if branches:
- for v in branches.variants:
- if v.type.name == 'q_empty':
- continue
- assert not v.type.is_implicit()
- term = [nodes.Text('The members of '),
- nodes.literal('', v.type.doc_type())]
- term.extend(self._nodes_for_variant_when(branches, v))
- dlnode += self._make_dlitem(term, None)
-
- if not dlnode.children:
- return []
-
- section = self._make_section(what)
- section += dlnode
- return [section]
-
- def _nodes_for_enum_values(self, doc):
- """Return list of doctree nodes for the table of enum values"""
- seen_item = False
- dlnode = nodes.definition_list()
- for section in doc.args.values():
- termtext = [nodes.literal('', section.member.name)]
- if section.member.ifcond.is_present():
- termtext.extend(self._nodes_for_ifcond(section.member.ifcond))
- # TODO drop fallbacks when undocumented members are outlawed
- if section.text:
- defn = dedent(section.text)
- else:
- defn = [nodes.Text('Not documented')]
-
- dlnode += self._make_dlitem(termtext, defn)
- seen_item = True
-
- if not seen_item:
- return []
-
- section = self._make_section('Values')
- section += dlnode
- return [section]
-
- def _nodes_for_arguments(self, doc, arg_type):
- """Return list of doctree nodes for the arguments section"""
- if arg_type and not arg_type.is_implicit():
- assert not doc.args
- section = self._make_section('Arguments')
- dlnode = nodes.definition_list()
- dlnode += self._make_dlitem(
- [nodes.Text('The members of '),
- nodes.literal('', arg_type.name)],
- None)
- section += dlnode
- return [section]
-
- return self._nodes_for_members(doc, 'Arguments')
-
- def _nodes_for_features(self, doc):
- """Return list of doctree nodes for the table of features"""
- seen_item = False
- dlnode = nodes.definition_list()
- for section in doc.features.values():
- dlnode += self._make_dlitem(
- [nodes.literal('', section.member.name)], dedent(section.text))
- seen_item = True
-
- if not seen_item:
- return []
-
- section = self._make_section('Features')
- section += dlnode
- return [section]
-
- def _nodes_for_sections(self, doc):
- """Return list of doctree nodes for additional sections"""
- nodelist = []
- for section in doc.sections:
- if section.kind == QAPIDoc.Kind.TODO:
- # Hide TODO: sections
- continue
-
- if section.kind == QAPIDoc.Kind.PLAIN:
- # Sphinx cannot handle sectionless titles;
- # Instead, just append the results to the prior section.
- container = nodes.container()
- self._parse_text_into_node(section.text, container)
- nodelist += container.children
- continue
-
- snode = self._make_section(section.kind.name.title())
- self._parse_text_into_node(dedent(section.text), snode)
- nodelist.append(snode)
- return nodelist
-
- def _nodes_for_if_section(self, ifcond):
- """Return list of doctree nodes for the "If" section"""
- nodelist = []
- if ifcond.is_present():
- snode = self._make_section('If')
- snode += nodes.paragraph(
- '', '', *self._nodes_for_ifcond(ifcond, with_if=False)
- )
- nodelist.append(snode)
- return nodelist
-
- def _add_doc(self, typ, sections):
- """Add documentation for a command/object/enum...
-
- We assume we're documenting the thing defined in self._cur_doc.
- typ is the type of thing being added ("Command", "Object", etc)
-
- sections is a list of nodes for sections to add to the definition.
- """
-
- doc = self._cur_doc
- snode = nodes.section(ids=[self._sphinx_directive.new_serialno()])
- snode += nodes.title('', '', *[nodes.literal(doc.symbol, doc.symbol),
- nodes.Text(' (' + typ + ')')])
- self._parse_text_into_node(doc.body.text, snode)
- for s in sections:
- if s is not None:
- snode += s
- self._add_node_to_current_heading(snode)
-
- def visit_enum_type(self, name, info, ifcond, features, members, prefix):
- doc = self._cur_doc
- self._add_doc('Enum',
- self._nodes_for_enum_values(doc)
- + self._nodes_for_features(doc)
- + self._nodes_for_sections(doc)
- + self._nodes_for_if_section(ifcond))
-
- def visit_object_type(self, name, info, ifcond, features,
- base, members, branches):
- doc = self._cur_doc
- if base and base.is_implicit():
- base = None
- self._add_doc('Object',
- self._nodes_for_members(doc, 'Members', base, branches)
- + self._nodes_for_features(doc)
- + self._nodes_for_sections(doc)
- + self._nodes_for_if_section(ifcond))
-
- def visit_alternate_type(self, name, info, ifcond, features,
- alternatives):
- doc = self._cur_doc
- self._add_doc('Alternate',
- self._nodes_for_members(doc, 'Members')
- + self._nodes_for_features(doc)
- + self._nodes_for_sections(doc)
- + self._nodes_for_if_section(ifcond))
-
- def visit_command(self, name, info, ifcond, features, arg_type,
- ret_type, gen, success_response, boxed, allow_oob,
- allow_preconfig, coroutine):
- doc = self._cur_doc
- self._add_doc('Command',
- self._nodes_for_arguments(doc, arg_type)
- + self._nodes_for_features(doc)
- + self._nodes_for_sections(doc)
- + self._nodes_for_if_section(ifcond))
-
- def visit_event(self, name, info, ifcond, features, arg_type, boxed):
- doc = self._cur_doc
- self._add_doc('Event',
- self._nodes_for_arguments(doc, arg_type)
- + self._nodes_for_features(doc)
- + self._nodes_for_sections(doc)
- + self._nodes_for_if_section(ifcond))
-
- def symbol(self, doc, entity):
- """Add documentation for one symbol to the document tree
-
- This is the main entry point which causes us to add documentation
- nodes for a symbol (which could be a 'command', 'object', 'event',
- etc). We do this by calling 'visit' on the schema entity, which
- will then call back into one of our visit_* methods, depending
- on what kind of thing this symbol is.
- """
- self._cur_doc = doc
- entity.visit(self)
- self._cur_doc = None
-
- def _start_new_heading(self, heading, level):
- """Start a new heading at the specified heading level
-
- Create a new section whose title is 'heading' and which is placed
- in the docutils node tree as a child of the most recent level-1
- heading. Subsequent document sections (commands, freeform doc chunks,
- etc) will be placed as children of this new heading section.
- """
- if len(self._active_headings) < level:
- raise QAPISemError(self._cur_doc.info,
- 'Level %d subheading found outside a '
- 'level %d heading'
- % (level, level - 1))
- snode = self._make_section(heading)
- self._active_headings[level - 1] += snode
- self._active_headings = self._active_headings[:level]
- self._active_headings.append(snode)
- return snode
-
- def _add_node_to_current_heading(self, node):
- """Add the node to whatever the current active heading is"""
- self._active_headings[-1] += node
-
- def freeform(self, doc):
- """Add a piece of 'freeform' documentation to the document tree
-
- A 'freeform' document chunk doesn't relate to any particular
- symbol (for instance, it could be an introduction).
-
- If the freeform document starts with a line of the form
- '= Heading text', this is a section or subsection heading, with
- the heading level indicated by the number of '=' signs.
- """
-
- # QAPIDoc documentation says free-form documentation blocks
- # must have only a body section, nothing else.
- assert not doc.sections
- assert not doc.args
- assert not doc.features
- self._cur_doc = doc
-
- text = doc.body.text
- if re.match(r'=+ ', text):
- # Section/subsection heading (if present, will always be
- # the first line of the block)
- (heading, _, text) = text.partition('\n')
- (leader, _, heading) = heading.partition(' ')
- node = self._start_new_heading(heading, len(leader))
- if text == '':
- return
- else:
- node = nodes.container()
-
- self._parse_text_into_node(text, node)
- self._cur_doc = None
-
- def _parse_text_into_node(self, doctext, node):
- """Parse a chunk of QAPI-doc-format text into the node
-
- The doc comment can contain most inline rST markup, including
- bulleted and enumerated lists.
- As an extra permitted piece of markup, @var will be turned
- into ``var``.
- """
-
- # Handle the "@var means ``var`` case
- doctext = re.sub(r'@([\w-]+)', r'``\1``', doctext)
-
- rstlist = ViewList()
- for line in doctext.splitlines():
- # The reported line number will always be that of the start line
- # of the doc comment, rather than the actual location of the error.
- # Being more precise would require overhaul of the QAPIDoc class
- # to track lines more exactly within all the sub-parts of the doc
- # comment, as well as counting lines here.
- rstlist.append(line, self._cur_doc.info.fname,
- self._cur_doc.info.line)
- # Append a blank line -- in some cases rST syntax errors get
- # attributed to the line after one with actual text, and if there
- # isn't anything in the ViewList corresponding to that then Sphinx
- # 1.6's AutodocReporter will then misidentify the source/line location
- # in the error message (usually attributing it to the top-level
- # .rst file rather than the offending .json file). The extra blank
- # line won't affect the rendered output.
- rstlist.append("", self._cur_doc.info.fname, self._cur_doc.info.line)
- self._sphinx_directive.do_parse(rstlist, node)
-
- def get_document_node(self):
- """Return the root docutils node which makes up the document"""
- return self._top_node
diff --git a/python/tests/qapi-isort.sh b/python/tests/qapi-isort.sh
index 78dd947f68c..067c16d5d94 100755
--- a/python/tests/qapi-isort.sh
+++ b/python/tests/qapi-isort.sh
@@ -3,6 +3,6 @@
python3 -m isort --sp . -c ../scripts/qapi/
# Force isort to recognize "compat" as a local module and not third-party
-python3 -m isort --sp . -c -p compat -p qapidoc_legacy \
+python3 -m isort --sp . -c -p compat \
../docs/sphinx/qapi_domain.py \
../docs/sphinx/qapidoc.py
--
2.48.1John Snow <jsnow@redhat.com> writes:
> Thanks for your service!
>
> Remove the old qapidoc and the option to enable the transmogrifier,
> leaving the "transmogrifier" as the ONLY qapi doc generator. This in
> effect also converts the QAPI test to use the new documentation
> generator, too.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
Fails "make check", because tests/qapi-schema/doc-good.txt needs an
update.
Unfortunately, the diff of the update is less than useful. To make
sense of what changes, I split doc-good.txt into parts before and after,
and diffed those.
diff -rupw o/01 n/01
--- o/01 2025-06-16 13:53:05.036940854 +0200
+++ n/01 2025-06-16 13:49:07.167435996 +0200
@@ -1,11 +1,13 @@
Section
*******
+Just text, no heading.
+
Looks like a bug fix. Needs a mention in the commit message then.
Subsection
==========
-*with emphasis* "var" {in braces}
+*with emphasis* @var {in braces}
Rendering of @references changes. Okay.
* List item one
@@ -35,4 +37,3 @@ Example:
-> in <- out Examples: - *verbatim* - {braces}
-
diff -rupw o/02 n/02
--- o/02 2025-06-16 13:53:17.133712123 +0200
+++ n/02 2025-06-16 13:49:21.024174424 +0200
@@ -1,32 +1,15 @@
-"Enum" (Enum)
--------------
+Enum Enum
+ *Availability*: "IFCOND"
+ Values:
+ * **one** -- The _one_ {and only}, description on the same line
-Values
-~~~~~~
+ * **two** -- Not documented
-"one" (**If: **"IFONE")
Member conditional is lost. Known issue; see commit dbf51d15fdb.
- The _one_ {and only}, description on the same line
+ Features:
+ * **enum-feat** -- Also _one_ {and only}
-"two"
- Not documented
-
-
-Features
-~~~~~~~~
-
-"enum-feat"
- Also _one_ {and only}
-
-"enum-member-feat"
- a member feature
+ * **enum-member-feat** -- a member feature
"two" is undocumented
-
-If
-~~
-
-"IFCOND"
-
-
diff -rupw o/03 n/03
--- o/03 2025-06-16 13:53:27.556514971 +0200
+++ n/03 2025-06-16 13:50:44.582595942 +0200
@@ -1,17 +1,7 @@
-"Base" (Object)
----------------
-
-
-Members
-~~~~~~~
-
-"base1": "Enum"
- description starts on a new line, minimally indented
-
-
-If
-~~
-
-"IFALL1 and IFALL2"
+Object Base
+ *Availability*: "IFALL1 and IFALL2"
+ Members:
+ * **base1** ("Enum") -- description starts on a new line,
+ minimally indented
diff -rupw o/04 n/04
--- o/04 2025-06-16 13:53:39.356291772 +0200
+++ n/04 2025-06-16 13:50:54.486408751 +0200
@@ -1,5 +1,4 @@
-"Variant1" (Object)
--------------------
+Object Variant1
A paragraph
@@ -7,21 +6,11 @@ Another paragraph
"var1" is undocumented
+ Members:
+ * **var1** ("string") -- Not documented
-Members
-~~~~~~~
-
-"var1": "string" (**If: **"IFSTR")
Likewise.
- Not documented
-
-
-Features
-~~~~~~~~
-
-"variant1-feat"
- a feature
-
-"member-feat"
- a member feature
+ Features:
+ * **variant1-feat** -- a feature
+ * **member-feat** -- a member feature
diff -rupw o/05 n/05
--- o/05 2025-06-16 13:53:43.429214731 +0200
+++ n/05 2025-06-16 13:51:05.247205330 +0200
@@ -1,4 +1,2 @@
-"Variant2" (Object)
--------------------
-
+Object Variant2
diff -rupw o/06 n/06
--- o/06 2025-06-16 13:53:48.461119551 +0200
+++ n/06 2025-06-16 13:51:10.990096739 +0200
@@ -1,19 +1,12 @@
-"Object" (Object)
------------------
+Object Object
+ Members:
+ * The members of "Base".
-Members
-~~~~~~~
+ * When "base1" is "one": The members of "Variant1".
-The members of "Base"
-The members of "Variant1" when "base1" is ""one""
-The members of "Variant2" when "base1" is ""two"" (**If: **"IFONE or
-IFTWO")
Likewise.
-
-Features
-~~~~~~~~
-
-"union-feat1"
- a feature
+ * When "base1" is "two": The members of "Variant2".
+ Features:
+ * **union-feat1** -- a feature
diff -rupw o/07 n/07
--- o/07 2025-06-16 13:53:55.988977158 +0200
+++ n/07 2025-06-16 13:51:16.869985559 +0200
@@ -1,28 +1,13 @@
-"Alternate" (Alternate)
------------------------
+Alternate Alternate
+ *Availability*: "not (IFONE or IFTWO)"
+ Alternatives:
+ * **i** ("int") -- description starts on the same line remainder
+ indented the same "b" is undocumented
-Members
-~~~~~~~
+ * **b** ("boolean") -- Not documented
-"i": "int"
- description starts on the same line remainder indented the same "b"
- is undocumented
-
-"b": "boolean"
- Not documented
-
-
-Features
-~~~~~~~~
-
-"alt-feat"
- a feature
-
-
-If
-~~
-
-"not (IFONE or IFTWO)"
+ Features:
+ * **alt-feat** -- a feature
diff -rupw o/08 n/08
--- o/08 2025-06-16 13:54:11.692680115 +0200
+++ n/08 2025-06-16 13:51:35.957624638 +0200
@@ -1,47 +1,29 @@
Another subsection
==================
+Command cmd (Since: 2.10)
-"cmd" (Command)
----------------
+ Arguments:
+ * **arg1** ("int") -- description starts on a new line, indented
+ * **arg2** ("string", *optional*) -- description starts on the
+ same line remainder indented differently
-Arguments
-~~~~~~~~~
+ * **arg3** ("boolean") -- Not documented
-"arg1": "int"
- description starts on a new line, indented
+ Features:
+ * **cmd-feat1** -- a feature
-"arg2": "string" (optional)
- description starts on the same line remainder indented differently
-
-"arg3": "boolean"
- Not documented
-
-
-Features
-~~~~~~~~
-
-"cmd-feat1"
- a feature
-
-"cmd-feat2"
- another feature
+ * **cmd-feat2** -- another feature
Note:
"arg3" is undocumented
+ Return:
+ "Object" -- "Object"
-Returns
-~~~~~~~
-
-"Object"
-
-
-Errors
-~~~~~~
-
+ Errors:
* some
Notes:
@@ -68,10 +50,3 @@ Examples:
Note::
Ceci n'est pas une note
-
-Since
-~~~~~
-
-2.10
-
-
diff -rupw o/09 n/09
--- o/09 2025-06-16 14:11:32.819939859 +0200
+++ n/09 2025-06-16 13:51:43.469482599 +0200
@@ -1,22 +1,14 @@
-"cmd-boxed" (Command)
----------------------
+Command cmd-boxed
If you're bored enough to read this, go see a video of boxed cats
+ Arguments:
+ * The members of "Object".
-Arguments
-~~~~~~~~~
+ Features:
+ * **cmd-feat1** -- a feature
-The members of "Object"
-
-Features
-~~~~~~~~
-
-"cmd-feat1"
- a feature
-
-"cmd-feat2"
- another feature
+ * **cmd-feat2** -- another feature
Example::
@@ -24,4 +16,3 @@ Example::
<- ... has no title ...
-
diff -rupw o/10 n/10
--- o/10 2025-06-16 14:11:35.771883514 +0200
+++ n/10 2025-06-16 13:51:46.653422395 +0200
@@ -1,14 +1,7 @@
-"EVT_BOXED" (Event)
--------------------
+Event EVT_BOXED
+ Members:
+ * The members of "Object".
-Arguments
-~~~~~~~~~
-
-The members of "Object"
-
-Features
-~~~~~~~~
-
-"feat3"
- a feature
+ Features:
+ * **feat3** -- a feature
The only unexpected change is the first hunk.
On Mon, Jun 16, 2025 at 8:20 AM Markus Armbruster <armbru@redhat.com> wrote:
> John Snow <jsnow@redhat.com> writes:
>
> > Thanks for your service!
> >
> > Remove the old qapidoc and the option to enable the transmogrifier,
> > leaving the "transmogrifier" as the ONLY qapi doc generator. This in
> > effect also converts the QAPI test to use the new documentation
> > generator, too.
> >
> > Signed-off-by: John Snow <jsnow@redhat.com>
>
> Fails "make check", because tests/qapi-schema/doc-good.txt needs an
> update.
>
> Unfortunately, the diff of the update is less than useful. To make
> sense of what changes, I split doc-good.txt into parts before and after,
> and diffed those.
>
>
> diff -rupw o/01 n/01
> --- o/01 2025-06-16 13:53:05.036940854 +0200
> +++ n/01 2025-06-16 13:49:07.167435996 +0200
> @@ -1,11 +1,13 @@
> Section
> *******
>
> +Just text, no heading.
> +
>
> Looks like a bug fix. Needs a mention in the commit message then.
>
I think before, these sections just got ... discarded? but with no special
formatting, they just get copied through. You could call it a bugfix, you
could call it an unintentional side effect.
For my money, I think it's fine to allow free-form docs to have any
arbitrary content. If it produces bad results, don't do it, then. Fewer
constraints = less code.
>
> Subsection
> ==========
>
> -*with emphasis* "var" {in braces}
> +*with emphasis* @var {in braces}
>
> Rendering of @references changes. Okay.
>
Unintentional. Freeform sections are handled outside of "visit_sections",
because they are not attached to an entity, and so the @references
rendering is missed. Bug, I'll fix it.
>
> * List item one
>
> @@ -35,4 +37,3 @@ Example:
>
> -> in <- out Examples: - *verbatim* - {braces}
>
> -
> diff -rupw o/02 n/02
> --- o/02 2025-06-16 13:53:17.133712123 +0200
> +++ n/02 2025-06-16 13:49:21.024174424 +0200
> @@ -1,32 +1,15 @@
> -"Enum" (Enum)
> --------------
> +Enum Enum
> + *Availability*: "IFCOND"
>
> + Values:
> + * **one** -- The _one_ {and only}, description on the same line
>
> -Values
> -~~~~~~
> + * **two** -- Not documented
>
> -"one" (**If: **"IFONE")
>
> Member conditional is lost. Known issue; see commit dbf51d15fdb.
>
> - The _one_ {and only}, description on the same line
> + Features:
> + * **enum-feat** -- Also _one_ {and only}
>
> -"two"
> - Not documented
> -
> -
> -Features
> -~~~~~~~~
> -
> -"enum-feat"
> - Also _one_ {and only}
> -
> -"enum-member-feat"
> - a member feature
> + * **enum-member-feat** -- a member feature
>
> "two" is undocumented
>
> -
> -If
> -~~
> -
> -"IFCOND"
> -
> -
> diff -rupw o/03 n/03
> --- o/03 2025-06-16 13:53:27.556514971 +0200
> +++ n/03 2025-06-16 13:50:44.582595942 +0200
> @@ -1,17 +1,7 @@
> -"Base" (Object)
> ----------------
> -
> -
> -Members
> -~~~~~~~
> -
> -"base1": "Enum"
> - description starts on a new line, minimally indented
> -
> -
> -If
> -~~
> -
> -"IFALL1 and IFALL2"
> +Object Base
> + *Availability*: "IFALL1 and IFALL2"
>
> + Members:
> + * **base1** ("Enum") -- description starts on a new line,
> + minimally indented
>
> diff -rupw o/04 n/04
> --- o/04 2025-06-16 13:53:39.356291772 +0200
> +++ n/04 2025-06-16 13:50:54.486408751 +0200
> @@ -1,5 +1,4 @@
> -"Variant1" (Object)
> --------------------
> +Object Variant1
>
> A paragraph
>
> @@ -7,21 +6,11 @@ Another paragraph
>
> "var1" is undocumented
>
> + Members:
> + * **var1** ("string") -- Not documented
>
> -Members
> -~~~~~~~
> -
> -"var1": "string" (**If: **"IFSTR")
>
> Likewise.
>
> - Not documented
> -
> -
> -Features
> -~~~~~~~~
> -
> -"variant1-feat"
> - a feature
> -
> -"member-feat"
> - a member feature
> + Features:
> + * **variant1-feat** -- a feature
>
> + * **member-feat** -- a member feature
>
> diff -rupw o/05 n/05
> --- o/05 2025-06-16 13:53:43.429214731 +0200
> +++ n/05 2025-06-16 13:51:05.247205330 +0200
> @@ -1,4 +1,2 @@
> -"Variant2" (Object)
> --------------------
> -
> +Object Variant2
>
> diff -rupw o/06 n/06
> --- o/06 2025-06-16 13:53:48.461119551 +0200
> +++ n/06 2025-06-16 13:51:10.990096739 +0200
> @@ -1,19 +1,12 @@
> -"Object" (Object)
> ------------------
> +Object Object
>
> + Members:
> + * The members of "Base".
>
> -Members
> -~~~~~~~
> + * When "base1" is "one": The members of "Variant1".
>
> -The members of "Base"
> -The members of "Variant1" when "base1" is ""one""
> -The members of "Variant2" when "base1" is ""two"" (**If: **"IFONE or
> -IFTWO")
>
> Likewise.
>
> -
> -Features
> -~~~~~~~~
> -
> -"union-feat1"
> - a feature
> + * When "base1" is "two": The members of "Variant2".
>
> + Features:
> + * **union-feat1** -- a feature
>
> diff -rupw o/07 n/07
> --- o/07 2025-06-16 13:53:55.988977158 +0200
> +++ n/07 2025-06-16 13:51:16.869985559 +0200
> @@ -1,28 +1,13 @@
> -"Alternate" (Alternate)
> ------------------------
> +Alternate Alternate
> + *Availability*: "not (IFONE or IFTWO)"
>
> + Alternatives:
> + * **i** ("int") -- description starts on the same line remainder
> + indented the same "b" is undocumented
>
> -Members
> -~~~~~~~
> + * **b** ("boolean") -- Not documented
>
> -"i": "int"
> - description starts on the same line remainder indented the same "b"
> - is undocumented
> -
> -"b": "boolean"
> - Not documented
> -
> -
> -Features
> -~~~~~~~~
> -
> -"alt-feat"
> - a feature
> -
> -
> -If
> -~~
> -
> -"not (IFONE or IFTWO)"
> + Features:
> + * **alt-feat** -- a feature
>
>
> diff -rupw o/08 n/08
> --- o/08 2025-06-16 13:54:11.692680115 +0200
> +++ n/08 2025-06-16 13:51:35.957624638 +0200
> @@ -1,47 +1,29 @@
> Another subsection
> ==================
>
> +Command cmd (Since: 2.10)
>
> -"cmd" (Command)
> ----------------
> + Arguments:
> + * **arg1** ("int") -- description starts on a new line, indented
>
> + * **arg2** ("string", *optional*) -- description starts on the
> + same line remainder indented differently
>
> -Arguments
> -~~~~~~~~~
> + * **arg3** ("boolean") -- Not documented
>
> -"arg1": "int"
> - description starts on a new line, indented
> + Features:
> + * **cmd-feat1** -- a feature
>
> -"arg2": "string" (optional)
> - description starts on the same line remainder indented differently
> -
> -"arg3": "boolean"
> - Not documented
> -
> -
> -Features
> -~~~~~~~~
> -
> -"cmd-feat1"
> - a feature
> -
> -"cmd-feat2"
> - another feature
> + * **cmd-feat2** -- another feature
>
> Note:
>
> "arg3" is undocumented
>
> + Return:
> + "Object" -- "Object"
>
> -Returns
> -~~~~~~~
> -
> -"Object"
> -
> -
> -Errors
> -~~~~~~
> -
> + Errors:
> * some
>
> Notes:
> @@ -68,10 +50,3 @@ Examples:
> Note::
> Ceci n'est pas une note
>
> -
> -Since
> -~~~~~
> -
> -2.10
> -
> -
> diff -rupw o/09 n/09
> --- o/09 2025-06-16 14:11:32.819939859 +0200
> +++ n/09 2025-06-16 13:51:43.469482599 +0200
> @@ -1,22 +1,14 @@
> -"cmd-boxed" (Command)
> ----------------------
> +Command cmd-boxed
>
> If you're bored enough to read this, go see a video of boxed cats
>
> + Arguments:
> + * The members of "Object".
>
> -Arguments
> -~~~~~~~~~
> + Features:
> + * **cmd-feat1** -- a feature
>
> -The members of "Object"
> -
> -Features
> -~~~~~~~~
> -
> -"cmd-feat1"
> - a feature
> -
> -"cmd-feat2"
> - another feature
> + * **cmd-feat2** -- another feature
>
> Example::
>
> @@ -24,4 +16,3 @@ Example::
>
> <- ... has no title ...
>
> -
> diff -rupw o/10 n/10
> --- o/10 2025-06-16 14:11:35.771883514 +0200
> +++ n/10 2025-06-16 13:51:46.653422395 +0200
> @@ -1,14 +1,7 @@
> -"EVT_BOXED" (Event)
> --------------------
> +Event EVT_BOXED
>
> + Members:
> + * The members of "Object".
>
> -Arguments
> -~~~~~~~~~
> -
> -The members of "Object"
> -
> -Features
> -~~~~~~~~
> -
> -"feat3"
> - a feature
> + Features:
> + * **feat3** -- a feature
>
> The only unexpected change is the first hunk.
Some of these look a little silly, let me see what I can do ... The IFCOND
stuff is a known issue, and I believe is best tackled in conjunction with
your project to add conditional documentation entities.
Everything else, I'll review and see what can be improved upon if anything.
John Snow <jsnow@redhat.com> writes:
> On Mon, Jun 16, 2025 at 8:20 AM Markus Armbruster <armbru@redhat.com> wrote:
>
>> John Snow <jsnow@redhat.com> writes:
>>
>> > Thanks for your service!
>> >
>> > Remove the old qapidoc and the option to enable the transmogrifier,
>> > leaving the "transmogrifier" as the ONLY qapi doc generator. This in
>> > effect also converts the QAPI test to use the new documentation
>> > generator, too.
>> >
>> > Signed-off-by: John Snow <jsnow@redhat.com>
>>
>> Fails "make check", because tests/qapi-schema/doc-good.txt needs an
>> update.
>>
>> Unfortunately, the diff of the update is less than useful. To make
>> sense of what changes, I split doc-good.txt into parts before and after,
>> and diffed those.
>>
>>
>> diff -rupw o/01 n/01
>> --- o/01 2025-06-16 13:53:05.036940854 +0200
>> +++ n/01 2025-06-16 13:49:07.167435996 +0200
>> @@ -1,11 +1,13 @@
>> Section
>> *******
>>
>> +Just text, no heading.
>> +
>>
>> Looks like a bug fix. Needs a mention in the commit message then.
>>
>
> I think before, these sections just got ... discarded?
Looks like it. Definitely a bug.
> but with no special
> formatting, they just get copied through. You could call it a bugfix, you
> could call it an unintentional side effect.
I'm calling it a bug fix. Where was it broken? Dig, dig, dig, ...
commit b61a4eb3f32ce74c5ffe001806f9e786788a546f
Author: John Snow <jsnow@redhat.com>
Date: Sun Feb 23 22:37:35 2025 -0500
docs/qapidoc: support header-less freeform sections
The code as written crashes when a free-form documentation block doesn't
start with a heading or subheading, for example:
| ##
| # Just text, no heading.
| ##
The code will attempt to use the `node` variable uninitialized. To fix,
create a generic block to insert the doc text into.
(This patch also removes a lingering pylint warning in the QAPIDoc
implementation that prevents getting a clean baseline to use for
forthcoming additions.)
Fixes: 43e0d14ee09a (docs/sphinx: fix extra stuff in TOC after freeform QMP sections)
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250224033741.222749-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Test updated to cover this]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
The patch adds such a block to doc-good.json. It shows up in expected
output doc-good.out, but not in doc-good.txt. Review fail.
Please mention the fix in the commit message, and add the Fixes: tag.
[...]
© 2016 - 2025 Red Hat, Inc.